diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2989d57aa1..d54a5f76dc 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,31 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.52.0 - 2021-11-30 +==================== + +Added +----- +* Support for SQL Tuning Advisor in the Database Management service +* Support for listing users and getting user details in the Database Management service +* Support for autonomous databases in the Database Management service +* Support for enabling and disabling Database Management features on autonomous databases in the Database service +* Support for the Solaris platform in the Management Agent Cloud service +* Support for cross-compartment operations in the Operations Insights service +* Support for listing deployment backups in the GoldenGate service +* Support for standard tags in the Identity service +* Support for viewing problems for deleted targets in the Cloud Guard service +* Support for choosing a platform version while creating a platform instance in the Blockchain Platform service +* Support for custom IPSec connection tunnel internet key exchange phase 1 and phase 2 encryption algorithms in the Networking service +* Support for pagination when listing work requests corresponding to an APM domain in the Application Performance Monitoring service +* Support for the "deleted" lifecycle state on APM domains in the Application Performance Monitoring service +* Support for calling Oracle Cloud Infrastructure services in the eu-milan-1 and me-abudhabi-1 regions + +Breaking +-------- +* Support for retries enabled by default in all operations of the DevOps, Build, and Source Code Management services + ==================== 2.51.0 - 2021-11-17 ==================== diff --git a/docs/api/blockchain.rst b/docs/api/blockchain.rst index a0b34d6247..3a2a220c1c 100644 --- a/docs/api/blockchain.rst +++ b/docs/api/blockchain.rst @@ -23,6 +23,8 @@ Blockchain oci.blockchain.models.BlockchainPlatformByHostname oci.blockchain.models.BlockchainPlatformCollection oci.blockchain.models.BlockchainPlatformComponentDetails + oci.blockchain.models.BlockchainPlatformPatchCollection + oci.blockchain.models.BlockchainPlatformPatchSummary oci.blockchain.models.BlockchainPlatformSummary oci.blockchain.models.ChangeBlockchainPlatformCompartmentDetails oci.blockchain.models.CreateBlockchainPlatformDetails @@ -47,6 +49,7 @@ Blockchain oci.blockchain.models.UpdateBlockchainPlatformDetails oci.blockchain.models.UpdateOsnDetails oci.blockchain.models.UpdatePeerDetails + oci.blockchain.models.UpgradeBlockchainPlatformDetails oci.blockchain.models.WorkRequest oci.blockchain.models.WorkRequestCollection oci.blockchain.models.WorkRequestError diff --git a/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchCollection.rst b/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchCollection.rst new file mode 100644 index 0000000000..a0a9a9b7f8 --- /dev/null +++ b/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchCollection.rst @@ -0,0 +1,11 @@ +BlockchainPlatformPatchCollection +================================= + +.. currentmodule:: oci.blockchain.models + +.. autoclass:: BlockchainPlatformPatchCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchSummary.rst b/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchSummary.rst new file mode 100644 index 0000000000..8b8e5955be --- /dev/null +++ b/docs/api/blockchain/models/oci.blockchain.models.BlockchainPlatformPatchSummary.rst @@ -0,0 +1,11 @@ +BlockchainPlatformPatchSummary +============================== + +.. currentmodule:: oci.blockchain.models + +.. autoclass:: BlockchainPlatformPatchSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/blockchain/models/oci.blockchain.models.UpgradeBlockchainPlatformDetails.rst b/docs/api/blockchain/models/oci.blockchain.models.UpgradeBlockchainPlatformDetails.rst new file mode 100644 index 0000000000..8eb4d2e8c0 --- /dev/null +++ b/docs/api/blockchain/models/oci.blockchain.models.UpgradeBlockchainPlatformDetails.rst @@ -0,0 +1,11 @@ +UpgradeBlockchainPlatformDetails +================================ + +.. currentmodule:: oci.blockchain.models + +.. autoclass:: UpgradeBlockchainPlatformDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core.rst b/docs/api/core.rst index 3ee6a0e37a..efe500599f 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -34,6 +34,9 @@ Core Services oci.core.models.AddSecurityRuleDetails oci.core.models.AddVcnCidrDetails oci.core.models.AddedNetworkSecurityGroupSecurityRules + oci.core.models.AllowedIkeIPSecParameters + oci.core.models.AllowedPhaseOneParameters + oci.core.models.AllowedPhaseTwoParameters oci.core.models.AmdMilanBmLaunchInstancePlatformConfig oci.core.models.AmdMilanBmPlatformConfig oci.core.models.AmdRomeBmLaunchInstancePlatformConfig @@ -209,6 +212,8 @@ Core Services oci.core.models.DedicatedVmHostShapeSummary oci.core.models.DedicatedVmHostSummary oci.core.models.DefaultDrgRouteTables + oci.core.models.DefaultPhaseOneParameters + oci.core.models.DefaultPhaseTwoParameters oci.core.models.DeleteVirtualCircuitPublicPrefixDetails oci.core.models.DetachInstancePoolInstanceDetails oci.core.models.DetachLoadBalancerDetails @@ -217,6 +222,7 @@ Core Services oci.core.models.DhcpOption oci.core.models.DhcpOptions oci.core.models.DhcpSearchDomainOption + oci.core.models.DpdConfig oci.core.models.Drg oci.core.models.DrgAttachment oci.core.models.DrgAttachmentIdDrgRouteDistributionMatchCriteria @@ -247,6 +253,7 @@ Core Services oci.core.models.IPSecConnectionDeviceConfig oci.core.models.IPSecConnectionDeviceStatus oci.core.models.IPSecConnectionTunnel + oci.core.models.IPSecConnectionTunnelErrorDetails oci.core.models.IPSecConnectionTunnelSharedSecret oci.core.models.IScsiVolumeAttachment oci.core.models.IcmpOptions @@ -339,6 +346,8 @@ Core Services oci.core.models.NetworkingTopology oci.core.models.ParavirtualizedVolumeAttachment oci.core.models.PeerRegionForRemotePeering + oci.core.models.PhaseOneConfigDetails + oci.core.models.PhaseTwoConfigDetails oci.core.models.PlatformConfig oci.core.models.PortRange oci.core.models.PreemptibleInstanceConfigDetails @@ -386,6 +395,10 @@ Core Services oci.core.models.TopologyRoutesToRelationshipDetails oci.core.models.TunnelConfig oci.core.models.TunnelCpeDeviceConfig + oci.core.models.TunnelPhaseOneDetails + oci.core.models.TunnelPhaseTwoDetails + oci.core.models.TunnelRouteSummary + oci.core.models.TunnelSecurityAssociationSummary oci.core.models.TunnelStatus oci.core.models.UdpOptions oci.core.models.UpdateBootVolumeBackupDetails diff --git a/docs/api/core/models/oci.core.models.AllowedIkeIPSecParameters.rst b/docs/api/core/models/oci.core.models.AllowedIkeIPSecParameters.rst new file mode 100644 index 0000000000..b2c51f5021 --- /dev/null +++ b/docs/api/core/models/oci.core.models.AllowedIkeIPSecParameters.rst @@ -0,0 +1,11 @@ +AllowedIkeIPSecParameters +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: AllowedIkeIPSecParameters + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.AllowedPhaseOneParameters.rst b/docs/api/core/models/oci.core.models.AllowedPhaseOneParameters.rst new file mode 100644 index 0000000000..c8d4a5cbd1 --- /dev/null +++ b/docs/api/core/models/oci.core.models.AllowedPhaseOneParameters.rst @@ -0,0 +1,11 @@ +AllowedPhaseOneParameters +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: AllowedPhaseOneParameters + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.AllowedPhaseTwoParameters.rst b/docs/api/core/models/oci.core.models.AllowedPhaseTwoParameters.rst new file mode 100644 index 0000000000..2abb463b6d --- /dev/null +++ b/docs/api/core/models/oci.core.models.AllowedPhaseTwoParameters.rst @@ -0,0 +1,11 @@ +AllowedPhaseTwoParameters +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: AllowedPhaseTwoParameters + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.DefaultPhaseOneParameters.rst b/docs/api/core/models/oci.core.models.DefaultPhaseOneParameters.rst new file mode 100644 index 0000000000..06165858e9 --- /dev/null +++ b/docs/api/core/models/oci.core.models.DefaultPhaseOneParameters.rst @@ -0,0 +1,11 @@ +DefaultPhaseOneParameters +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: DefaultPhaseOneParameters + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.DefaultPhaseTwoParameters.rst b/docs/api/core/models/oci.core.models.DefaultPhaseTwoParameters.rst new file mode 100644 index 0000000000..a0934c7c37 --- /dev/null +++ b/docs/api/core/models/oci.core.models.DefaultPhaseTwoParameters.rst @@ -0,0 +1,11 @@ +DefaultPhaseTwoParameters +========================= + +.. currentmodule:: oci.core.models + +.. autoclass:: DefaultPhaseTwoParameters + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.DpdConfig.rst b/docs/api/core/models/oci.core.models.DpdConfig.rst new file mode 100644 index 0000000000..c3bc1f14c4 --- /dev/null +++ b/docs/api/core/models/oci.core.models.DpdConfig.rst @@ -0,0 +1,11 @@ +DpdConfig +========= + +.. currentmodule:: oci.core.models + +.. autoclass:: DpdConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.IPSecConnectionTunnelErrorDetails.rst b/docs/api/core/models/oci.core.models.IPSecConnectionTunnelErrorDetails.rst new file mode 100644 index 0000000000..b1c347de95 --- /dev/null +++ b/docs/api/core/models/oci.core.models.IPSecConnectionTunnelErrorDetails.rst @@ -0,0 +1,11 @@ +IPSecConnectionTunnelErrorDetails +================================= + +.. currentmodule:: oci.core.models + +.. autoclass:: IPSecConnectionTunnelErrorDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.PhaseOneConfigDetails.rst b/docs/api/core/models/oci.core.models.PhaseOneConfigDetails.rst new file mode 100644 index 0000000000..61f1ac8fad --- /dev/null +++ b/docs/api/core/models/oci.core.models.PhaseOneConfigDetails.rst @@ -0,0 +1,11 @@ +PhaseOneConfigDetails +===================== + +.. currentmodule:: oci.core.models + +.. autoclass:: PhaseOneConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.PhaseTwoConfigDetails.rst b/docs/api/core/models/oci.core.models.PhaseTwoConfigDetails.rst new file mode 100644 index 0000000000..beb4a6553b --- /dev/null +++ b/docs/api/core/models/oci.core.models.PhaseTwoConfigDetails.rst @@ -0,0 +1,11 @@ +PhaseTwoConfigDetails +===================== + +.. currentmodule:: oci.core.models + +.. autoclass:: PhaseTwoConfigDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.TunnelPhaseOneDetails.rst b/docs/api/core/models/oci.core.models.TunnelPhaseOneDetails.rst new file mode 100644 index 0000000000..317ed50185 --- /dev/null +++ b/docs/api/core/models/oci.core.models.TunnelPhaseOneDetails.rst @@ -0,0 +1,11 @@ +TunnelPhaseOneDetails +===================== + +.. currentmodule:: oci.core.models + +.. autoclass:: TunnelPhaseOneDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.TunnelPhaseTwoDetails.rst b/docs/api/core/models/oci.core.models.TunnelPhaseTwoDetails.rst new file mode 100644 index 0000000000..b8e1dfcfbb --- /dev/null +++ b/docs/api/core/models/oci.core.models.TunnelPhaseTwoDetails.rst @@ -0,0 +1,11 @@ +TunnelPhaseTwoDetails +===================== + +.. currentmodule:: oci.core.models + +.. autoclass:: TunnelPhaseTwoDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.TunnelRouteSummary.rst b/docs/api/core/models/oci.core.models.TunnelRouteSummary.rst new file mode 100644 index 0000000000..9f867be898 --- /dev/null +++ b/docs/api/core/models/oci.core.models.TunnelRouteSummary.rst @@ -0,0 +1,11 @@ +TunnelRouteSummary +================== + +.. currentmodule:: oci.core.models + +.. autoclass:: TunnelRouteSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core/models/oci.core.models.TunnelSecurityAssociationSummary.rst b/docs/api/core/models/oci.core.models.TunnelSecurityAssociationSummary.rst new file mode 100644 index 0000000000..99b9466c2f --- /dev/null +++ b/docs/api/core/models/oci.core.models.TunnelSecurityAssociationSummary.rst @@ -0,0 +1,11 @@ +TunnelSecurityAssociationSummary +================================ + +.. currentmodule:: oci.core.models + +.. autoclass:: TunnelSecurityAssociationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management.rst b/docs/api/database_management.rst index 47166178d4..f13575847c 100644 --- a/docs/api/database_management.rst +++ b/docs/api/database_management.rst @@ -7,7 +7,9 @@ Database Management :template: autosummary/service_client.rst oci.database_management.DbManagementClient + oci.database_management.SqlTuningClient oci.database_management.DbManagementClientCompositeOperations + oci.database_management.SqlTuningClientCompositeOperations -------- Models @@ -54,11 +56,17 @@ Database Management oci.database_management.models.ChangeJobCompartmentDetails oci.database_management.models.ChangeManagedDatabaseGroupCompartmentDetails oci.database_management.models.ChildDatabase + oci.database_management.models.CloneSqlTuningTaskDetails oci.database_management.models.ClusterCacheMetric + oci.database_management.models.ConsumerGroupPrivilegeCollection + oci.database_management.models.ConsumerGroupPrivilegeSummary + oci.database_management.models.CpuUtilizationAggregateMetrics oci.database_management.models.CreateDbManagementPrivateEndpointDetails oci.database_management.models.CreateJobDetails oci.database_management.models.CreateManagedDatabaseGroupDetails oci.database_management.models.CreateSqlJobDetails + oci.database_management.models.DataAccessContainerCollection + oci.database_management.models.DataAccessContainerSummary oci.database_management.models.DatabaseCredentials oci.database_management.models.DatabaseFleetHealthMetrics oci.database_management.models.DatabaseHomeMetricDefinition @@ -75,6 +83,9 @@ Database Management oci.database_management.models.DbManagementPrivateEndpoint oci.database_management.models.DbManagementPrivateEndpointCollection oci.database_management.models.DbManagementPrivateEndpointSummary + oci.database_management.models.DropSqlTuningTaskDetails + oci.database_management.models.ExecutionPlanStatsComparision + oci.database_management.models.FailedConnectionsAggregateMetrics oci.database_management.models.FleetMetricDefinition oci.database_management.models.FleetMetricSummaryDefinition oci.database_management.models.FleetStatusByCategory @@ -104,14 +115,48 @@ Database Management oci.database_management.models.MemoryAggregateMetrics oci.database_management.models.MetricDataPoint oci.database_management.models.MetricDimensionDefinition + oci.database_management.models.ObjectPrivilegeCollection + oci.database_management.models.ObjectPrivilegeSummary oci.database_management.models.ObjectStorageJobExecutionResultDetails oci.database_management.models.ObjectStorageJobExecutionResultLocation oci.database_management.models.ParentGroup oci.database_management.models.PdbMetrics oci.database_management.models.PdbStatusDetails + oci.database_management.models.ProxiedForUserCollection + oci.database_management.models.ProxiedForUserSummary + oci.database_management.models.ProxyUserCollection + oci.database_management.models.ProxyUserSummary oci.database_management.models.RemoveManagedDatabaseFromManagedDatabaseGroupDetails oci.database_management.models.ResetDatabaseParametersDetails + oci.database_management.models.RoleCollection + oci.database_management.models.RoleSummary oci.database_management.models.SqlJob + oci.database_management.models.SqlTuningAdvisorTaskCollection + oci.database_management.models.SqlTuningAdvisorTaskFindingCollection + oci.database_management.models.SqlTuningAdvisorTaskFindingSummary + oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection + oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary + oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan + oci.database_management.models.SqlTuningAdvisorTaskSummary + oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits + oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts + oci.database_management.models.SqlTuningAdvisorTaskSummaryReport + oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary + oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary + oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts + oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics + oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo + oci.database_management.models.SqlTuningTaskCredentialDetails + oci.database_management.models.SqlTuningTaskPasswordCredentialDetails + oci.database_management.models.SqlTuningTaskPlanStats + oci.database_management.models.SqlTuningTaskReturn + oci.database_management.models.SqlTuningTaskSecretCredentialDetails + oci.database_management.models.SqlTuningTaskSqlDetail + oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep + oci.database_management.models.StartSqlTuningTaskDetails + oci.database_management.models.StatementsAggregateMetrics + oci.database_management.models.SystemPrivilegeCollection + oci.database_management.models.SystemPrivilegeSummary oci.database_management.models.Tablespace oci.database_management.models.TablespaceCollection oci.database_management.models.TablespaceSummary @@ -122,6 +167,9 @@ Database Management oci.database_management.models.UpdateJobDetails oci.database_management.models.UpdateManagedDatabaseGroupDetails oci.database_management.models.UpdateSqlJobDetails + oci.database_management.models.User + oci.database_management.models.UserCollection + oci.database_management.models.UserSummary oci.database_management.models.WorkRequest oci.database_management.models.WorkRequestCollection oci.database_management.models.WorkRequestError diff --git a/docs/api/database_management/client/oci.database_management.SqlTuningClient.rst b/docs/api/database_management/client/oci.database_management.SqlTuningClient.rst new file mode 100644 index 0000000000..831e5356c4 --- /dev/null +++ b/docs/api/database_management/client/oci.database_management.SqlTuningClient.rst @@ -0,0 +1,8 @@ +SqlTuningClient +=============== + +.. currentmodule:: oci.database_management + +.. autoclass:: SqlTuningClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/database_management/client/oci.database_management.SqlTuningClientCompositeOperations.rst b/docs/api/database_management/client/oci.database_management.SqlTuningClientCompositeOperations.rst new file mode 100644 index 0000000000..b8d4ce633b --- /dev/null +++ b/docs/api/database_management/client/oci.database_management.SqlTuningClientCompositeOperations.rst @@ -0,0 +1,8 @@ +SqlTuningClientCompositeOperations +================================== + +.. currentmodule:: oci.database_management + +.. autoclass:: SqlTuningClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.CloneSqlTuningTaskDetails.rst b/docs/api/database_management/models/oci.database_management.models.CloneSqlTuningTaskDetails.rst new file mode 100644 index 0000000000..ea9a84fc37 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.CloneSqlTuningTaskDetails.rst @@ -0,0 +1,11 @@ +CloneSqlTuningTaskDetails +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: CloneSqlTuningTaskDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeCollection.rst b/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeCollection.rst new file mode 100644 index 0000000000..c0bd0324a7 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeCollection.rst @@ -0,0 +1,11 @@ +ConsumerGroupPrivilegeCollection +================================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ConsumerGroupPrivilegeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeSummary.rst b/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeSummary.rst new file mode 100644 index 0000000000..4985807ff6 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ConsumerGroupPrivilegeSummary.rst @@ -0,0 +1,11 @@ +ConsumerGroupPrivilegeSummary +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ConsumerGroupPrivilegeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.CpuUtilizationAggregateMetrics.rst b/docs/api/database_management/models/oci.database_management.models.CpuUtilizationAggregateMetrics.rst new file mode 100644 index 0000000000..51b669f10e --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.CpuUtilizationAggregateMetrics.rst @@ -0,0 +1,11 @@ +CpuUtilizationAggregateMetrics +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: CpuUtilizationAggregateMetrics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DataAccessContainerCollection.rst b/docs/api/database_management/models/oci.database_management.models.DataAccessContainerCollection.rst new file mode 100644 index 0000000000..4e2c665d66 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DataAccessContainerCollection.rst @@ -0,0 +1,11 @@ +DataAccessContainerCollection +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DataAccessContainerCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DataAccessContainerSummary.rst b/docs/api/database_management/models/oci.database_management.models.DataAccessContainerSummary.rst new file mode 100644 index 0000000000..5cf01f5d1f --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DataAccessContainerSummary.rst @@ -0,0 +1,11 @@ +DataAccessContainerSummary +========================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DataAccessContainerSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.DropSqlTuningTaskDetails.rst b/docs/api/database_management/models/oci.database_management.models.DropSqlTuningTaskDetails.rst new file mode 100644 index 0000000000..f01bb9b6ba --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.DropSqlTuningTaskDetails.rst @@ -0,0 +1,11 @@ +DropSqlTuningTaskDetails +======================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: DropSqlTuningTaskDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ExecutionPlanStatsComparision.rst b/docs/api/database_management/models/oci.database_management.models.ExecutionPlanStatsComparision.rst new file mode 100644 index 0000000000..fa6d45051c --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ExecutionPlanStatsComparision.rst @@ -0,0 +1,11 @@ +ExecutionPlanStatsComparision +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ExecutionPlanStatsComparision + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.FailedConnectionsAggregateMetrics.rst b/docs/api/database_management/models/oci.database_management.models.FailedConnectionsAggregateMetrics.rst new file mode 100644 index 0000000000..f9e68bbfe2 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.FailedConnectionsAggregateMetrics.rst @@ -0,0 +1,11 @@ +FailedConnectionsAggregateMetrics +================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: FailedConnectionsAggregateMetrics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeCollection.rst b/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeCollection.rst new file mode 100644 index 0000000000..8aada88e83 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeCollection.rst @@ -0,0 +1,11 @@ +ObjectPrivilegeCollection +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ObjectPrivilegeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeSummary.rst b/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeSummary.rst new file mode 100644 index 0000000000..1d46c0c48e --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ObjectPrivilegeSummary.rst @@ -0,0 +1,11 @@ +ObjectPrivilegeSummary +====================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ObjectPrivilegeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ProxiedForUserCollection.rst b/docs/api/database_management/models/oci.database_management.models.ProxiedForUserCollection.rst new file mode 100644 index 0000000000..66e80c4d0f --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ProxiedForUserCollection.rst @@ -0,0 +1,11 @@ +ProxiedForUserCollection +======================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ProxiedForUserCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ProxiedForUserSummary.rst b/docs/api/database_management/models/oci.database_management.models.ProxiedForUserSummary.rst new file mode 100644 index 0000000000..b0a635c402 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ProxiedForUserSummary.rst @@ -0,0 +1,11 @@ +ProxiedForUserSummary +===================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ProxiedForUserSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ProxyUserCollection.rst b/docs/api/database_management/models/oci.database_management.models.ProxyUserCollection.rst new file mode 100644 index 0000000000..fc70a0687e --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ProxyUserCollection.rst @@ -0,0 +1,11 @@ +ProxyUserCollection +=================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ProxyUserCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.ProxyUserSummary.rst b/docs/api/database_management/models/oci.database_management.models.ProxyUserSummary.rst new file mode 100644 index 0000000000..3dffbfe946 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.ProxyUserSummary.rst @@ -0,0 +1,11 @@ +ProxyUserSummary +================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: ProxyUserSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.RoleCollection.rst b/docs/api/database_management/models/oci.database_management.models.RoleCollection.rst new file mode 100644 index 0000000000..ed2d0d6a5d --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.RoleCollection.rst @@ -0,0 +1,11 @@ +RoleCollection +============== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: RoleCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.RoleSummary.rst b/docs/api/database_management/models/oci.database_management.models.RoleSummary.rst new file mode 100644 index 0000000000..13faaebbfa --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.RoleSummary.rst @@ -0,0 +1,11 @@ +RoleSummary +=========== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: RoleSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskCollection.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskCollection.rst new file mode 100644 index 0000000000..471b1a0662 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskCollection.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskCollection +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingCollection.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingCollection.rst new file mode 100644 index 0000000000..791571e446 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingCollection.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskFindingCollection +===================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskFindingCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingSummary.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingSummary.rst new file mode 100644 index 0000000000..8c79bbc91d --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskFindingSummary.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskFindingSummary +================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskFindingSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection.rst new file mode 100644 index 0000000000..5741d37891 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskRecommendationCollection +============================================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskRecommendationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary.rst new file mode 100644 index 0000000000..adb31e3db8 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskRecommendationSummary +========================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskRecommendationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan.rst new file mode 100644 index 0000000000..b748a18ef4 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSqlExecutionPlan +==================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSqlExecutionPlan + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummary.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummary.rst new file mode 100644 index 0000000000..6d91079e57 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummary.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummary +=========================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits.rst new file mode 100644 index 0000000000..27d6350c73 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryFindingBenefits +========================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryFindingBenefits + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts.rst new file mode 100644 index 0000000000..be8078d486 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryFindingCounts +======================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryFindingCounts + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReport.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReport.rst new file mode 100644 index 0000000000..c09beb3f60 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReport.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReport +================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReport + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary.rst new file mode 100644 index 0000000000..cd7af82bc9 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReportIndexFindingSummary +==================================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReportIndexFindingSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary.rst new file mode 100644 index 0000000000..5c0e423088 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary +========================================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts.rst new file mode 100644 index 0000000000..8117e9e872 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReportStatementCounts +================================================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReportStatementCounts + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics.rst new file mode 100644 index 0000000000..49eafc124d --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReportStatistics +=========================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReportStatistics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo.rst new file mode 100644 index 0000000000..055912f701 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo.rst @@ -0,0 +1,11 @@ +SqlTuningAdvisorTaskSummaryReportTaskInfo +========================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningAdvisorTaskSummaryReportTaskInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskCredentialDetails.rst new file mode 100644 index 0000000000..92514ba4ce --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningTaskCredentialDetails +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPasswordCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPasswordCredentialDetails.rst new file mode 100644 index 0000000000..c77951dd32 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPasswordCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningTaskPasswordCredentialDetails +====================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskPasswordCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPlanStats.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPlanStats.rst new file mode 100644 index 0000000000..d5b61cebd4 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskPlanStats.rst @@ -0,0 +1,11 @@ +SqlTuningTaskPlanStats +====================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskPlanStats + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskReturn.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskReturn.rst new file mode 100644 index 0000000000..327c623c29 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskReturn.rst @@ -0,0 +1,11 @@ +SqlTuningTaskReturn +=================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskReturn + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSecretCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSecretCredentialDetails.rst new file mode 100644 index 0000000000..07b62726d6 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSecretCredentialDetails.rst @@ -0,0 +1,11 @@ +SqlTuningTaskSecretCredentialDetails +==================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskSecretCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlDetail.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlDetail.rst new file mode 100644 index 0000000000..d363fb8eba --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlDetail.rst @@ -0,0 +1,11 @@ +SqlTuningTaskSqlDetail +====================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskSqlDetail + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep.rst b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep.rst new file mode 100644 index 0000000000..52c3ac4ff7 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep.rst @@ -0,0 +1,11 @@ +SqlTuningTaskSqlExecutionPlanStep +================================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SqlTuningTaskSqlExecutionPlanStep + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.StartSqlTuningTaskDetails.rst b/docs/api/database_management/models/oci.database_management.models.StartSqlTuningTaskDetails.rst new file mode 100644 index 0000000000..13dfcf2e6d --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.StartSqlTuningTaskDetails.rst @@ -0,0 +1,11 @@ +StartSqlTuningTaskDetails +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: StartSqlTuningTaskDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.StatementsAggregateMetrics.rst b/docs/api/database_management/models/oci.database_management.models.StatementsAggregateMetrics.rst new file mode 100644 index 0000000000..5fa3e21e4a --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.StatementsAggregateMetrics.rst @@ -0,0 +1,11 @@ +StatementsAggregateMetrics +========================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: StatementsAggregateMetrics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeCollection.rst b/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeCollection.rst new file mode 100644 index 0000000000..5186c3a795 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeCollection.rst @@ -0,0 +1,11 @@ +SystemPrivilegeCollection +========================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SystemPrivilegeCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeSummary.rst b/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeSummary.rst new file mode 100644 index 0000000000..7a07bf802e --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.SystemPrivilegeSummary.rst @@ -0,0 +1,11 @@ +SystemPrivilegeSummary +====================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: SystemPrivilegeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.User.rst b/docs/api/database_management/models/oci.database_management.models.User.rst new file mode 100644 index 0000000000..7412f7f492 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.User.rst @@ -0,0 +1,11 @@ +User +==== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: User + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.UserCollection.rst b/docs/api/database_management/models/oci.database_management.models.UserCollection.rst new file mode 100644 index 0000000000..04676c7773 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.UserCollection.rst @@ -0,0 +1,11 @@ +UserCollection +============== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: UserCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.UserSummary.rst b/docs/api/database_management/models/oci.database_management.models.UserSummary.rst new file mode 100644 index 0000000000..5aaad58732 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.UserSummary.rst @@ -0,0 +1,11 @@ +UserSummary +=========== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: UserSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/identity.rst b/docs/api/identity.rst index ce9c11b6ed..28c14244c8 100644 --- a/docs/api/identity.rst +++ b/docs/api/identity.rst @@ -82,6 +82,7 @@ Identity oci.identity.models.IdentityProvider oci.identity.models.IdentityProviderGroupSummary oci.identity.models.IdpGroupMapping + oci.identity.models.ImportStandardTagsDetails oci.identity.models.MfaTotpDevice oci.identity.models.MfaTotpDeviceSummary oci.identity.models.MfaTotpToken @@ -101,6 +102,9 @@ Identity oci.identity.models.ScimClientCredentials oci.identity.models.SmtpCredential oci.identity.models.SmtpCredentialSummary + oci.identity.models.StandardTagDefinitionTemplate + oci.identity.models.StandardTagNamespaceTemplate + oci.identity.models.StandardTagNamespaceTemplateSummary oci.identity.models.SwiftPassword oci.identity.models.Tag oci.identity.models.TagDefault diff --git a/docs/api/identity/models/oci.identity.models.ImportStandardTagsDetails.rst b/docs/api/identity/models/oci.identity.models.ImportStandardTagsDetails.rst new file mode 100644 index 0000000000..37ffee8987 --- /dev/null +++ b/docs/api/identity/models/oci.identity.models.ImportStandardTagsDetails.rst @@ -0,0 +1,11 @@ +ImportStandardTagsDetails +========================= + +.. currentmodule:: oci.identity.models + +.. autoclass:: ImportStandardTagsDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/identity/models/oci.identity.models.StandardTagDefinitionTemplate.rst b/docs/api/identity/models/oci.identity.models.StandardTagDefinitionTemplate.rst new file mode 100644 index 0000000000..0475e23a69 --- /dev/null +++ b/docs/api/identity/models/oci.identity.models.StandardTagDefinitionTemplate.rst @@ -0,0 +1,11 @@ +StandardTagDefinitionTemplate +============================= + +.. currentmodule:: oci.identity.models + +.. autoclass:: StandardTagDefinitionTemplate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplate.rst b/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplate.rst new file mode 100644 index 0000000000..31736da8e1 --- /dev/null +++ b/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplate.rst @@ -0,0 +1,11 @@ +StandardTagNamespaceTemplate +============================ + +.. currentmodule:: oci.identity.models + +.. autoclass:: StandardTagNamespaceTemplate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplateSummary.rst b/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplateSummary.rst new file mode 100644 index 0000000000..814a25815b --- /dev/null +++ b/docs/api/identity/models/oci.identity.models.StandardTagNamespaceTemplateSummary.rst @@ -0,0 +1,11 @@ +StandardTagNamespaceTemplateSummary +=================================== + +.. currentmodule:: oci.identity.models + +.. autoclass:: StandardTagNamespaceTemplateSummary + :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 bc2ff83a1a..ac748fd35c 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -47,6 +47,7 @@ API Reference * :doc:`Data Science ` * :doc:`Database ` * :doc:`Db Management ` +* :doc:`Sql Tuning ` * :doc:`Database Migration ` * :doc:`Database Tools ` * :doc:`Devops ` diff --git a/src/oci/apm_control_plane/apm_domain_client.py b/src/oci/apm_control_plane/apm_domain_client.py index 0acf2b269f..fa93f8ec7a 100644 --- a/src/oci/apm_control_plane/apm_domain_client.py +++ b/src/oci/apm_control_plane/apm_domain_client.py @@ -18,8 +18,8 @@ class ApmDomainClient(object): """ - Provide a set of APIs for tenant to perform operations like create, update, delete and list APM domains, and also - work request APIs to monitor progress of these operations. + Use the Application Performance Monitoring Control Plane API to perform operations such as creating, updating, + deleting and listing APM domains and monitoring the progress of these operations using the work request APIs. """ def __init__(self, config, **kwargs): @@ -101,19 +101,18 @@ def __init__(self, config, **kwargs): def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compartment_details, **kwargs): """ - Moves a APM Domain into a different compartment. When provided, If-Match is checked against ETag values of the resource. + Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param oci.apm_control_plane.models.ChangeApmDomainCompartmentDetails change_apm_domain_compartment_details: (required) The information to be used in changing compartment. :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. + For optimistic concurrency control. 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. @@ -202,11 +201,11 @@ def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compart def create_apm_domain(self, create_apm_domain_details, **kwargs): """ - Creates a new APM Domain. + Creates a new APM domain. :param oci.apm_control_plane.models.CreateApmDomainDetails create_apm_domain_details: (required) - Details for the new APM Domain. + Details for the new APM domain. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -279,18 +278,17 @@ def create_apm_domain(self, create_apm_domain_details, **kwargs): def delete_apm_domain(self, apm_domain_id, **kwargs): """ - Delete the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop + Deletes the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the - returned work request to track the progress of the background activity to complete deleting the domain. + returned work request ID to track the progress of the background activity to complete deleting the APM domain. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :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. + For optimistic concurrency control. 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. @@ -375,12 +373,11 @@ def generate_data_keys(self, generate_data_keys_list_details, apm_domain_id, **k List of new Data Keys to be generated. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :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. + For optimistic concurrency control. 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. @@ -459,11 +456,11 @@ def generate_data_keys(self, generate_data_keys_list_details, apm_domain_id, **k def get_apm_domain(self, apm_domain_id, **kwargs): """ - Gets details of APM Domain by identifier + Gets the details of the APM domain specified by OCID. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param str opc_request_id: (optional) The client request ID for tracing. @@ -617,15 +614,21 @@ def get_work_request(self, work_request_id, **kwargs): def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): """ - Returns a (paginated) list of work requests related to a specific APM Domain. + Returns a (paginated) list of work requests related to a specific APM domain. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :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. @@ -646,7 +649,9 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_request_id" + "opc_request_id", + "page", + "limit" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -663,6 +668,12 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + query_params = { + "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", @@ -684,6 +695,7 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="list[WorkRequest]") else: @@ -691,12 +703,13 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="list[WorkRequest]") def list_apm_domains(self, compartment_id, **kwargs): """ - Lists all APM Domains for the specified tenant compartment. + Lists all APM domains for the specified tenant compartment. :param str compartment_id: (required) @@ -708,7 +721,7 @@ def list_apm_domains(self, compartment_id, **kwargs): :param str lifecycle_state: (optional) A filter to return only resources that match the given life-cycle state. - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED" + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" :param int limit: (optional) The maximum number of items to return. @@ -763,7 +776,7 @@ def list_apm_domains(self, compartment_id, **kwargs): "list_apm_domains got unknown kwargs: {!r}".format(extra_kwargs)) if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"] + 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) @@ -827,12 +840,12 @@ def list_apm_domains(self, compartment_id, **kwargs): def list_data_keys(self, apm_domain_id, **kwargs): """ - Lists all Data Keys for the specified APM Domain. The caller may filter the list by specifying the 'dataKeyType' + Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the 'dataKeyType' query parameter. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param str data_key_type: (optional) Data key type. @@ -927,7 +940,7 @@ def list_data_keys(self, apm_domain_id, **kwargs): def list_work_request_errors(self, work_request_id, **kwargs): """ - Return a (paginated) list of errors for a given work request. + Returns a (paginated) list of errors for a given work request. :param str work_request_id: (required) @@ -1022,7 +1035,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): def list_work_request_logs(self, work_request_id, **kwargs): """ - Return a (paginated) list of logs for a given work request. + Returns a (paginated) list of logs for a given work request. :param str work_request_id: (required) @@ -1206,15 +1219,14 @@ def remove_data_keys(self, apm_domain_id, remove_data_keys_list_details, **kwarg :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param oci.apm_control_plane.models.list[RemoveDataKeyDetails] remove_data_keys_list_details: (required) List of Data Keys to be removed. :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. + For optimistic concurrency control. 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. @@ -1293,19 +1305,18 @@ def remove_data_keys(self, apm_domain_id, remove_data_keys_list_details, **kwarg def update_apm_domain(self, apm_domain_id, update_apm_domain_details, **kwargs): """ - Update the APM domain when it is ready and active. + Updates the APM domain. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param oci.apm_control_plane.models.UpdateApmDomainDetails update_apm_domain_details: (required) - The information to be updated for the APM Domain. + The information to be updated for the APM domain. :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. + For optimistic concurrency control. 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. diff --git a/src/oci/apm_control_plane/apm_domain_client_composite_operations.py b/src/oci/apm_control_plane/apm_domain_client_composite_operations.py index d7fc0ea785..c8b3067994 100644 --- a/src/oci/apm_control_plane/apm_domain_client_composite_operations.py +++ b/src/oci/apm_control_plane/apm_domain_client_composite_operations.py @@ -29,7 +29,7 @@ def change_apm_domain_compartment_and_wait_for_state(self, apm_domain_id, change to enter the given state(s). :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param oci.apm_control_plane.models.ChangeApmDomainCompartmentDetails change_apm_domain_compartment_details: (required) The information to be used in changing compartment. @@ -70,7 +70,7 @@ def create_apm_domain_and_wait_for_state(self, create_apm_domain_details, wait_f to enter the given state(s). :param oci.apm_control_plane.models.CreateApmDomainDetails create_apm_domain_details: (required) - Details for the new APM Domain. + Details for the new APM domain. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` @@ -108,7 +108,7 @@ def delete_apm_domain_and_wait_for_state(self, apm_domain_id, wait_for_states=[] to enter the given state(s). :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` @@ -157,7 +157,7 @@ def generate_data_keys_and_wait_for_state(self, generate_data_keys_list_details, List of new Data Keys to be generated. :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` @@ -195,7 +195,7 @@ def remove_data_keys_and_wait_for_state(self, apm_domain_id, remove_data_keys_li to enter the given state(s). :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param list[RemoveDataKeyDetails] remove_data_keys_list_details: (required) List of Data Keys to be removed. @@ -236,10 +236,10 @@ def update_apm_domain_and_wait_for_state(self, apm_domain_id, update_apm_domain_ to enter the given state(s). :param str apm_domain_id: (required) - OCID of the APM Domain + The OCID of the APM domain :param oci.apm_control_plane.models.UpdateApmDomainDetails update_apm_domain_details: (required) - The information to be updated for the APM Domain. + The information to be updated for the APM domain. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` diff --git a/src/oci/apm_control_plane/models/apm_domain.py b/src/oci/apm_control_plane/models/apm_domain.py index 2d7392dd8d..b0c3af7414 100644 --- a/src/oci/apm_control_plane/models/apm_domain.py +++ b/src/oci/apm_control_plane/models/apm_domain.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ApmDomain(object): """ - Details of an APM Domain. + Details of an APM domain. """ #: A constant which can be used with the lifecycle_state property of a ApmDomain. @@ -29,6 +29,10 @@ class ApmDomain(object): #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" + #: A constant which can be used with the lifecycle_state property of a ApmDomain. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the lifecycle_state property of a ApmDomain. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" @@ -60,7 +64,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this ApmDomain. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + 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 @@ -129,7 +133,7 @@ def __init__(self, **kwargs): def data_upload_endpoint(self): """ Gets the data_upload_endpoint of this ApmDomain. - Where APM Agents upload their observations and metrics. + The endpoint where the APM agents upload their observations and metrics. :return: The data_upload_endpoint of this ApmDomain. @@ -141,7 +145,7 @@ def data_upload_endpoint(self): def data_upload_endpoint(self, data_upload_endpoint): """ Sets the data_upload_endpoint of this ApmDomain. - Where APM Agents upload their observations and metrics. + The endpoint where the APM agents upload their observations and metrics. :param data_upload_endpoint: The data_upload_endpoint of this ApmDomain. @@ -177,7 +181,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this ApmDomain. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :return: The display_name of this ApmDomain. @@ -189,7 +193,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ApmDomain. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :param display_name: The display_name of this ApmDomain. @@ -201,7 +205,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ApmDomain. - Description of the APM Domain. + Description of the APM domain. :return: The description of this ApmDomain. @@ -213,7 +217,7 @@ def description(self): def description(self, description): """ Sets the description of this ApmDomain. - Description of the APM Domain. + Description of the APM domain. :param description: The description of this ApmDomain. @@ -225,7 +229,7 @@ def description(self, description): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ApmDomain. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :return: The compartment_id of this ApmDomain. @@ -237,7 +241,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ApmDomain. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :param compartment_id: The compartment_id of this ApmDomain. @@ -249,9 +253,9 @@ def compartment_id(self, compartment_id): def lifecycle_state(self): """ Gets the lifecycle_state of this ApmDomain. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + 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'. @@ -264,13 +268,13 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ApmDomain. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. :param lifecycle_state: The lifecycle_state of this ApmDomain. :type: str """ - allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"] + 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 @@ -303,7 +307,7 @@ def is_free_tier(self, is_free_tier): def time_created(self): """ Gets the time_created of this ApmDomain. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :return: The time_created of this ApmDomain. @@ -315,7 +319,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this ApmDomain. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :param time_created: The time_created of this ApmDomain. @@ -327,7 +331,7 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this ApmDomain. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :return: The time_updated of this ApmDomain. @@ -339,7 +343,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this ApmDomain. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :param time_updated: The time_updated of this ApmDomain. diff --git a/src/oci/apm_control_plane/models/apm_domain_summary.py b/src/oci/apm_control_plane/models/apm_domain_summary.py index d2ab789b5b..3eec3039ff 100644 --- a/src/oci/apm_control_plane/models/apm_domain_summary.py +++ b/src/oci/apm_control_plane/models/apm_domain_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ApmDomainSummary(object): """ - Summary of an APM Domain. + Summary of an APM domain. """ #: A constant which can be used with the lifecycle_state property of a ApmDomainSummary. @@ -29,6 +29,10 @@ class ApmDomainSummary(object): #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" + #: A constant which can be used with the lifecycle_state property of a ApmDomainSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the lifecycle_state property of a ApmDomainSummary. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" @@ -56,7 +60,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this ApmDomainSummary. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + 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 @@ -146,7 +150,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this ApmDomainSummary. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :return: The display_name of this ApmDomainSummary. @@ -158,7 +162,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ApmDomainSummary. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :param display_name: The display_name of this ApmDomainSummary. @@ -170,7 +174,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ApmDomainSummary. - Description of the APM Domain. + Description of the APM domain. :return: The description of this ApmDomainSummary. @@ -182,7 +186,7 @@ def description(self): def description(self, description): """ Sets the description of this ApmDomainSummary. - Description of the APM Domain. + Description of the APM domain. :param description: The description of this ApmDomainSummary. @@ -194,7 +198,7 @@ def description(self, description): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ApmDomainSummary. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :return: The compartment_id of this ApmDomainSummary. @@ -206,7 +210,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ApmDomainSummary. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :param compartment_id: The compartment_id of this ApmDomainSummary. @@ -218,9 +222,9 @@ def compartment_id(self, compartment_id): def lifecycle_state(self): """ Gets the lifecycle_state of this ApmDomainSummary. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + 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'. @@ -233,13 +237,13 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ApmDomainSummary. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. :param lifecycle_state: The lifecycle_state of this ApmDomainSummary. :type: str """ - allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"] + 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 @@ -272,7 +276,7 @@ def is_free_tier(self, is_free_tier): def time_created(self): """ Gets the time_created of this ApmDomainSummary. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :return: The time_created of this ApmDomainSummary. @@ -284,7 +288,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this ApmDomainSummary. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :param time_created: The time_created of this ApmDomainSummary. @@ -296,7 +300,7 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this ApmDomainSummary. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :return: The time_updated of this ApmDomainSummary. @@ -308,7 +312,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this ApmDomainSummary. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :param time_updated: The time_updated of this ApmDomainSummary. diff --git a/src/oci/apm_control_plane/models/base_domain_details.py b/src/oci/apm_control_plane/models/base_domain_details.py index c4a426f3c3..f97e121e4b 100644 --- a/src/oci/apm_control_plane/models/base_domain_details.py +++ b/src/oci/apm_control_plane/models/base_domain_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BaseDomainDetails(object): """ - Basic details for an APM Domain. + Details for an APM domain. """ #: A constant which can be used with the lifecycle_state property of a BaseDomainDetails. @@ -29,6 +29,10 @@ class BaseDomainDetails(object): #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" + #: A constant which can be used with the lifecycle_state property of a BaseDomainDetails. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + #: A constant which can be used with the lifecycle_state property of a BaseDomainDetails. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" @@ -56,7 +60,7 @@ def __init__(self, **kwargs): :param lifecycle_state: The value to assign to the lifecycle_state property of this BaseDomainDetails. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED" + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" :type lifecycle_state: str :param is_free_tier: @@ -145,7 +149,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this BaseDomainDetails. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :return: The display_name of this BaseDomainDetails. @@ -157,7 +161,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BaseDomainDetails. - APM Domain display name, can be updated. + Display name of the APM domain, which can be updated. :param display_name: The display_name of this BaseDomainDetails. @@ -169,7 +173,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this BaseDomainDetails. - Description of the APM Domain. + Description of the APM domain. :return: The description of this BaseDomainDetails. @@ -181,7 +185,7 @@ def description(self): def description(self, description): """ Sets the description of this BaseDomainDetails. - Description of the APM Domain. + Description of the APM domain. :param description: The description of this BaseDomainDetails. @@ -193,7 +197,7 @@ def description(self, description): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BaseDomainDetails. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :return: The compartment_id of this BaseDomainDetails. @@ -205,7 +209,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BaseDomainDetails. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :param compartment_id: The compartment_id of this BaseDomainDetails. @@ -217,9 +221,9 @@ def compartment_id(self, compartment_id): def lifecycle_state(self): """ Gets the lifecycle_state of this BaseDomainDetails. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. - Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED" + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" :return: The lifecycle_state of this BaseDomainDetails. @@ -231,13 +235,13 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BaseDomainDetails. - The current lifecycle state of the APM Domain. + The current lifecycle state of the APM domain. :param lifecycle_state: The lifecycle_state of this BaseDomainDetails. :type: str """ - allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"] + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): raise ValueError( "Invalid value for `lifecycle_state`, must be None or one of {0}" @@ -273,7 +277,7 @@ def is_free_tier(self, is_free_tier): def time_created(self): """ Gets the time_created of this BaseDomainDetails. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :return: The time_created of this BaseDomainDetails. @@ -285,7 +289,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BaseDomainDetails. - The time the the APM Domain was created. An RFC3339 formatted datetime string + The time the APM domain was created, expressed in RFC 3339 timestamp format. :param time_created: The time_created of this BaseDomainDetails. @@ -297,7 +301,7 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BaseDomainDetails. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :return: The time_updated of this BaseDomainDetails. @@ -309,7 +313,7 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BaseDomainDetails. - The time the APM Domain was updated. An RFC3339 formatted datetime string + The time the APM domain was updated, expressed in RFC 3339 timestamp format. :param time_updated: The time_updated of this BaseDomainDetails. diff --git a/src/oci/apm_control_plane/models/change_apm_domain_compartment_details.py b/src/oci/apm_control_plane/models/change_apm_domain_compartment_details.py index ccad61b450..8870b98e04 100644 --- a/src/oci/apm_control_plane/models/change_apm_domain_compartment_details.py +++ b/src/oci/apm_control_plane/models/change_apm_domain_compartment_details.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ChangeApmDomainCompartmentDetails. - The OCID of the destination compartment for the APM Domain. + The OCID of the destination compartment for the APM domain. :return: The compartment_id of this ChangeApmDomainCompartmentDetails. @@ -49,7 +49,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangeApmDomainCompartmentDetails. - The OCID of the destination compartment for the APM Domain. + The OCID of the destination compartment for the APM domain. :param compartment_id: The compartment_id of this ChangeApmDomainCompartmentDetails. diff --git a/src/oci/apm_control_plane/models/create_apm_domain_details.py b/src/oci/apm_control_plane/models/create_apm_domain_details.py index 764293a5e9..8d1ec51016 100644 --- a/src/oci/apm_control_plane/models/create_apm_domain_details.py +++ b/src/oci/apm_control_plane/models/create_apm_domain_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateApmDomainDetails(object): """ - The information about new APM Domain. + The information about the new APM domain. """ def __init__(self, **kwargs): @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateApmDomainDetails. - Display name of the APM Domain + Display name of the APM domain. :return: The display_name of this CreateApmDomainDetails. @@ -84,7 +84,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateApmDomainDetails. - Display name of the APM Domain + Display name of the APM domain. :param display_name: The display_name of this CreateApmDomainDetails. @@ -96,7 +96,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this CreateApmDomainDetails. - Description of the APM Domain + Description of the APM domain. :return: The description of this CreateApmDomainDetails. @@ -108,7 +108,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateApmDomainDetails. - Description of the APM Domain + Description of the APM domain. :param description: The description of this CreateApmDomainDetails. @@ -120,7 +120,7 @@ def description(self, description): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateApmDomainDetails. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :return: The compartment_id of this CreateApmDomainDetails. @@ -132,7 +132,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateApmDomainDetails. - The OCID of the compartment corresponding to the APM Domain. + The OCID of the compartment corresponding to the APM domain. :param compartment_id: The compartment_id of this CreateApmDomainDetails. diff --git a/src/oci/apm_control_plane/models/update_apm_domain_details.py b/src/oci/apm_control_plane/models/update_apm_domain_details.py index dd7e80cd6d..159db550ab 100644 --- a/src/oci/apm_control_plane/models/update_apm_domain_details.py +++ b/src/oci/apm_control_plane/models/update_apm_domain_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateApmDomainDetails(object): """ - The information to be updated. + The information that can be updated by update APM domain operation. """ def __init__(self, **kwargs): @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateApmDomainDetails. - Display name of the APM Domain + Display name of the APM domain. :return: The display_name of this UpdateApmDomainDetails. @@ -70,7 +70,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateApmDomainDetails. - Display name of the APM Domain + Display name of the APM domain. :param display_name: The display_name of this UpdateApmDomainDetails. @@ -82,7 +82,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateApmDomainDetails. - Description of the APM Domain + Description of the APM domain. :return: The description of this UpdateApmDomainDetails. @@ -94,7 +94,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateApmDomainDetails. - Description of the APM Domain + Description of the APM domain. :param description: The description of this UpdateApmDomainDetails. diff --git a/src/oci/apm_control_plane/models/work_request.py b/src/oci/apm_control_plane/models/work_request.py index d85389c48e..83b349ed3b 100644 --- a/src/oci/apm_control_plane/models/work_request.py +++ b/src/oci/apm_control_plane/models/work_request.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequest(object): """ - A description of workrequest status + A description of work request. """ #: A constant which can be used with the operation_type property of a WorkRequest. @@ -141,7 +141,7 @@ def __init__(self, **kwargs): def operation_type(self): """ **[Required]** Gets the operation_type of this WorkRequest. - Type of the work request + The type of the work request. Allowed values for this property are: "CREATE_APM_DOMAIN", "UPDATE_APM_DOMAIN", "DELETE_APM_DOMAIN", "GENERATE_DATA_KEYS", "REMOVE_DATA_KEYS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -156,7 +156,7 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this WorkRequest. - Type of the work request + The type of the work request. :param operation_type: The operation_type of this WorkRequest. @@ -201,7 +201,7 @@ def status(self, status): def id(self): """ **[Required]** Gets the id of this WorkRequest. - The id of the work request. + The ID of the work request. :return: The id of this WorkRequest. @@ -213,7 +213,7 @@ def id(self): def id(self, id): """ Sets the id of this WorkRequest. - The id of the work request. + The ID of the work request. :param id: The id of this WorkRequest. @@ -225,7 +225,7 @@ def id(self, id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. + The OCID of the compartment that contains the work request. :return: The compartment_id of this WorkRequest. @@ -237,7 +237,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. + The OCID of the compartment that contains the work request. :param compartment_id: The compartment_id of this WorkRequest. @@ -249,7 +249,7 @@ def compartment_id(self, compartment_id): def resources(self): """ **[Required]** Gets the resources of this WorkRequest. - The resources affected by this work request. + The resources affected by the work request. :return: The resources of this WorkRequest. @@ -261,7 +261,7 @@ def resources(self): def resources(self, resources): """ Sets the resources of this WorkRequest. - The resources affected by this work request. + The resources affected by the work request. :param resources: The resources of this WorkRequest. diff --git a/src/oci/apm_control_plane/models/work_request_error.py b/src/oci/apm_control_plane/models/work_request_error.py index 04dde83e08..abfc24ba54 100644 --- a/src/oci/apm_control_plane/models/work_request_error.py +++ b/src/oci/apm_control_plane/models/work_request_error.py @@ -51,8 +51,10 @@ def __init__(self, **kwargs): 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) + A machine-usable code for the error that occured. Error codes are listed at + `API Errors`__ + + __ https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm :return: The code of this WorkRequestError. @@ -64,8 +66,10 @@ def code(self): 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) + A machine-usable code for the error that occured. Error codes are listed at + `API Errors`__ + + __ https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm :param code: The code of this WorkRequestError. @@ -101,7 +105,9 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestError. - The time the error occured. An RFC3339 formatted datetime string. + The time the error occurred, expressed in `RFC 3339`__ timestamp format. + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestError. @@ -113,7 +119,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestError. - The time the error occured. An RFC3339 formatted datetime string. + The time the error occurred, expressed in `RFC 3339`__ timestamp format. + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestError. diff --git a/src/oci/apm_control_plane/models/work_request_log_entry.py b/src/oci/apm_control_plane/models/work_request_log_entry.py index 8d02a6a994..5f3f17a1f8 100644 --- a/src/oci/apm_control_plane/models/work_request_log_entry.py +++ b/src/oci/apm_control_plane/models/work_request_log_entry.py @@ -68,7 +68,9 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestLogEntry. - The time the log message was written. An RFC3339 formatted datetime string + The time the error occurred, expressed in `RFC 3339`__ timestamp format. + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestLogEntry. @@ -80,7 +82,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestLogEntry. - The time the log message was written. An RFC3339 formatted datetime string + The time the error occurred, expressed in `RFC 3339`__ timestamp format. + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestLogEntry. diff --git a/src/oci/apm_control_plane/models/work_request_resource.py b/src/oci/apm_control_plane/models/work_request_resource.py index 6decbf1282..58d553cbf5 100644 --- a/src/oci/apm_control_plane/models/work_request_resource.py +++ b/src/oci/apm_control_plane/models/work_request_resource.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestResource(object): """ - A resource created or operated on by a work request. + The details of the resource that the work request affects. """ #: A constant which can be used with the action_type property of a WorkRequestResource. @@ -164,7 +164,7 @@ def identifier(self, identifier): 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 + The URI path that the user can do a GET on to access the resource metadata. :return: The entity_uri of this WorkRequestResource. @@ -176,7 +176,7 @@ def entity_uri(self): 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 + 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. diff --git a/src/oci/blockchain/blockchain_platform_client.py b/src/oci/blockchain/blockchain_platform_client.py index 72972429db..5d02ec71bf 100644 --- a/src/oci/blockchain/blockchain_platform_client.py +++ b/src/oci/blockchain/blockchain_platform_client.py @@ -487,6 +487,13 @@ def delete_blockchain_platform(self, blockchain_platform_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param 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. @@ -508,7 +515,8 @@ def delete_blockchain_platform(self, blockchain_platform_id, **kwargs): expected_kwargs = [ "retry_strategy", "opc_request_id", - "if_match" + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -529,7 +537,8 @@ def delete_blockchain_platform(self, blockchain_platform_id, **kwargs): "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing) + "if-match": kwargs.get("if_match", missing), + "opc-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} @@ -540,6 +549,7 @@ def delete_blockchain_platform(self, blockchain_platform_id, **kwargs): if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -666,6 +676,13 @@ def delete_peer(self, blockchain_platform_id, peer_id, **kwargs): The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + :param 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. @@ -687,7 +704,8 @@ def delete_peer(self, blockchain_platform_id, peer_id, **kwargs): expected_kwargs = [ "retry_strategy", "opc_request_id", - "if_match" + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -709,7 +727,8 @@ def delete_peer(self, blockchain_platform_id, peer_id, **kwargs): "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing) + "if-match": kwargs.get("if_match", missing), + "opc-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} @@ -720,6 +739,7 @@ def delete_peer(self, blockchain_platform_id, peer_id, **kwargs): if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -1145,6 +1165,101 @@ def get_work_request(self, work_request_id, **kwargs): header_params=header_params, response_type="WorkRequest") + def list_blockchain_platform_patches(self, blockchain_platform_id, **kwargs): + """ + List Blockchain Platform Patches + + + :param str blockchain_platform_id: (required) + Unique service identifier. + + :param str page: (optional) + The page at which to start retrieving results. + + :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 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.blockchain.models.BlockchainPlatformPatchCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_blockchain_platform_patches API. + """ + resource_path = "/blockchainPlatforms/{blockchainPlatformId}/patches" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "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_blockchain_platform_patches got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "blockchainPlatformId": blockchain_platform_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 = { + "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="BlockchainPlatformPatchCollection") + 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="BlockchainPlatformPatchCollection") + def list_blockchain_platforms(self, compartment_id, **kwargs): """ Returns a list Blockchain Platform Instances in a compartment @@ -2549,3 +2664,104 @@ def update_peer(self, blockchain_platform_id, peer_id, update_peer_details, **kw path_params=path_params, header_params=header_params, body=update_peer_details) + + def upgrade_blockchain_platform(self, upgrade_blockchain_platform_details, blockchain_platform_id, **kwargs): + """ + Upgrade a Blockchain Platform version + + + :param oci.blockchain.models.UpgradeBlockchainPlatformDetails upgrade_blockchain_platform_details: (required) + Details for the new version to which it needs to be upgraded. + + :param str blockchain_platform_id: (required) + Unique service 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`. + + :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 upgrade_blockchain_platform API. + """ + resource_path = "/blockchainPlatforms/{blockchainPlatformId}/actions/upgrade" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "upgrade_blockchain_platform got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "blockchainPlatformId": blockchain_platform_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=upgrade_blockchain_platform_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=upgrade_blockchain_platform_details) diff --git a/src/oci/blockchain/blockchain_platform_client_composite_operations.py b/src/oci/blockchain/blockchain_platform_client_composite_operations.py index 7fc8517d22..7e5bfd8804 100644 --- a/src/oci/blockchain/blockchain_platform_client_composite_operations.py +++ b/src/oci/blockchain/blockchain_platform_client_composite_operations.py @@ -619,3 +619,44 @@ def update_peer_and_wait_for_state(self, blockchain_platform_id, peer_id, update return result_to_return except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def upgrade_blockchain_platform_and_wait_for_state(self, upgrade_blockchain_platform_details, blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.blockchain.BlockchainPlatformClient.upgrade_blockchain_platform` and waits for the :py:class:`~oci.blockchain.models.WorkRequest` + to enter the given state(s). + + :param oci.blockchain.models.UpgradeBlockchainPlatformDetails upgrade_blockchain_platform_details: (required) + Details for the new version to which it needs to be upgraded. + + :param str blockchain_platform_id: (required) + Unique service identifier. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.blockchain.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.blockchain.BlockchainPlatformClient.upgrade_blockchain_platform` + + :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.upgrade_blockchain_platform(upgrade_blockchain_platform_details, blockchain_platform_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) diff --git a/src/oci/blockchain/models/__init__.py b/src/oci/blockchain/models/__init__.py index 18faa566a8..e7b9d7b824 100644 --- a/src/oci/blockchain/models/__init__.py +++ b/src/oci/blockchain/models/__init__.py @@ -9,6 +9,8 @@ from .blockchain_platform_by_hostname import BlockchainPlatformByHostname from .blockchain_platform_collection import BlockchainPlatformCollection from .blockchain_platform_component_details import BlockchainPlatformComponentDetails +from .blockchain_platform_patch_collection import BlockchainPlatformPatchCollection +from .blockchain_platform_patch_summary import BlockchainPlatformPatchSummary from .blockchain_platform_summary import BlockchainPlatformSummary from .change_blockchain_platform_compartment_details import ChangeBlockchainPlatformCompartmentDetails from .create_blockchain_platform_details import CreateBlockchainPlatformDetails @@ -33,6 +35,7 @@ from .update_blockchain_platform_details import UpdateBlockchainPlatformDetails from .update_osn_details import UpdateOsnDetails from .update_peer_details import UpdatePeerDetails +from .upgrade_blockchain_platform_details import UpgradeBlockchainPlatformDetails from .work_request import WorkRequest from .work_request_collection import WorkRequestCollection from .work_request_error import WorkRequestError @@ -50,6 +53,8 @@ "BlockchainPlatformByHostname": BlockchainPlatformByHostname, "BlockchainPlatformCollection": BlockchainPlatformCollection, "BlockchainPlatformComponentDetails": BlockchainPlatformComponentDetails, + "BlockchainPlatformPatchCollection": BlockchainPlatformPatchCollection, + "BlockchainPlatformPatchSummary": BlockchainPlatformPatchSummary, "BlockchainPlatformSummary": BlockchainPlatformSummary, "ChangeBlockchainPlatformCompartmentDetails": ChangeBlockchainPlatformCompartmentDetails, "CreateBlockchainPlatformDetails": CreateBlockchainPlatformDetails, @@ -74,6 +79,7 @@ "UpdateBlockchainPlatformDetails": UpdateBlockchainPlatformDetails, "UpdateOsnDetails": UpdateOsnDetails, "UpdatePeerDetails": UpdatePeerDetails, + "UpgradeBlockchainPlatformDetails": UpgradeBlockchainPlatformDetails, "WorkRequest": WorkRequest, "WorkRequestCollection": WorkRequestCollection, "WorkRequestError": WorkRequestError, diff --git a/src/oci/blockchain/models/blockchain_platform.py b/src/oci/blockchain/models/blockchain_platform.py index 67b6e76a4c..4ed2b0d2a3 100644 --- a/src/oci/blockchain/models/blockchain_platform.py +++ b/src/oci/blockchain/models/blockchain_platform.py @@ -126,6 +126,10 @@ def __init__(self, **kwargs): The value to assign to the time_updated property of this BlockchainPlatform. :type time_updated: datetime + :param platform_version: + The value to assign to the platform_version property of this BlockchainPlatform. + :type platform_version: str + :param service_version: The value to assign to the service_version property of this BlockchainPlatform. :type service_version: str @@ -213,6 +217,7 @@ def __init__(self, **kwargs): 'is_byol': 'bool', 'time_created': 'datetime', 'time_updated': 'datetime', + 'platform_version': 'str', 'service_version': 'str', 'platform_role': 'str', 'compute_shape': 'str', @@ -240,6 +245,7 @@ def __init__(self, **kwargs): 'is_byol': 'isByol', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', + 'platform_version': 'platformVersion', 'service_version': 'serviceVersion', 'platform_role': 'platformRole', 'compute_shape': 'computeShape', @@ -266,6 +272,7 @@ def __init__(self, **kwargs): self._is_byol = None self._time_created = None self._time_updated = None + self._platform_version = None self._service_version = None self._platform_role = None self._compute_shape = None @@ -452,6 +459,30 @@ def time_updated(self, time_updated): """ self._time_updated = time_updated + @property + def platform_version(self): + """ + Gets the platform_version of this BlockchainPlatform. + Platform Version + + + :return: The platform_version of this BlockchainPlatform. + :rtype: str + """ + return self._platform_version + + @platform_version.setter + def platform_version(self, platform_version): + """ + Sets the platform_version of this BlockchainPlatform. + Platform Version + + + :param platform_version: The platform_version of this BlockchainPlatform. + :type: str + """ + self._platform_version = platform_version + @property def service_version(self): """ diff --git a/src/oci/blockchain/models/blockchain_platform_patch_collection.py b/src/oci/blockchain/models/blockchain_platform_patch_collection.py new file mode 100644 index 0000000000..1dacb5521d --- /dev/null +++ b/src/oci/blockchain/models/blockchain_platform_patch_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 BlockchainPlatformPatchCollection(object): + """ + Result of a patch list. Contains PatchSummary + """ + + def __init__(self, **kwargs): + """ + Initializes a new BlockchainPlatformPatchCollection 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 BlockchainPlatformPatchCollection. + :type items: list[oci.blockchain.models.BlockchainPlatformPatchSummary] + + """ + self.swagger_types = { + 'items': 'list[BlockchainPlatformPatchSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this BlockchainPlatformPatchCollection. + Collection of PatchSummary + + + :return: The items of this BlockchainPlatformPatchCollection. + :rtype: list[oci.blockchain.models.BlockchainPlatformPatchSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this BlockchainPlatformPatchCollection. + Collection of PatchSummary + + + :param items: The items of this BlockchainPlatformPatchCollection. + :type: list[oci.blockchain.models.BlockchainPlatformPatchSummary] + """ + 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/blockchain/models/blockchain_platform_patch_summary.py b/src/oci/blockchain/models/blockchain_platform_patch_summary.py new file mode 100644 index 0000000000..c4dfe0a2fc --- /dev/null +++ b/src/oci/blockchain/models/blockchain_platform_patch_summary.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 BlockchainPlatformPatchSummary(object): + """ + Patch Details + """ + + def __init__(self, **kwargs): + """ + Initializes a new BlockchainPlatformPatchSummary 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 BlockchainPlatformPatchSummary. + :type id: str + + :param service_version: + The value to assign to the service_version property of this BlockchainPlatformPatchSummary. + :type service_version: str + + :param patch_info_url: + The value to assign to the patch_info_url property of this BlockchainPlatformPatchSummary. + :type patch_info_url: str + + :param time_patch_due: + The value to assign to the time_patch_due property of this BlockchainPlatformPatchSummary. + :type time_patch_due: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'service_version': 'str', + 'patch_info_url': 'str', + 'time_patch_due': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'service_version': 'serviceVersion', + 'patch_info_url': 'patchInfoUrl', + 'time_patch_due': 'timePatchDue' + } + + self._id = None + self._service_version = None + self._patch_info_url = None + self._time_patch_due = None + + @property + def id(self): + """ + Gets the id of this BlockchainPlatformPatchSummary. + patch id + + + :return: The id of this BlockchainPlatformPatchSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this BlockchainPlatformPatchSummary. + patch id + + + :param id: The id of this BlockchainPlatformPatchSummary. + :type: str + """ + self._id = id + + @property + def service_version(self): + """ + Gets the service_version of this BlockchainPlatformPatchSummary. + patch service version + + + :return: The service_version of this BlockchainPlatformPatchSummary. + :rtype: str + """ + return self._service_version + + @service_version.setter + def service_version(self, service_version): + """ + Sets the service_version of this BlockchainPlatformPatchSummary. + patch service version + + + :param service_version: The service_version of this BlockchainPlatformPatchSummary. + :type: str + """ + self._service_version = service_version + + @property + def patch_info_url(self): + """ + Gets the patch_info_url of this BlockchainPlatformPatchSummary. + A URL for the patch specific documentation + + + :return: The patch_info_url of this BlockchainPlatformPatchSummary. + :rtype: str + """ + return self._patch_info_url + + @patch_info_url.setter + def patch_info_url(self, patch_info_url): + """ + Sets the patch_info_url of this BlockchainPlatformPatchSummary. + A URL for the patch specific documentation + + + :param patch_info_url: The patch_info_url of this BlockchainPlatformPatchSummary. + :type: str + """ + self._patch_info_url = patch_info_url + + @property + def time_patch_due(self): + """ + Gets the time_patch_due of this BlockchainPlatformPatchSummary. + patch due date for customer initiated patching + + + :return: The time_patch_due of this BlockchainPlatformPatchSummary. + :rtype: datetime + """ + return self._time_patch_due + + @time_patch_due.setter + def time_patch_due(self, time_patch_due): + """ + Sets the time_patch_due of this BlockchainPlatformPatchSummary. + patch due date for customer initiated patching + + + :param time_patch_due: The time_patch_due of this BlockchainPlatformPatchSummary. + :type: datetime + """ + self._time_patch_due = time_patch_due + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/blockchain/models/create_blockchain_platform_details.py b/src/oci/blockchain/models/create_blockchain_platform_details.py index c5a89b46ec..2371ec756c 100644 --- a/src/oci/blockchain/models/create_blockchain_platform_details.py +++ b/src/oci/blockchain/models/create_blockchain_platform_details.py @@ -42,6 +42,10 @@ def __init__(self, **kwargs): The value to assign to the is_byol property of this CreateBlockchainPlatformDetails. :type is_byol: bool + :param platform_version: + The value to assign to the platform_version property of this CreateBlockchainPlatformDetails. + :type platform_version: str + :param idcs_access_token: The value to assign to the idcs_access_token property of this CreateBlockchainPlatformDetails. :type idcs_access_token: str @@ -70,6 +74,7 @@ def __init__(self, **kwargs): 'platform_role': 'str', 'compute_shape': 'str', 'is_byol': 'bool', + 'platform_version': 'str', 'idcs_access_token': 'str', 'federated_user_id': 'str', 'ca_cert_archive_text': 'str', @@ -84,6 +89,7 @@ def __init__(self, **kwargs): 'platform_role': 'platformRole', 'compute_shape': 'computeShape', 'is_byol': 'isByol', + 'platform_version': 'platformVersion', 'idcs_access_token': 'idcsAccessToken', 'federated_user_id': 'federatedUserId', 'ca_cert_archive_text': 'caCertArchiveText', @@ -97,6 +103,7 @@ def __init__(self, **kwargs): self._platform_role = None self._compute_shape = None self._is_byol = None + self._platform_version = None self._idcs_access_token = None self._federated_user_id = None self._ca_cert_archive_text = None @@ -247,6 +254,30 @@ def is_byol(self, is_byol): """ self._is_byol = is_byol + @property + def platform_version(self): + """ + Gets the platform_version of this CreateBlockchainPlatformDetails. + Platform version + + + :return: The platform_version of this CreateBlockchainPlatformDetails. + :rtype: str + """ + return self._platform_version + + @platform_version.setter + def platform_version(self, platform_version): + """ + Sets the platform_version of this CreateBlockchainPlatformDetails. + Platform version + + + :param platform_version: The platform_version of this CreateBlockchainPlatformDetails. + :type: str + """ + self._platform_version = platform_version + @property def idcs_access_token(self): """ diff --git a/src/oci/blockchain/models/upgrade_blockchain_platform_details.py b/src/oci/blockchain/models/upgrade_blockchain_platform_details.py new file mode 100644 index 0000000000..5d66271eca --- /dev/null +++ b/src/oci/blockchain/models/upgrade_blockchain_platform_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 UpgradeBlockchainPlatformDetails(object): + """ + Input payload to upgrade the blockchain platform. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpgradeBlockchainPlatformDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param patch_id: + The value to assign to the patch_id property of this UpgradeBlockchainPlatformDetails. + :type patch_id: str + + """ + self.swagger_types = { + 'patch_id': 'str' + } + + self.attribute_map = { + 'patch_id': 'patchId' + } + + self._patch_id = None + + @property + def patch_id(self): + """ + **[Required]** Gets the patch_id of this UpgradeBlockchainPlatformDetails. + The patch ID corresponding to the version to which platform will be upgraded. + + + :return: The patch_id of this UpgradeBlockchainPlatformDetails. + :rtype: str + """ + return self._patch_id + + @patch_id.setter + def patch_id(self, patch_id): + """ + Sets the patch_id of this UpgradeBlockchainPlatformDetails. + The patch ID corresponding to the version to which platform will be upgraded. + + + :param patch_id: The patch_id of this UpgradeBlockchainPlatformDetails. + :type: str + """ + self._patch_id = patch_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/blockchain/models/work_request.py b/src/oci/blockchain/models/work_request.py index 54cd7b6754..123b5f2fa8 100644 --- a/src/oci/blockchain/models/work_request.py +++ b/src/oci/blockchain/models/work_request.py @@ -21,6 +21,10 @@ class WorkRequest(object): #: This constant has a value of "UPDATE_PLATFORM" OPERATION_TYPE_UPDATE_PLATFORM = "UPDATE_PLATFORM" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPGRADE_PLATFORM" + OPERATION_TYPE_UPGRADE_PLATFORM = "UPGRADE_PLATFORM" + #: A constant which can be used with the operation_type property of a WorkRequest. #: This constant has a value of "DELETE_PLATFORM" OPERATION_TYPE_DELETE_PLATFORM = "DELETE_PLATFORM" @@ -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_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", '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_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", '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_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE"] + allowed_values = ["CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE"] 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/blockchain/models/work_request_summary.py b/src/oci/blockchain/models/work_request_summary.py index 06c9c4c8eb..c55075d8ac 100644 --- a/src/oci/blockchain/models/work_request_summary.py +++ b/src/oci/blockchain/models/work_request_summary.py @@ -21,6 +21,10 @@ class WorkRequestSummary(object): #: This constant has a value of "UPDATE_PLATFORM" OPERATION_TYPE_UPDATE_PLATFORM = "UPDATE_PLATFORM" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPGRADE_PLATFORM" + OPERATION_TYPE_UPGRADE_PLATFORM = "UPGRADE_PLATFORM" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. #: This constant has a value of "DELETE_PLATFORM" OPERATION_TYPE_DELETE_PLATFORM = "DELETE_PLATFORM" @@ -52,7 +56,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_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -129,7 +133,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_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -148,7 +152,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_PLATFORM", "UPDATE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE"] + allowed_values = ["CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_PLATFORM", "DELETE_PLATFORM", "SCALE_PLATFORM", "START_PLATFORM", "STOP_PLATFORM", "CUSTOMIZE_PLATFORM", "SCALE_STORAGE"] 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/cloud_guard/cloud_guard_client.py b/src/oci/cloud_guard/cloud_guard_client.py index cd2f8a5a66..e2668b4c79 100644 --- a/src/oci/cloud_guard/cloud_guard_client.py +++ b/src/oci/cloud_guard/cloud_guard_client.py @@ -4813,7 +4813,7 @@ def list_problems(self, compartment_id, **kwargs): :param str lifecycle_detail: (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - Allowed values are: "OPEN", "RESOLVED", "DISMISSED" + Allowed values are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" :param str lifecycle_state: (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. @@ -4940,7 +4940,7 @@ def list_problems(self, compartment_id, **kwargs): "list_problems got unknown kwargs: {!r}".format(extra_kwargs)) if 'lifecycle_detail' in kwargs: - lifecycle_detail_allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + lifecycle_detail_allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if kwargs['lifecycle_detail'] not in lifecycle_detail_allowed_values: raise ValueError( "Invalid value for `lifecycle_detail`, must be one of {0}".format(lifecycle_detail_allowed_values) diff --git a/src/oci/cloud_guard/models/impacted_resource_summary.py b/src/oci/cloud_guard/models/impacted_resource_summary.py index beabe1376f..b4a5da028b 100644 --- a/src/oci/cloud_guard/models/impacted_resource_summary.py +++ b/src/oci/cloud_guard/models/impacted_resource_summary.py @@ -34,6 +34,14 @@ def __init__(self, **kwargs): The value to assign to the compartment_id property of this ImpactedResourceSummary. :type compartment_id: str + :param sighting_type: + The value to assign to the sighting_type property of this ImpactedResourceSummary. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this ImpactedResourceSummary. + :type sighting_type_display_name: str + :param resource_name: The value to assign to the resource_name property of this ImpactedResourceSummary. :type resource_name: str @@ -56,6 +64,8 @@ def __init__(self, **kwargs): 'resource_id': 'str', 'problem_id': 'str', 'compartment_id': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', 'resource_name': 'str', 'resource_type': 'str', 'region': 'str', @@ -67,6 +77,8 @@ def __init__(self, **kwargs): 'resource_id': 'resourceId', 'problem_id': 'problemId', 'compartment_id': 'compartmentId', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', 'resource_name': 'resourceName', 'resource_type': 'resourceType', 'region': 'region', @@ -77,6 +89,8 @@ def __init__(self, **kwargs): self._resource_id = None self._problem_id = None self._compartment_id = None + self._sighting_type = None + self._sighting_type_display_name = None self._resource_name = None self._resource_type = None self._region = None @@ -178,6 +192,54 @@ def compartment_id(self, compartment_id): """ self._compartment_id = compartment_id + @property + def sighting_type(self): + """ + Gets the sighting_type of this ImpactedResourceSummary. + Identifier for the sighting type + + + :return: The sighting_type of this ImpactedResourceSummary. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this ImpactedResourceSummary. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this ImpactedResourceSummary. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + Gets the sighting_type_display_name of this ImpactedResourceSummary. + Name of the sighting type + + + :return: The sighting_type_display_name of this ImpactedResourceSummary. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this ImpactedResourceSummary. + Name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this ImpactedResourceSummary. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + @property def resource_name(self): """ diff --git a/src/oci/cloud_guard/models/problem.py b/src/oci/cloud_guard/models/problem.py index 04f24095dd..648841a8a0 100644 --- a/src/oci/cloud_guard/models/problem.py +++ b/src/oci/cloud_guard/models/problem.py @@ -53,6 +53,10 @@ class Problem(object): #: This constant has a value of "DISMISSED" LIFECYCLE_DETAIL_DISMISSED = "DISMISSED" + #: A constant which can be used with the lifecycle_detail property of a Problem. + #: This constant has a value of "DELETED" + LIFECYCLE_DETAIL_DELETED = "DELETED" + #: A constant which can be used with the detector_id property of a Problem. #: This constant has a value of "IAAS_ACTIVITY_DETECTOR" DETECTOR_ID_IAAS_ACTIVITY_DETECTOR = "IAAS_ACTIVITY_DETECTOR" @@ -124,7 +128,7 @@ def __init__(self, **kwargs): :param lifecycle_detail: The value to assign to the lifecycle_detail property of this Problem. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_detail: str @@ -552,7 +556,7 @@ def lifecycle_detail(self): Gets the lifecycle_detail of this Problem. The lifecycleDetail will give more detail on the substate of the lifecycleState. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -571,7 +575,7 @@ def lifecycle_detail(self, lifecycle_detail): :param lifecycle_detail: The lifecycle_detail of this Problem. :type: str """ - allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if not value_allowed_none_or_none_sentinel(lifecycle_detail, allowed_values): lifecycle_detail = 'UNKNOWN_ENUM_VALUE' self._lifecycle_detail = lifecycle_detail diff --git a/src/oci/cloud_guard/models/problem_history_summary.py b/src/oci/cloud_guard/models/problem_history_summary.py index 1c62cca825..1aad3f4c6b 100644 --- a/src/oci/cloud_guard/models/problem_history_summary.py +++ b/src/oci/cloud_guard/models/problem_history_summary.py @@ -41,6 +41,10 @@ class ProblemHistorySummary(object): #: This constant has a value of "DISMISSED" LIFECYCLE_DETAIL_DISMISSED = "DISMISSED" + #: A constant which can be used with the lifecycle_detail property of a ProblemHistorySummary. + #: This constant has a value of "DELETED" + LIFECYCLE_DETAIL_DELETED = "DELETED" + #: A constant which can be used with the event_status property of a ProblemHistorySummary. #: This constant has a value of "REOPEN" EVENT_STATUS_REOPEN = "REOPEN" @@ -61,6 +65,10 @@ class ProblemHistorySummary(object): #: This constant has a value of "DISMISS" EVENT_STATUS_DISMISS = "DISMISS" + #: A constant which can be used with the event_status property of a ProblemHistorySummary. + #: This constant has a value of "DELETE" + EVENT_STATUS_DELETE = "DELETE" + def __init__(self, **kwargs): """ Initializes a new ProblemHistorySummary object with values from keyword arguments. @@ -90,13 +98,13 @@ def __init__(self, **kwargs): :param lifecycle_detail: The value to assign to the lifecycle_detail property of this ProblemHistorySummary. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_detail: str :param event_status: The value to assign to the event_status property of this ProblemHistorySummary. - Allowed values for this property are: "REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS", "DELETE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type event_status: str @@ -282,7 +290,7 @@ def lifecycle_detail(self): **[Required]** Gets the lifecycle_detail of this ProblemHistorySummary. Problem Lifecycle Detail Status - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -301,7 +309,7 @@ def lifecycle_detail(self, lifecycle_detail): :param lifecycle_detail: The lifecycle_detail of this ProblemHistorySummary. :type: str """ - allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if not value_allowed_none_or_none_sentinel(lifecycle_detail, allowed_values): lifecycle_detail = 'UNKNOWN_ENUM_VALUE' self._lifecycle_detail = lifecycle_detail @@ -312,7 +320,7 @@ def event_status(self): Gets the event_status of this ProblemHistorySummary. Event status - Allowed values for this property are: "REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS", "DELETE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -331,7 +339,7 @@ def event_status(self, event_status): :param event_status: The event_status of this ProblemHistorySummary. :type: str """ - allowed_values = ["REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS"] + allowed_values = ["REOPEN", "OPEN", "UPDATE", "RESOLVE", "DISMISS", "DELETE"] if not value_allowed_none_or_none_sentinel(event_status, allowed_values): event_status = 'UNKNOWN_ENUM_VALUE' self._event_status = event_status diff --git a/src/oci/cloud_guard/models/problem_summary.py b/src/oci/cloud_guard/models/problem_summary.py index 4a17db1446..90cebeabd8 100644 --- a/src/oci/cloud_guard/models/problem_summary.py +++ b/src/oci/cloud_guard/models/problem_summary.py @@ -53,6 +53,10 @@ class ProblemSummary(object): #: This constant has a value of "DISMISSED" LIFECYCLE_DETAIL_DISMISSED = "DISMISSED" + #: A constant which can be used with the lifecycle_detail property of a ProblemSummary. + #: This constant has a value of "DELETED" + LIFECYCLE_DETAIL_DELETED = "DELETED" + #: A constant which can be used with the detector_id property of a ProblemSummary. #: This constant has a value of "IAAS_ACTIVITY_DETECTOR" DETECTOR_ID_IAAS_ACTIVITY_DETECTOR = "IAAS_ACTIVITY_DETECTOR" @@ -116,7 +120,7 @@ def __init__(self, **kwargs): :param lifecycle_detail: The value to assign to the lifecycle_detail property of this ProblemSummary. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_detail: str @@ -476,7 +480,7 @@ def lifecycle_detail(self): Gets the lifecycle_detail of this ProblemSummary. The lifecycleDetail will give more detail on the substate of the lifecycleState. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -495,7 +499,7 @@ def lifecycle_detail(self, lifecycle_detail): :param lifecycle_detail: The lifecycle_detail of this ProblemSummary. :type: str """ - allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if not value_allowed_none_or_none_sentinel(lifecycle_detail, allowed_values): lifecycle_detail = 'UNKNOWN_ENUM_VALUE' self._lifecycle_detail = lifecycle_detail diff --git a/src/oci/cloud_guard/models/update_bulk_problem_status_details.py b/src/oci/cloud_guard/models/update_bulk_problem_status_details.py index 112235d471..5c6c9e4382 100644 --- a/src/oci/cloud_guard/models/update_bulk_problem_status_details.py +++ b/src/oci/cloud_guard/models/update_bulk_problem_status_details.py @@ -25,6 +25,10 @@ class UpdateBulkProblemStatusDetails(object): #: This constant has a value of "DISMISSED" STATUS_DISMISSED = "DISMISSED" + #: A constant which can be used with the status property of a UpdateBulkProblemStatusDetails. + #: This constant has a value of "DELETED" + STATUS_DELETED = "DELETED" + def __init__(self, **kwargs): """ Initializes a new UpdateBulkProblemStatusDetails object with values from keyword arguments. @@ -32,7 +36,7 @@ def __init__(self, **kwargs): :param status: The value to assign to the status property of this UpdateBulkProblemStatusDetails. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED" + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" :type status: str :param problem_ids: @@ -66,7 +70,7 @@ def status(self): **[Required]** Gets the status of this UpdateBulkProblemStatusDetails. Action taken by user - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED" + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" :return: The status of this UpdateBulkProblemStatusDetails. @@ -84,7 +88,7 @@ def status(self, status): :param status: The status of this UpdateBulkProblemStatusDetails. :type: str """ - allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if not value_allowed_none_or_none_sentinel(status, allowed_values): raise ValueError( "Invalid value for `status`, must be None or one of {0}" diff --git a/src/oci/cloud_guard/models/update_problem_status_details.py b/src/oci/cloud_guard/models/update_problem_status_details.py index 119c8e92d9..1387a68b85 100644 --- a/src/oci/cloud_guard/models/update_problem_status_details.py +++ b/src/oci/cloud_guard/models/update_problem_status_details.py @@ -25,6 +25,10 @@ class UpdateProblemStatusDetails(object): #: This constant has a value of "DISMISSED" STATUS_DISMISSED = "DISMISSED" + #: A constant which can be used with the status property of a UpdateProblemStatusDetails. + #: This constant has a value of "DELETED" + STATUS_DELETED = "DELETED" + def __init__(self, **kwargs): """ Initializes a new UpdateProblemStatusDetails object with values from keyword arguments. @@ -32,7 +36,7 @@ def __init__(self, **kwargs): :param status: The value to assign to the status property of this UpdateProblemStatusDetails. - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED" + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" :type status: str :param comment: @@ -59,7 +63,7 @@ def status(self): **[Required]** Gets the status of this UpdateProblemStatusDetails. Action taken by user - Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED" + Allowed values for this property are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" :return: The status of this UpdateProblemStatusDetails. @@ -77,7 +81,7 @@ def status(self, status): :param status: The status of this UpdateProblemStatusDetails. :type: str """ - allowed_values = ["OPEN", "RESOLVED", "DISMISSED"] + allowed_values = ["OPEN", "RESOLVED", "DISMISSED", "DELETED"] if not value_allowed_none_or_none_sentinel(status, allowed_values): raise ValueError( "Invalid value for `status`, must be None or one of {0}" diff --git a/src/oci/core/models/__init__.py b/src/oci/core/models/__init__.py index 5b61331f00..eab22d22a5 100644 --- a/src/oci/core/models/__init__.py +++ b/src/oci/core/models/__init__.py @@ -14,6 +14,9 @@ from .add_security_rule_details import AddSecurityRuleDetails from .add_vcn_cidr_details import AddVcnCidrDetails from .added_network_security_group_security_rules import AddedNetworkSecurityGroupSecurityRules +from .allowed_ike_ip_sec_parameters import AllowedIkeIPSecParameters +from .allowed_phase_one_parameters import AllowedPhaseOneParameters +from .allowed_phase_two_parameters import AllowedPhaseTwoParameters from .amd_milan_bm_launch_instance_platform_config import AmdMilanBmLaunchInstancePlatformConfig from .amd_milan_bm_platform_config import AmdMilanBmPlatformConfig from .amd_rome_bm_launch_instance_platform_config import AmdRomeBmLaunchInstancePlatformConfig @@ -189,6 +192,8 @@ from .dedicated_vm_host_shape_summary import DedicatedVmHostShapeSummary from .dedicated_vm_host_summary import DedicatedVmHostSummary from .default_drg_route_tables import DefaultDrgRouteTables +from .default_phase_one_parameters import DefaultPhaseOneParameters +from .default_phase_two_parameters import DefaultPhaseTwoParameters from .delete_virtual_circuit_public_prefix_details import DeleteVirtualCircuitPublicPrefixDetails from .detach_instance_pool_instance_details import DetachInstancePoolInstanceDetails from .detach_load_balancer_details import DetachLoadBalancerDetails @@ -197,6 +202,7 @@ from .dhcp_option import DhcpOption from .dhcp_options import DhcpOptions from .dhcp_search_domain_option import DhcpSearchDomainOption +from .dpd_config import DpdConfig from .drg import Drg from .drg_attachment import DrgAttachment from .drg_attachment_id_drg_route_distribution_match_criteria import DrgAttachmentIdDrgRouteDistributionMatchCriteria @@ -227,6 +233,7 @@ from .ip_sec_connection_device_config import IPSecConnectionDeviceConfig from .ip_sec_connection_device_status import IPSecConnectionDeviceStatus from .ip_sec_connection_tunnel import IPSecConnectionTunnel +from .ip_sec_connection_tunnel_error_details import IPSecConnectionTunnelErrorDetails from .ip_sec_connection_tunnel_shared_secret import IPSecConnectionTunnelSharedSecret from .i_scsi_volume_attachment import IScsiVolumeAttachment from .icmp_options import IcmpOptions @@ -319,6 +326,8 @@ from .networking_topology import NetworkingTopology from .paravirtualized_volume_attachment import ParavirtualizedVolumeAttachment from .peer_region_for_remote_peering import PeerRegionForRemotePeering +from .phase_one_config_details import PhaseOneConfigDetails +from .phase_two_config_details import PhaseTwoConfigDetails from .platform_config import PlatformConfig from .port_range import PortRange from .preemptible_instance_config_details import PreemptibleInstanceConfigDetails @@ -366,6 +375,10 @@ from .topology_routes_to_relationship_details import TopologyRoutesToRelationshipDetails from .tunnel_config import TunnelConfig from .tunnel_cpe_device_config import TunnelCpeDeviceConfig +from .tunnel_phase_one_details import TunnelPhaseOneDetails +from .tunnel_phase_two_details import TunnelPhaseTwoDetails +from .tunnel_route_summary import TunnelRouteSummary +from .tunnel_security_association_summary import TunnelSecurityAssociationSummary from .tunnel_status import TunnelStatus from .udp_options import UdpOptions from .update_boot_volume_backup_details import UpdateBootVolumeBackupDetails @@ -479,6 +492,9 @@ "AddSecurityRuleDetails": AddSecurityRuleDetails, "AddVcnCidrDetails": AddVcnCidrDetails, "AddedNetworkSecurityGroupSecurityRules": AddedNetworkSecurityGroupSecurityRules, + "AllowedIkeIPSecParameters": AllowedIkeIPSecParameters, + "AllowedPhaseOneParameters": AllowedPhaseOneParameters, + "AllowedPhaseTwoParameters": AllowedPhaseTwoParameters, "AmdMilanBmLaunchInstancePlatformConfig": AmdMilanBmLaunchInstancePlatformConfig, "AmdMilanBmPlatformConfig": AmdMilanBmPlatformConfig, "AmdRomeBmLaunchInstancePlatformConfig": AmdRomeBmLaunchInstancePlatformConfig, @@ -654,6 +670,8 @@ "DedicatedVmHostShapeSummary": DedicatedVmHostShapeSummary, "DedicatedVmHostSummary": DedicatedVmHostSummary, "DefaultDrgRouteTables": DefaultDrgRouteTables, + "DefaultPhaseOneParameters": DefaultPhaseOneParameters, + "DefaultPhaseTwoParameters": DefaultPhaseTwoParameters, "DeleteVirtualCircuitPublicPrefixDetails": DeleteVirtualCircuitPublicPrefixDetails, "DetachInstancePoolInstanceDetails": DetachInstancePoolInstanceDetails, "DetachLoadBalancerDetails": DetachLoadBalancerDetails, @@ -662,6 +680,7 @@ "DhcpOption": DhcpOption, "DhcpOptions": DhcpOptions, "DhcpSearchDomainOption": DhcpSearchDomainOption, + "DpdConfig": DpdConfig, "Drg": Drg, "DrgAttachment": DrgAttachment, "DrgAttachmentIdDrgRouteDistributionMatchCriteria": DrgAttachmentIdDrgRouteDistributionMatchCriteria, @@ -692,6 +711,7 @@ "IPSecConnectionDeviceConfig": IPSecConnectionDeviceConfig, "IPSecConnectionDeviceStatus": IPSecConnectionDeviceStatus, "IPSecConnectionTunnel": IPSecConnectionTunnel, + "IPSecConnectionTunnelErrorDetails": IPSecConnectionTunnelErrorDetails, "IPSecConnectionTunnelSharedSecret": IPSecConnectionTunnelSharedSecret, "IScsiVolumeAttachment": IScsiVolumeAttachment, "IcmpOptions": IcmpOptions, @@ -784,6 +804,8 @@ "NetworkingTopology": NetworkingTopology, "ParavirtualizedVolumeAttachment": ParavirtualizedVolumeAttachment, "PeerRegionForRemotePeering": PeerRegionForRemotePeering, + "PhaseOneConfigDetails": PhaseOneConfigDetails, + "PhaseTwoConfigDetails": PhaseTwoConfigDetails, "PlatformConfig": PlatformConfig, "PortRange": PortRange, "PreemptibleInstanceConfigDetails": PreemptibleInstanceConfigDetails, @@ -831,6 +853,10 @@ "TopologyRoutesToRelationshipDetails": TopologyRoutesToRelationshipDetails, "TunnelConfig": TunnelConfig, "TunnelCpeDeviceConfig": TunnelCpeDeviceConfig, + "TunnelPhaseOneDetails": TunnelPhaseOneDetails, + "TunnelPhaseTwoDetails": TunnelPhaseTwoDetails, + "TunnelRouteSummary": TunnelRouteSummary, + "TunnelSecurityAssociationSummary": TunnelSecurityAssociationSummary, "TunnelStatus": TunnelStatus, "UdpOptions": UdpOptions, "UpdateBootVolumeBackupDetails": UpdateBootVolumeBackupDetails, diff --git a/src/oci/core/models/allowed_ike_ip_sec_parameters.py b/src/oci/core/models/allowed_ike_ip_sec_parameters.py new file mode 100644 index 0000000000..eedf05947f --- /dev/null +++ b/src/oci/core/models/allowed_ike_ip_sec_parameters.py @@ -0,0 +1,147 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 AllowedIkeIPSecParameters(object): + """ + Allowed IKE IPSec Parameters + """ + + def __init__(self, **kwargs): + """ + Initializes a new AllowedIkeIPSecParameters object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param allowed_phase_one_parameters: + The value to assign to the allowed_phase_one_parameters property of this AllowedIkeIPSecParameters. + :type allowed_phase_one_parameters: oci.core.models.AllowedPhaseOneParameters + + :param allowed_phase_two_parameters: + The value to assign to the allowed_phase_two_parameters property of this AllowedIkeIPSecParameters. + :type allowed_phase_two_parameters: oci.core.models.AllowedPhaseTwoParameters + + :param default_phase_one_parameters: + The value to assign to the default_phase_one_parameters property of this AllowedIkeIPSecParameters. + :type default_phase_one_parameters: oci.core.models.DefaultPhaseOneParameters + + :param default_phase_two_parameters: + The value to assign to the default_phase_two_parameters property of this AllowedIkeIPSecParameters. + :type default_phase_two_parameters: oci.core.models.DefaultPhaseTwoParameters + + """ + self.swagger_types = { + 'allowed_phase_one_parameters': 'AllowedPhaseOneParameters', + 'allowed_phase_two_parameters': 'AllowedPhaseTwoParameters', + 'default_phase_one_parameters': 'DefaultPhaseOneParameters', + 'default_phase_two_parameters': 'DefaultPhaseTwoParameters' + } + + self.attribute_map = { + 'allowed_phase_one_parameters': 'allowedPhaseOneParameters', + 'allowed_phase_two_parameters': 'allowedPhaseTwoParameters', + 'default_phase_one_parameters': 'defaultPhaseOneParameters', + 'default_phase_two_parameters': 'defaultPhaseTwoParameters' + } + + self._allowed_phase_one_parameters = None + self._allowed_phase_two_parameters = None + self._default_phase_one_parameters = None + self._default_phase_two_parameters = None + + @property + def allowed_phase_one_parameters(self): + """ + **[Required]** Gets the allowed_phase_one_parameters of this AllowedIkeIPSecParameters. + + :return: The allowed_phase_one_parameters of this AllowedIkeIPSecParameters. + :rtype: oci.core.models.AllowedPhaseOneParameters + """ + return self._allowed_phase_one_parameters + + @allowed_phase_one_parameters.setter + def allowed_phase_one_parameters(self, allowed_phase_one_parameters): + """ + Sets the allowed_phase_one_parameters of this AllowedIkeIPSecParameters. + + :param allowed_phase_one_parameters: The allowed_phase_one_parameters of this AllowedIkeIPSecParameters. + :type: oci.core.models.AllowedPhaseOneParameters + """ + self._allowed_phase_one_parameters = allowed_phase_one_parameters + + @property + def allowed_phase_two_parameters(self): + """ + **[Required]** Gets the allowed_phase_two_parameters of this AllowedIkeIPSecParameters. + + :return: The allowed_phase_two_parameters of this AllowedIkeIPSecParameters. + :rtype: oci.core.models.AllowedPhaseTwoParameters + """ + return self._allowed_phase_two_parameters + + @allowed_phase_two_parameters.setter + def allowed_phase_two_parameters(self, allowed_phase_two_parameters): + """ + Sets the allowed_phase_two_parameters of this AllowedIkeIPSecParameters. + + :param allowed_phase_two_parameters: The allowed_phase_two_parameters of this AllowedIkeIPSecParameters. + :type: oci.core.models.AllowedPhaseTwoParameters + """ + self._allowed_phase_two_parameters = allowed_phase_two_parameters + + @property + def default_phase_one_parameters(self): + """ + **[Required]** Gets the default_phase_one_parameters of this AllowedIkeIPSecParameters. + + :return: The default_phase_one_parameters of this AllowedIkeIPSecParameters. + :rtype: oci.core.models.DefaultPhaseOneParameters + """ + return self._default_phase_one_parameters + + @default_phase_one_parameters.setter + def default_phase_one_parameters(self, default_phase_one_parameters): + """ + Sets the default_phase_one_parameters of this AllowedIkeIPSecParameters. + + :param default_phase_one_parameters: The default_phase_one_parameters of this AllowedIkeIPSecParameters. + :type: oci.core.models.DefaultPhaseOneParameters + """ + self._default_phase_one_parameters = default_phase_one_parameters + + @property + def default_phase_two_parameters(self): + """ + **[Required]** Gets the default_phase_two_parameters of this AllowedIkeIPSecParameters. + + :return: The default_phase_two_parameters of this AllowedIkeIPSecParameters. + :rtype: oci.core.models.DefaultPhaseTwoParameters + """ + return self._default_phase_two_parameters + + @default_phase_two_parameters.setter + def default_phase_two_parameters(self, default_phase_two_parameters): + """ + Sets the default_phase_two_parameters of this AllowedIkeIPSecParameters. + + :param default_phase_two_parameters: The default_phase_two_parameters of this AllowedIkeIPSecParameters. + :type: oci.core.models.DefaultPhaseTwoParameters + """ + self._default_phase_two_parameters = default_phase_two_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/core/models/allowed_phase_one_parameters.py b/src/oci/core/models/allowed_phase_one_parameters.py new file mode 100644 index 0000000000..856c4daeff --- /dev/null +++ b/src/oci/core/models/allowed_phase_one_parameters.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 AllowedPhaseOneParameters(object): + """ + Phase One Parameters + """ + + def __init__(self, **kwargs): + """ + Initializes a new AllowedPhaseOneParameters object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param encryption_algorithms: + The value to assign to the encryption_algorithms property of this AllowedPhaseOneParameters. + :type encryption_algorithms: list[str] + + :param authentication_algorithms: + The value to assign to the authentication_algorithms property of this AllowedPhaseOneParameters. + :type authentication_algorithms: list[str] + + :param dh_groups: + The value to assign to the dh_groups property of this AllowedPhaseOneParameters. + :type dh_groups: list[str] + + """ + self.swagger_types = { + 'encryption_algorithms': 'list[str]', + 'authentication_algorithms': 'list[str]', + 'dh_groups': 'list[str]' + } + + self.attribute_map = { + 'encryption_algorithms': 'encryptionAlgorithms', + 'authentication_algorithms': 'authenticationAlgorithms', + 'dh_groups': 'dhGroups' + } + + self._encryption_algorithms = None + self._authentication_algorithms = None + self._dh_groups = None + + @property + def encryption_algorithms(self): + """ + Gets the encryption_algorithms of this AllowedPhaseOneParameters. + Phase One Encryption Algorithms + + + :return: The encryption_algorithms of this AllowedPhaseOneParameters. + :rtype: list[str] + """ + return self._encryption_algorithms + + @encryption_algorithms.setter + def encryption_algorithms(self, encryption_algorithms): + """ + Sets the encryption_algorithms of this AllowedPhaseOneParameters. + Phase One Encryption Algorithms + + + :param encryption_algorithms: The encryption_algorithms of this AllowedPhaseOneParameters. + :type: list[str] + """ + self._encryption_algorithms = encryption_algorithms + + @property + def authentication_algorithms(self): + """ + Gets the authentication_algorithms of this AllowedPhaseOneParameters. + Phase One Authentication Algorithms + + + :return: The authentication_algorithms of this AllowedPhaseOneParameters. + :rtype: list[str] + """ + return self._authentication_algorithms + + @authentication_algorithms.setter + def authentication_algorithms(self, authentication_algorithms): + """ + Sets the authentication_algorithms of this AllowedPhaseOneParameters. + Phase One Authentication Algorithms + + + :param authentication_algorithms: The authentication_algorithms of this AllowedPhaseOneParameters. + :type: list[str] + """ + self._authentication_algorithms = authentication_algorithms + + @property + def dh_groups(self): + """ + Gets the dh_groups of this AllowedPhaseOneParameters. + DH Groups + + + :return: The dh_groups of this AllowedPhaseOneParameters. + :rtype: list[str] + """ + return self._dh_groups + + @dh_groups.setter + def dh_groups(self, dh_groups): + """ + Sets the dh_groups of this AllowedPhaseOneParameters. + DH Groups + + + :param dh_groups: The dh_groups of this AllowedPhaseOneParameters. + :type: list[str] + """ + self._dh_groups = dh_groups + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/allowed_phase_two_parameters.py b/src/oci/core/models/allowed_phase_two_parameters.py new file mode 100644 index 0000000000..59dd3bfdc1 --- /dev/null +++ b/src/oci/core/models/allowed_phase_two_parameters.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 AllowedPhaseTwoParameters(object): + """ + Phase Two Parameters + """ + + def __init__(self, **kwargs): + """ + Initializes a new AllowedPhaseTwoParameters object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param encryption_algorithms: + The value to assign to the encryption_algorithms property of this AllowedPhaseTwoParameters. + :type encryption_algorithms: list[str] + + :param authentication_algorithms: + The value to assign to the authentication_algorithms property of this AllowedPhaseTwoParameters. + :type authentication_algorithms: list[str] + + :param pfs_dh_groups: + The value to assign to the pfs_dh_groups property of this AllowedPhaseTwoParameters. + :type pfs_dh_groups: list[str] + + """ + self.swagger_types = { + 'encryption_algorithms': 'list[str]', + 'authentication_algorithms': 'list[str]', + 'pfs_dh_groups': 'list[str]' + } + + self.attribute_map = { + 'encryption_algorithms': 'encryptionAlgorithms', + 'authentication_algorithms': 'authenticationAlgorithms', + 'pfs_dh_groups': 'pfsDhGroups' + } + + self._encryption_algorithms = None + self._authentication_algorithms = None + self._pfs_dh_groups = None + + @property + def encryption_algorithms(self): + """ + Gets the encryption_algorithms of this AllowedPhaseTwoParameters. + Phase Two Encryption Algorithms + + + :return: The encryption_algorithms of this AllowedPhaseTwoParameters. + :rtype: list[str] + """ + return self._encryption_algorithms + + @encryption_algorithms.setter + def encryption_algorithms(self, encryption_algorithms): + """ + Sets the encryption_algorithms of this AllowedPhaseTwoParameters. + Phase Two Encryption Algorithms + + + :param encryption_algorithms: The encryption_algorithms of this AllowedPhaseTwoParameters. + :type: list[str] + """ + self._encryption_algorithms = encryption_algorithms + + @property + def authentication_algorithms(self): + """ + Gets the authentication_algorithms of this AllowedPhaseTwoParameters. + Phase Two Authentication Algorithms + + + :return: The authentication_algorithms of this AllowedPhaseTwoParameters. + :rtype: list[str] + """ + return self._authentication_algorithms + + @authentication_algorithms.setter + def authentication_algorithms(self, authentication_algorithms): + """ + Sets the authentication_algorithms of this AllowedPhaseTwoParameters. + Phase Two Authentication Algorithms + + + :param authentication_algorithms: The authentication_algorithms of this AllowedPhaseTwoParameters. + :type: list[str] + """ + self._authentication_algorithms = authentication_algorithms + + @property + def pfs_dh_groups(self): + """ + Gets the pfs_dh_groups of this AllowedPhaseTwoParameters. + PFS DH Groups + + + :return: The pfs_dh_groups of this AllowedPhaseTwoParameters. + :rtype: list[str] + """ + return self._pfs_dh_groups + + @pfs_dh_groups.setter + def pfs_dh_groups(self, pfs_dh_groups): + """ + Sets the pfs_dh_groups of this AllowedPhaseTwoParameters. + PFS DH Groups + + + :param pfs_dh_groups: The pfs_dh_groups of this AllowedPhaseTwoParameters. + :type: list[str] + """ + self._pfs_dh_groups = pfs_dh_groups + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/create_ip_sec_connection_tunnel_details.py b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py index 40d088efb5..c4abe96f5b 100644 --- a/src/oci/core/models/create_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py @@ -33,6 +33,26 @@ class CreateIPSecConnectionTunnelDetails(object): #: This constant has a value of "V2" IKE_VERSION_V2 = "V2" + #: A constant which can be used with the oracle_initiation property of a CreateIPSecConnectionTunnelDetails. + #: This constant has a value of "INITIATOR_OR_RESPONDER" + ORACLE_INITIATION_INITIATOR_OR_RESPONDER = "INITIATOR_OR_RESPONDER" + + #: A constant which can be used with the oracle_initiation property of a CreateIPSecConnectionTunnelDetails. + #: This constant has a value of "RESPONDER_ONLY" + ORACLE_INITIATION_RESPONDER_ONLY = "RESPONDER_ONLY" + + #: A constant which can be used with the nat_translation_enabled property of a CreateIPSecConnectionTunnelDetails. + #: This constant has a value of "ENABLED" + NAT_TRANSLATION_ENABLED_ENABLED = "ENABLED" + + #: A constant which can be used with the nat_translation_enabled property of a CreateIPSecConnectionTunnelDetails. + #: This constant has a value of "DISABLED" + NAT_TRANSLATION_ENABLED_DISABLED = "DISABLED" + + #: A constant which can be used with the nat_translation_enabled property of a CreateIPSecConnectionTunnelDetails. + #: This constant has a value of "AUTO" + NAT_TRANSLATION_ENABLED_AUTO = "AUTO" + def __init__(self, **kwargs): """ Initializes a new CreateIPSecConnectionTunnelDetails object with values from keyword arguments. @@ -60,6 +80,28 @@ def __init__(self, **kwargs): The value to assign to the bgp_session_config property of this CreateIPSecConnectionTunnelDetails. :type bgp_session_config: oci.core.models.CreateIPSecTunnelBgpSessionDetails + :param oracle_initiation: + The value to assign to the oracle_initiation property of this CreateIPSecConnectionTunnelDetails. + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" + :type oracle_initiation: str + + :param nat_translation_enabled: + The value to assign to the nat_translation_enabled property of this CreateIPSecConnectionTunnelDetails. + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" + :type nat_translation_enabled: str + + :param phase_one_config: + The value to assign to the phase_one_config property of this CreateIPSecConnectionTunnelDetails. + :type phase_one_config: oci.core.models.PhaseOneConfigDetails + + :param phase_two_config: + The value to assign to the phase_two_config property of this CreateIPSecConnectionTunnelDetails. + :type phase_two_config: oci.core.models.PhaseTwoConfigDetails + + :param dpd_config: + The value to assign to the dpd_config property of this CreateIPSecConnectionTunnelDetails. + :type dpd_config: oci.core.models.DpdConfig + :param encryption_domain_config: The value to assign to the encryption_domain_config property of this CreateIPSecConnectionTunnelDetails. :type encryption_domain_config: oci.core.models.CreateIPSecTunnelEncryptionDomainDetails @@ -71,6 +113,11 @@ def __init__(self, **kwargs): 'ike_version': 'str', 'shared_secret': 'str', 'bgp_session_config': 'CreateIPSecTunnelBgpSessionDetails', + 'oracle_initiation': 'str', + 'nat_translation_enabled': 'str', + 'phase_one_config': 'PhaseOneConfigDetails', + 'phase_two_config': 'PhaseTwoConfigDetails', + 'dpd_config': 'DpdConfig', 'encryption_domain_config': 'CreateIPSecTunnelEncryptionDomainDetails' } @@ -80,6 +127,11 @@ def __init__(self, **kwargs): 'ike_version': 'ikeVersion', 'shared_secret': 'sharedSecret', 'bgp_session_config': 'bgpSessionConfig', + 'oracle_initiation': 'oracleInitiation', + 'nat_translation_enabled': 'natTranslationEnabled', + 'phase_one_config': 'phaseOneConfig', + 'phase_two_config': 'phaseTwoConfig', + 'dpd_config': 'dpdConfig', 'encryption_domain_config': 'encryptionDomainConfig' } @@ -88,6 +140,11 @@ def __init__(self, **kwargs): self._ike_version = None self._shared_secret = None self._bgp_session_config = None + self._oracle_initiation = None + self._nat_translation_enabled = None + self._phase_one_config = None + self._phase_two_config = None + self._dpd_config = None self._encryption_domain_config = None @property @@ -230,6 +287,130 @@ def bgp_session_config(self, bgp_session_config): """ self._bgp_session_config = bgp_session_config + @property + def oracle_initiation(self): + """ + Gets the oracle_initiation of this CreateIPSecConnectionTunnelDetails. + Whether Oracle side is the initiator for negotiation. + + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" + + + :return: The oracle_initiation of this CreateIPSecConnectionTunnelDetails. + :rtype: str + """ + return self._oracle_initiation + + @oracle_initiation.setter + def oracle_initiation(self, oracle_initiation): + """ + Sets the oracle_initiation of this CreateIPSecConnectionTunnelDetails. + Whether Oracle side is the initiator for negotiation. + + + :param oracle_initiation: The oracle_initiation of this CreateIPSecConnectionTunnelDetails. + :type: str + """ + allowed_values = ["INITIATOR_OR_RESPONDER", "RESPONDER_ONLY"] + if not value_allowed_none_or_none_sentinel(oracle_initiation, allowed_values): + raise ValueError( + "Invalid value for `oracle_initiation`, must be None or one of {0}" + .format(allowed_values) + ) + self._oracle_initiation = oracle_initiation + + @property + def nat_translation_enabled(self): + """ + Gets the nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. + Whether NAT-T Enabled on the tunnel + + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" + + + :return: The nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. + :rtype: str + """ + return self._nat_translation_enabled + + @nat_translation_enabled.setter + def nat_translation_enabled(self, nat_translation_enabled): + """ + Sets the nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. + Whether NAT-T Enabled on the tunnel + + + :param nat_translation_enabled: The nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED", "AUTO"] + if not value_allowed_none_or_none_sentinel(nat_translation_enabled, allowed_values): + raise ValueError( + "Invalid value for `nat_translation_enabled`, must be None or one of {0}" + .format(allowed_values) + ) + self._nat_translation_enabled = nat_translation_enabled + + @property + def phase_one_config(self): + """ + Gets the phase_one_config of this CreateIPSecConnectionTunnelDetails. + + :return: The phase_one_config of this CreateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.PhaseOneConfigDetails + """ + return self._phase_one_config + + @phase_one_config.setter + def phase_one_config(self, phase_one_config): + """ + Sets the phase_one_config of this CreateIPSecConnectionTunnelDetails. + + :param phase_one_config: The phase_one_config of this CreateIPSecConnectionTunnelDetails. + :type: oci.core.models.PhaseOneConfigDetails + """ + self._phase_one_config = phase_one_config + + @property + def phase_two_config(self): + """ + Gets the phase_two_config of this CreateIPSecConnectionTunnelDetails. + + :return: The phase_two_config of this CreateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.PhaseTwoConfigDetails + """ + return self._phase_two_config + + @phase_two_config.setter + def phase_two_config(self, phase_two_config): + """ + Sets the phase_two_config of this CreateIPSecConnectionTunnelDetails. + + :param phase_two_config: The phase_two_config of this CreateIPSecConnectionTunnelDetails. + :type: oci.core.models.PhaseTwoConfigDetails + """ + self._phase_two_config = phase_two_config + + @property + def dpd_config(self): + """ + Gets the dpd_config of this CreateIPSecConnectionTunnelDetails. + + :return: The dpd_config of this CreateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.DpdConfig + """ + return self._dpd_config + + @dpd_config.setter + def dpd_config(self, dpd_config): + """ + Sets the dpd_config of this CreateIPSecConnectionTunnelDetails. + + :param dpd_config: The dpd_config of this CreateIPSecConnectionTunnelDetails. + :type: oci.core.models.DpdConfig + """ + self._dpd_config = dpd_config + @property def encryption_domain_config(self): """ diff --git a/src/oci/core/models/default_phase_one_parameters.py b/src/oci/core/models/default_phase_one_parameters.py new file mode 100644 index 0000000000..90243152d8 --- /dev/null +++ b/src/oci/core/models/default_phase_one_parameters.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DefaultPhaseOneParameters(object): + """ + Phase One Parameters + """ + + def __init__(self, **kwargs): + """ + Initializes a new DefaultPhaseOneParameters object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param default_encryption_algorithms: + The value to assign to the default_encryption_algorithms property of this DefaultPhaseOneParameters. + :type default_encryption_algorithms: list[str] + + :param default_authentication_algorithms: + The value to assign to the default_authentication_algorithms property of this DefaultPhaseOneParameters. + :type default_authentication_algorithms: list[str] + + :param default_dh_groups: + The value to assign to the default_dh_groups property of this DefaultPhaseOneParameters. + :type default_dh_groups: list[str] + + """ + self.swagger_types = { + 'default_encryption_algorithms': 'list[str]', + 'default_authentication_algorithms': 'list[str]', + 'default_dh_groups': 'list[str]' + } + + self.attribute_map = { + 'default_encryption_algorithms': 'defaultEncryptionAlgorithms', + 'default_authentication_algorithms': 'defaultAuthenticationAlgorithms', + 'default_dh_groups': 'defaultDhGroups' + } + + self._default_encryption_algorithms = None + self._default_authentication_algorithms = None + self._default_dh_groups = None + + @property + def default_encryption_algorithms(self): + """ + Gets the default_encryption_algorithms of this DefaultPhaseOneParameters. + Default Phase One Encryption Algorithms + + + :return: The default_encryption_algorithms of this DefaultPhaseOneParameters. + :rtype: list[str] + """ + return self._default_encryption_algorithms + + @default_encryption_algorithms.setter + def default_encryption_algorithms(self, default_encryption_algorithms): + """ + Sets the default_encryption_algorithms of this DefaultPhaseOneParameters. + Default Phase One Encryption Algorithms + + + :param default_encryption_algorithms: The default_encryption_algorithms of this DefaultPhaseOneParameters. + :type: list[str] + """ + self._default_encryption_algorithms = default_encryption_algorithms + + @property + def default_authentication_algorithms(self): + """ + Gets the default_authentication_algorithms of this DefaultPhaseOneParameters. + Default Phase One Authentication Algorithms + + + :return: The default_authentication_algorithms of this DefaultPhaseOneParameters. + :rtype: list[str] + """ + return self._default_authentication_algorithms + + @default_authentication_algorithms.setter + def default_authentication_algorithms(self, default_authentication_algorithms): + """ + Sets the default_authentication_algorithms of this DefaultPhaseOneParameters. + Default Phase One Authentication Algorithms + + + :param default_authentication_algorithms: The default_authentication_algorithms of this DefaultPhaseOneParameters. + :type: list[str] + """ + self._default_authentication_algorithms = default_authentication_algorithms + + @property + def default_dh_groups(self): + """ + Gets the default_dh_groups of this DefaultPhaseOneParameters. + Default DH Groups + + + :return: The default_dh_groups of this DefaultPhaseOneParameters. + :rtype: list[str] + """ + return self._default_dh_groups + + @default_dh_groups.setter + def default_dh_groups(self, default_dh_groups): + """ + Sets the default_dh_groups of this DefaultPhaseOneParameters. + Default DH Groups + + + :param default_dh_groups: The default_dh_groups of this DefaultPhaseOneParameters. + :type: list[str] + """ + self._default_dh_groups = default_dh_groups + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/default_phase_two_parameters.py b/src/oci/core/models/default_phase_two_parameters.py new file mode 100644 index 0000000000..c8fef9cf86 --- /dev/null +++ b/src/oci/core/models/default_phase_two_parameters.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DefaultPhaseTwoParameters(object): + """ + Phase Two Parameters + """ + + def __init__(self, **kwargs): + """ + Initializes a new DefaultPhaseTwoParameters object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param default_encryption_algorithms: + The value to assign to the default_encryption_algorithms property of this DefaultPhaseTwoParameters. + :type default_encryption_algorithms: list[str] + + :param default_authentication_algorithms: + The value to assign to the default_authentication_algorithms property of this DefaultPhaseTwoParameters. + :type default_authentication_algorithms: list[str] + + :param default_pfs_dh_group: + The value to assign to the default_pfs_dh_group property of this DefaultPhaseTwoParameters. + :type default_pfs_dh_group: str + + """ + self.swagger_types = { + 'default_encryption_algorithms': 'list[str]', + 'default_authentication_algorithms': 'list[str]', + 'default_pfs_dh_group': 'str' + } + + self.attribute_map = { + 'default_encryption_algorithms': 'defaultEncryptionAlgorithms', + 'default_authentication_algorithms': 'defaultAuthenticationAlgorithms', + 'default_pfs_dh_group': 'defaultPfsDhGroup' + } + + self._default_encryption_algorithms = None + self._default_authentication_algorithms = None + self._default_pfs_dh_group = None + + @property + def default_encryption_algorithms(self): + """ + Gets the default_encryption_algorithms of this DefaultPhaseTwoParameters. + Default Phase Two Encryption Algorithms + + + :return: The default_encryption_algorithms of this DefaultPhaseTwoParameters. + :rtype: list[str] + """ + return self._default_encryption_algorithms + + @default_encryption_algorithms.setter + def default_encryption_algorithms(self, default_encryption_algorithms): + """ + Sets the default_encryption_algorithms of this DefaultPhaseTwoParameters. + Default Phase Two Encryption Algorithms + + + :param default_encryption_algorithms: The default_encryption_algorithms of this DefaultPhaseTwoParameters. + :type: list[str] + """ + self._default_encryption_algorithms = default_encryption_algorithms + + @property + def default_authentication_algorithms(self): + """ + Gets the default_authentication_algorithms of this DefaultPhaseTwoParameters. + Default Phase Two Authentication Algorithms + + + :return: The default_authentication_algorithms of this DefaultPhaseTwoParameters. + :rtype: list[str] + """ + return self._default_authentication_algorithms + + @default_authentication_algorithms.setter + def default_authentication_algorithms(self, default_authentication_algorithms): + """ + Sets the default_authentication_algorithms of this DefaultPhaseTwoParameters. + Default Phase Two Authentication Algorithms + + + :param default_authentication_algorithms: The default_authentication_algorithms of this DefaultPhaseTwoParameters. + :type: list[str] + """ + self._default_authentication_algorithms = default_authentication_algorithms + + @property + def default_pfs_dh_group(self): + """ + Gets the default_pfs_dh_group of this DefaultPhaseTwoParameters. + Default PFS DH Group + + + :return: The default_pfs_dh_group of this DefaultPhaseTwoParameters. + :rtype: str + """ + return self._default_pfs_dh_group + + @default_pfs_dh_group.setter + def default_pfs_dh_group(self, default_pfs_dh_group): + """ + Sets the default_pfs_dh_group of this DefaultPhaseTwoParameters. + Default PFS DH Group + + + :param default_pfs_dh_group: The default_pfs_dh_group of this DefaultPhaseTwoParameters. + :type: str + """ + self._default_pfs_dh_group = default_pfs_dh_group + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/core/models/dpd_config.py b/src/oci/core/models/dpd_config.py new file mode 100644 index 0000000000..c2aff529f2 --- /dev/null +++ b/src/oci/core/models/dpd_config.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DpdConfig(object): + """ + DPD Configuration Details + """ + + #: A constant which can be used with the dpd_mode property of a DpdConfig. + #: This constant has a value of "INITIATE_AND_RESPOND" + DPD_MODE_INITIATE_AND_RESPOND = "INITIATE_AND_RESPOND" + + #: A constant which can be used with the dpd_mode property of a DpdConfig. + #: This constant has a value of "RESPOND_ONLY" + DPD_MODE_RESPOND_ONLY = "RESPOND_ONLY" + + def __init__(self, **kwargs): + """ + Initializes a new DpdConfig object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param dpd_mode: + The value to assign to the dpd_mode property of this DpdConfig. + Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY" + :type dpd_mode: str + + :param dpd_timeout_in_sec: + The value to assign to the dpd_timeout_in_sec property of this DpdConfig. + :type dpd_timeout_in_sec: int + + """ + self.swagger_types = { + 'dpd_mode': 'str', + 'dpd_timeout_in_sec': 'int' + } + + self.attribute_map = { + 'dpd_mode': 'dpdMode', + 'dpd_timeout_in_sec': 'dpdTimeoutInSec' + } + + self._dpd_mode = None + self._dpd_timeout_in_sec = None + + @property + def dpd_mode(self): + """ + Gets the dpd_mode of this DpdConfig. + dpd mode + + Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY" + + + :return: The dpd_mode of this DpdConfig. + :rtype: str + """ + return self._dpd_mode + + @dpd_mode.setter + def dpd_mode(self, dpd_mode): + """ + Sets the dpd_mode of this DpdConfig. + dpd mode + + + :param dpd_mode: The dpd_mode of this DpdConfig. + :type: str + """ + allowed_values = ["INITIATE_AND_RESPOND", "RESPOND_ONLY"] + if not value_allowed_none_or_none_sentinel(dpd_mode, allowed_values): + raise ValueError( + "Invalid value for `dpd_mode`, must be None or one of {0}" + .format(allowed_values) + ) + self._dpd_mode = dpd_mode + + @property + def dpd_timeout_in_sec(self): + """ + Gets the dpd_timeout_in_sec of this DpdConfig. + DPD Timeout in seconds. + + + :return: The dpd_timeout_in_sec of this DpdConfig. + :rtype: int + """ + return self._dpd_timeout_in_sec + + @dpd_timeout_in_sec.setter + def dpd_timeout_in_sec(self, dpd_timeout_in_sec): + """ + Sets the dpd_timeout_in_sec of this DpdConfig. + DPD Timeout in seconds. + + + :param dpd_timeout_in_sec: The dpd_timeout_in_sec of this DpdConfig. + :type: int + """ + self._dpd_timeout_in_sec = dpd_timeout_in_sec + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/ip_sec_connection_tunnel.py b/src/oci/core/models/ip_sec_connection_tunnel.py index cf75ff956a..9b7f3146b1 100644 --- a/src/oci/core/models/ip_sec_connection_tunnel.py +++ b/src/oci/core/models/ip_sec_connection_tunnel.py @@ -67,6 +67,34 @@ class IPSecConnectionTunnel(object): #: This constant has a value of "POLICY" ROUTING_POLICY = "POLICY" + #: A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel. + #: This constant has a value of "INITIATOR_OR_RESPONDER" + ORACLE_CAN_INITIATE_INITIATOR_OR_RESPONDER = "INITIATOR_OR_RESPONDER" + + #: A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel. + #: This constant has a value of "RESPONDER_ONLY" + ORACLE_CAN_INITIATE_RESPONDER_ONLY = "RESPONDER_ONLY" + + #: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. + #: This constant has a value of "ENABLED" + NAT_TRANSLATION_ENABLED_ENABLED = "ENABLED" + + #: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. + #: This constant has a value of "DISABLED" + NAT_TRANSLATION_ENABLED_DISABLED = "DISABLED" + + #: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. + #: This constant has a value of "AUTO" + NAT_TRANSLATION_ENABLED_AUTO = "AUTO" + + #: A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel. + #: This constant has a value of "INITIATE_AND_RESPOND" + DPD_MODE_INITIATE_AND_RESPOND = "INITIATE_AND_RESPOND" + + #: A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel. + #: This constant has a value of "RESPOND_ONLY" + DPD_MODE_RESPOND_ONLY = "RESPOND_ONLY" + def __init__(self, **kwargs): """ Initializes a new IPSecConnectionTunnel object with values from keyword arguments. @@ -132,6 +160,36 @@ def __init__(self, **kwargs): The value to assign to the time_status_updated property of this IPSecConnectionTunnel. :type time_status_updated: datetime + :param oracle_can_initiate: + The value to assign to the oracle_can_initiate property of this IPSecConnectionTunnel. + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type oracle_can_initiate: str + + :param nat_translation_enabled: + The value to assign to the nat_translation_enabled property of this IPSecConnectionTunnel. + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type nat_translation_enabled: str + + :param dpd_mode: + The value to assign to the dpd_mode property of this IPSecConnectionTunnel. + Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type dpd_mode: str + + :param dpd_timeout_in_sec: + The value to assign to the dpd_timeout_in_sec property of this IPSecConnectionTunnel. + :type dpd_timeout_in_sec: int + + :param phase_one_details: + The value to assign to the phase_one_details property of this IPSecConnectionTunnel. + :type phase_one_details: oci.core.models.TunnelPhaseOneDetails + + :param phase_two_details: + The value to assign to the phase_two_details property of this IPSecConnectionTunnel. + :type phase_two_details: oci.core.models.TunnelPhaseTwoDetails + """ self.swagger_types = { 'compartment_id': 'str', @@ -146,7 +204,13 @@ def __init__(self, **kwargs): 'encryption_domain_config': 'EncryptionDomainConfig', 'routing': 'str', 'time_created': 'datetime', - 'time_status_updated': 'datetime' + 'time_status_updated': 'datetime', + 'oracle_can_initiate': 'str', + 'nat_translation_enabled': 'str', + 'dpd_mode': 'str', + 'dpd_timeout_in_sec': 'int', + 'phase_one_details': 'TunnelPhaseOneDetails', + 'phase_two_details': 'TunnelPhaseTwoDetails' } self.attribute_map = { @@ -162,7 +226,13 @@ def __init__(self, **kwargs): 'encryption_domain_config': 'encryptionDomainConfig', 'routing': 'routing', 'time_created': 'timeCreated', - 'time_status_updated': 'timeStatusUpdated' + 'time_status_updated': 'timeStatusUpdated', + 'oracle_can_initiate': 'oracleCanInitiate', + 'nat_translation_enabled': 'natTranslationEnabled', + 'dpd_mode': 'dpdMode', + 'dpd_timeout_in_sec': 'dpdTimeoutInSec', + 'phase_one_details': 'phaseOneDetails', + 'phase_two_details': 'phaseTwoDetails' } self._compartment_id = None @@ -178,6 +248,12 @@ def __init__(self, **kwargs): self._routing = None self._time_created = None self._time_status_updated = None + self._oracle_can_initiate = None + self._nat_translation_enabled = None + self._dpd_mode = None + self._dpd_timeout_in_sec = None + self._phase_one_details = None + self._phase_two_details = None @property def compartment_id(self): @@ -541,6 +617,160 @@ def time_status_updated(self, time_status_updated): """ self._time_status_updated = time_status_updated + @property + def oracle_can_initiate(self): + """ + Gets the oracle_can_initiate of this IPSecConnectionTunnel. + Indicates whether Oracle can either initiate the tunnel or respond, or respond only. + + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The oracle_can_initiate of this IPSecConnectionTunnel. + :rtype: str + """ + return self._oracle_can_initiate + + @oracle_can_initiate.setter + def oracle_can_initiate(self, oracle_can_initiate): + """ + Sets the oracle_can_initiate of this IPSecConnectionTunnel. + Indicates whether Oracle can either initiate the tunnel or respond, or respond only. + + + :param oracle_can_initiate: The oracle_can_initiate of this IPSecConnectionTunnel. + :type: str + """ + allowed_values = ["INITIATOR_OR_RESPONDER", "RESPONDER_ONLY"] + if not value_allowed_none_or_none_sentinel(oracle_can_initiate, allowed_values): + oracle_can_initiate = 'UNKNOWN_ENUM_VALUE' + self._oracle_can_initiate = oracle_can_initiate + + @property + def nat_translation_enabled(self): + """ + Gets the nat_translation_enabled of this IPSecConnectionTunnel. + Whether NAT-T Enabled on the tunnel + + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The nat_translation_enabled of this IPSecConnectionTunnel. + :rtype: str + """ + return self._nat_translation_enabled + + @nat_translation_enabled.setter + def nat_translation_enabled(self, nat_translation_enabled): + """ + Sets the nat_translation_enabled of this IPSecConnectionTunnel. + Whether NAT-T Enabled on the tunnel + + + :param nat_translation_enabled: The nat_translation_enabled of this IPSecConnectionTunnel. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED", "AUTO"] + if not value_allowed_none_or_none_sentinel(nat_translation_enabled, allowed_values): + nat_translation_enabled = 'UNKNOWN_ENUM_VALUE' + self._nat_translation_enabled = nat_translation_enabled + + @property + def dpd_mode(self): + """ + Gets the dpd_mode of this IPSecConnectionTunnel. + dpd mode + + Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The dpd_mode of this IPSecConnectionTunnel. + :rtype: str + """ + return self._dpd_mode + + @dpd_mode.setter + def dpd_mode(self, dpd_mode): + """ + Sets the dpd_mode of this IPSecConnectionTunnel. + dpd mode + + + :param dpd_mode: The dpd_mode of this IPSecConnectionTunnel. + :type: str + """ + allowed_values = ["INITIATE_AND_RESPOND", "RESPOND_ONLY"] + if not value_allowed_none_or_none_sentinel(dpd_mode, allowed_values): + dpd_mode = 'UNKNOWN_ENUM_VALUE' + self._dpd_mode = dpd_mode + + @property + def dpd_timeout_in_sec(self): + """ + Gets the dpd_timeout_in_sec of this IPSecConnectionTunnel. + Dead peer detection (DPD) timeout in seconds. + + + :return: The dpd_timeout_in_sec of this IPSecConnectionTunnel. + :rtype: int + """ + return self._dpd_timeout_in_sec + + @dpd_timeout_in_sec.setter + def dpd_timeout_in_sec(self, dpd_timeout_in_sec): + """ + Sets the dpd_timeout_in_sec of this IPSecConnectionTunnel. + Dead peer detection (DPD) timeout in seconds. + + + :param dpd_timeout_in_sec: The dpd_timeout_in_sec of this IPSecConnectionTunnel. + :type: int + """ + self._dpd_timeout_in_sec = dpd_timeout_in_sec + + @property + def phase_one_details(self): + """ + Gets the phase_one_details of this IPSecConnectionTunnel. + + :return: The phase_one_details of this IPSecConnectionTunnel. + :rtype: oci.core.models.TunnelPhaseOneDetails + """ + return self._phase_one_details + + @phase_one_details.setter + def phase_one_details(self, phase_one_details): + """ + Sets the phase_one_details of this IPSecConnectionTunnel. + + :param phase_one_details: The phase_one_details of this IPSecConnectionTunnel. + :type: oci.core.models.TunnelPhaseOneDetails + """ + self._phase_one_details = phase_one_details + + @property + def phase_two_details(self): + """ + Gets the phase_two_details of this IPSecConnectionTunnel. + + :return: The phase_two_details of this IPSecConnectionTunnel. + :rtype: oci.core.models.TunnelPhaseTwoDetails + """ + return self._phase_two_details + + @phase_two_details.setter + def phase_two_details(self, phase_two_details): + """ + Sets the phase_two_details of this IPSecConnectionTunnel. + + :param phase_two_details: The phase_two_details of this IPSecConnectionTunnel. + :type: oci.core.models.TunnelPhaseTwoDetails + """ + self._phase_two_details = phase_two_details + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/ip_sec_connection_tunnel_error_details.py b/src/oci/core/models/ip_sec_connection_tunnel_error_details.py new file mode 100644 index 0000000000..32128e315a --- /dev/null +++ b/src/oci/core/models/ip_sec_connection_tunnel_error_details.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 IPSecConnectionTunnelErrorDetails(object): + """ + Ipsec tunnels error details + """ + + def __init__(self, **kwargs): + """ + Initializes a new IPSecConnectionTunnelErrorDetails 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 IPSecConnectionTunnelErrorDetails. + :type id: str + + :param error_code: + The value to assign to the error_code property of this IPSecConnectionTunnelErrorDetails. + :type error_code: str + + :param error_description: + The value to assign to the error_description property of this IPSecConnectionTunnelErrorDetails. + :type error_description: str + + :param solution: + The value to assign to the solution property of this IPSecConnectionTunnelErrorDetails. + :type solution: str + + :param oci_resources_link: + The value to assign to the oci_resources_link property of this IPSecConnectionTunnelErrorDetails. + :type oci_resources_link: str + + :param timestamp: + The value to assign to the timestamp property of this IPSecConnectionTunnelErrorDetails. + :type timestamp: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'error_code': 'str', + 'error_description': 'str', + 'solution': 'str', + 'oci_resources_link': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'error_code': 'errorCode', + 'error_description': 'errorDescription', + 'solution': 'solution', + 'oci_resources_link': 'ociResourcesLink', + 'timestamp': 'timestamp' + } + + self._id = None + self._error_code = None + self._error_description = None + self._solution = None + self._oci_resources_link = None + self._timestamp = None + + @property + def id(self): + """ + **[Required]** Gets the id of this IPSecConnectionTunnelErrorDetails. + unique id generated for each error report + + + :return: The id of this IPSecConnectionTunnelErrorDetails. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this IPSecConnectionTunnelErrorDetails. + unique id generated for each error report + + + :param id: The id of this IPSecConnectionTunnelErrorDetails. + :type: str + """ + self._id = id + + @property + def error_code(self): + """ + **[Required]** Gets the error_code of this IPSecConnectionTunnelErrorDetails. + unique code describes error type + + + :return: The error_code of this IPSecConnectionTunnelErrorDetails. + :rtype: str + """ + return self._error_code + + @error_code.setter + def error_code(self, error_code): + """ + Sets the error_code of this IPSecConnectionTunnelErrorDetails. + unique code describes error type + + + :param error_code: The error_code of this IPSecConnectionTunnelErrorDetails. + :type: str + """ + self._error_code = error_code + + @property + def error_description(self): + """ + **[Required]** Gets the error_description of this IPSecConnectionTunnelErrorDetails. + detailed description of the error + + + :return: The error_description of this IPSecConnectionTunnelErrorDetails. + :rtype: str + """ + return self._error_description + + @error_description.setter + def error_description(self, error_description): + """ + Sets the error_description of this IPSecConnectionTunnelErrorDetails. + detailed description of the error + + + :param error_description: The error_description of this IPSecConnectionTunnelErrorDetails. + :type: str + """ + self._error_description = error_description + + @property + def solution(self): + """ + **[Required]** Gets the solution of this IPSecConnectionTunnelErrorDetails. + how to resolve the error + + + :return: The solution of this IPSecConnectionTunnelErrorDetails. + :rtype: str + """ + return self._solution + + @solution.setter + def solution(self, solution): + """ + Sets the solution of this IPSecConnectionTunnelErrorDetails. + how to resolve the error + + + :param solution: The solution of this IPSecConnectionTunnelErrorDetails. + :type: str + """ + self._solution = solution + + @property + def oci_resources_link(self): + """ + **[Required]** Gets the oci_resources_link of this IPSecConnectionTunnelErrorDetails. + link to oracle resources + + + :return: The oci_resources_link of this IPSecConnectionTunnelErrorDetails. + :rtype: str + """ + return self._oci_resources_link + + @oci_resources_link.setter + def oci_resources_link(self, oci_resources_link): + """ + Sets the oci_resources_link of this IPSecConnectionTunnelErrorDetails. + link to oracle resources + + + :param oci_resources_link: The oci_resources_link of this IPSecConnectionTunnelErrorDetails. + :type: str + """ + self._oci_resources_link = oci_resources_link + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this IPSecConnectionTunnelErrorDetails. + timestamp when error occurred. + + + :return: The timestamp of this IPSecConnectionTunnelErrorDetails. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this IPSecConnectionTunnelErrorDetails. + timestamp when error occurred. + + + :param timestamp: The timestamp of this IPSecConnectionTunnelErrorDetails. + :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/core/models/phase_one_config_details.py b/src/oci/core/models/phase_one_config_details.py new file mode 100644 index 0000000000..bdc538d4ef --- /dev/null +++ b/src/oci/core/models/phase_one_config_details.py @@ -0,0 +1,269 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 PhaseOneConfigDetails(object): + """ + Phase 1 Configuration Details + """ + + #: A constant which can be used with the authentication_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "SHA2_384" + AUTHENTICATION_ALGORITHM_SHA2_384 = "SHA2_384" + + #: A constant which can be used with the authentication_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "SHA2_256" + AUTHENTICATION_ALGORITHM_SHA2_256 = "SHA2_256" + + #: A constant which can be used with the authentication_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "SHA1_96" + AUTHENTICATION_ALGORITHM_SHA1_96 = "SHA1_96" + + #: A constant which can be used with the encryption_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "AES_256_CBC" + ENCRYPTION_ALGORITHM_AES_256_CBC = "AES_256_CBC" + + #: A constant which can be used with the encryption_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "AES_192_CBC" + ENCRYPTION_ALGORITHM_AES_192_CBC = "AES_192_CBC" + + #: A constant which can be used with the encryption_algorithm property of a PhaseOneConfigDetails. + #: This constant has a value of "AES_128_CBC" + ENCRYPTION_ALGORITHM_AES_128_CBC = "AES_128_CBC" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP2" + DIFFIE_HELMAN_GROUP_GROUP2 = "GROUP2" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP5" + DIFFIE_HELMAN_GROUP_GROUP5 = "GROUP5" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP14" + DIFFIE_HELMAN_GROUP_GROUP14 = "GROUP14" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP19" + DIFFIE_HELMAN_GROUP_GROUP19 = "GROUP19" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP20" + DIFFIE_HELMAN_GROUP_GROUP20 = "GROUP20" + + #: A constant which can be used with the diffie_helman_group property of a PhaseOneConfigDetails. + #: This constant has a value of "GROUP24" + DIFFIE_HELMAN_GROUP_GROUP24 = "GROUP24" + + def __init__(self, **kwargs): + """ + Initializes a new PhaseOneConfigDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_custom_phase_one_config: + The value to assign to the is_custom_phase_one_config property of this PhaseOneConfigDetails. + :type is_custom_phase_one_config: bool + + :param authentication_algorithm: + The value to assign to the authentication_algorithm property of this PhaseOneConfigDetails. + Allowed values for this property are: "SHA2_384", "SHA2_256", "SHA1_96" + :type authentication_algorithm: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this PhaseOneConfigDetails. + Allowed values for this property are: "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" + :type encryption_algorithm: str + + :param diffie_helman_group: + The value to assign to the diffie_helman_group property of this PhaseOneConfigDetails. + Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" + :type diffie_helman_group: str + + :param lifetime_in_seconds: + The value to assign to the lifetime_in_seconds property of this PhaseOneConfigDetails. + :type lifetime_in_seconds: int + + """ + self.swagger_types = { + 'is_custom_phase_one_config': 'bool', + 'authentication_algorithm': 'str', + 'encryption_algorithm': 'str', + 'diffie_helman_group': 'str', + 'lifetime_in_seconds': 'int' + } + + self.attribute_map = { + 'is_custom_phase_one_config': 'isCustomPhaseOneConfig', + 'authentication_algorithm': 'authenticationAlgorithm', + 'encryption_algorithm': 'encryptionAlgorithm', + 'diffie_helman_group': 'diffieHelmanGroup', + 'lifetime_in_seconds': 'lifetimeInSeconds' + } + + self._is_custom_phase_one_config = None + self._authentication_algorithm = None + self._encryption_algorithm = None + self._diffie_helman_group = None + self._lifetime_in_seconds = None + + @property + def is_custom_phase_one_config(self): + """ + Gets the is_custom_phase_one_config of this PhaseOneConfigDetails. + Indicates whether custom phase one configuration is enabled. + + + :return: The is_custom_phase_one_config of this PhaseOneConfigDetails. + :rtype: bool + """ + return self._is_custom_phase_one_config + + @is_custom_phase_one_config.setter + def is_custom_phase_one_config(self, is_custom_phase_one_config): + """ + Sets the is_custom_phase_one_config of this PhaseOneConfigDetails. + Indicates whether custom phase one configuration is enabled. + + + :param is_custom_phase_one_config: The is_custom_phase_one_config of this PhaseOneConfigDetails. + :type: bool + """ + self._is_custom_phase_one_config = is_custom_phase_one_config + + @property + def authentication_algorithm(self): + """ + Gets the authentication_algorithm of this PhaseOneConfigDetails. + Phase one authentication algorithm supported during tunnel negotiation. + + Allowed values for this property are: "SHA2_384", "SHA2_256", "SHA1_96" + + + :return: The authentication_algorithm of this PhaseOneConfigDetails. + :rtype: str + """ + return self._authentication_algorithm + + @authentication_algorithm.setter + def authentication_algorithm(self, authentication_algorithm): + """ + Sets the authentication_algorithm of this PhaseOneConfigDetails. + Phase one authentication algorithm supported during tunnel negotiation. + + + :param authentication_algorithm: The authentication_algorithm of this PhaseOneConfigDetails. + :type: str + """ + allowed_values = ["SHA2_384", "SHA2_256", "SHA1_96"] + if not value_allowed_none_or_none_sentinel(authentication_algorithm, allowed_values): + raise ValueError( + "Invalid value for `authentication_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._authentication_algorithm = authentication_algorithm + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this PhaseOneConfigDetails. + Phase one encryption algorithm supported during tunnel negotiation. + + Allowed values for this property are: "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" + + + :return: The encryption_algorithm of this PhaseOneConfigDetails. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this PhaseOneConfigDetails. + Phase one encryption algorithm supported during tunnel negotiation. + + + :param encryption_algorithm: The encryption_algorithm of this PhaseOneConfigDetails. + :type: str + """ + allowed_values = ["AES_256_CBC", "AES_192_CBC", "AES_128_CBC"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + raise ValueError( + "Invalid value for `encryption_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._encryption_algorithm = encryption_algorithm + + @property + def diffie_helman_group(self): + """ + Gets the diffie_helman_group of this PhaseOneConfigDetails. + Phase One Diffie Hellman group supported during tunnel negotiation. + + Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" + + + :return: The diffie_helman_group of this PhaseOneConfigDetails. + :rtype: str + """ + return self._diffie_helman_group + + @diffie_helman_group.setter + def diffie_helman_group(self, diffie_helman_group): + """ + Sets the diffie_helman_group of this PhaseOneConfigDetails. + Phase One Diffie Hellman group supported during tunnel negotiation. + + + :param diffie_helman_group: The diffie_helman_group of this PhaseOneConfigDetails. + :type: str + """ + allowed_values = ["GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24"] + if not value_allowed_none_or_none_sentinel(diffie_helman_group, allowed_values): + raise ValueError( + "Invalid value for `diffie_helman_group`, must be None or one of {0}" + .format(allowed_values) + ) + self._diffie_helman_group = diffie_helman_group + + @property + def lifetime_in_seconds(self): + """ + Gets the lifetime_in_seconds of this PhaseOneConfigDetails. + IKE session key lifetime in seconds for IPSec phase one. + + + :return: The lifetime_in_seconds of this PhaseOneConfigDetails. + :rtype: int + """ + return self._lifetime_in_seconds + + @lifetime_in_seconds.setter + def lifetime_in_seconds(self, lifetime_in_seconds): + """ + Sets the lifetime_in_seconds of this PhaseOneConfigDetails. + IKE session key lifetime in seconds for IPSec phase one. + + + :param lifetime_in_seconds: The lifetime_in_seconds of this PhaseOneConfigDetails. + :type: int + """ + self._lifetime_in_seconds = lifetime_in_seconds + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/phase_two_config_details.py b/src/oci/core/models/phase_two_config_details.py new file mode 100644 index 0000000000..f321bfc465 --- /dev/null +++ b/src/oci/core/models/phase_two_config_details.py @@ -0,0 +1,308 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 PhaseTwoConfigDetails(object): + """ + Phase 2 Configuration Details + """ + + #: A constant which can be used with the authentication_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "HMAC_SHA2_256_128" + AUTHENTICATION_ALGORITHM_HMAC_SHA2_256_128 = "HMAC_SHA2_256_128" + + #: A constant which can be used with the authentication_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "HMAC_SHA1_128" + AUTHENTICATION_ALGORITHM_HMAC_SHA1_128 = "HMAC_SHA1_128" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_256_GCM" + ENCRYPTION_ALGORITHM_AES_256_GCM = "AES_256_GCM" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_192_GCM" + ENCRYPTION_ALGORITHM_AES_192_GCM = "AES_192_GCM" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_128_GCM" + ENCRYPTION_ALGORITHM_AES_128_GCM = "AES_128_GCM" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_256_CBC" + ENCRYPTION_ALGORITHM_AES_256_CBC = "AES_256_CBC" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_192_CBC" + ENCRYPTION_ALGORITHM_AES_192_CBC = "AES_192_CBC" + + #: A constant which can be used with the encryption_algorithm property of a PhaseTwoConfigDetails. + #: This constant has a value of "AES_128_CBC" + ENCRYPTION_ALGORITHM_AES_128_CBC = "AES_128_CBC" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP2" + PFS_DH_GROUP_GROUP2 = "GROUP2" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP5" + PFS_DH_GROUP_GROUP5 = "GROUP5" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP14" + PFS_DH_GROUP_GROUP14 = "GROUP14" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP19" + PFS_DH_GROUP_GROUP19 = "GROUP19" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP20" + PFS_DH_GROUP_GROUP20 = "GROUP20" + + #: A constant which can be used with the pfs_dh_group property of a PhaseTwoConfigDetails. + #: This constant has a value of "GROUP24" + PFS_DH_GROUP_GROUP24 = "GROUP24" + + def __init__(self, **kwargs): + """ + Initializes a new PhaseTwoConfigDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_custom_phase_two_config: + The value to assign to the is_custom_phase_two_config property of this PhaseTwoConfigDetails. + :type is_custom_phase_two_config: bool + + :param authentication_algorithm: + The value to assign to the authentication_algorithm property of this PhaseTwoConfigDetails. + Allowed values for this property are: "HMAC_SHA2_256_128", "HMAC_SHA1_128" + :type authentication_algorithm: str + + :param encryption_algorithm: + The value to assign to the encryption_algorithm property of this PhaseTwoConfigDetails. + Allowed values for this property are: "AES_256_GCM", "AES_192_GCM", "AES_128_GCM", "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" + :type encryption_algorithm: str + + :param lifetime_in_seconds: + The value to assign to the lifetime_in_seconds property of this PhaseTwoConfigDetails. + :type lifetime_in_seconds: int + + :param is_pfs_enabled: + The value to assign to the is_pfs_enabled property of this PhaseTwoConfigDetails. + :type is_pfs_enabled: bool + + :param pfs_dh_group: + The value to assign to the pfs_dh_group property of this PhaseTwoConfigDetails. + Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" + :type pfs_dh_group: str + + """ + self.swagger_types = { + 'is_custom_phase_two_config': 'bool', + 'authentication_algorithm': 'str', + 'encryption_algorithm': 'str', + 'lifetime_in_seconds': 'int', + 'is_pfs_enabled': 'bool', + 'pfs_dh_group': 'str' + } + + self.attribute_map = { + 'is_custom_phase_two_config': 'isCustomPhaseTwoConfig', + 'authentication_algorithm': 'authenticationAlgorithm', + 'encryption_algorithm': 'encryptionAlgorithm', + 'lifetime_in_seconds': 'lifetimeInSeconds', + 'is_pfs_enabled': 'isPfsEnabled', + 'pfs_dh_group': 'pfsDhGroup' + } + + self._is_custom_phase_two_config = None + self._authentication_algorithm = None + self._encryption_algorithm = None + self._lifetime_in_seconds = None + self._is_pfs_enabled = None + self._pfs_dh_group = None + + @property + def is_custom_phase_two_config(self): + """ + Gets the is_custom_phase_two_config of this PhaseTwoConfigDetails. + Indicates whether custom phase two configuration is enabled. + + + :return: The is_custom_phase_two_config of this PhaseTwoConfigDetails. + :rtype: bool + """ + return self._is_custom_phase_two_config + + @is_custom_phase_two_config.setter + def is_custom_phase_two_config(self, is_custom_phase_two_config): + """ + Sets the is_custom_phase_two_config of this PhaseTwoConfigDetails. + Indicates whether custom phase two configuration is enabled. + + + :param is_custom_phase_two_config: The is_custom_phase_two_config of this PhaseTwoConfigDetails. + :type: bool + """ + self._is_custom_phase_two_config = is_custom_phase_two_config + + @property + def authentication_algorithm(self): + """ + Gets the authentication_algorithm of this PhaseTwoConfigDetails. + Phase two authentication algorithm supported during tunnel negotiation. + + Allowed values for this property are: "HMAC_SHA2_256_128", "HMAC_SHA1_128" + + + :return: The authentication_algorithm of this PhaseTwoConfigDetails. + :rtype: str + """ + return self._authentication_algorithm + + @authentication_algorithm.setter + def authentication_algorithm(self, authentication_algorithm): + """ + Sets the authentication_algorithm of this PhaseTwoConfigDetails. + Phase two authentication algorithm supported during tunnel negotiation. + + + :param authentication_algorithm: The authentication_algorithm of this PhaseTwoConfigDetails. + :type: str + """ + allowed_values = ["HMAC_SHA2_256_128", "HMAC_SHA1_128"] + if not value_allowed_none_or_none_sentinel(authentication_algorithm, allowed_values): + raise ValueError( + "Invalid value for `authentication_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._authentication_algorithm = authentication_algorithm + + @property + def encryption_algorithm(self): + """ + Gets the encryption_algorithm of this PhaseTwoConfigDetails. + Phase two encryption algorithm supported during tunnel negotiation. + + Allowed values for this property are: "AES_256_GCM", "AES_192_GCM", "AES_128_GCM", "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" + + + :return: The encryption_algorithm of this PhaseTwoConfigDetails. + :rtype: str + """ + return self._encryption_algorithm + + @encryption_algorithm.setter + def encryption_algorithm(self, encryption_algorithm): + """ + Sets the encryption_algorithm of this PhaseTwoConfigDetails. + Phase two encryption algorithm supported during tunnel negotiation. + + + :param encryption_algorithm: The encryption_algorithm of this PhaseTwoConfigDetails. + :type: str + """ + allowed_values = ["AES_256_GCM", "AES_192_GCM", "AES_128_GCM", "AES_256_CBC", "AES_192_CBC", "AES_128_CBC"] + if not value_allowed_none_or_none_sentinel(encryption_algorithm, allowed_values): + raise ValueError( + "Invalid value for `encryption_algorithm`, must be None or one of {0}" + .format(allowed_values) + ) + self._encryption_algorithm = encryption_algorithm + + @property + def lifetime_in_seconds(self): + """ + Gets the lifetime_in_seconds of this PhaseTwoConfigDetails. + Lifetime in seconds for IPSec phase two. + + + :return: The lifetime_in_seconds of this PhaseTwoConfigDetails. + :rtype: int + """ + return self._lifetime_in_seconds + + @lifetime_in_seconds.setter + def lifetime_in_seconds(self, lifetime_in_seconds): + """ + Sets the lifetime_in_seconds of this PhaseTwoConfigDetails. + Lifetime in seconds for IPSec phase two. + + + :param lifetime_in_seconds: The lifetime_in_seconds of this PhaseTwoConfigDetails. + :type: int + """ + self._lifetime_in_seconds = lifetime_in_seconds + + @property + def is_pfs_enabled(self): + """ + Gets the is_pfs_enabled of this PhaseTwoConfigDetails. + Indicates whether perfect forward secrecy (PFS) is enabled. + + + :return: The is_pfs_enabled of this PhaseTwoConfigDetails. + :rtype: bool + """ + return self._is_pfs_enabled + + @is_pfs_enabled.setter + def is_pfs_enabled(self, is_pfs_enabled): + """ + Sets the is_pfs_enabled of this PhaseTwoConfigDetails. + Indicates whether perfect forward secrecy (PFS) is enabled. + + + :param is_pfs_enabled: The is_pfs_enabled of this PhaseTwoConfigDetails. + :type: bool + """ + self._is_pfs_enabled = is_pfs_enabled + + @property + def pfs_dh_group(self): + """ + Gets the pfs_dh_group of this PhaseTwoConfigDetails. + Diffie-Hellman group used for PFS. + + Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" + + + :return: The pfs_dh_group of this PhaseTwoConfigDetails. + :rtype: str + """ + return self._pfs_dh_group + + @pfs_dh_group.setter + def pfs_dh_group(self, pfs_dh_group): + """ + Sets the pfs_dh_group of this PhaseTwoConfigDetails. + Diffie-Hellman group used for PFS. + + + :param pfs_dh_group: The pfs_dh_group of this PhaseTwoConfigDetails. + :type: str + """ + allowed_values = ["GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24"] + if not value_allowed_none_or_none_sentinel(pfs_dh_group, allowed_values): + raise ValueError( + "Invalid value for `pfs_dh_group`, must be None or one of {0}" + .format(allowed_values) + ) + self._pfs_dh_group = pfs_dh_group + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/core/models/tunnel_phase_one_details.py b/src/oci/core/models/tunnel_phase_one_details.py new file mode 100644 index 0000000000..98213795b5 --- /dev/null +++ b/src/oci/core/models/tunnel_phase_one_details.py @@ -0,0 +1,388 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 TunnelPhaseOneDetails(object): + """ + Tunnel detail information specific to IPSec phase 1. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TunnelPhaseOneDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_custom_phase_one_config: + The value to assign to the is_custom_phase_one_config property of this TunnelPhaseOneDetails. + :type is_custom_phase_one_config: bool + + :param lifetime: + The value to assign to the lifetime property of this TunnelPhaseOneDetails. + :type lifetime: int + + :param remaining_lifetime: + The value to assign to the remaining_lifetime property of this TunnelPhaseOneDetails. + :type remaining_lifetime: int + + :param custom_authentication_algorithm: + The value to assign to the custom_authentication_algorithm property of this TunnelPhaseOneDetails. + :type custom_authentication_algorithm: str + + :param negotiated_authentication_algorithm: + The value to assign to the negotiated_authentication_algorithm property of this TunnelPhaseOneDetails. + :type negotiated_authentication_algorithm: str + + :param custom_encryption_algorithm: + The value to assign to the custom_encryption_algorithm property of this TunnelPhaseOneDetails. + :type custom_encryption_algorithm: str + + :param negotiated_encryption_algorithm: + The value to assign to the negotiated_encryption_algorithm property of this TunnelPhaseOneDetails. + :type negotiated_encryption_algorithm: str + + :param custom_dh_group: + The value to assign to the custom_dh_group property of this TunnelPhaseOneDetails. + :type custom_dh_group: str + + :param negotiated_dh_group: + The value to assign to the negotiated_dh_group property of this TunnelPhaseOneDetails. + :type negotiated_dh_group: str + + :param is_ike_established: + The value to assign to the is_ike_established property of this TunnelPhaseOneDetails. + :type is_ike_established: bool + + :param remaining_lifetime_last_retrieved: + The value to assign to the remaining_lifetime_last_retrieved property of this TunnelPhaseOneDetails. + :type remaining_lifetime_last_retrieved: datetime + + """ + self.swagger_types = { + 'is_custom_phase_one_config': 'bool', + 'lifetime': 'int', + 'remaining_lifetime': 'int', + 'custom_authentication_algorithm': 'str', + 'negotiated_authentication_algorithm': 'str', + 'custom_encryption_algorithm': 'str', + 'negotiated_encryption_algorithm': 'str', + 'custom_dh_group': 'str', + 'negotiated_dh_group': 'str', + 'is_ike_established': 'bool', + 'remaining_lifetime_last_retrieved': 'datetime' + } + + self.attribute_map = { + 'is_custom_phase_one_config': 'isCustomPhaseOneConfig', + 'lifetime': 'lifetime', + 'remaining_lifetime': 'remainingLifetime', + 'custom_authentication_algorithm': 'customAuthenticationAlgorithm', + 'negotiated_authentication_algorithm': 'negotiatedAuthenticationAlgorithm', + 'custom_encryption_algorithm': 'customEncryptionAlgorithm', + 'negotiated_encryption_algorithm': 'negotiatedEncryptionAlgorithm', + 'custom_dh_group': 'customDhGroup', + 'negotiated_dh_group': 'negotiatedDhGroup', + 'is_ike_established': 'isIkeEstablished', + 'remaining_lifetime_last_retrieved': 'remainingLifetimeLastRetrieved' + } + + self._is_custom_phase_one_config = None + self._lifetime = None + self._remaining_lifetime = None + self._custom_authentication_algorithm = None + self._negotiated_authentication_algorithm = None + self._custom_encryption_algorithm = None + self._negotiated_encryption_algorithm = None + self._custom_dh_group = None + self._negotiated_dh_group = None + self._is_ike_established = None + self._remaining_lifetime_last_retrieved = None + + @property + def is_custom_phase_one_config(self): + """ + Gets the is_custom_phase_one_config of this TunnelPhaseOneDetails. + Indicates whether custom phase one configuration is enabled. + + + :return: The is_custom_phase_one_config of this TunnelPhaseOneDetails. + :rtype: bool + """ + return self._is_custom_phase_one_config + + @is_custom_phase_one_config.setter + def is_custom_phase_one_config(self, is_custom_phase_one_config): + """ + Sets the is_custom_phase_one_config of this TunnelPhaseOneDetails. + Indicates whether custom phase one configuration is enabled. + + + :param is_custom_phase_one_config: The is_custom_phase_one_config of this TunnelPhaseOneDetails. + :type: bool + """ + self._is_custom_phase_one_config = is_custom_phase_one_config + + @property + def lifetime(self): + """ + Gets the lifetime of this TunnelPhaseOneDetails. + The total configured lifetime of an IKE security association. + + + :return: The lifetime of this TunnelPhaseOneDetails. + :rtype: int + """ + return self._lifetime + + @lifetime.setter + def lifetime(self, lifetime): + """ + Sets the lifetime of this TunnelPhaseOneDetails. + The total configured lifetime of an IKE security association. + + + :param lifetime: The lifetime of this TunnelPhaseOneDetails. + :type: int + """ + self._lifetime = lifetime + + @property + def remaining_lifetime(self): + """ + Gets the remaining_lifetime of this TunnelPhaseOneDetails. + The lifetime remaining before the key is refreshed. + + + :return: The remaining_lifetime of this TunnelPhaseOneDetails. + :rtype: int + """ + return self._remaining_lifetime + + @remaining_lifetime.setter + def remaining_lifetime(self, remaining_lifetime): + """ + Sets the remaining_lifetime of this TunnelPhaseOneDetails. + The lifetime remaining before the key is refreshed. + + + :param remaining_lifetime: The remaining_lifetime of this TunnelPhaseOneDetails. + :type: int + """ + self._remaining_lifetime = remaining_lifetime + + @property + def custom_authentication_algorithm(self): + """ + Gets the custom_authentication_algorithm of this TunnelPhaseOneDetails. + Custom authentication algorithm + + + :return: The custom_authentication_algorithm of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._custom_authentication_algorithm + + @custom_authentication_algorithm.setter + def custom_authentication_algorithm(self, custom_authentication_algorithm): + """ + Sets the custom_authentication_algorithm of this TunnelPhaseOneDetails. + Custom authentication algorithm + + + :param custom_authentication_algorithm: The custom_authentication_algorithm of this TunnelPhaseOneDetails. + :type: str + """ + self._custom_authentication_algorithm = custom_authentication_algorithm + + @property + def negotiated_authentication_algorithm(self): + """ + Gets the negotiated_authentication_algorithm of this TunnelPhaseOneDetails. + The negotiated authentication algorithm. + + + :return: The negotiated_authentication_algorithm of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._negotiated_authentication_algorithm + + @negotiated_authentication_algorithm.setter + def negotiated_authentication_algorithm(self, negotiated_authentication_algorithm): + """ + Sets the negotiated_authentication_algorithm of this TunnelPhaseOneDetails. + The negotiated authentication algorithm. + + + :param negotiated_authentication_algorithm: The negotiated_authentication_algorithm of this TunnelPhaseOneDetails. + :type: str + """ + self._negotiated_authentication_algorithm = negotiated_authentication_algorithm + + @property + def custom_encryption_algorithm(self): + """ + Gets the custom_encryption_algorithm of this TunnelPhaseOneDetails. + Custom encryption algorithm. + + + :return: The custom_encryption_algorithm of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._custom_encryption_algorithm + + @custom_encryption_algorithm.setter + def custom_encryption_algorithm(self, custom_encryption_algorithm): + """ + Sets the custom_encryption_algorithm of this TunnelPhaseOneDetails. + Custom encryption algorithm. + + + :param custom_encryption_algorithm: The custom_encryption_algorithm of this TunnelPhaseOneDetails. + :type: str + """ + self._custom_encryption_algorithm = custom_encryption_algorithm + + @property + def negotiated_encryption_algorithm(self): + """ + Gets the negotiated_encryption_algorithm of this TunnelPhaseOneDetails. + The negotiated encryption algorithm. + + + :return: The negotiated_encryption_algorithm of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._negotiated_encryption_algorithm + + @negotiated_encryption_algorithm.setter + def negotiated_encryption_algorithm(self, negotiated_encryption_algorithm): + """ + Sets the negotiated_encryption_algorithm of this TunnelPhaseOneDetails. + The negotiated encryption algorithm. + + + :param negotiated_encryption_algorithm: The negotiated_encryption_algorithm of this TunnelPhaseOneDetails. + :type: str + """ + self._negotiated_encryption_algorithm = negotiated_encryption_algorithm + + @property + def custom_dh_group(self): + """ + Gets the custom_dh_group of this TunnelPhaseOneDetails. + Custom Diffie-Hellman group. + + + :return: The custom_dh_group of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._custom_dh_group + + @custom_dh_group.setter + def custom_dh_group(self, custom_dh_group): + """ + Sets the custom_dh_group of this TunnelPhaseOneDetails. + Custom Diffie-Hellman group. + + + :param custom_dh_group: The custom_dh_group of this TunnelPhaseOneDetails. + :type: str + """ + self._custom_dh_group = custom_dh_group + + @property + def negotiated_dh_group(self): + """ + Gets the negotiated_dh_group of this TunnelPhaseOneDetails. + The negotiated Diffie-Hellman group. + + + :return: The negotiated_dh_group of this TunnelPhaseOneDetails. + :rtype: str + """ + return self._negotiated_dh_group + + @negotiated_dh_group.setter + def negotiated_dh_group(self, negotiated_dh_group): + """ + Sets the negotiated_dh_group of this TunnelPhaseOneDetails. + The negotiated Diffie-Hellman group. + + + :param negotiated_dh_group: The negotiated_dh_group of this TunnelPhaseOneDetails. + :type: str + """ + self._negotiated_dh_group = negotiated_dh_group + + @property + def is_ike_established(self): + """ + Gets the is_ike_established of this TunnelPhaseOneDetails. + Indicates whether IKE Phase 1 is established. + + + :return: The is_ike_established of this TunnelPhaseOneDetails. + :rtype: bool + """ + return self._is_ike_established + + @is_ike_established.setter + def is_ike_established(self, is_ike_established): + """ + Sets the is_ike_established of this TunnelPhaseOneDetails. + Indicates whether IKE Phase 1 is established. + + + :param is_ike_established: The is_ike_established of this TunnelPhaseOneDetails. + :type: bool + """ + self._is_ike_established = is_ike_established + + @property + def remaining_lifetime_last_retrieved(self): + """ + Gets the remaining_lifetime_last_retrieved of this TunnelPhaseOneDetails. + The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The remaining_lifetime_last_retrieved of this TunnelPhaseOneDetails. + :rtype: datetime + """ + return self._remaining_lifetime_last_retrieved + + @remaining_lifetime_last_retrieved.setter + def remaining_lifetime_last_retrieved(self, remaining_lifetime_last_retrieved): + """ + Sets the remaining_lifetime_last_retrieved of this TunnelPhaseOneDetails. + The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param remaining_lifetime_last_retrieved: The remaining_lifetime_last_retrieved of this TunnelPhaseOneDetails. + :type: datetime + """ + self._remaining_lifetime_last_retrieved = remaining_lifetime_last_retrieved + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/tunnel_phase_two_details.py b/src/oci/core/models/tunnel_phase_two_details.py new file mode 100644 index 0000000000..c660ecf1ef --- /dev/null +++ b/src/oci/core/models/tunnel_phase_two_details.py @@ -0,0 +1,419 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 TunnelPhaseTwoDetails(object): + """ + Tunnel detail information specific to IPSec phase 2. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TunnelPhaseTwoDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_custom_phase_two_config: + The value to assign to the is_custom_phase_two_config property of this TunnelPhaseTwoDetails. + :type is_custom_phase_two_config: bool + + :param lifetime: + The value to assign to the lifetime property of this TunnelPhaseTwoDetails. + :type lifetime: int + + :param remaining_lifetime: + The value to assign to the remaining_lifetime property of this TunnelPhaseTwoDetails. + :type remaining_lifetime: int + + :param custom_authentication_algorithm: + The value to assign to the custom_authentication_algorithm property of this TunnelPhaseTwoDetails. + :type custom_authentication_algorithm: str + + :param negotiated_authentication_algorithm: + The value to assign to the negotiated_authentication_algorithm property of this TunnelPhaseTwoDetails. + :type negotiated_authentication_algorithm: str + + :param custom_encryption_algorithm: + The value to assign to the custom_encryption_algorithm property of this TunnelPhaseTwoDetails. + :type custom_encryption_algorithm: str + + :param negotiated_encryption_algorithm: + The value to assign to the negotiated_encryption_algorithm property of this TunnelPhaseTwoDetails. + :type negotiated_encryption_algorithm: str + + :param dh_group: + The value to assign to the dh_group property of this TunnelPhaseTwoDetails. + :type dh_group: str + + :param negotiated_dh_group: + The value to assign to the negotiated_dh_group property of this TunnelPhaseTwoDetails. + :type negotiated_dh_group: str + + :param is_esp_established: + The value to assign to the is_esp_established property of this TunnelPhaseTwoDetails. + :type is_esp_established: bool + + :param is_pfs_enabled: + The value to assign to the is_pfs_enabled property of this TunnelPhaseTwoDetails. + :type is_pfs_enabled: bool + + :param remaining_lifetime_last_retrieved: + The value to assign to the remaining_lifetime_last_retrieved property of this TunnelPhaseTwoDetails. + :type remaining_lifetime_last_retrieved: datetime + + """ + self.swagger_types = { + 'is_custom_phase_two_config': 'bool', + 'lifetime': 'int', + 'remaining_lifetime': 'int', + 'custom_authentication_algorithm': 'str', + 'negotiated_authentication_algorithm': 'str', + 'custom_encryption_algorithm': 'str', + 'negotiated_encryption_algorithm': 'str', + 'dh_group': 'str', + 'negotiated_dh_group': 'str', + 'is_esp_established': 'bool', + 'is_pfs_enabled': 'bool', + 'remaining_lifetime_last_retrieved': 'datetime' + } + + self.attribute_map = { + 'is_custom_phase_two_config': 'isCustomPhaseTwoConfig', + 'lifetime': 'lifetime', + 'remaining_lifetime': 'remainingLifetime', + 'custom_authentication_algorithm': 'customAuthenticationAlgorithm', + 'negotiated_authentication_algorithm': 'negotiatedAuthenticationAlgorithm', + 'custom_encryption_algorithm': 'customEncryptionAlgorithm', + 'negotiated_encryption_algorithm': 'negotiatedEncryptionAlgorithm', + 'dh_group': 'dhGroup', + 'negotiated_dh_group': 'negotiatedDhGroup', + 'is_esp_established': 'isEspEstablished', + 'is_pfs_enabled': 'isPfsEnabled', + 'remaining_lifetime_last_retrieved': 'remainingLifetimeLastRetrieved' + } + + self._is_custom_phase_two_config = None + self._lifetime = None + self._remaining_lifetime = None + self._custom_authentication_algorithm = None + self._negotiated_authentication_algorithm = None + self._custom_encryption_algorithm = None + self._negotiated_encryption_algorithm = None + self._dh_group = None + self._negotiated_dh_group = None + self._is_esp_established = None + self._is_pfs_enabled = None + self._remaining_lifetime_last_retrieved = None + + @property + def is_custom_phase_two_config(self): + """ + Gets the is_custom_phase_two_config of this TunnelPhaseTwoDetails. + Indicates whether custom phase two configuration is enabled. + + + :return: The is_custom_phase_two_config of this TunnelPhaseTwoDetails. + :rtype: bool + """ + return self._is_custom_phase_two_config + + @is_custom_phase_two_config.setter + def is_custom_phase_two_config(self, is_custom_phase_two_config): + """ + Sets the is_custom_phase_two_config of this TunnelPhaseTwoDetails. + Indicates whether custom phase two configuration is enabled. + + + :param is_custom_phase_two_config: The is_custom_phase_two_config of this TunnelPhaseTwoDetails. + :type: bool + """ + self._is_custom_phase_two_config = is_custom_phase_two_config + + @property + def lifetime(self): + """ + Gets the lifetime of this TunnelPhaseTwoDetails. + The total configured lifetime of an IKE security association. + + + :return: The lifetime of this TunnelPhaseTwoDetails. + :rtype: int + """ + return self._lifetime + + @lifetime.setter + def lifetime(self, lifetime): + """ + Sets the lifetime of this TunnelPhaseTwoDetails. + The total configured lifetime of an IKE security association. + + + :param lifetime: The lifetime of this TunnelPhaseTwoDetails. + :type: int + """ + self._lifetime = lifetime + + @property + def remaining_lifetime(self): + """ + Gets the remaining_lifetime of this TunnelPhaseTwoDetails. + The lifetime remaining before the key is refreshed. + + + :return: The remaining_lifetime of this TunnelPhaseTwoDetails. + :rtype: int + """ + return self._remaining_lifetime + + @remaining_lifetime.setter + def remaining_lifetime(self, remaining_lifetime): + """ + Sets the remaining_lifetime of this TunnelPhaseTwoDetails. + The lifetime remaining before the key is refreshed. + + + :param remaining_lifetime: The remaining_lifetime of this TunnelPhaseTwoDetails. + :type: int + """ + self._remaining_lifetime = remaining_lifetime + + @property + def custom_authentication_algorithm(self): + """ + Gets the custom_authentication_algorithm of this TunnelPhaseTwoDetails. + Phase Two authentication algorithm supported during tunnel negotiation. + + + :return: The custom_authentication_algorithm of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._custom_authentication_algorithm + + @custom_authentication_algorithm.setter + def custom_authentication_algorithm(self, custom_authentication_algorithm): + """ + Sets the custom_authentication_algorithm of this TunnelPhaseTwoDetails. + Phase Two authentication algorithm supported during tunnel negotiation. + + + :param custom_authentication_algorithm: The custom_authentication_algorithm of this TunnelPhaseTwoDetails. + :type: str + """ + self._custom_authentication_algorithm = custom_authentication_algorithm + + @property + def negotiated_authentication_algorithm(self): + """ + Gets the negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. + The negotiated authentication algorithm. + + + :return: The negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._negotiated_authentication_algorithm + + @negotiated_authentication_algorithm.setter + def negotiated_authentication_algorithm(self, negotiated_authentication_algorithm): + """ + Sets the negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. + The negotiated authentication algorithm. + + + :param negotiated_authentication_algorithm: The negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. + :type: str + """ + self._negotiated_authentication_algorithm = negotiated_authentication_algorithm + + @property + def custom_encryption_algorithm(self): + """ + Gets the custom_encryption_algorithm of this TunnelPhaseTwoDetails. + Custom Encryption Algorithm + + + :return: The custom_encryption_algorithm of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._custom_encryption_algorithm + + @custom_encryption_algorithm.setter + def custom_encryption_algorithm(self, custom_encryption_algorithm): + """ + Sets the custom_encryption_algorithm of this TunnelPhaseTwoDetails. + Custom Encryption Algorithm + + + :param custom_encryption_algorithm: The custom_encryption_algorithm of this TunnelPhaseTwoDetails. + :type: str + """ + self._custom_encryption_algorithm = custom_encryption_algorithm + + @property + def negotiated_encryption_algorithm(self): + """ + Gets the negotiated_encryption_algorithm of this TunnelPhaseTwoDetails. + The negotiated encryption algorithm. + + + :return: The negotiated_encryption_algorithm of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._negotiated_encryption_algorithm + + @negotiated_encryption_algorithm.setter + def negotiated_encryption_algorithm(self, negotiated_encryption_algorithm): + """ + Sets the negotiated_encryption_algorithm of this TunnelPhaseTwoDetails. + The negotiated encryption algorithm. + + + :param negotiated_encryption_algorithm: The negotiated_encryption_algorithm of this TunnelPhaseTwoDetails. + :type: str + """ + self._negotiated_encryption_algorithm = negotiated_encryption_algorithm + + @property + def dh_group(self): + """ + Gets the dh_group of this TunnelPhaseTwoDetails. + Proposed Diffie-Hellman group. + + + :return: The dh_group of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._dh_group + + @dh_group.setter + def dh_group(self, dh_group): + """ + Sets the dh_group of this TunnelPhaseTwoDetails. + Proposed Diffie-Hellman group. + + + :param dh_group: The dh_group of this TunnelPhaseTwoDetails. + :type: str + """ + self._dh_group = dh_group + + @property + def negotiated_dh_group(self): + """ + Gets the negotiated_dh_group of this TunnelPhaseTwoDetails. + The negotiated Diffie-Hellman group. + + + :return: The negotiated_dh_group of this TunnelPhaseTwoDetails. + :rtype: str + """ + return self._negotiated_dh_group + + @negotiated_dh_group.setter + def negotiated_dh_group(self, negotiated_dh_group): + """ + Sets the negotiated_dh_group of this TunnelPhaseTwoDetails. + The negotiated Diffie-Hellman group. + + + :param negotiated_dh_group: The negotiated_dh_group of this TunnelPhaseTwoDetails. + :type: str + """ + self._negotiated_dh_group = negotiated_dh_group + + @property + def is_esp_established(self): + """ + Gets the is_esp_established of this TunnelPhaseTwoDetails. + ESP Phase 2 established + + + :return: The is_esp_established of this TunnelPhaseTwoDetails. + :rtype: bool + """ + return self._is_esp_established + + @is_esp_established.setter + def is_esp_established(self, is_esp_established): + """ + Sets the is_esp_established of this TunnelPhaseTwoDetails. + ESP Phase 2 established + + + :param is_esp_established: The is_esp_established of this TunnelPhaseTwoDetails. + :type: bool + """ + self._is_esp_established = is_esp_established + + @property + def is_pfs_enabled(self): + """ + Gets the is_pfs_enabled of this TunnelPhaseTwoDetails. + Is PFS (perfect forward secrecy) enabled + + + :return: The is_pfs_enabled of this TunnelPhaseTwoDetails. + :rtype: bool + """ + return self._is_pfs_enabled + + @is_pfs_enabled.setter + def is_pfs_enabled(self, is_pfs_enabled): + """ + Sets the is_pfs_enabled of this TunnelPhaseTwoDetails. + Is PFS (perfect forward secrecy) enabled + + + :param is_pfs_enabled: The is_pfs_enabled of this TunnelPhaseTwoDetails. + :type: bool + """ + self._is_pfs_enabled = is_pfs_enabled + + @property + def remaining_lifetime_last_retrieved(self): + """ + Gets the remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. + The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. + :rtype: datetime + """ + return self._remaining_lifetime_last_retrieved + + @remaining_lifetime_last_retrieved.setter + def remaining_lifetime_last_retrieved(self, remaining_lifetime_last_retrieved): + """ + Sets the remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. + The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + + Example: `2016-08-25T21:10:29.600Z` + + __ https://tools.ietf.org/html/rfc3339 + + + :param remaining_lifetime_last_retrieved: The remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. + :type: datetime + """ + self._remaining_lifetime_last_retrieved = remaining_lifetime_last_retrieved + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/tunnel_route_summary.py b/src/oci/core/models/tunnel_route_summary.py new file mode 100644 index 0000000000..6d921aa988 --- /dev/null +++ b/src/oci/core/models/tunnel_route_summary.py @@ -0,0 +1,210 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 TunnelRouteSummary(object): + """ + The routes advertised to the Customer and the routes received from the Customer + """ + + #: A constant which can be used with the advertiser property of a TunnelRouteSummary. + #: This constant has a value of "CUSTOMER" + ADVERTISER_CUSTOMER = "CUSTOMER" + + #: A constant which can be used with the advertiser property of a TunnelRouteSummary. + #: This constant has a value of "ORACLE" + ADVERTISER_ORACLE = "ORACLE" + + def __init__(self, **kwargs): + """ + Initializes a new TunnelRouteSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param prefix: + The value to assign to the prefix property of this TunnelRouteSummary. + :type prefix: str + + :param age: + The value to assign to the age property of this TunnelRouteSummary. + :type age: int + + :param is_best_path: + The value to assign to the is_best_path property of this TunnelRouteSummary. + :type is_best_path: bool + + :param as_path: + The value to assign to the as_path property of this TunnelRouteSummary. + :type as_path: list[int] + + :param advertiser: + The value to assign to the advertiser property of this TunnelRouteSummary. + Allowed values for this property are: "CUSTOMER", "ORACLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type advertiser: str + + """ + self.swagger_types = { + 'prefix': 'str', + 'age': 'int', + 'is_best_path': 'bool', + 'as_path': 'list[int]', + 'advertiser': 'str' + } + + self.attribute_map = { + 'prefix': 'prefix', + 'age': 'age', + 'is_best_path': 'isBestPath', + 'as_path': 'asPath', + 'advertiser': 'advertiser' + } + + self._prefix = None + self._age = None + self._is_best_path = None + self._as_path = None + self._advertiser = None + + @property + def prefix(self): + """ + Gets the prefix of this TunnelRouteSummary. + BGP Network Layer Reachability Information + + + :return: The prefix of this TunnelRouteSummary. + :rtype: str + """ + return self._prefix + + @prefix.setter + def prefix(self, prefix): + """ + Sets the prefix of this TunnelRouteSummary. + BGP Network Layer Reachability Information + + + :param prefix: The prefix of this TunnelRouteSummary. + :type: str + """ + self._prefix = prefix + + @property + def age(self): + """ + Gets the age of this TunnelRouteSummary. + The age of the route + + + :return: The age of this TunnelRouteSummary. + :rtype: int + """ + return self._age + + @age.setter + def age(self, age): + """ + Sets the age of this TunnelRouteSummary. + The age of the route + + + :param age: The age of this TunnelRouteSummary. + :type: int + """ + self._age = age + + @property + def is_best_path(self): + """ + Gets the is_best_path of this TunnelRouteSummary. + Is this the best route + + + :return: The is_best_path of this TunnelRouteSummary. + :rtype: bool + """ + return self._is_best_path + + @is_best_path.setter + def is_best_path(self, is_best_path): + """ + Sets the is_best_path of this TunnelRouteSummary. + Is this the best route + + + :param is_best_path: The is_best_path of this TunnelRouteSummary. + :type: bool + """ + self._is_best_path = is_best_path + + @property + def as_path(self): + """ + Gets the as_path of this TunnelRouteSummary. + List of ASNs in AS Path + + + :return: The as_path of this TunnelRouteSummary. + :rtype: list[int] + """ + return self._as_path + + @as_path.setter + def as_path(self, as_path): + """ + Sets the as_path of this TunnelRouteSummary. + List of ASNs in AS Path + + + :param as_path: The as_path of this TunnelRouteSummary. + :type: list[int] + """ + self._as_path = as_path + + @property + def advertiser(self): + """ + Gets the advertiser of this TunnelRouteSummary. + Route advertiser + + Allowed values for this property are: "CUSTOMER", "ORACLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The advertiser of this TunnelRouteSummary. + :rtype: str + """ + return self._advertiser + + @advertiser.setter + def advertiser(self, advertiser): + """ + Sets the advertiser of this TunnelRouteSummary. + Route advertiser + + + :param advertiser: The advertiser of this TunnelRouteSummary. + :type: str + """ + allowed_values = ["CUSTOMER", "ORACLE"] + if not value_allowed_none_or_none_sentinel(advertiser, allowed_values): + advertiser = 'UNKNOWN_ENUM_VALUE' + self._advertiser = advertiser + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/tunnel_security_association_summary.py b/src/oci/core/models/tunnel_security_association_summary.py new file mode 100644 index 0000000000..16247fd1f7 --- /dev/null +++ b/src/oci/core/models/tunnel_security_association_summary.py @@ -0,0 +1,226 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 TunnelSecurityAssociationSummary(object): + """ + Detailed Tunnel SA + """ + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "INITIATING" + TUNNEL_SA_STATUS_INITIATING = "INITIATING" + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "LISTENING" + TUNNEL_SA_STATUS_LISTENING = "LISTENING" + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "UP" + TUNNEL_SA_STATUS_UP = "UP" + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "DOWN" + TUNNEL_SA_STATUS_DOWN = "DOWN" + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "ERROR" + TUNNEL_SA_STATUS_ERROR = "ERROR" + + #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. + #: This constant has a value of "UNKNOWN" + TUNNEL_SA_STATUS_UNKNOWN = "UNKNOWN" + + def __init__(self, **kwargs): + """ + Initializes a new TunnelSecurityAssociationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cpe_subnet: + The value to assign to the cpe_subnet property of this TunnelSecurityAssociationSummary. + :type cpe_subnet: str + + :param oracle_subnet: + The value to assign to the oracle_subnet property of this TunnelSecurityAssociationSummary. + :type oracle_subnet: str + + :param tunnel_sa_status: + The value to assign to the tunnel_sa_status property of this TunnelSecurityAssociationSummary. + Allowed values for this property are: "INITIATING", "LISTENING", "UP", "DOWN", "ERROR", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type tunnel_sa_status: str + + :param tunnel_sa_error_info: + The value to assign to the tunnel_sa_error_info property of this TunnelSecurityAssociationSummary. + :type tunnel_sa_error_info: str + + :param time: + The value to assign to the time property of this TunnelSecurityAssociationSummary. + :type time: str + + """ + self.swagger_types = { + 'cpe_subnet': 'str', + 'oracle_subnet': 'str', + 'tunnel_sa_status': 'str', + 'tunnel_sa_error_info': 'str', + 'time': 'str' + } + + self.attribute_map = { + 'cpe_subnet': 'cpeSubnet', + 'oracle_subnet': 'oracleSubnet', + 'tunnel_sa_status': 'tunnelSaStatus', + 'tunnel_sa_error_info': 'tunnelSaErrorInfo', + 'time': 'time' + } + + self._cpe_subnet = None + self._oracle_subnet = None + self._tunnel_sa_status = None + self._tunnel_sa_error_info = None + self._time = None + + @property + def cpe_subnet(self): + """ + Gets the cpe_subnet of this TunnelSecurityAssociationSummary. + IP and mask of the Partner Subnet for Policy Based VPNs or Static Routes + + + :return: The cpe_subnet of this TunnelSecurityAssociationSummary. + :rtype: str + """ + return self._cpe_subnet + + @cpe_subnet.setter + def cpe_subnet(self, cpe_subnet): + """ + Sets the cpe_subnet of this TunnelSecurityAssociationSummary. + IP and mask of the Partner Subnet for Policy Based VPNs or Static Routes + + + :param cpe_subnet: The cpe_subnet of this TunnelSecurityAssociationSummary. + :type: str + """ + self._cpe_subnet = cpe_subnet + + @property + def oracle_subnet(self): + """ + Gets the oracle_subnet of this TunnelSecurityAssociationSummary. + IP and mask of the Local Subnet for Policy Based VPNs or Static Routes + + + :return: The oracle_subnet of this TunnelSecurityAssociationSummary. + :rtype: str + """ + return self._oracle_subnet + + @oracle_subnet.setter + def oracle_subnet(self, oracle_subnet): + """ + Sets the oracle_subnet of this TunnelSecurityAssociationSummary. + IP and mask of the Local Subnet for Policy Based VPNs or Static Routes + + + :param oracle_subnet: The oracle_subnet of this TunnelSecurityAssociationSummary. + :type: str + """ + self._oracle_subnet = oracle_subnet + + @property + def tunnel_sa_status(self): + """ + Gets the tunnel_sa_status of this TunnelSecurityAssociationSummary. + Phase 1 Status of the Tunnel + + Allowed values for this property are: "INITIATING", "LISTENING", "UP", "DOWN", "ERROR", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The tunnel_sa_status of this TunnelSecurityAssociationSummary. + :rtype: str + """ + return self._tunnel_sa_status + + @tunnel_sa_status.setter + def tunnel_sa_status(self, tunnel_sa_status): + """ + Sets the tunnel_sa_status of this TunnelSecurityAssociationSummary. + Phase 1 Status of the Tunnel + + + :param tunnel_sa_status: The tunnel_sa_status of this TunnelSecurityAssociationSummary. + :type: str + """ + allowed_values = ["INITIATING", "LISTENING", "UP", "DOWN", "ERROR", "UNKNOWN"] + if not value_allowed_none_or_none_sentinel(tunnel_sa_status, allowed_values): + tunnel_sa_status = 'UNKNOWN_ENUM_VALUE' + self._tunnel_sa_status = tunnel_sa_status + + @property + def tunnel_sa_error_info(self): + """ + Gets the tunnel_sa_error_info of this TunnelSecurityAssociationSummary. + Current state if status is not up, including phase1/phase2 and possible reason for tunnel not up + + + :return: The tunnel_sa_error_info of this TunnelSecurityAssociationSummary. + :rtype: str + """ + return self._tunnel_sa_error_info + + @tunnel_sa_error_info.setter + def tunnel_sa_error_info(self, tunnel_sa_error_info): + """ + Sets the tunnel_sa_error_info of this TunnelSecurityAssociationSummary. + Current state if status is not up, including phase1/phase2 and possible reason for tunnel not up + + + :param tunnel_sa_error_info: The tunnel_sa_error_info of this TunnelSecurityAssociationSummary. + :type: str + """ + self._tunnel_sa_error_info = tunnel_sa_error_info + + @property + def time(self): + """ + Gets the time of this TunnelSecurityAssociationSummary. + Seconds in current state + + + :return: The time of this TunnelSecurityAssociationSummary. + :rtype: str + """ + return self._time + + @time.setter + def time(self, time): + """ + Sets the time of this TunnelSecurityAssociationSummary. + Seconds in current state + + + :param time: The time of this TunnelSecurityAssociationSummary. + :type: str + """ + self._time = time + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py index 58b6598db4..35df5c0528 100644 --- a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py @@ -33,6 +33,26 @@ class UpdateIPSecConnectionTunnelDetails(object): #: This constant has a value of "V2" IKE_VERSION_V2 = "V2" + #: A constant which can be used with the oracle_initiation property of a UpdateIPSecConnectionTunnelDetails. + #: This constant has a value of "INITIATOR_OR_RESPONDER" + ORACLE_INITIATION_INITIATOR_OR_RESPONDER = "INITIATOR_OR_RESPONDER" + + #: A constant which can be used with the oracle_initiation property of a UpdateIPSecConnectionTunnelDetails. + #: This constant has a value of "RESPONDER_ONLY" + ORACLE_INITIATION_RESPONDER_ONLY = "RESPONDER_ONLY" + + #: A constant which can be used with the nat_translation_enabled property of a UpdateIPSecConnectionTunnelDetails. + #: This constant has a value of "ENABLED" + NAT_TRANSLATION_ENABLED_ENABLED = "ENABLED" + + #: A constant which can be used with the nat_translation_enabled property of a UpdateIPSecConnectionTunnelDetails. + #: This constant has a value of "DISABLED" + NAT_TRANSLATION_ENABLED_DISABLED = "DISABLED" + + #: A constant which can be used with the nat_translation_enabled property of a UpdateIPSecConnectionTunnelDetails. + #: This constant has a value of "AUTO" + NAT_TRANSLATION_ENABLED_AUTO = "AUTO" + def __init__(self, **kwargs): """ Initializes a new UpdateIPSecConnectionTunnelDetails object with values from keyword arguments. @@ -56,6 +76,28 @@ def __init__(self, **kwargs): The value to assign to the bgp_session_config property of this UpdateIPSecConnectionTunnelDetails. :type bgp_session_config: oci.core.models.UpdateIPSecTunnelBgpSessionDetails + :param oracle_initiation: + The value to assign to the oracle_initiation property of this UpdateIPSecConnectionTunnelDetails. + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" + :type oracle_initiation: str + + :param nat_translation_enabled: + The value to assign to the nat_translation_enabled property of this UpdateIPSecConnectionTunnelDetails. + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" + :type nat_translation_enabled: str + + :param phase_one_config: + The value to assign to the phase_one_config property of this UpdateIPSecConnectionTunnelDetails. + :type phase_one_config: oci.core.models.PhaseOneConfigDetails + + :param phase_two_config: + The value to assign to the phase_two_config property of this UpdateIPSecConnectionTunnelDetails. + :type phase_two_config: oci.core.models.PhaseTwoConfigDetails + + :param dpd_config: + The value to assign to the dpd_config property of this UpdateIPSecConnectionTunnelDetails. + :type dpd_config: oci.core.models.DpdConfig + :param encryption_domain_config: The value to assign to the encryption_domain_config property of this UpdateIPSecConnectionTunnelDetails. :type encryption_domain_config: oci.core.models.UpdateIPSecTunnelEncryptionDomainDetails @@ -66,6 +108,11 @@ def __init__(self, **kwargs): 'routing': 'str', 'ike_version': 'str', 'bgp_session_config': 'UpdateIPSecTunnelBgpSessionDetails', + 'oracle_initiation': 'str', + 'nat_translation_enabled': 'str', + 'phase_one_config': 'PhaseOneConfigDetails', + 'phase_two_config': 'PhaseTwoConfigDetails', + 'dpd_config': 'DpdConfig', 'encryption_domain_config': 'UpdateIPSecTunnelEncryptionDomainDetails' } @@ -74,6 +121,11 @@ def __init__(self, **kwargs): 'routing': 'routing', 'ike_version': 'ikeVersion', 'bgp_session_config': 'bgpSessionConfig', + 'oracle_initiation': 'oracleInitiation', + 'nat_translation_enabled': 'natTranslationEnabled', + 'phase_one_config': 'phaseOneConfig', + 'phase_two_config': 'phaseTwoConfig', + 'dpd_config': 'dpdConfig', 'encryption_domain_config': 'encryptionDomainConfig' } @@ -81,6 +133,11 @@ def __init__(self, **kwargs): self._routing = None self._ike_version = None self._bgp_session_config = None + self._oracle_initiation = None + self._nat_translation_enabled = None + self._phase_one_config = None + self._phase_two_config = None + self._dpd_config = None self._encryption_domain_config = None @property @@ -193,6 +250,130 @@ def bgp_session_config(self, bgp_session_config): """ self._bgp_session_config = bgp_session_config + @property + def oracle_initiation(self): + """ + Gets the oracle_initiation of this UpdateIPSecConnectionTunnelDetails. + Whether Oracle side is the initiator for negotiation. + + Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" + + + :return: The oracle_initiation of this UpdateIPSecConnectionTunnelDetails. + :rtype: str + """ + return self._oracle_initiation + + @oracle_initiation.setter + def oracle_initiation(self, oracle_initiation): + """ + Sets the oracle_initiation of this UpdateIPSecConnectionTunnelDetails. + Whether Oracle side is the initiator for negotiation. + + + :param oracle_initiation: The oracle_initiation of this UpdateIPSecConnectionTunnelDetails. + :type: str + """ + allowed_values = ["INITIATOR_OR_RESPONDER", "RESPONDER_ONLY"] + if not value_allowed_none_or_none_sentinel(oracle_initiation, allowed_values): + raise ValueError( + "Invalid value for `oracle_initiation`, must be None or one of {0}" + .format(allowed_values) + ) + self._oracle_initiation = oracle_initiation + + @property + def nat_translation_enabled(self): + """ + Gets the nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. + Whether NAT-T Enabled on the tunnel + + Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" + + + :return: The nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. + :rtype: str + """ + return self._nat_translation_enabled + + @nat_translation_enabled.setter + def nat_translation_enabled(self, nat_translation_enabled): + """ + Sets the nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. + Whether NAT-T Enabled on the tunnel + + + :param nat_translation_enabled: The nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED", "AUTO"] + if not value_allowed_none_or_none_sentinel(nat_translation_enabled, allowed_values): + raise ValueError( + "Invalid value for `nat_translation_enabled`, must be None or one of {0}" + .format(allowed_values) + ) + self._nat_translation_enabled = nat_translation_enabled + + @property + def phase_one_config(self): + """ + Gets the phase_one_config of this UpdateIPSecConnectionTunnelDetails. + + :return: The phase_one_config of this UpdateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.PhaseOneConfigDetails + """ + return self._phase_one_config + + @phase_one_config.setter + def phase_one_config(self, phase_one_config): + """ + Sets the phase_one_config of this UpdateIPSecConnectionTunnelDetails. + + :param phase_one_config: The phase_one_config of this UpdateIPSecConnectionTunnelDetails. + :type: oci.core.models.PhaseOneConfigDetails + """ + self._phase_one_config = phase_one_config + + @property + def phase_two_config(self): + """ + Gets the phase_two_config of this UpdateIPSecConnectionTunnelDetails. + + :return: The phase_two_config of this UpdateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.PhaseTwoConfigDetails + """ + return self._phase_two_config + + @phase_two_config.setter + def phase_two_config(self, phase_two_config): + """ + Sets the phase_two_config of this UpdateIPSecConnectionTunnelDetails. + + :param phase_two_config: The phase_two_config of this UpdateIPSecConnectionTunnelDetails. + :type: oci.core.models.PhaseTwoConfigDetails + """ + self._phase_two_config = phase_two_config + + @property + def dpd_config(self): + """ + Gets the dpd_config of this UpdateIPSecConnectionTunnelDetails. + + :return: The dpd_config of this UpdateIPSecConnectionTunnelDetails. + :rtype: oci.core.models.DpdConfig + """ + return self._dpd_config + + @dpd_config.setter + def dpd_config(self, dpd_config): + """ + Sets the dpd_config of this UpdateIPSecConnectionTunnelDetails. + + :param dpd_config: The dpd_config of this UpdateIPSecConnectionTunnelDetails. + :type: oci.core.models.DpdConfig + """ + self._dpd_config = dpd_config + @property def encryption_domain_config(self): """ diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index 7462c52d82..e7bb2e3896 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -8005,6 +8005,71 @@ def get_all_drg_attachments(self, drg_id, **kwargs): header_params=header_params, response_type="list[DrgAttachmentInfo]") + def get_allowed_ike_ip_sec_parameters(self, **kwargs): + """ + The allowed parameters for IKE IPSec + + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.AllowedIkeIPSecParameters` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_allowed_ike_ip_sec_parameters API. + """ + resource_path = "/ipsecAlgorithms" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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_allowed_ike_ip_sec_parameters 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) + } + 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, + header_params=header_params, + response_type="AllowedIkeIPSecParameters") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + response_type="AllowedIkeIPSecParameters") + def get_byoip_range(self, byoip_range_id, **kwargs): """ Gets the `ByoipRange` resource. You must specify the `OCID`__. @@ -9612,6 +9677,84 @@ def get_ip_sec_connection_tunnel(self, ipsc_id, tunnel_id, **kwargs): header_params=header_params, response_type="IPSecConnectionTunnel") + def get_ip_sec_connection_tunnel_error(self, ipsc_id, tunnel_id, **kwargs): + """ + Get the identified error for the specified IPSec Tunnel ID. + + + :param str ipsc_id: (required) + The `OCID`__ of the IPSec connection. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str tunnel_id: (required) + The `OCID`__ of the tunnel. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.core.models.IPSecConnectionTunnelErrorDetails` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_ip_sec_connection_tunnel_error API. + """ + resource_path = "/ipsecConnections/{ipscId}/tunnels/{tunnelId}/error" + method = "GET" + + expected_kwargs = ["retry_strategy"] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_ip_sec_connection_tunnel_error got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "ipscId": ipsc_id, + "tunnelId": tunnel_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" + } + + 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="IPSecConnectionTunnelErrorDetails") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="IPSecConnectionTunnelErrorDetails") + def get_ip_sec_connection_tunnel_shared_secret(self, ipsc_id, tunnel_id, **kwargs): """ Gets the specified tunnel's shared secret (pre-shared key). To get other information @@ -14379,6 +14522,236 @@ def list_internet_gateways(self, compartment_id, **kwargs): header_params=header_params, response_type="list[InternetGateway]") + def list_ip_sec_connection_tunnel_routes(self, ipsc_id, tunnel_id, **kwargs): + """ + The routes advertised to the Customer and the routes received from the Customer. + + + :param str ipsc_id: (required) + The `OCID`__ of the IPSec connection. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str tunnel_id: (required) + The `OCID`__ of the tunnel. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param int limit: (optional) + For list pagination. The maximum number of results per page, or items to return in a paginated + \"List\" call. For important details about how pagination works, see + `List Pagination`__. + + Example: `50` + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value of the `opc-next-page` response header from the previous \"List\" + call. For important details about how pagination works, see + `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str advertiser: (optional) + Specifies the advertiser of the routes. If set to ORACLE, then returns only the + routes advertised by ORACLE, else if set to CUSTOMER, then returns only the + routes advertised by the CUSTOMER. + + Allowed values are: "CUSTOMER", "ORACLE" + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.TunnelRouteSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_ip_sec_connection_tunnel_routes API. + """ + resource_path = "/ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "limit", + "page", + "advertiser" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_ip_sec_connection_tunnel_routes got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "ipscId": ipsc_id, + "tunnelId": tunnel_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 'advertiser' in kwargs: + advertiser_allowed_values = ["CUSTOMER", "ORACLE"] + if kwargs['advertiser'] not in advertiser_allowed_values: + raise ValueError( + "Invalid value for `advertiser`, must be one of {0}".format(advertiser_allowed_values) + ) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "advertiser": kwargs.get("advertiser", 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" + } + + 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="list[TunnelRouteSummary]") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[TunnelRouteSummary]") + + def list_ip_sec_connection_tunnel_security_associations(self, ipsc_id, tunnel_id, **kwargs): + """ + Lists the tunnel Security Associations information for the specified IPSec Tunnel ID. + + + :param str ipsc_id: (required) + The `OCID`__ of the IPSec connection. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str tunnel_id: (required) + The `OCID`__ of the tunnel. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param int limit: (optional) + For list pagination. The maximum number of results per page, or items to return in a paginated + \"List\" call. For important details about how pagination works, see + `List Pagination`__. + + Example: `50` + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value of the `opc-next-page` response header from the previous \"List\" + call. For important details about how pagination works, see + `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.core.models.TunnelSecurityAssociationSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_ip_sec_connection_tunnel_security_associations API. + """ + resource_path = "/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "limit", + "page" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_ip_sec_connection_tunnel_security_associations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "ipscId": ipsc_id, + "tunnelId": tunnel_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 = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + 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="list[TunnelSecurityAssociationSummary]") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[TunnelSecurityAssociationSummary]") + def list_ip_sec_connection_tunnels(self, ipsc_id, **kwargs): """ Lists the tunnel information for the specified IPSec connection. diff --git a/src/oci/database/database_client.py b/src/oci/database/database_client.py index ceb06976c0..e4d108465d 100644 --- a/src/oci/database/database_client.py +++ b/src/oci/database/database_client.py @@ -6207,6 +6207,85 @@ def deregister_autonomous_database_data_safe(self, autonomous_database_id, **kwa header_params=header_params, body=kwargs.get('deregister_autonomous_database_data_safe_details')) + def disable_autonomous_database_management(self, autonomous_database_id, **kwargs): + """ + Disables Database Management for the Autonomous Database resource. + + + :param str autonomous_database_id: (required) + The database `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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`. + + :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 disable_autonomous_database_management API. + """ + resource_path = "/autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "disable_autonomous_database_management got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "autonomousDatabaseId": autonomous_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + def disable_autonomous_database_operations_insights(self, autonomous_database_id, **kwargs): """ Disables Operations Insights for the Autonomous Database resource. @@ -7157,6 +7236,85 @@ def download_vm_cluster_network_config_file(self, exadata_infrastructure_id, vm_ header_params=header_params, response_type="stream") + def enable_autonomous_database_management(self, autonomous_database_id, **kwargs): + """ + Enables Database Management for Autonomous Database. + + + :param str autonomous_database_id: (required) + The database `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + Unique identifier for the request. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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`. + + :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 enable_autonomous_database_management API. + """ + resource_path = "/autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "enable_autonomous_database_management got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "autonomousDatabaseId": autonomous_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + def enable_autonomous_database_operations_insights(self, autonomous_database_id, **kwargs): """ Enables the specified Autonomous Database with Operations Insights. diff --git a/src/oci/database/database_client_composite_operations.py b/src/oci/database/database_client_composite_operations.py index 87b81ccae3..fafdebc770 100644 --- a/src/oci/database/database_client_composite_operations.py +++ b/src/oci/database/database_client_composite_operations.py @@ -3556,6 +3556,43 @@ def deregister_autonomous_database_data_safe_and_wait_for_work_request(self, aut except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def disable_autonomous_database_management_and_wait_for_work_request(self, autonomous_database_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.database.DatabaseClient.disable_autonomous_database_management` and waits for the oci.work_requests.models.WorkRequest + to enter the given state(s). + + :param str autonomous_database_id: (required) + The database `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param list[str] work_request_states: (optional) + An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` + Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.database.DatabaseClient.disable_autonomous_database_management` + + :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.disable_autonomous_database_management(autonomous_database_id, **operation_kwargs) + work_request_states = work_request_states if work_request_states else oci.waiter._WORK_REQUEST_TERMINATION_STATES + lowered_work_request_states = [w.lower() for w in work_request_states] + work_request_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self._work_request_client, + self._work_request_client.get_work_request(work_request_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_work_request_states, + **waiter_kwargs + ) + return waiter_result + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def disable_autonomous_database_operations_insights_and_wait_for_work_request(self, autonomous_database_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.database.DatabaseClient.disable_autonomous_database_operations_insights` and waits for the oci.work_requests.models.WorkRequest @@ -3855,6 +3892,43 @@ def disable_external_pluggable_database_operations_insights_and_wait_for_work_re except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def enable_autonomous_database_management_and_wait_for_work_request(self, autonomous_database_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.database.DatabaseClient.enable_autonomous_database_management` and waits for the oci.work_requests.models.WorkRequest + to enter the given state(s). + + :param str autonomous_database_id: (required) + The database `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param list[str] work_request_states: (optional) + An array of work requests states to wait on. These should be valid values for :py:attr:`~oci.work_requests.models.WorkRequest.status` + Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.database.DatabaseClient.enable_autonomous_database_management` + + :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.enable_autonomous_database_management(autonomous_database_id, **operation_kwargs) + work_request_states = work_request_states if work_request_states else oci.waiter._WORK_REQUEST_TERMINATION_STATES + lowered_work_request_states = [w.lower() for w in work_request_states] + work_request_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self._work_request_client, + self._work_request_client.get_work_request(work_request_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_work_request_states, + **waiter_kwargs + ) + return waiter_result + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def enable_autonomous_database_operations_insights_and_wait_for_work_request(self, autonomous_database_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.database.DatabaseClient.enable_autonomous_database_operations_insights` and waits for the oci.work_requests.models.WorkRequest diff --git a/src/oci/database/models/autonomous_database.py b/src/oci/database/models/autonomous_database.py index aa659ae842..73d84f319e 100644 --- a/src/oci/database/models/autonomous_database.py +++ b/src/oci/database/models/autonomous_database.py @@ -169,6 +169,30 @@ class AutonomousDatabase(object): #: This constant has a value of "FAILED_DISABLING" OPERATIONS_INSIGHTS_STATUS_FAILED_DISABLING = "FAILED_DISABLING" + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "ENABLING" + DATABASE_MANAGEMENT_STATUS_ENABLING = "ENABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "ENABLED" + DATABASE_MANAGEMENT_STATUS_ENABLED = "ENABLED" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "DISABLING" + DATABASE_MANAGEMENT_STATUS_DISABLING = "DISABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "NOT_ENABLED" + DATABASE_MANAGEMENT_STATUS_NOT_ENABLED = "NOT_ENABLED" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "FAILED_ENABLING" + DATABASE_MANAGEMENT_STATUS_FAILED_ENABLING = "FAILED_ENABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabase. + #: This constant has a value of "FAILED_DISABLING" + DATABASE_MANAGEMENT_STATUS_FAILED_DISABLING = "FAILED_DISABLING" + #: A constant which can be used with the open_mode property of a AutonomousDatabase. #: This constant has a value of "READ_ONLY" OPEN_MODE_READ_ONLY = "READ_ONLY" @@ -430,6 +454,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operations_insights_status: str + :param database_management_status: + The value to assign to the database_management_status property of this AutonomousDatabase. + Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type database_management_status: str + :param time_maintenance_begin: The value to assign to the time_maintenance_begin property of this AutonomousDatabase. :type time_maintenance_begin: datetime @@ -604,6 +634,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_enabled': 'bool', 'data_safe_status': 'str', 'operations_insights_status': 'str', + 'database_management_status': 'str', 'time_maintenance_begin': 'datetime', 'time_maintenance_end': 'datetime', 'is_refreshable_clone': 'bool', @@ -681,6 +712,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_enabled': 'isAutoScalingEnabled', 'data_safe_status': 'dataSafeStatus', 'operations_insights_status': 'operationsInsightsStatus', + 'database_management_status': 'databaseManagementStatus', 'time_maintenance_begin': 'timeMaintenanceBegin', 'time_maintenance_end': 'timeMaintenanceEnd', 'is_refreshable_clone': 'isRefreshableClone', @@ -757,6 +789,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_enabled = None self._data_safe_status = None self._operations_insights_status = None + self._database_management_status = None self._time_maintenance_begin = None self._time_maintenance_end = None self._is_refreshable_clone = None @@ -2104,6 +2137,36 @@ def operations_insights_status(self, operations_insights_status): operations_insights_status = 'UNKNOWN_ENUM_VALUE' self._operations_insights_status = operations_insights_status + @property + def database_management_status(self): + """ + Gets the database_management_status of this AutonomousDatabase. + Status of Database Management for this Autonomous Database. + + Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_management_status of this AutonomousDatabase. + :rtype: str + """ + return self._database_management_status + + @database_management_status.setter + def database_management_status(self, database_management_status): + """ + Sets the database_management_status of this AutonomousDatabase. + Status of Database Management for this Autonomous Database. + + + :param database_management_status: The database_management_status of this AutonomousDatabase. + :type: str + """ + allowed_values = ["ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"] + if not value_allowed_none_or_none_sentinel(database_management_status, allowed_values): + database_management_status = 'UNKNOWN_ENUM_VALUE' + self._database_management_status = database_management_status + @property def time_maintenance_begin(self): """ diff --git a/src/oci/database/models/autonomous_database_summary.py b/src/oci/database/models/autonomous_database_summary.py index 46a7649afa..873dd49d03 100644 --- a/src/oci/database/models/autonomous_database_summary.py +++ b/src/oci/database/models/autonomous_database_summary.py @@ -171,6 +171,30 @@ class AutonomousDatabaseSummary(object): #: This constant has a value of "FAILED_DISABLING" OPERATIONS_INSIGHTS_STATUS_FAILED_DISABLING = "FAILED_DISABLING" + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "ENABLING" + DATABASE_MANAGEMENT_STATUS_ENABLING = "ENABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "ENABLED" + DATABASE_MANAGEMENT_STATUS_ENABLED = "ENABLED" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "DISABLING" + DATABASE_MANAGEMENT_STATUS_DISABLING = "DISABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "NOT_ENABLED" + DATABASE_MANAGEMENT_STATUS_NOT_ENABLED = "NOT_ENABLED" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "FAILED_ENABLING" + DATABASE_MANAGEMENT_STATUS_FAILED_ENABLING = "FAILED_ENABLING" + + #: A constant which can be used with the database_management_status property of a AutonomousDatabaseSummary. + #: This constant has a value of "FAILED_DISABLING" + DATABASE_MANAGEMENT_STATUS_FAILED_DISABLING = "FAILED_DISABLING" + #: A constant which can be used with the open_mode property of a AutonomousDatabaseSummary. #: This constant has a value of "READ_ONLY" OPEN_MODE_READ_ONLY = "READ_ONLY" @@ -432,6 +456,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operations_insights_status: str + :param database_management_status: + The value to assign to the database_management_status property of this AutonomousDatabaseSummary. + Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type database_management_status: str + :param time_maintenance_begin: The value to assign to the time_maintenance_begin property of this AutonomousDatabaseSummary. :type time_maintenance_begin: datetime @@ -606,6 +636,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_enabled': 'bool', 'data_safe_status': 'str', 'operations_insights_status': 'str', + 'database_management_status': 'str', 'time_maintenance_begin': 'datetime', 'time_maintenance_end': 'datetime', 'is_refreshable_clone': 'bool', @@ -683,6 +714,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_enabled': 'isAutoScalingEnabled', 'data_safe_status': 'dataSafeStatus', 'operations_insights_status': 'operationsInsightsStatus', + 'database_management_status': 'databaseManagementStatus', 'time_maintenance_begin': 'timeMaintenanceBegin', 'time_maintenance_end': 'timeMaintenanceEnd', 'is_refreshable_clone': 'isRefreshableClone', @@ -759,6 +791,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_enabled = None self._data_safe_status = None self._operations_insights_status = None + self._database_management_status = None self._time_maintenance_begin = None self._time_maintenance_end = None self._is_refreshable_clone = None @@ -2106,6 +2139,36 @@ def operations_insights_status(self, operations_insights_status): operations_insights_status = 'UNKNOWN_ENUM_VALUE' self._operations_insights_status = operations_insights_status + @property + def database_management_status(self): + """ + Gets the database_management_status of this AutonomousDatabaseSummary. + Status of Database Management for this Autonomous Database. + + Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The database_management_status of this AutonomousDatabaseSummary. + :rtype: str + """ + return self._database_management_status + + @database_management_status.setter + def database_management_status(self, database_management_status): + """ + Sets the database_management_status of this AutonomousDatabaseSummary. + Status of Database Management for this Autonomous Database. + + + :param database_management_status: The database_management_status of this AutonomousDatabaseSummary. + :type: str + """ + allowed_values = ["ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"] + if not value_allowed_none_or_none_sentinel(database_management_status, allowed_values): + database_management_status = 'UNKNOWN_ENUM_VALUE' + self._database_management_status = database_management_status + @property def time_maintenance_begin(self): """ diff --git a/src/oci/database_management/__init__.py b/src/oci/database_management/__init__.py index abfc79d9ac..d976f5fa8a 100644 --- a/src/oci/database_management/__init__.py +++ b/src/oci/database_management/__init__.py @@ -7,6 +7,8 @@ from .db_management_client import DbManagementClient from .db_management_client_composite_operations import DbManagementClientCompositeOperations +from .sql_tuning_client import SqlTuningClient +from .sql_tuning_client_composite_operations import SqlTuningClientCompositeOperations from . import models -__all__ = ["DbManagementClient", "DbManagementClientCompositeOperations", "models"] +__all__ = ["DbManagementClient", "DbManagementClientCompositeOperations", "SqlTuningClient", "SqlTuningClientCompositeOperations", "models"] diff --git a/src/oci/database_management/db_management_client.py b/src/oci/database_management/db_management_client.py index 58269cd165..0bb4d5a760 100644 --- a/src/oci/database_management/db_management_client.py +++ b/src/oci/database_management/db_management_client.py @@ -315,7 +315,7 @@ def change_db_management_private_endpoint_compartment(self, db_management_privat __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.database_management.models.ChangeDbManagementPrivateEndpointCompartmentDetails change_db_management_private_endpoint_compartment_details: (required) - The details used to change the compartment of a Database Management private endpoint. + The details used to move the Database Management private endpoint to another compartment. :param str opc_request_id: (optional) The client request ID for tracing. @@ -623,7 +623,7 @@ def create_db_management_private_endpoint(self, create_db_management_private_end :param oci.database_management.models.CreateDbManagementPrivateEndpointDetails create_db_management_private_endpoint_details: (required) - Details to create a new private endpoint. + Details used to create a new Database Management private endpoint. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -859,7 +859,7 @@ def create_managed_database_group(self, create_managed_database_group_details, * def delete_db_management_private_endpoint(self, db_management_private_endpoint_id, **kwargs): """ - Deletes the specified Database Management private endpoint. + Deletes a specific Database Management private endpoint. :param str db_management_private_endpoint_id: (required) @@ -1755,7 +1755,7 @@ def get_database_home_metrics(self, managed_database_id, start_time, end_time, * def get_db_management_private_endpoint(self, db_management_private_endpoint_id, **kwargs): """ - Gets the details of the specified Database Management private endpoint. + Gets the details of a specific Database Management private endpoint. :param str db_management_private_endpoint_id: (required) @@ -2235,9 +2235,10 @@ def get_managed_database_group(self, managed_database_group_id, **kwargs): def get_pdb_metrics(self, managed_database_id, start_time, end_time, **kwargs): """ - Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory - for each Pdb under specified Container database in same compartment as container database. - If comparmentId is provided then for each Pdb under specified compartmentId. + Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each + PDB within a specific CDB. If comparmentId is specified, then the metrics for + each PDB (within the CDB) in the specified compartment are retrieved. + If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved. :param str managed_database_id: (required) @@ -2358,13 +2359,98 @@ def get_pdb_metrics(self, managed_database_id, start_time, end_time, **kwargs): header_params=header_params, response_type="PdbMetrics") + def get_user(self, managed_database_id, user_name, **kwargs): + """ + Gets the details of a specific user for the specified managedDatabaseId and userName. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str user_name: (required) + The name of the user whose details are to be viewed. + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.User` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_user API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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_user got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + 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="User") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="User") + def get_work_request(self, work_request_id, **kwargs): """ - Gets information of the work request with the given Work Request Id. + Gets the status of the work request with the given Work Request ID :param str work_request_id: (required) - The `OCID`__ of the async Work Request. + The `OCID`__ of the asynchronous work request. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -2441,7 +2527,7 @@ def get_work_request(self, work_request_id, **kwargs): def list_associated_databases(self, db_management_private_endpoint_id, compartment_id, **kwargs): """ - Gets the list of Databases using the specified Database Management private endpoint. + Gets the list of databases using a specific Database Management private endpoint. :param str db_management_private_endpoint_id: (required) @@ -2458,10 +2544,10 @@ def list_associated_databases(self, db_management_private_endpoint_id, compartme The client request ID for tracing. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param str sort_order: (optional) @@ -2470,7 +2556,7 @@ def list_associated_databases(self, db_management_private_endpoint_id, compartme Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort Databases using a specific Database Management Private Endpoint + The option to sort databases using a specific Database Management private endpoint. Allowed values are: "timeRegistered" @@ -2607,11 +2693,11 @@ def list_awr_db_snapshots(self, managed_database_id, awr_db_id, **kwargs): /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str sort_by: (optional) The option to sort the AWR snapshot summary data. @@ -2765,11 +2851,11 @@ def list_awr_dbs(self, managed_database_id, **kwargs): The optional less than or equal to query parameter to filter the timestamp. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str sort_by: (optional) The option to sort the AWR summary data. @@ -2896,9 +2982,9 @@ def list_awr_dbs(self, managed_database_id, **kwargs): header_params=header_params, response_type="AwrDbCollection") - def list_database_parameters(self, managed_database_id, **kwargs): + def list_consumer_group_privileges(self, managed_database_id, user_name, **kwargs): """ - Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values. + Gets the list of Consumer Group Privileges granted for the specified user. :param str managed_database_id: (required) @@ -2906,26 +2992,18 @@ def list_database_parameters(self, managed_database_id, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str user_name: (required) + The name of the user whose details are to be viewed. + :param str opc_request_id: (optional) The client request ID for tracing. - :param str source: (optional) - The source used to list database parameters. `CURRENT` is used to get the - database parameters that are currently in effect for the database - instance. `SPFILE` is used to list parameters from the server parameter - file. Default is `CURRENT`. - - Allowed values are: "CURRENT", "SPFILE" - :param str name: (optional) - A filter to return all parameters that have the text given in their names. - - :param bool is_allowed_values_included: (optional) - When true, results include a list of valid values for parameters (if applicable). + A filter to return only resources that match the entire name. :param str sort_by: (optional) - The field to sort information by. Only one sortOrder can be used. The - default sort order for `NAME` is ascending and it is case-sensitive. + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. Allowed values are: "NAME" @@ -2934,6 +3012,13 @@ def list_database_parameters(self, managed_database_id, **kwargs): Allowed values are: "ASC", "DESC" + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + :param 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. @@ -2942,32 +3027,33 @@ def list_database_parameters(self, managed_database_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.DatabaseParametersCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ConsumerGroupPrivilegeCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_database_parameters API. + Click `here `__ to see an example of how to use list_consumer_group_privileges API. """ - resource_path = "/managedDatabases/{managedDatabaseId}/databaseParameters" + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/consumerGroupPrivileges" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", "opc_request_id", - "source", "name", - "is_allowed_values_included", "sort_by", - "sort_order" + "sort_order", + "limit", + "page" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_database_parameters got unknown kwargs: {!r}".format(extra_kwargs)) + "list_consumer_group_privileges got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "managedDatabaseId": managed_database_id + "managedDatabaseId": managed_database_id, + "userName": user_name } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2976,13 +3062,6 @@ def list_database_parameters(self, managed_database_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'source' in kwargs: - source_allowed_values = ["CURRENT", "SPFILE"] - if kwargs['source'] not in source_allowed_values: - raise ValueError( - "Invalid value for `source`, must be one of {0}".format(source_allowed_values) - ) - if 'sort_by' in kwargs: sort_by_allowed_values = ["NAME"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -2998,11 +3077,11 @@ def list_database_parameters(self, managed_database_id, **kwargs): ) query_params = { - "source": kwargs.get("source", missing), "name": kwargs.get("name", missing), - "isAllowedValuesIncluded": kwargs.get("is_allowed_values_included", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing) + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3029,7 +3108,7 @@ def list_database_parameters(self, managed_database_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="DatabaseParametersCollection") + response_type="ConsumerGroupPrivilegeCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -3037,52 +3116,44 @@ def list_database_parameters(self, managed_database_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="DatabaseParametersCollection") + response_type="ConsumerGroupPrivilegeCollection") - def list_db_management_private_endpoints(self, compartment_id, **kwargs): + def list_data_access_containers(self, managed_database_id, user_name, **kwargs): """ - Gets a list of Database Management private endpoints. + Gets the list of Containers if it does not apply to all containers for the specified user. - :param str compartment_id: (required) - The `OCID`__ of the compartment. + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str name: (optional) - A filter to return only resources that match the entire name. - - :param str vcn_id: (optional) - The `OCID`__ of the VCN. - - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str user_name: (required) + The name of the user whose details are to be viewed. - :param str lifecycle_state: (optional) - The lifecycle state of a resource. + :param str opc_request_id: (optional) + The client request ID for tracing. - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + :param str name: (optional) + A filter to return only resources that match the entire name. - :param int limit: (optional) - The maximum number of records returned in paginated response. + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. - :param str page: (optional) - The page token representing the page, from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. + Allowed values are: "NAME" :param str sort_order: (optional) The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. Allowed values are: "ASC", "DESC" - :param str sort_by: (optional) - The field to sort information by. Only one sortOrder can be used. The default sort order - for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. - The \u2018NAME\u2019 sort order is case-sensitive. - - Allowed values are: "TIMECREATED", "NAME" + :param int limit: (optional) + The maximum number of records returned in the paginated response. - :param str opc_request_id: (optional) - The client request ID for tracing. + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. :param 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. @@ -3092,37 +3163,46 @@ def list_db_management_private_endpoints(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.DbManagementPrivateEndpointCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.DataAccessContainerCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_db_management_private_endpoints API. + Click `here `__ to see an example of how to use list_data_access_containers API. """ - resource_path = "/dbManagementPrivateEndpoints" + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/dataAccessContainers" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", + "opc_request_id", "name", - "vcn_id", - "lifecycle_state", - "limit", - "page", - "sort_order", "sort_by", - "opc_request_id" + "sort_order", + "limit", + "page" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_db_management_private_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) + "list_data_access_containers 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: + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( - "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) if 'sort_order' in kwargs: @@ -3132,22 +3212,12 @@ def list_db_management_private_endpoints(self, compartment_id, **kwargs): "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", "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, "name": kwargs.get("name", missing), - "vcnId": kwargs.get("vcn_id", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing), + "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3171,62 +3241,200 @@ def list_db_management_private_endpoints(self, compartment_id, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="DbManagementPrivateEndpointCollection") + response_type="DataAccessContainerCollection") 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="DbManagementPrivateEndpointCollection") + response_type="DataAccessContainerCollection") - def list_job_executions(self, compartment_id, **kwargs): + def list_database_parameters(self, managed_database_id, **kwargs): """ - Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group - in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. - If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered - based on the name and status parameters. + Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values. - :param str compartment_id: (required) - The `OCID`__ of the compartment. + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) The client request ID for tracing. - :param str id: (optional) - The identifier of the resource. + :param str source: (optional) + The source used to list database parameters. `CURRENT` is used to get the + database parameters that are currently in effect for the database + instance. `SPFILE` is used to list parameters from the server parameter + file. Default is `CURRENT`. - :param str job_id: (optional) - The identifier of the job. + Allowed values are: "CURRENT", "SPFILE" - :param str managed_database_id: (optional) - The `OCID`__ of the Managed Database. + :param str name: (optional) + A filter to return all parameters that have the text given in their names. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param bool is_allowed_values_included: (optional) + When true, results include a list of valid values for parameters (if applicable). - :param str managed_database_group_id: (optional) - The `OCID`__ of the Managed Database Group. + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The + default sort order for `NAME` is ascending and it is case-sensitive. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + Allowed values are: "NAME" - :param str status: (optional) - The status of the job execution. + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. - :param str name: (optional) - A filter to return only resources that match the entire name. + Allowed values are: "ASC", "DESC" - :param int limit: (optional) - The maximum number of records returned in paginated response. + :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. - :param str page: (optional) - The page token representing the page, from where the next set of paginated results + 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.DatabaseParametersCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_database_parameters API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/databaseParameters" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "source", + "name", + "is_allowed_values_included", + "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_database_parameters got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'source' in kwargs: + source_allowed_values = ["CURRENT", "SPFILE"] + if kwargs['source'] not in source_allowed_values: + raise ValueError( + "Invalid value for `source`, must be one of {0}".format(source_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "source": kwargs.get("source", missing), + "name": kwargs.get("name", missing), + "isAllowedValuesIncluded": kwargs.get("is_allowed_values_included", 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="DatabaseParametersCollection") + 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="DatabaseParametersCollection") + + def list_db_management_private_endpoints(self, compartment_id, **kwargs): + """ + Gets a list of Database Management private endpoints. + + + :param str compartment_id: (required) + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str vcn_id: (optional) + The `OCID`__ of the VCN. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param bool is_cluster: (optional) + The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter. + + :param str lifecycle_state: (optional) + The lifecycle state of a resource. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + :param str sort_by: (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. @@ -3234,13 +3442,8 @@ def list_job_executions(self, compartment_id, **kwargs): Allowed values are: "TIMECREATED", "NAME" - :param str sort_order: (optional) - The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. - - Allowed values are: "ASC", "DESC" - - :param str job_run_id: (optional) - The identifier of the job run. + :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. @@ -3250,41 +3453,38 @@ def list_job_executions(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobExecutionCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.DbManagementPrivateEndpointCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_job_executions API. + Click `here `__ to see an example of how to use list_db_management_private_endpoints API. """ - resource_path = "/jobExecutions" + resource_path = "/dbManagementPrivateEndpoints" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", - "opc_request_id", - "id", - "job_id", - "managed_database_id", - "managed_database_group_id", - "status", "name", + "vcn_id", + "is_cluster", + "lifecycle_state", "limit", "page", - "sort_by", "sort_order", - "job_run_id" + "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_job_executions got unknown kwargs: {!r}".format(extra_kwargs)) + "list_db_management_private_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) - if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "NAME"] - if kwargs['sort_by'] not in sort_by_allowed_values: + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: raise ValueError( - "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) ) if 'sort_order' in kwargs: @@ -3294,19 +3494,23 @@ def list_job_executions(self, compartment_id, **kwargs): "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", "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, - "id": kwargs.get("id", missing), - "jobId": kwargs.get("job_id", missing), - "managedDatabaseId": kwargs.get("managed_database_id", missing), - "managedDatabaseGroupId": kwargs.get("managed_database_group_id", missing), - "status": kwargs.get("status", missing), "name": kwargs.get("name", missing), + "vcnId": kwargs.get("vcn_id", missing), + "isCluster": kwargs.get("is_cluster", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "jobRunId": kwargs.get("job_run_id", 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} @@ -3332,21 +3536,21 @@ def list_job_executions(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="JobExecutionCollection") + response_type="DbManagementPrivateEndpointCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="JobExecutionCollection") + response_type="DbManagementPrivateEndpointCollection") - def list_job_runs(self, compartment_id, **kwargs): + def list_job_executions(self, compartment_id, **kwargs): """ - Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group - in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId - should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. - Job runs can also be filtered based on name and runStatus parameters. + Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group + in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. + If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered + based on the name and status parameters. :param str compartment_id: (required) @@ -3373,17 +3577,17 @@ def list_job_runs(self, compartment_id, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str run_status: (optional) - The status of the job run. + :param str status: (optional) + The status of the job execution. :param str name: (optional) A filter to return only resources that match the entire name. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param str sort_by: (optional) @@ -3398,6 +3602,9 @@ def list_job_runs(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" + :param str job_run_id: (optional) + The identifier of the job run. + :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. @@ -3406,13 +3613,13 @@ def list_job_runs(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobRunCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobExecutionCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_job_runs API. + Click `here `__ to see an example of how to use list_job_executions API. """ - resource_path = "/jobRuns" + resource_path = "/jobExecutions" method = "GET" # Don't accept unknown kwargs @@ -3423,17 +3630,18 @@ def list_job_runs(self, compartment_id, **kwargs): "job_id", "managed_database_id", "managed_database_group_id", - "run_status", + "status", "name", "limit", "page", "sort_by", - "sort_order" + "sort_order", + "job_run_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_job_runs got unknown kwargs: {!r}".format(extra_kwargs)) + "list_job_executions got unknown kwargs: {!r}".format(extra_kwargs)) if 'sort_by' in kwargs: sort_by_allowed_values = ["TIMECREATED", "NAME"] @@ -3455,12 +3663,13 @@ def list_job_runs(self, compartment_id, **kwargs): "jobId": kwargs.get("job_id", missing), "managedDatabaseId": kwargs.get("managed_database_id", missing), "managedDatabaseGroupId": kwargs.get("managed_database_group_id", missing), - "runStatus": kwargs.get("run_status", missing), + "status": kwargs.get("status", missing), "name": kwargs.get("name", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing) + "sortOrder": kwargs.get("sort_order", missing), + "jobRunId": kwargs.get("job_run_id", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3486,21 +3695,21 @@ def list_job_runs(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="JobRunCollection") + response_type="JobExecutionCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="JobRunCollection") + response_type="JobExecutionCollection") - def list_jobs(self, compartment_id, **kwargs): + def list_job_runs(self, compartment_id, **kwargs): """ - Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group - in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, - should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. - Jobs can also be filtered based on the name and lifecycleState parameters. + Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group + in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId + should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. + Job runs can also be filtered based on name and runStatus parameters. :param str compartment_id: (required) @@ -3508,49 +3717,1054 @@ def list_jobs(self, compartment_id, **kwargs): __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str opc_request_id: (optional) - The client request ID for tracing. + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str id: (optional) + The identifier of the resource. + + :param str job_id: (optional) + The identifier of the job. + + :param str managed_database_id: (optional) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str managed_database_group_id: (optional) + The `OCID`__ of the Managed Database Group. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str run_status: (optional) + The status of the job run. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. + The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "TIMECREATED", "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobRunCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_job_runs API. + """ + resource_path = "/jobRuns" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "id", + "job_id", + "managed_database_id", + "managed_database_group_id", + "run_status", + "name", + "limit", + "page", + "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_job_runs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "id": kwargs.get("id", missing), + "jobId": kwargs.get("job_id", missing), + "managedDatabaseId": kwargs.get("managed_database_id", missing), + "managedDatabaseGroupId": kwargs.get("managed_database_group_id", missing), + "runStatus": kwargs.get("run_status", missing), + "name": kwargs.get("name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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, + query_params=query_params, + header_params=header_params, + response_type="JobRunCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="JobRunCollection") + + def list_jobs(self, compartment_id, **kwargs): + """ + Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group + in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, + should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. + Jobs can also be filtered based on the name and lifecycleState parameters. + + + :param str compartment_id: (required) + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str id: (optional) + The identifier of the resource. + + :param str managed_database_group_id: (optional) + The `OCID`__ of the Managed Database Group. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str managed_database_id: (optional) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str lifecycle_state: (optional) + The lifecycle state of the job. + + Allowed values are: "ACTIVE", "INACTIVE" + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. + The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "TIMECREATED", "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_jobs API. + """ + resource_path = "/jobs" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "id", + "managed_database_group_id", + "managed_database_id", + "name", + "lifecycle_state", + "limit", + "page", + "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_jobs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "INACTIVE"] + 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", "NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "id": kwargs.get("id", missing), + "managedDatabaseGroupId": kwargs.get("managed_database_group_id", missing), + "managedDatabaseId": kwargs.get("managed_database_id", missing), + "name": kwargs.get("name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", 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, + query_params=query_params, + header_params=header_params, + response_type="JobCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="JobCollection") + + def list_managed_database_groups(self, compartment_id, **kwargs): + """ + Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in + a specific compartment. Managed Database Groups can also be filtered based on the name parameter. + Only one of the parameters, ID or name should be provided. If none of these parameters is provided, + all the Managed Database Groups in the compartment are listed. + + + :param str compartment_id: (required) + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str id: (optional) + The identifier of the resource. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str lifecycle_state: (optional) + The lifecycle state of a resource. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. + The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "TIMECREATED", "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ManagedDatabaseGroupCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_managed_database_groups API. + """ + resource_path = "/managedDatabaseGroups" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "id", + "name", + "lifecycle_state", + "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_managed_database_groups 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_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "id": kwargs.get("id", missing), + "name": kwargs.get("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: + 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="ManagedDatabaseGroupCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ManagedDatabaseGroupCollection") + + def list_managed_databases(self, compartment_id, **kwargs): + """ + Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. + Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name + should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment + are listed. Managed Databases can also be filtered based on the deployment type and management option. + If the deployment type is not specified or if it is `ONPREMISE`, then the management option is not + considered and Managed Databases with `ADVANCED` management option are listed. + + + :param str compartment_id: (required) + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str id: (optional) + The identifier of the resource. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str management_option: (optional) + A filter to return Managed Databases with the specified management option. + + Allowed values are: "BASIC", "ADVANCED" + + :param str deployment_type: (optional) + A filter to return Managed Databases of the specified deployment type. + + Allowed values are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. + The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "TIMECREATED", "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ManagedDatabaseCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_managed_databases API. + """ + resource_path = "/managedDatabases" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "id", + "name", + "management_option", + "deployment_type", + "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_managed_databases got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'management_option' in kwargs: + management_option_allowed_values = ["BASIC", "ADVANCED"] + if kwargs['management_option'] not in management_option_allowed_values: + raise ValueError( + "Invalid value for `management_option`, must be one of {0}".format(management_option_allowed_values) + ) + + if 'deployment_type' in kwargs: + deployment_type_allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] + if kwargs['deployment_type'] not in deployment_type_allowed_values: + raise ValueError( + "Invalid value for `deployment_type`, must be one of {0}".format(deployment_type_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "id": kwargs.get("id", missing), + "name": kwargs.get("name", missing), + "managementOption": kwargs.get("management_option", missing), + "deploymentType": kwargs.get("deployment_type", 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: + 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="ManagedDatabaseCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ManagedDatabaseCollection") + + def list_object_privileges(self, managed_database_id, user_name, **kwargs): + """ + Gets the list of Object Privileges granted for the specified user. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str user_name: (required) + The name of the user whose details are to be viewed. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ObjectPrivilegeCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_object_privileges API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/objectPrivileges" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "name", + "sort_by", + "sort_order", + "limit", + "page" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_object_privileges got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ObjectPrivilegeCollection") + 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="ObjectPrivilegeCollection") + + def list_proxied_for_users(self, managed_database_id, user_name, **kwargs): + """ + Gets the list of Users for which the current user acts as proxy. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str user_name: (required) + The name of the user whose details are to be viewed. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ProxiedForUserCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_proxied_for_users API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/proxiedForUsers" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "name", + "sort_by", + "sort_order", + "limit", + "page" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_proxied_for_users got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ProxiedForUserCollection") + 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="ProxiedForUserCollection") + + def list_proxy_users(self, managed_database_id, user_name, **kwargs): + """ + Gets the list of proxy users for the current User. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str user_name: (required) + The name of the user whose details are to be viewed. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str name: (optional) + A filter to return only resources that match the entire name. + + :param str sort_by: (optional) + The field to sort information by. Only one sortOrder can be used. The default sort order + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. + + Allowed values are: "NAME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ProxyUserCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_proxy_users API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/proxyUsers" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "name", + "sort_by", + "sort_order", + "limit", + "page" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_proxy_users got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ProxyUserCollection") + 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="ProxyUserCollection") + + def list_roles(self, managed_database_id, user_name, **kwargs): + """ + Gets the list of roles granted for the specified user. - :param str id: (optional) - The identifier of the resource. - :param str managed_database_group_id: (optional) - The `OCID`__ of the Managed Database Group. + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param str managed_database_id: (optional) - The `OCID`__ of the Managed Database. + :param str user_name: (required) + The name of the user whose details are to be viewed. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str opc_request_id: (optional) + The client request ID for tracing. :param str name: (optional) A filter to return only resources that match the entire name. - :param str lifecycle_state: (optional) - The lifecycle state of the job. - - Allowed values are: "ACTIVE", "INACTIVE" - - :param int limit: (optional) - The maximum number of records returned in paginated response. - - :param str page: (optional) - The page token representing the page, from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. - :param str sort_by: (optional) The field to sort information by. Only one sortOrder can be used. The default sort order - for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. - The \u2018NAME\u2019 sort order is case-sensitive. + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. - Allowed values are: "TIMECREATED", "NAME" + Allowed values are: "NAME" :param str sort_order: (optional) The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. Allowed values are: "ASC", "DESC" + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + :param 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. @@ -3559,43 +4773,43 @@ def list_jobs(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.JobCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.RoleCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_jobs API. + Click `here `__ to see an example of how to use list_roles API. """ - resource_path = "/jobs" + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/roles" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", "opc_request_id", - "id", - "managed_database_group_id", - "managed_database_id", "name", - "lifecycle_state", - "limit", - "page", "sort_by", - "sort_order" + "sort_order", + "limit", + "page" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_jobs got unknown kwargs: {!r}".format(extra_kwargs)) + "list_roles got unknown kwargs: {!r}".format(extra_kwargs)) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["ACTIVE", "INACTIVE"] - 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) - ) + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + 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 = ["TIMECREATED", "NAME"] + sort_by_allowed_values = ["NAME"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -3609,16 +4823,11 @@ def list_jobs(self, compartment_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, - "id": kwargs.get("id", missing), - "managedDatabaseGroupId": kwargs.get("managed_database_group_id", missing), - "managedDatabaseId": kwargs.get("managed_database_id", missing), "name": kwargs.get("name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing) + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3642,63 +4851,56 @@ def list_jobs(self, compartment_id, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="JobCollection") + response_type="RoleCollection") 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="JobCollection") + response_type="RoleCollection") - def list_managed_database_groups(self, compartment_id, **kwargs): + def list_system_privileges(self, managed_database_id, user_name, **kwargs): """ - Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in - a specific compartment. Managed Database Groups can also be filtered based on the name parameter. - Only one of the parameters, ID or name should be provided. If none of these parameters is provided, - all the Managed Database Groups in the compartment are listed. + Gets the list of System Privileges granted for the specified user. - :param str compartment_id: (required) - The `OCID`__ of the compartment. + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str user_name: (required) + The name of the user whose details are to be viewed. + :param str opc_request_id: (optional) The client request ID for tracing. - :param str id: (optional) - The identifier of the resource. - :param str name: (optional) A filter to return only resources that match the entire name. - :param str lifecycle_state: (optional) - The lifecycle state of a resource. - - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" - - :param str page: (optional) - The page token representing the page, from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of records returned in paginated response. - :param str sort_by: (optional) The field to sort information by. Only one sortOrder can be used. The default sort order - for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. - The \u2018NAME\u2019 sort order is case-sensitive. + for \u2018NAME\u2019 is ascending. The \u2018NAME\u2019 sort order is case-sensitive. - Allowed values are: "TIMECREATED", "NAME" + Allowed values are: "NAME" :param str sort_order: (optional) The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Ascending order is the default order. Allowed values are: "ASC", "DESC" + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + :param 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. @@ -3707,41 +4909,43 @@ def list_managed_database_groups(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ManagedDatabaseGroupCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SystemPrivilegeCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_managed_database_groups API. + Click `here `__ to see an example of how to use list_system_privileges API. """ - resource_path = "/managedDatabaseGroups" + resource_path = "/managedDatabases/{managedDatabaseId}/users/{userName}/systemPrivileges" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", "opc_request_id", - "id", "name", - "lifecycle_state", - "page", - "limit", "sort_by", - "sort_order" + "sort_order", + "limit", + "page" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_managed_database_groups got unknown kwargs: {!r}".format(extra_kwargs)) + "list_system_privileges 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) - ) + path_params = { + "managedDatabaseId": managed_database_id, + "userName": user_name + } + + 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 = ["TIMECREATED", "NAME"] + sort_by_allowed_values = ["NAME"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -3755,14 +4959,11 @@ def list_managed_database_groups(self, compartment_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, - "id": kwargs.get("id", missing), "name": kwargs.get("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) + "sortOrder": kwargs.get("sort_order", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3786,58 +4987,35 @@ def list_managed_database_groups(self, compartment_id, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ManagedDatabaseGroupCollection") + response_type="SystemPrivilegeCollection") 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="ManagedDatabaseGroupCollection") + response_type="SystemPrivilegeCollection") - def list_managed_databases(self, compartment_id, **kwargs): + def list_tablespaces(self, managed_database_id, **kwargs): """ - Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. - Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name - should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment - are listed. Managed Databases can also be filtered based on the deployment type and management option. - If the deployment type is not specified or if it is `ONPREMISE`, then the management option is not - considered and Managed Databases with `ADVANCED` management option are listed. + Gets the list of tablespaces for the specified managedDatabaseId. - :param str compartment_id: (required) - The `OCID`__ of the compartment. + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) The client request ID for tracing. - :param str id: (optional) - The identifier of the resource. - :param str name: (optional) A filter to return only resources that match the entire name. - :param str management_option: (optional) - A filter to return Managed Databases with the specified management option. - - Allowed values are: "BASIC", "ADVANCED" - - :param str deployment_type: (optional) - A filter to return Managed Databases of the specified deployment type. - - Allowed values are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC" - - :param str page: (optional) - The page token representing the page, from where the next set of paginated results - are retrieved. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of records returned in paginated response. - :param str sort_by: (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for \u2018TIMECREATED\u2019 is descending and the default sort order for \u2018NAME\u2019 is ascending. @@ -3850,6 +5028,13 @@ def list_managed_databases(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + :param 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. @@ -3858,46 +5043,39 @@ def list_managed_databases(self, compartment_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ManagedDatabaseCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.TablespaceCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_managed_databases API. + Click `here `__ to see an example of how to use list_tablespaces API. """ - resource_path = "/managedDatabases" + resource_path = "/managedDatabases/{managedDatabaseId}/tablespaces" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "retry_strategy", "opc_request_id", - "id", "name", - "management_option", - "deployment_type", - "page", - "limit", "sort_by", - "sort_order" + "sort_order", + "page", + "limit" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_managed_databases got unknown kwargs: {!r}".format(extra_kwargs)) + "list_tablespaces got unknown kwargs: {!r}".format(extra_kwargs)) - if 'management_option' in kwargs: - management_option_allowed_values = ["BASIC", "ADVANCED"] - if kwargs['management_option'] not in management_option_allowed_values: - raise ValueError( - "Invalid value for `management_option`, must be one of {0}".format(management_option_allowed_values) - ) + path_params = { + "managedDatabaseId": managed_database_id + } - if 'deployment_type' in kwargs: - deployment_type_allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] - if kwargs['deployment_type'] not in deployment_type_allowed_values: - raise ValueError( - "Invalid value for `deployment_type`, must be one of {0}".format(deployment_type_allowed_values) - ) + 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 = ["TIMECREATED", "NAME"] @@ -3914,15 +5092,11 @@ def list_managed_databases(self, compartment_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, - "id": kwargs.get("id", missing), "name": kwargs.get("name", missing), - "managementOption": kwargs.get("management_option", missing), - "deploymentType": kwargs.get("deployment_type", missing), - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", 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} @@ -3946,20 +5120,22 @@ def list_managed_databases(self, compartment_id, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ManagedDatabaseCollection") + response_type="TablespaceCollection") 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="ManagedDatabaseCollection") + response_type="TablespaceCollection") - def list_tablespaces(self, managed_database_id, **kwargs): + def list_users(self, managed_database_id, **kwargs): """ - Gets the list of tablespaces for the specified managedDatabaseId. + Gets the list of users for the specified managedDatabaseId. :param str managed_database_id: (required) @@ -3985,13 +5161,13 @@ def list_tablespaces(self, managed_database_id, **kwargs): Allowed values are: "ASC", "DESC" + :param int limit: (optional) + The maximum number of records returned in the paginated response. + :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. - :param int limit: (optional) - The maximum number of records returned in paginated response. - :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. @@ -4000,13 +5176,13 @@ def list_tablespaces(self, managed_database_id, **kwargs): To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.TablespaceCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.UserCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_tablespaces API. + Click `here `__ to see an example of how to use list_users API. """ - resource_path = "/managedDatabases/{managedDatabaseId}/tablespaces" + resource_path = "/managedDatabases/{managedDatabaseId}/users" method = "GET" # Don't accept unknown kwargs @@ -4016,13 +5192,13 @@ def list_tablespaces(self, managed_database_id, **kwargs): "name", "sort_by", "sort_order", - "page", - "limit" + "limit", + "page" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_tablespaces got unknown kwargs: {!r}".format(extra_kwargs)) + "list_users got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "managedDatabaseId": managed_database_id @@ -4052,8 +5228,8 @@ def list_tablespaces(self, managed_database_id, **kwargs): "name": kwargs.get("name", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4080,7 +5256,7 @@ def list_tablespaces(self, managed_database_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="TablespaceCollection") + response_type="UserCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -4088,15 +5264,15 @@ def list_tablespaces(self, managed_database_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="TablespaceCollection") + response_type="UserCollection") def list_work_request_errors(self, work_request_id, **kwargs): """ - Returns a (paginated) list of errors for a given work request. + Returns a paginated list of errors for a given work request. :param str work_request_id: (required) - The `OCID`__ of the async Work Request. + The `OCID`__ of the asynchronous work request. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -4104,14 +5280,14 @@ def list_work_request_errors(self, work_request_id, **kwargs): The client request ID for tracing. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: "timeAccepted" @@ -4218,11 +5394,11 @@ def list_work_request_errors(self, work_request_id, **kwargs): def list_work_request_logs(self, work_request_id, **kwargs): """ - Returns a (paginated) list of logs for a given work request. + Returns a paginated list of logs for a given work request. :param str work_request_id: (required) - The `OCID`__ of the async Work Request. + The `OCID`__ of the asynchronous work request. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm @@ -4230,14 +5406,14 @@ def list_work_request_logs(self, work_request_id, **kwargs): The client request ID for tracing. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: "timeAccepted" @@ -4344,7 +5520,7 @@ def list_work_request_logs(self, work_request_id, **kwargs): def list_work_requests(self, compartment_id, **kwargs): """ - Lists all the work requests in the specified compartment. + The list of work requests in a specific compartment was retrieved successfully. :param str compartment_id: (required) @@ -4361,10 +5537,12 @@ def list_work_requests(self, compartment_id, **kwargs): The client request ID for tracing. :param str work_request_id: (optional) - The ID of the asynchronous work request. + The `OCID`__ of the asynchronous work request. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str status: (optional) - A filter to return only resources their status matches the given WorkRequestStatus. + A filter that returns the resources whose status matches the given WorkRequestStatus. Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" @@ -4374,16 +5552,16 @@ def list_work_requests(self, compartment_id, **kwargs): 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. + The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: "timeAccepted" :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :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. @@ -4717,7 +5895,7 @@ def summarize_awr_db_cpu_usages(self, managed_database_id, awr_db_id, **kwargs): /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -4903,7 +6081,7 @@ def summarize_awr_db_metrics(self, managed_database_id, awr_db_id, name, **kwarg /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -5085,7 +6263,7 @@ def summarize_awr_db_parameter_changes(self, managed_database_id, awr_db_id, nam /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -5291,7 +6469,7 @@ def summarize_awr_db_parameters(self, managed_database_id, awr_db_id, **kwargs): Allowed values are: "MODIFIED", "SYSTEM_MOD", "FALSE" :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -5480,11 +6658,11 @@ def summarize_awr_db_snapshot_ranges(self, managed_database_id, **kwargs): The optional less than or equal to query parameter to filter the timestamp. :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) - The maximum number of records returned in paginated response. + The maximum number of records returned in the paginated response. :param str sort_by: (optional) The option to sort the AWR summary data. @@ -5650,7 +6828,7 @@ def summarize_awr_db_sysstats(self, managed_database_id, awr_db_id, name, **kwar /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -6019,7 +7197,7 @@ def summarize_awr_db_wait_event_buckets(self, managed_database_id, awr_db_id, na /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -6208,7 +7386,7 @@ def summarize_awr_db_wait_events(self, managed_database_id, awr_db_id, **kwargs) /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges :param str page: (optional) - The page token representing the page, from where the next set of paginated results + The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. :param int limit: (optional) @@ -6499,7 +7677,7 @@ def summarize_job_executions_statuses(self, compartment_id, start_time, end_time def update_db_management_private_endpoint(self, db_management_private_endpoint_id, update_db_management_private_endpoint_details, **kwargs): """ - Updates one or more attributes of the specified Database Management private endpoint. + Updates one or more attributes of a specific Database Management private endpoint. :param str db_management_private_endpoint_id: (required) diff --git a/src/oci/database_management/db_management_client_composite_operations.py b/src/oci/database_management/db_management_client_composite_operations.py index 1ecf321f6a..4b754f8076 100644 --- a/src/oci/database_management/db_management_client_composite_operations.py +++ b/src/oci/database_management/db_management_client_composite_operations.py @@ -29,7 +29,7 @@ def create_db_management_private_endpoint_and_wait_for_state(self, create_db_man to enter the given state(s). :param oci.database_management.models.CreateDbManagementPrivateEndpointDetails create_db_management_private_endpoint_details: (required) - Details to create a new private endpoint. + Details used to create a new Database Management private endpoint. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.database_management.models.WorkRequest.status` diff --git a/src/oci/database_management/models/__init__.py b/src/oci/database_management/models/__init__.py index f930fbaf5b..6810cfc1ce 100644 --- a/src/oci/database_management/models/__init__.py +++ b/src/oci/database_management/models/__init__.py @@ -40,11 +40,17 @@ from .change_job_compartment_details import ChangeJobCompartmentDetails from .change_managed_database_group_compartment_details import ChangeManagedDatabaseGroupCompartmentDetails from .child_database import ChildDatabase +from .clone_sql_tuning_task_details import CloneSqlTuningTaskDetails from .cluster_cache_metric import ClusterCacheMetric +from .consumer_group_privilege_collection import ConsumerGroupPrivilegeCollection +from .consumer_group_privilege_summary import ConsumerGroupPrivilegeSummary +from .cpu_utilization_aggregate_metrics import CpuUtilizationAggregateMetrics from .create_db_management_private_endpoint_details import CreateDbManagementPrivateEndpointDetails from .create_job_details import CreateJobDetails from .create_managed_database_group_details import CreateManagedDatabaseGroupDetails from .create_sql_job_details import CreateSqlJobDetails +from .data_access_container_collection import DataAccessContainerCollection +from .data_access_container_summary import DataAccessContainerSummary from .database_credentials import DatabaseCredentials from .database_fleet_health_metrics import DatabaseFleetHealthMetrics from .database_home_metric_definition import DatabaseHomeMetricDefinition @@ -61,6 +67,9 @@ from .db_management_private_endpoint import DbManagementPrivateEndpoint from .db_management_private_endpoint_collection import DbManagementPrivateEndpointCollection from .db_management_private_endpoint_summary import DbManagementPrivateEndpointSummary +from .drop_sql_tuning_task_details import DropSqlTuningTaskDetails +from .execution_plan_stats_comparision import ExecutionPlanStatsComparision +from .failed_connections_aggregate_metrics import FailedConnectionsAggregateMetrics from .fleet_metric_definition import FleetMetricDefinition from .fleet_metric_summary_definition import FleetMetricSummaryDefinition from .fleet_status_by_category import FleetStatusByCategory @@ -90,14 +99,48 @@ from .memory_aggregate_metrics import MemoryAggregateMetrics from .metric_data_point import MetricDataPoint from .metric_dimension_definition import MetricDimensionDefinition +from .object_privilege_collection import ObjectPrivilegeCollection +from .object_privilege_summary import ObjectPrivilegeSummary from .object_storage_job_execution_result_details import ObjectStorageJobExecutionResultDetails from .object_storage_job_execution_result_location import ObjectStorageJobExecutionResultLocation from .parent_group import ParentGroup from .pdb_metrics import PdbMetrics from .pdb_status_details import PdbStatusDetails +from .proxied_for_user_collection import ProxiedForUserCollection +from .proxied_for_user_summary import ProxiedForUserSummary +from .proxy_user_collection import ProxyUserCollection +from .proxy_user_summary import ProxyUserSummary from .remove_managed_database_from_managed_database_group_details import RemoveManagedDatabaseFromManagedDatabaseGroupDetails from .reset_database_parameters_details import ResetDatabaseParametersDetails +from .role_collection import RoleCollection +from .role_summary import RoleSummary from .sql_job import SqlJob +from .sql_tuning_advisor_task_collection import SqlTuningAdvisorTaskCollection +from .sql_tuning_advisor_task_finding_collection import SqlTuningAdvisorTaskFindingCollection +from .sql_tuning_advisor_task_finding_summary import SqlTuningAdvisorTaskFindingSummary +from .sql_tuning_advisor_task_recommendation_collection import SqlTuningAdvisorTaskRecommendationCollection +from .sql_tuning_advisor_task_recommendation_summary import SqlTuningAdvisorTaskRecommendationSummary +from .sql_tuning_advisor_task_sql_execution_plan import SqlTuningAdvisorTaskSqlExecutionPlan +from .sql_tuning_advisor_task_summary import SqlTuningAdvisorTaskSummary +from .sql_tuning_advisor_task_summary_finding_benefits import SqlTuningAdvisorTaskSummaryFindingBenefits +from .sql_tuning_advisor_task_summary_finding_counts import SqlTuningAdvisorTaskSummaryFindingCounts +from .sql_tuning_advisor_task_summary_report import SqlTuningAdvisorTaskSummaryReport +from .sql_tuning_advisor_task_summary_report_index_finding_summary import SqlTuningAdvisorTaskSummaryReportIndexFindingSummary +from .sql_tuning_advisor_task_summary_report_object_stat_finding_summary import SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary +from .sql_tuning_advisor_task_summary_report_statement_counts import SqlTuningAdvisorTaskSummaryReportStatementCounts +from .sql_tuning_advisor_task_summary_report_statistics import SqlTuningAdvisorTaskSummaryReportStatistics +from .sql_tuning_advisor_task_summary_report_task_info import SqlTuningAdvisorTaskSummaryReportTaskInfo +from .sql_tuning_task_credential_details import SqlTuningTaskCredentialDetails +from .sql_tuning_task_password_credential_details import SqlTuningTaskPasswordCredentialDetails +from .sql_tuning_task_plan_stats import SqlTuningTaskPlanStats +from .sql_tuning_task_return import SqlTuningTaskReturn +from .sql_tuning_task_secret_credential_details import SqlTuningTaskSecretCredentialDetails +from .sql_tuning_task_sql_detail import SqlTuningTaskSqlDetail +from .sql_tuning_task_sql_execution_plan_step import SqlTuningTaskSqlExecutionPlanStep +from .start_sql_tuning_task_details import StartSqlTuningTaskDetails +from .statements_aggregate_metrics import StatementsAggregateMetrics +from .system_privilege_collection import SystemPrivilegeCollection +from .system_privilege_summary import SystemPrivilegeSummary from .tablespace import Tablespace from .tablespace_collection import TablespaceCollection from .tablespace_summary import TablespaceSummary @@ -108,6 +151,9 @@ from .update_job_details import UpdateJobDetails from .update_managed_database_group_details import UpdateManagedDatabaseGroupDetails from .update_sql_job_details import UpdateSqlJobDetails +from .user import User +from .user_collection import UserCollection +from .user_summary import UserSummary from .work_request import WorkRequest from .work_request_collection import WorkRequestCollection from .work_request_error import WorkRequestError @@ -155,11 +201,17 @@ "ChangeJobCompartmentDetails": ChangeJobCompartmentDetails, "ChangeManagedDatabaseGroupCompartmentDetails": ChangeManagedDatabaseGroupCompartmentDetails, "ChildDatabase": ChildDatabase, + "CloneSqlTuningTaskDetails": CloneSqlTuningTaskDetails, "ClusterCacheMetric": ClusterCacheMetric, + "ConsumerGroupPrivilegeCollection": ConsumerGroupPrivilegeCollection, + "ConsumerGroupPrivilegeSummary": ConsumerGroupPrivilegeSummary, + "CpuUtilizationAggregateMetrics": CpuUtilizationAggregateMetrics, "CreateDbManagementPrivateEndpointDetails": CreateDbManagementPrivateEndpointDetails, "CreateJobDetails": CreateJobDetails, "CreateManagedDatabaseGroupDetails": CreateManagedDatabaseGroupDetails, "CreateSqlJobDetails": CreateSqlJobDetails, + "DataAccessContainerCollection": DataAccessContainerCollection, + "DataAccessContainerSummary": DataAccessContainerSummary, "DatabaseCredentials": DatabaseCredentials, "DatabaseFleetHealthMetrics": DatabaseFleetHealthMetrics, "DatabaseHomeMetricDefinition": DatabaseHomeMetricDefinition, @@ -176,6 +228,9 @@ "DbManagementPrivateEndpoint": DbManagementPrivateEndpoint, "DbManagementPrivateEndpointCollection": DbManagementPrivateEndpointCollection, "DbManagementPrivateEndpointSummary": DbManagementPrivateEndpointSummary, + "DropSqlTuningTaskDetails": DropSqlTuningTaskDetails, + "ExecutionPlanStatsComparision": ExecutionPlanStatsComparision, + "FailedConnectionsAggregateMetrics": FailedConnectionsAggregateMetrics, "FleetMetricDefinition": FleetMetricDefinition, "FleetMetricSummaryDefinition": FleetMetricSummaryDefinition, "FleetStatusByCategory": FleetStatusByCategory, @@ -205,14 +260,48 @@ "MemoryAggregateMetrics": MemoryAggregateMetrics, "MetricDataPoint": MetricDataPoint, "MetricDimensionDefinition": MetricDimensionDefinition, + "ObjectPrivilegeCollection": ObjectPrivilegeCollection, + "ObjectPrivilegeSummary": ObjectPrivilegeSummary, "ObjectStorageJobExecutionResultDetails": ObjectStorageJobExecutionResultDetails, "ObjectStorageJobExecutionResultLocation": ObjectStorageJobExecutionResultLocation, "ParentGroup": ParentGroup, "PdbMetrics": PdbMetrics, "PdbStatusDetails": PdbStatusDetails, + "ProxiedForUserCollection": ProxiedForUserCollection, + "ProxiedForUserSummary": ProxiedForUserSummary, + "ProxyUserCollection": ProxyUserCollection, + "ProxyUserSummary": ProxyUserSummary, "RemoveManagedDatabaseFromManagedDatabaseGroupDetails": RemoveManagedDatabaseFromManagedDatabaseGroupDetails, "ResetDatabaseParametersDetails": ResetDatabaseParametersDetails, + "RoleCollection": RoleCollection, + "RoleSummary": RoleSummary, "SqlJob": SqlJob, + "SqlTuningAdvisorTaskCollection": SqlTuningAdvisorTaskCollection, + "SqlTuningAdvisorTaskFindingCollection": SqlTuningAdvisorTaskFindingCollection, + "SqlTuningAdvisorTaskFindingSummary": SqlTuningAdvisorTaskFindingSummary, + "SqlTuningAdvisorTaskRecommendationCollection": SqlTuningAdvisorTaskRecommendationCollection, + "SqlTuningAdvisorTaskRecommendationSummary": SqlTuningAdvisorTaskRecommendationSummary, + "SqlTuningAdvisorTaskSqlExecutionPlan": SqlTuningAdvisorTaskSqlExecutionPlan, + "SqlTuningAdvisorTaskSummary": SqlTuningAdvisorTaskSummary, + "SqlTuningAdvisorTaskSummaryFindingBenefits": SqlTuningAdvisorTaskSummaryFindingBenefits, + "SqlTuningAdvisorTaskSummaryFindingCounts": SqlTuningAdvisorTaskSummaryFindingCounts, + "SqlTuningAdvisorTaskSummaryReport": SqlTuningAdvisorTaskSummaryReport, + "SqlTuningAdvisorTaskSummaryReportIndexFindingSummary": SqlTuningAdvisorTaskSummaryReportIndexFindingSummary, + "SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary": SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary, + "SqlTuningAdvisorTaskSummaryReportStatementCounts": SqlTuningAdvisorTaskSummaryReportStatementCounts, + "SqlTuningAdvisorTaskSummaryReportStatistics": SqlTuningAdvisorTaskSummaryReportStatistics, + "SqlTuningAdvisorTaskSummaryReportTaskInfo": SqlTuningAdvisorTaskSummaryReportTaskInfo, + "SqlTuningTaskCredentialDetails": SqlTuningTaskCredentialDetails, + "SqlTuningTaskPasswordCredentialDetails": SqlTuningTaskPasswordCredentialDetails, + "SqlTuningTaskPlanStats": SqlTuningTaskPlanStats, + "SqlTuningTaskReturn": SqlTuningTaskReturn, + "SqlTuningTaskSecretCredentialDetails": SqlTuningTaskSecretCredentialDetails, + "SqlTuningTaskSqlDetail": SqlTuningTaskSqlDetail, + "SqlTuningTaskSqlExecutionPlanStep": SqlTuningTaskSqlExecutionPlanStep, + "StartSqlTuningTaskDetails": StartSqlTuningTaskDetails, + "StatementsAggregateMetrics": StatementsAggregateMetrics, + "SystemPrivilegeCollection": SystemPrivilegeCollection, + "SystemPrivilegeSummary": SystemPrivilegeSummary, "Tablespace": Tablespace, "TablespaceCollection": TablespaceCollection, "TablespaceSummary": TablespaceSummary, @@ -223,6 +312,9 @@ "UpdateJobDetails": UpdateJobDetails, "UpdateManagedDatabaseGroupDetails": UpdateManagedDatabaseGroupDetails, "UpdateSqlJobDetails": UpdateSqlJobDetails, + "User": User, + "UserCollection": UserCollection, + "UserSummary": UserSummary, "WorkRequest": WorkRequest, "WorkRequestCollection": WorkRequestCollection, "WorkRequestError": WorkRequestError, diff --git a/src/oci/database_management/models/associated_database_summary.py b/src/oci/database_management/models/associated_database_summary.py index b6c67ba481..255cf87395 100644 --- a/src/oci/database_management/models/associated_database_summary.py +++ b/src/oci/database_management/models/associated_database_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AssociatedDatabaseSummary(object): """ - Summary of a Database currently using a Private Endpoint. + The summary of a database currently using a Database Management private endpoint. """ def __init__(self, **kwargs): @@ -58,7 +58,9 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this AssociatedDatabaseSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this AssociatedDatabaseSummary. @@ -70,7 +72,9 @@ def id(self): def id(self, id): """ Sets the id of this AssociatedDatabaseSummary. - The OCID of the database. + The `OCID`__ of the database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this AssociatedDatabaseSummary. @@ -106,7 +110,9 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this AssociatedDatabaseSummary. - The compartment ID of the database. + The compartment `OCID`__ of the database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this AssociatedDatabaseSummary. @@ -118,7 +124,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this AssociatedDatabaseSummary. - The compartment ID of the database. + The compartment `OCID`__ of the database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this AssociatedDatabaseSummary. @@ -130,7 +138,7 @@ def compartment_id(self, compartment_id): def time_registered(self): """ **[Required]** Gets the time_registered of this AssociatedDatabaseSummary. - The time when the database was registered for Database Management. + The time when Database Management was enabled for the database. :return: The time_registered of this AssociatedDatabaseSummary. @@ -142,7 +150,7 @@ def time_registered(self): def time_registered(self, time_registered): """ Sets the time_registered of this AssociatedDatabaseSummary. - The time when the database was registered for Database Management. + The time when Database Management was enabled for the database. :param time_registered: The time_registered of this AssociatedDatabaseSummary. diff --git a/src/oci/database_management/models/change_db_management_private_endpoint_compartment_details.py b/src/oci/database_management/models/change_db_management_private_endpoint_compartment_details.py index cf4856b933..7d72473337 100644 --- a/src/oci/database_management/models/change_db_management_private_endpoint_compartment_details.py +++ b/src/oci/database_management/models/change_db_management_private_endpoint_compartment_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ChangeDbManagementPrivateEndpointCompartmentDetails(object): """ - The details used to change the compartment of a Database Management private endpoint. + The details used to move the Database Management private endpoint to another compartment. """ def __init__(self, **kwargs): @@ -37,7 +37,9 @@ def __init__(self, **kwargs): def compartment_id(self): """ Gets the compartment_id of this ChangeDbManagementPrivateEndpointCompartmentDetails. - The OCID of the new compartment. + The `OCID`__ of the compartment to which the Database Management private endpoint needs to be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this ChangeDbManagementPrivateEndpointCompartmentDetails. @@ -49,7 +51,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ChangeDbManagementPrivateEndpointCompartmentDetails. - The OCID of the new compartment. + The `OCID`__ of the compartment to which the Database Management private endpoint needs to be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this ChangeDbManagementPrivateEndpointCompartmentDetails. diff --git a/src/oci/database_management/models/child_database.py b/src/oci/database_management/models/child_database.py index 1c131d4b0b..73ed3f037e 100644 --- a/src/oci/database_management/models/child_database.py +++ b/src/oci/database_management/models/child_database.py @@ -33,6 +33,26 @@ class ChildDatabase(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a ChildDatabase. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + + #: A constant which can be used with the workload_type property of a ChildDatabase. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a ChildDatabase. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a ChildDatabase. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a ChildDatabase. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + #: A constant which can be used with the database_type property of a ChildDatabase. #: This constant has a value of "EXTERNAL_SIDB" DATABASE_TYPE_EXTERNAL_SIDB = "EXTERNAL_SIDB" @@ -49,6 +69,14 @@ class ChildDatabase(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a ChildDatabase. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a ChildDatabase. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a ChildDatabase. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -61,6 +89,14 @@ class ChildDatabase(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a ChildDatabase. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a ChildDatabase. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + def __init__(self, **kwargs): """ Initializes a new ChildDatabase object with values from keyword arguments. @@ -80,19 +116,25 @@ def __init__(self, **kwargs): :param deployment_type: The value to assign to the deployment_type property of this ChildDatabase. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str + :param workload_type: + The value to assign to the workload_type property of this ChildDatabase. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param database_type: The value to assign to the database_type property of this ChildDatabase. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this ChildDatabase. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str @@ -106,6 +148,7 @@ def __init__(self, **kwargs): 'name': 'str', 'compartment_id': 'str', 'deployment_type': 'str', + 'workload_type': 'str', 'database_type': 'str', 'database_sub_type': 'str', 'time_added': 'datetime' @@ -116,6 +159,7 @@ def __init__(self, **kwargs): 'name': 'name', 'compartment_id': 'compartmentId', 'deployment_type': 'deploymentType', + 'workload_type': 'workloadType', 'database_type': 'databaseType', 'database_sub_type': 'databaseSubType', 'time_added': 'timeAdded' @@ -125,6 +169,7 @@ def __init__(self, **kwargs): self._name = None self._compartment_id = None self._deployment_type = None + self._workload_type = None self._database_type = None self._database_sub_type = None self._time_added = None @@ -215,7 +260,7 @@ def deployment_type(self): Gets the deployment_type of this ChildDatabase. The infrastructure used to deploy the Oracle Database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -234,18 +279,48 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this ChildDatabase. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type + @property + def workload_type(self): + """ + Gets the workload_type of this ChildDatabase. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this ChildDatabase. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this ChildDatabase. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this ChildDatabase. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def database_type(self): """ Gets the database_type of this ChildDatabase. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -264,7 +339,7 @@ def database_type(self, database_type): :param database_type: The database_type of this ChildDatabase. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -273,9 +348,10 @@ def database_type(self, database_type): def database_sub_type(self): """ Gets the database_sub_type of this ChildDatabase. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -288,13 +364,14 @@ def database_sub_type(self): def database_sub_type(self, database_sub_type): """ Sets the database_sub_type of this ChildDatabase. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. :param database_sub_type: The database_sub_type of this ChildDatabase. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type diff --git a/src/oci/database_management/models/clone_sql_tuning_task_details.py b/src/oci/database_management/models/clone_sql_tuning_task_details.py new file mode 100644 index 0000000000..083a7415b4 --- /dev/null +++ b/src/oci/database_management/models/clone_sql_tuning_task_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 CloneSqlTuningTaskDetails(object): + """ + Request to clone and run a SQL tuning task. The new task uses same inputs as the one being cloned. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CloneSqlTuningTaskDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param task_name: + The value to assign to the task_name property of this CloneSqlTuningTaskDetails. + :type task_name: str + + :param original_task_id: + The value to assign to the original_task_id property of this CloneSqlTuningTaskDetails. + :type original_task_id: int + + :param task_description: + The value to assign to the task_description property of this CloneSqlTuningTaskDetails. + :type task_description: str + + :param credential_details: + The value to assign to the credential_details property of this CloneSqlTuningTaskDetails. + :type credential_details: oci.database_management.models.SqlTuningTaskCredentialDetails + + """ + self.swagger_types = { + 'task_name': 'str', + 'original_task_id': 'int', + 'task_description': 'str', + 'credential_details': 'SqlTuningTaskCredentialDetails' + } + + self.attribute_map = { + 'task_name': 'taskName', + 'original_task_id': 'originalTaskId', + 'task_description': 'taskDescription', + 'credential_details': 'credentialDetails' + } + + self._task_name = None + self._original_task_id = None + self._task_description = None + self._credential_details = None + + @property + def task_name(self): + """ + **[Required]** Gets the task_name of this CloneSqlTuningTaskDetails. + The name of the SQL tuning task. The name is unique per user in a database, and it is case sensitive. + + + :return: The task_name of this CloneSqlTuningTaskDetails. + :rtype: str + """ + return self._task_name + + @task_name.setter + def task_name(self, task_name): + """ + Sets the task_name of this CloneSqlTuningTaskDetails. + The name of the SQL tuning task. The name is unique per user in a database, and it is case sensitive. + + + :param task_name: The task_name of this CloneSqlTuningTaskDetails. + :type: str + """ + self._task_name = task_name + + @property + def original_task_id(self): + """ + **[Required]** Gets the original_task_id of this CloneSqlTuningTaskDetails. + The identifier of the task being cloned. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The original_task_id of this CloneSqlTuningTaskDetails. + :rtype: int + """ + return self._original_task_id + + @original_task_id.setter + def original_task_id(self, original_task_id): + """ + Sets the original_task_id of this CloneSqlTuningTaskDetails. + The identifier of the task being cloned. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param original_task_id: The original_task_id of this CloneSqlTuningTaskDetails. + :type: int + """ + self._original_task_id = original_task_id + + @property + def task_description(self): + """ + Gets the task_description of this CloneSqlTuningTaskDetails. + The description of the SQL tuning task. + + + :return: The task_description of this CloneSqlTuningTaskDetails. + :rtype: str + """ + return self._task_description + + @task_description.setter + def task_description(self, task_description): + """ + Sets the task_description of this CloneSqlTuningTaskDetails. + The description of the SQL tuning task. + + + :param task_description: The task_description of this CloneSqlTuningTaskDetails. + :type: str + """ + self._task_description = task_description + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this CloneSqlTuningTaskDetails. + + :return: The credential_details of this CloneSqlTuningTaskDetails. + :rtype: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this CloneSqlTuningTaskDetails. + + :param credential_details: The credential_details of this CloneSqlTuningTaskDetails. + :type: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + self._credential_details = credential_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/database_management/models/consumer_group_privilege_collection.py b/src/oci/database_management/models/consumer_group_privilege_collection.py new file mode 100644 index 0000000000..5aaff9e463 --- /dev/null +++ b/src/oci/database_management/models/consumer_group_privilege_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ConsumerGroupPrivilegeCollection(object): + """ + A collection of ConsumerGroupPrivileges granted to the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConsumerGroupPrivilegeCollection 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 ConsumerGroupPrivilegeCollection. + :type items: list[oci.database_management.models.ConsumerGroupPrivilegeSummary] + + """ + self.swagger_types = { + 'items': 'list[ConsumerGroupPrivilegeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ConsumerGroupPrivilegeCollection. + An array of User resources. + + + :return: The items of this ConsumerGroupPrivilegeCollection. + :rtype: list[oci.database_management.models.ConsumerGroupPrivilegeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ConsumerGroupPrivilegeCollection. + An array of User resources. + + + :param items: The items of this ConsumerGroupPrivilegeCollection. + :type: list[oci.database_management.models.ConsumerGroupPrivilegeSummary] + """ + 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/database_management/models/consumer_group_privilege_summary.py b/src/oci/database_management/models/consumer_group_privilege_summary.py new file mode 100644 index 0000000000..7c140d6263 --- /dev/null +++ b/src/oci/database_management/models/consumer_group_privilege_summary.py @@ -0,0 +1,164 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ConsumerGroupPrivilegeSummary(object): + """ + Summary of consumerGroupPrivileges. + """ + + #: A constant which can be used with the grant_option property of a ConsumerGroupPrivilegeSummary. + #: This constant has a value of "YES" + GRANT_OPTION_YES = "YES" + + #: A constant which can be used with the grant_option property of a ConsumerGroupPrivilegeSummary. + #: This constant has a value of "NO" + GRANT_OPTION_NO = "NO" + + #: A constant which can be used with the initial_group property of a ConsumerGroupPrivilegeSummary. + #: This constant has a value of "YES" + INITIAL_GROUP_YES = "YES" + + #: A constant which can be used with the initial_group property of a ConsumerGroupPrivilegeSummary. + #: This constant has a value of "NO" + INITIAL_GROUP_NO = "NO" + + def __init__(self, **kwargs): + """ + Initializes a new ConsumerGroupPrivilegeSummary 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 ConsumerGroupPrivilegeSummary. + :type name: str + + :param grant_option: + The value to assign to the grant_option property of this ConsumerGroupPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type grant_option: str + + :param initial_group: + The value to assign to the initial_group property of this ConsumerGroupPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type initial_group: str + + """ + self.swagger_types = { + 'name': 'str', + 'grant_option': 'str', + 'initial_group': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'grant_option': 'grantOption', + 'initial_group': 'initialGroup' + } + + self._name = None + self._grant_option = None + self._initial_group = None + + @property + def name(self): + """ + Gets the name of this ConsumerGroupPrivilegeSummary. + The name of granted consumer group. + + + :return: The name of this ConsumerGroupPrivilegeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConsumerGroupPrivilegeSummary. + The name of granted consumer group. + + + :param name: The name of this ConsumerGroupPrivilegeSummary. + :type: str + """ + self._name = name + + @property + def grant_option(self): + """ + Gets the grant_option of this ConsumerGroupPrivilegeSummary. + Indicates whether the grant was with the GRANT option (YES) or not (NO). + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The grant_option of this ConsumerGroupPrivilegeSummary. + :rtype: str + """ + return self._grant_option + + @grant_option.setter + def grant_option(self, grant_option): + """ + Sets the grant_option of this ConsumerGroupPrivilegeSummary. + Indicates whether the grant was with the GRANT option (YES) or not (NO). + + + :param grant_option: The grant_option of this ConsumerGroupPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(grant_option, allowed_values): + grant_option = 'UNKNOWN_ENUM_VALUE' + self._grant_option = grant_option + + @property + def initial_group(self): + """ + Gets the initial_group of this ConsumerGroupPrivilegeSummary. + Indicates whether the consumer group is designated as the default for this user or role (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The initial_group of this ConsumerGroupPrivilegeSummary. + :rtype: str + """ + return self._initial_group + + @initial_group.setter + def initial_group(self, initial_group): + """ + Sets the initial_group of this ConsumerGroupPrivilegeSummary. + Indicates whether the consumer group is designated as the default for this user or role (YES) or not (NO) + + + :param initial_group: The initial_group of this ConsumerGroupPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(initial_group, allowed_values): + initial_group = 'UNKNOWN_ENUM_VALUE' + self._initial_group = initial_group + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/cpu_utilization_aggregate_metrics.py b/src/oci/database_management/models/cpu_utilization_aggregate_metrics.py new file mode 100644 index 0000000000..f9ee0e4b11 --- /dev/null +++ b/src/oci/database_management/models/cpu_utilization_aggregate_metrics.py @@ -0,0 +1,66 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 CpuUtilizationAggregateMetrics(object): + """ + The CPU utilization metrics for Autonomous Databases. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CpuUtilizationAggregateMetrics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cpu_utilization: + The value to assign to the cpu_utilization property of this CpuUtilizationAggregateMetrics. + :type cpu_utilization: oci.database_management.models.MetricDataPoint + + """ + self.swagger_types = { + 'cpu_utilization': 'MetricDataPoint' + } + + self.attribute_map = { + 'cpu_utilization': 'cpuUtilization' + } + + self._cpu_utilization = None + + @property + def cpu_utilization(self): + """ + Gets the cpu_utilization of this CpuUtilizationAggregateMetrics. + + :return: The cpu_utilization of this CpuUtilizationAggregateMetrics. + :rtype: oci.database_management.models.MetricDataPoint + """ + return self._cpu_utilization + + @cpu_utilization.setter + def cpu_utilization(self, cpu_utilization): + """ + Sets the cpu_utilization of this CpuUtilizationAggregateMetrics. + + :param cpu_utilization: The cpu_utilization of this CpuUtilizationAggregateMetrics. + :type: oci.database_management.models.MetricDataPoint + """ + self._cpu_utilization = cpu_utilization + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/create_db_management_private_endpoint_details.py b/src/oci/database_management/models/create_db_management_private_endpoint_details.py index dac228d0e6..6f2a691d60 100644 --- a/src/oci/database_management/models/create_db_management_private_endpoint_details.py +++ b/src/oci/database_management/models/create_db_management_private_endpoint_details.py @@ -26,6 +26,10 @@ def __init__(self, **kwargs): The value to assign to the compartment_id property of this CreateDbManagementPrivateEndpointDetails. :type compartment_id: str + :param is_cluster: + The value to assign to the is_cluster property of this CreateDbManagementPrivateEndpointDetails. + :type is_cluster: bool + :param subnet_id: The value to assign to the subnet_id property of this CreateDbManagementPrivateEndpointDetails. :type subnet_id: str @@ -42,6 +46,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'name': 'str', 'compartment_id': 'str', + 'is_cluster': 'bool', 'subnet_id': 'str', 'description': 'str', 'nsg_ids': 'list[str]' @@ -50,6 +55,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'name': 'name', 'compartment_id': 'compartmentId', + 'is_cluster': 'isCluster', 'subnet_id': 'subnetId', 'description': 'description', 'nsg_ids': 'nsgIds' @@ -57,6 +63,7 @@ def __init__(self, **kwargs): self._name = None self._compartment_id = None + self._is_cluster = None self._subnet_id = None self._description = None self._nsg_ids = None @@ -65,7 +72,7 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this CreateDbManagementPrivateEndpointDetails. - The display name for the private endpoint. It is changeable. + The display name of the Database Management private endpoint. :return: The name of this CreateDbManagementPrivateEndpointDetails. @@ -77,7 +84,7 @@ def name(self): def name(self, name): """ Sets the name of this CreateDbManagementPrivateEndpointDetails. - The display name for the private endpoint. It is changeable. + The display name of the Database Management private endpoint. :param name: The name of this CreateDbManagementPrivateEndpointDetails. @@ -89,7 +96,9 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateDbManagementPrivateEndpointDetails. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateDbManagementPrivateEndpointDetails. @@ -101,7 +110,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateDbManagementPrivateEndpointDetails. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateDbManagementPrivateEndpointDetails. @@ -109,11 +120,37 @@ def compartment_id(self, compartment_id): """ self._compartment_id = compartment_id + @property + def is_cluster(self): + """ + Gets the is_cluster of this CreateDbManagementPrivateEndpointDetails. + Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster. + + + :return: The is_cluster of this CreateDbManagementPrivateEndpointDetails. + :rtype: bool + """ + return self._is_cluster + + @is_cluster.setter + def is_cluster(self, is_cluster): + """ + Sets the is_cluster of this CreateDbManagementPrivateEndpointDetails. + Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster. + + + :param is_cluster: The is_cluster of this CreateDbManagementPrivateEndpointDetails. + :type: bool + """ + self._is_cluster = is_cluster + @property def subnet_id(self): """ **[Required]** Gets the subnet_id of this CreateDbManagementPrivateEndpointDetails. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this CreateDbManagementPrivateEndpointDetails. @@ -125,7 +162,9 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this CreateDbManagementPrivateEndpointDetails. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this CreateDbManagementPrivateEndpointDetails. @@ -161,7 +200,7 @@ def description(self, description): def nsg_ids(self): """ Gets the nsg_ids of this CreateDbManagementPrivateEndpointDetails. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :return: The nsg_ids of this CreateDbManagementPrivateEndpointDetails. @@ -173,7 +212,7 @@ def nsg_ids(self): def nsg_ids(self, nsg_ids): """ Sets the nsg_ids of this CreateDbManagementPrivateEndpointDetails. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :param nsg_ids: The nsg_ids of this CreateDbManagementPrivateEndpointDetails. diff --git a/src/oci/database_management/models/create_job_details.py b/src/oci/database_management/models/create_job_details.py index 07e91af7f5..39a7e9f4cf 100644 --- a/src/oci/database_management/models/create_job_details.py +++ b/src/oci/database_management/models/create_job_details.py @@ -25,6 +25,14 @@ class CreateJobDetails(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a CreateJobDetails. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a CreateJobDetails. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the job_type property of a CreateJobDetails. #: This constant has a value of "SQL" JOB_TYPE_SQL = "SQL" @@ -60,7 +68,7 @@ def __init__(self, **kwargs): :param database_sub_type: The value to assign to the database_sub_type property of this CreateJobDetails. - Allowed values for this property are: "CDB", "PDB", "NON_CDB" + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB" :type database_sub_type: str :param schedule_type: @@ -280,7 +288,7 @@ def database_sub_type(self): Gets the database_sub_type of this CreateJobDetails. The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided. - Allowed values for this property are: "CDB", "PDB", "NON_CDB" + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB" :return: The database_sub_type of this CreateJobDetails. @@ -298,7 +306,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this CreateJobDetails. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): raise ValueError( "Invalid value for `database_sub_type`, must be None or one of {0}" diff --git a/src/oci/database_management/models/create_sql_job_details.py b/src/oci/database_management/models/create_sql_job_details.py index 084bbce56b..88ab2263b1 100644 --- a/src/oci/database_management/models/create_sql_job_details.py +++ b/src/oci/database_management/models/create_sql_job_details.py @@ -41,7 +41,7 @@ def __init__(self, **kwargs): :param database_sub_type: The value to assign to the database_sub_type property of this CreateSqlJobDetails. - Allowed values for this property are: "CDB", "PDB", "NON_CDB" + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB" :type database_sub_type: str :param schedule_type: diff --git a/src/oci/database_management/models/data_access_container_collection.py b/src/oci/database_management/models/data_access_container_collection.py new file mode 100644 index 0000000000..0ef2dfc86e --- /dev/null +++ b/src/oci/database_management/models/data_access_container_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DataAccessContainerCollection(object): + """ + A collection of Containers if it does not apply to all containers for the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataAccessContainerCollection 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 DataAccessContainerCollection. + :type items: list[oci.database_management.models.DataAccessContainerSummary] + + """ + self.swagger_types = { + 'items': 'list[DataAccessContainerSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DataAccessContainerCollection. + An array of Container resources. + + + :return: The items of this DataAccessContainerCollection. + :rtype: list[oci.database_management.models.DataAccessContainerSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DataAccessContainerCollection. + An array of Container resources. + + + :param items: The items of this DataAccessContainerCollection. + :type: list[oci.database_management.models.DataAccessContainerSummary] + """ + 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/database_management/models/data_access_container_summary.py b/src/oci/database_management/models/data_access_container_summary.py new file mode 100644 index 0000000000..0d11447b15 --- /dev/null +++ b/src/oci/database_management/models/data_access_container_summary.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DataAccessContainerSummary(object): + """ + Summary of ContainerDataAccess user + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataAccessContainerSummary 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 DataAccessContainerSummary. + :type name: str + + """ + self.swagger_types = { + 'name': 'str' + } + + self.attribute_map = { + 'name': 'name' + } + + self._name = None + + @property + def name(self): + """ + Gets the name of this DataAccessContainerSummary. + The name of a container included in this attribute if it does not apply to all containers. + + + :return: The name of this DataAccessContainerSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataAccessContainerSummary. + The name of a container included in this attribute if it does not apply to all containers. + + + :param name: The name of this DataAccessContainerSummary. + :type: str + """ + self._name = name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/database_home_metric_definition.py b/src/oci/database_management/models/database_home_metric_definition.py index b6c94c661c..bfe82db1e8 100644 --- a/src/oci/database_management/models/database_home_metric_definition.py +++ b/src/oci/database_management/models/database_home_metric_definition.py @@ -38,13 +38,28 @@ def __init__(self, **kwargs): The value to assign to the db_storage_aggregate_metrics property of this DatabaseHomeMetricDefinition. :type db_storage_aggregate_metrics: oci.database_management.models.DatabaseStorageAggregateMetrics + :param cpu_utilization_aggregate_metrics: + The value to assign to the cpu_utilization_aggregate_metrics property of this DatabaseHomeMetricDefinition. + :type cpu_utilization_aggregate_metrics: oci.database_management.models.CpuUtilizationAggregateMetrics + + :param statements_aggregate_metrics: + The value to assign to the statements_aggregate_metrics property of this DatabaseHomeMetricDefinition. + :type statements_aggregate_metrics: oci.database_management.models.StatementsAggregateMetrics + + :param failed_connections_aggregate_metrics: + The value to assign to the failed_connections_aggregate_metrics property of this DatabaseHomeMetricDefinition. + :type failed_connections_aggregate_metrics: oci.database_management.models.FailedConnectionsAggregateMetrics + """ self.swagger_types = { 'activity_time_series_metrics': 'list[ActivityTimeSeriesMetrics]', 'db_time_aggregate_metrics': 'DatabaseTimeAggregateMetrics', 'io_aggregate_metrics': 'DatabaseIOAggregateMetrics', 'memory_aggregate_metrics': 'MemoryAggregateMetrics', - 'db_storage_aggregate_metrics': 'DatabaseStorageAggregateMetrics' + 'db_storage_aggregate_metrics': 'DatabaseStorageAggregateMetrics', + 'cpu_utilization_aggregate_metrics': 'CpuUtilizationAggregateMetrics', + 'statements_aggregate_metrics': 'StatementsAggregateMetrics', + 'failed_connections_aggregate_metrics': 'FailedConnectionsAggregateMetrics' } self.attribute_map = { @@ -52,7 +67,10 @@ def __init__(self, **kwargs): 'db_time_aggregate_metrics': 'dbTimeAggregateMetrics', 'io_aggregate_metrics': 'ioAggregateMetrics', 'memory_aggregate_metrics': 'memoryAggregateMetrics', - 'db_storage_aggregate_metrics': 'dbStorageAggregateMetrics' + 'db_storage_aggregate_metrics': 'dbStorageAggregateMetrics', + 'cpu_utilization_aggregate_metrics': 'cpuUtilizationAggregateMetrics', + 'statements_aggregate_metrics': 'statementsAggregateMetrics', + 'failed_connections_aggregate_metrics': 'failedConnectionsAggregateMetrics' } self._activity_time_series_metrics = None @@ -60,6 +78,9 @@ def __init__(self, **kwargs): self._io_aggregate_metrics = None self._memory_aggregate_metrics = None self._db_storage_aggregate_metrics = None + self._cpu_utilization_aggregate_metrics = None + self._statements_aggregate_metrics = None + self._failed_connections_aggregate_metrics = None @property def activity_time_series_metrics(self): @@ -165,6 +186,66 @@ def db_storage_aggregate_metrics(self, db_storage_aggregate_metrics): """ self._db_storage_aggregate_metrics = db_storage_aggregate_metrics + @property + def cpu_utilization_aggregate_metrics(self): + """ + Gets the cpu_utilization_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :return: The cpu_utilization_aggregate_metrics of this DatabaseHomeMetricDefinition. + :rtype: oci.database_management.models.CpuUtilizationAggregateMetrics + """ + return self._cpu_utilization_aggregate_metrics + + @cpu_utilization_aggregate_metrics.setter + def cpu_utilization_aggregate_metrics(self, cpu_utilization_aggregate_metrics): + """ + Sets the cpu_utilization_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :param cpu_utilization_aggregate_metrics: The cpu_utilization_aggregate_metrics of this DatabaseHomeMetricDefinition. + :type: oci.database_management.models.CpuUtilizationAggregateMetrics + """ + self._cpu_utilization_aggregate_metrics = cpu_utilization_aggregate_metrics + + @property + def statements_aggregate_metrics(self): + """ + Gets the statements_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :return: The statements_aggregate_metrics of this DatabaseHomeMetricDefinition. + :rtype: oci.database_management.models.StatementsAggregateMetrics + """ + return self._statements_aggregate_metrics + + @statements_aggregate_metrics.setter + def statements_aggregate_metrics(self, statements_aggregate_metrics): + """ + Sets the statements_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :param statements_aggregate_metrics: The statements_aggregate_metrics of this DatabaseHomeMetricDefinition. + :type: oci.database_management.models.StatementsAggregateMetrics + """ + self._statements_aggregate_metrics = statements_aggregate_metrics + + @property + def failed_connections_aggregate_metrics(self): + """ + Gets the failed_connections_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :return: The failed_connections_aggregate_metrics of this DatabaseHomeMetricDefinition. + :rtype: oci.database_management.models.FailedConnectionsAggregateMetrics + """ + return self._failed_connections_aggregate_metrics + + @failed_connections_aggregate_metrics.setter + def failed_connections_aggregate_metrics(self, failed_connections_aggregate_metrics): + """ + Sets the failed_connections_aggregate_metrics of this DatabaseHomeMetricDefinition. + + :param failed_connections_aggregate_metrics: The failed_connections_aggregate_metrics of this DatabaseHomeMetricDefinition. + :type: oci.database_management.models.FailedConnectionsAggregateMetrics + """ + self._failed_connections_aggregate_metrics = failed_connections_aggregate_metrics + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/database_management/models/database_instance_home_metrics_definition.py b/src/oci/database_management/models/database_instance_home_metrics_definition.py index 4f2bf6670b..5e3b00af9b 100644 --- a/src/oci/database_management/models/database_instance_home_metrics_definition.py +++ b/src/oci/database_management/models/database_instance_home_metrics_definition.py @@ -44,6 +44,10 @@ def __init__(self, **kwargs): The value to assign to the memory_aggregate_metrics property of this DatabaseInstanceHomeMetricsDefinition. :type memory_aggregate_metrics: oci.database_management.models.MemoryAggregateMetrics + :param cpu_utilization_aggregate_metrics: + The value to assign to the cpu_utilization_aggregate_metrics property of this DatabaseInstanceHomeMetricsDefinition. + :type cpu_utilization_aggregate_metrics: oci.database_management.models.CpuUtilizationAggregateMetrics + """ self.swagger_types = { 'instance_name': 'str', @@ -51,7 +55,8 @@ def __init__(self, **kwargs): 'activity_time_series_metrics': 'list[ActivityTimeSeriesMetrics]', 'db_time_aggregate_metrics': 'DatabaseTimeAggregateMetrics', 'io_aggregate_metrics': 'DatabaseIOAggregateMetrics', - 'memory_aggregate_metrics': 'MemoryAggregateMetrics' + 'memory_aggregate_metrics': 'MemoryAggregateMetrics', + 'cpu_utilization_aggregate_metrics': 'CpuUtilizationAggregateMetrics' } self.attribute_map = { @@ -60,7 +65,8 @@ def __init__(self, **kwargs): 'activity_time_series_metrics': 'activityTimeSeriesMetrics', 'db_time_aggregate_metrics': 'dbTimeAggregateMetrics', 'io_aggregate_metrics': 'ioAggregateMetrics', - 'memory_aggregate_metrics': 'memoryAggregateMetrics' + 'memory_aggregate_metrics': 'memoryAggregateMetrics', + 'cpu_utilization_aggregate_metrics': 'cpuUtilizationAggregateMetrics' } self._instance_name = None @@ -69,6 +75,7 @@ def __init__(self, **kwargs): self._db_time_aggregate_metrics = None self._io_aggregate_metrics = None self._memory_aggregate_metrics = None + self._cpu_utilization_aggregate_metrics = None @property def instance_name(self): @@ -210,6 +217,26 @@ def memory_aggregate_metrics(self, memory_aggregate_metrics): """ self._memory_aggregate_metrics = memory_aggregate_metrics + @property + def cpu_utilization_aggregate_metrics(self): + """ + Gets the cpu_utilization_aggregate_metrics of this DatabaseInstanceHomeMetricsDefinition. + + :return: The cpu_utilization_aggregate_metrics of this DatabaseInstanceHomeMetricsDefinition. + :rtype: oci.database_management.models.CpuUtilizationAggregateMetrics + """ + return self._cpu_utilization_aggregate_metrics + + @cpu_utilization_aggregate_metrics.setter + def cpu_utilization_aggregate_metrics(self, cpu_utilization_aggregate_metrics): + """ + Sets the cpu_utilization_aggregate_metrics of this DatabaseInstanceHomeMetricsDefinition. + + :param cpu_utilization_aggregate_metrics: The cpu_utilization_aggregate_metrics of this DatabaseInstanceHomeMetricsDefinition. + :type: oci.database_management.models.CpuUtilizationAggregateMetrics + """ + self._cpu_utilization_aggregate_metrics = cpu_utilization_aggregate_metrics + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/database_management/models/database_parameters_collection.py b/src/oci/database_management/models/database_parameters_collection.py index f593d096cd..6e87d19fc5 100644 --- a/src/oci/database_management/models/database_parameters_collection.py +++ b/src/oci/database_management/models/database_parameters_collection.py @@ -29,6 +29,14 @@ class DatabaseParametersCollection(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a DatabaseParametersCollection. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a DatabaseParametersCollection. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class DatabaseParametersCollection(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a DatabaseParametersCollection. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + def __init__(self, **kwargs): """ Initializes a new DatabaseParametersCollection object with values from keyword arguments. @@ -52,13 +68,13 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this DatabaseParametersCollection. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this DatabaseParametersCollection. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str @@ -123,7 +139,7 @@ def database_type(self): **[Required]** Gets the database_type of this DatabaseParametersCollection. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -142,7 +158,7 @@ def database_type(self, database_type): :param database_type: The database_type of this DatabaseParametersCollection. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -154,7 +170,7 @@ def database_sub_type(self): The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -174,7 +190,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this DatabaseParametersCollection. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type diff --git a/src/oci/database_management/models/database_usage_metrics.py b/src/oci/database_management/models/database_usage_metrics.py index 9d6063d49c..5a7608537c 100644 --- a/src/oci/database_management/models/database_usage_metrics.py +++ b/src/oci/database_management/models/database_usage_metrics.py @@ -29,6 +29,14 @@ class DatabaseUsageMetrics(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a DatabaseUsageMetrics. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a DatabaseUsageMetrics. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class DatabaseUsageMetrics(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a DatabaseUsageMetrics. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,26 @@ class DatabaseUsageMetrics(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a DatabaseUsageMetrics. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + + #: A constant which can be used with the workload_type property of a DatabaseUsageMetrics. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a DatabaseUsageMetrics. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a DatabaseUsageMetrics. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a DatabaseUsageMetrics. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + def __init__(self, **kwargs): """ Initializes a new DatabaseUsageMetrics object with values from keyword arguments. @@ -76,19 +112,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this DatabaseUsageMetrics. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this DatabaseUsageMetrics. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this DatabaseUsageMetrics. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -96,6 +132,12 @@ def __init__(self, **kwargs): The value to assign to the database_version property of this DatabaseUsageMetrics. :type database_version: str + :param workload_type: + The value to assign to the workload_type property of this DatabaseUsageMetrics. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param database_name: The value to assign to the database_name property of this DatabaseUsageMetrics. :type database_name: str @@ -116,6 +158,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'str', 'deployment_type': 'str', 'database_version': 'str', + 'workload_type': 'str', 'database_name': 'str', 'database_container_id': 'str', 'metrics': 'list[FleetMetricDefinition]' @@ -128,6 +171,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', 'database_version': 'databaseVersion', + 'workload_type': 'workloadType', 'database_name': 'databaseName', 'database_container_id': 'databaseContainerId', 'metrics': 'metrics' @@ -139,6 +183,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._database_version = None + self._workload_type = None self._database_name = None self._database_container_id = None self._metrics = None @@ -205,7 +250,7 @@ def database_type(self): Gets the database_type of this DatabaseUsageMetrics. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -224,7 +269,7 @@ def database_type(self, database_type): :param database_type: The database_type of this DatabaseUsageMetrics. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -233,9 +278,10 @@ def database_type(self, database_type): def database_sub_type(self): """ Gets the database_sub_type of this DatabaseUsageMetrics. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -248,13 +294,14 @@ def database_sub_type(self): def database_sub_type(self, database_sub_type): """ Sets the database_sub_type of this DatabaseUsageMetrics. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. :param database_sub_type: The database_sub_type of this DatabaseUsageMetrics. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -265,7 +312,7 @@ def deployment_type(self): Gets the deployment_type of this DatabaseUsageMetrics. The infrastructure used to deploy the Oracle Database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -284,7 +331,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this DatabaseUsageMetrics. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -313,6 +360,36 @@ def database_version(self, database_version): """ self._database_version = database_version + @property + def workload_type(self): + """ + Gets the workload_type of this DatabaseUsageMetrics. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this DatabaseUsageMetrics. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this DatabaseUsageMetrics. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this DatabaseUsageMetrics. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def database_name(self): """ diff --git a/src/oci/database_management/models/datafile.py b/src/oci/database_management/models/datafile.py index 7b313019cb..2f92270e16 100644 --- a/src/oci/database_management/models/datafile.py +++ b/src/oci/database_management/models/datafile.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Datafile(object): """ - The details of a datafile. + The details of a data file. """ #: A constant which can be used with the status property of a Datafile. @@ -207,7 +207,7 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this Datafile. - The filename (including the path) of the datafile or tempfile. + The filename (including the path) of the data file or temp file. :return: The name of this Datafile. @@ -219,7 +219,7 @@ def name(self): def name(self, name): """ Sets the name of this Datafile. - The filename (including the path) of the datafile or tempfile. + The filename (including the path) of the data file or temp file. :param name: The name of this Datafile. @@ -231,7 +231,7 @@ def name(self, name): def status(self): """ Gets the status of this Datafile. - The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was dropped. + The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed. Allowed values for this property are: "AVAILABLE", "INVALID", "OFFLINE", "ONLINE", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -246,7 +246,7 @@ def status(self): def status(self, status): """ Sets the status of this Datafile. - The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was dropped. + The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed. :param status: The status of this Datafile. @@ -291,7 +291,7 @@ def online_status(self, online_status): def is_auto_extensible(self): """ Gets the is_auto_extensible of this Datafile. - Indicates whether the datafile is auto-extensible. + Indicates whether the data file is auto-extensible. :return: The is_auto_extensible of this Datafile. @@ -303,7 +303,7 @@ def is_auto_extensible(self): def is_auto_extensible(self, is_auto_extensible): """ Sets the is_auto_extensible of this Datafile. - Indicates whether the datafile is auto-extensible. + Indicates whether the data file is auto-extensible. :param is_auto_extensible: The is_auto_extensible of this Datafile. @@ -495,7 +495,7 @@ def increment_by(self, increment_by): def free_space_kb(self): """ Gets the free_space_kb of this Datafile. - The free space available in the datafile in KB. + The free space available in the data file in KB. :return: The free_space_kb of this Datafile. @@ -507,7 +507,7 @@ def free_space_kb(self): def free_space_kb(self, free_space_kb): """ Sets the free_space_kb of this Datafile. - The free space available in the datafile in KB. + The free space available in the data file in KB. :param free_space_kb: The free_space_kb of this Datafile. @@ -519,7 +519,7 @@ def free_space_kb(self, free_space_kb): def used_space_kb(self): """ Gets the used_space_kb of this Datafile. - The total space used in the datafile in KB. + The total space used in the data file in KB. :return: The used_space_kb of this Datafile. @@ -531,7 +531,7 @@ def used_space_kb(self): def used_space_kb(self, used_space_kb): """ Sets the used_space_kb of this Datafile. - The total space used in the datafile in KB. + The total space used in the data file in KB. :param used_space_kb: The used_space_kb of this Datafile. diff --git a/src/oci/database_management/models/db_management_private_endpoint.py b/src/oci/database_management/models/db_management_private_endpoint.py index 24f6ac900d..5840fc9813 100644 --- a/src/oci/database_management/models/db_management_private_endpoint.py +++ b/src/oci/database_management/models/db_management_private_endpoint.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DbManagementPrivateEndpoint(object): """ - A Database Management private endpoint that allows Database Management services to connect to databases in a customer's virtual cloud network (VCN). + A Database Management private endpoint allows Database Management to connect to databases in a Virtual Cloud Network (VCN). """ #: A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. @@ -54,6 +54,10 @@ def __init__(self, **kwargs): The value to assign to the compartment_id property of this DbManagementPrivateEndpoint. :type compartment_id: str + :param is_cluster: + The value to assign to the is_cluster property of this DbManagementPrivateEndpoint. + :type is_cluster: bool + :param vcn_id: The value to assign to the vcn_id property of this DbManagementPrivateEndpoint. :type vcn_id: str @@ -89,6 +93,7 @@ def __init__(self, **kwargs): 'id': 'str', 'name': 'str', 'compartment_id': 'str', + 'is_cluster': 'bool', 'vcn_id': 'str', 'subnet_id': 'str', 'private_ip': 'str', @@ -102,6 +107,7 @@ def __init__(self, **kwargs): 'id': 'id', 'name': 'name', 'compartment_id': 'compartmentId', + 'is_cluster': 'isCluster', 'vcn_id': 'vcnId', 'subnet_id': 'subnetId', 'private_ip': 'privateIp', @@ -114,6 +120,7 @@ def __init__(self, **kwargs): self._id = None self._name = None self._compartment_id = None + self._is_cluster = None self._vcn_id = None self._subnet_id = None self._private_ip = None @@ -126,7 +133,9 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this DbManagementPrivateEndpoint. - The OCID of the Database Management private endpoint. + The `OCID`__ of the Database Management private endpoint. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this DbManagementPrivateEndpoint. @@ -138,7 +147,9 @@ def id(self): def id(self, id): """ Sets the id of this DbManagementPrivateEndpoint. - The OCID of the Database Management private endpoint. + The `OCID`__ of the Database Management private endpoint. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbManagementPrivateEndpoint. @@ -150,7 +161,7 @@ def id(self, id): def name(self): """ **[Required]** Gets the name of this DbManagementPrivateEndpoint. - The display name of the private endpoint. + The display name of the Database Management private endpoint. :return: The name of this DbManagementPrivateEndpoint. @@ -162,7 +173,7 @@ def name(self): def name(self, name): """ Sets the name of this DbManagementPrivateEndpoint. - The display name of the private endpoint. + The display name of the Database Management private endpoint. :param name: The name of this DbManagementPrivateEndpoint. @@ -174,7 +185,9 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbManagementPrivateEndpoint. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbManagementPrivateEndpoint. @@ -186,7 +199,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbManagementPrivateEndpoint. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbManagementPrivateEndpoint. @@ -194,11 +209,37 @@ def compartment_id(self, compartment_id): """ self._compartment_id = compartment_id + @property + def is_cluster(self): + """ + Gets the is_cluster of this DbManagementPrivateEndpoint. + Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster. + + + :return: The is_cluster of this DbManagementPrivateEndpoint. + :rtype: bool + """ + return self._is_cluster + + @is_cluster.setter + def is_cluster(self, is_cluster): + """ + Sets the is_cluster of this DbManagementPrivateEndpoint. + Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster. + + + :param is_cluster: The is_cluster of this DbManagementPrivateEndpoint. + :type: bool + """ + self._is_cluster = is_cluster + @property def vcn_id(self): """ **[Required]** Gets the vcn_id of this DbManagementPrivateEndpoint. - The OCID of the VCN. + The `OCID`__ of the VCN. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The vcn_id of this DbManagementPrivateEndpoint. @@ -210,7 +251,9 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this DbManagementPrivateEndpoint. - The OCID of the VCN. + The `OCID`__ of the VCN. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param vcn_id: The vcn_id of this DbManagementPrivateEndpoint. @@ -222,7 +265,9 @@ def vcn_id(self, vcn_id): def subnet_id(self): """ **[Required]** Gets the subnet_id of this DbManagementPrivateEndpoint. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this DbManagementPrivateEndpoint. @@ -234,7 +279,9 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this DbManagementPrivateEndpoint. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this DbManagementPrivateEndpoint. @@ -246,7 +293,7 @@ def subnet_id(self, subnet_id): def private_ip(self): """ Gets the private_ip of this DbManagementPrivateEndpoint. - The private IP addresses assigned to the private endpoint. + The IP addresses assigned to the Database Management private endpoint. :return: The private_ip of this DbManagementPrivateEndpoint. @@ -258,7 +305,7 @@ def private_ip(self): def private_ip(self, private_ip): """ Sets the private_ip of this DbManagementPrivateEndpoint. - The private IP addresses assigned to the private endpoint. + The IP addresses assigned to the Database Management private endpoint. :param private_ip: The private_ip of this DbManagementPrivateEndpoint. @@ -270,7 +317,7 @@ def private_ip(self, private_ip): def description(self): """ Gets the description of this DbManagementPrivateEndpoint. - The description of the private endpoint. + The description of the Database Management private endpoint. :return: The description of this DbManagementPrivateEndpoint. @@ -282,7 +329,7 @@ def description(self): def description(self, description): """ Sets the description of this DbManagementPrivateEndpoint. - The description of the private endpoint. + The description of the Database Management private endpoint. :param description: The description of this DbManagementPrivateEndpoint. @@ -294,7 +341,7 @@ def description(self, description): def time_created(self): """ Gets the time_created of this DbManagementPrivateEndpoint. - The date and time the private endpoint was created, in the format defined by `RFC3339`__. + The date and time the Database Managament private endpoint was created, in the format defined by `RFC3339`__. __ https://tools.ietf.org/html/rfc3339 @@ -308,7 +355,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this DbManagementPrivateEndpoint. - The date and time the private endpoint was created, in the format defined by `RFC3339`__. + The date and time the Database Managament private endpoint was created, in the format defined by `RFC3339`__. __ https://tools.ietf.org/html/rfc3339 @@ -322,7 +369,7 @@ def time_created(self, time_created): def lifecycle_state(self): """ Gets the lifecycle_state of this DbManagementPrivateEndpoint. - The current state of the private endpoint. + The current lifecycle state of the Database Management private endpoint. 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'. @@ -337,7 +384,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this DbManagementPrivateEndpoint. - The current state of the private endpoint. + The current lifecycle state of the Database Management private endpoint. :param lifecycle_state: The lifecycle_state of this DbManagementPrivateEndpoint. @@ -352,7 +399,7 @@ def lifecycle_state(self, lifecycle_state): def nsg_ids(self): """ Gets the nsg_ids of this DbManagementPrivateEndpoint. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :return: The nsg_ids of this DbManagementPrivateEndpoint. @@ -364,7 +411,7 @@ def nsg_ids(self): def nsg_ids(self, nsg_ids): """ Sets the nsg_ids of this DbManagementPrivateEndpoint. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :param nsg_ids: The nsg_ids of this DbManagementPrivateEndpoint. diff --git a/src/oci/database_management/models/db_management_private_endpoint_summary.py b/src/oci/database_management/models/db_management_private_endpoint_summary.py index 0ba192aef1..1ac5c503eb 100644 --- a/src/oci/database_management/models/db_management_private_endpoint_summary.py +++ b/src/oci/database_management/models/db_management_private_endpoint_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DbManagementPrivateEndpointSummary(object): """ - Summary of a Database Management private endpoint. + The summary of a Database Management private endpoint. """ #: A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpointSummary. @@ -112,7 +112,9 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this DbManagementPrivateEndpointSummary. - The OCID of the Database Management private endpoint. + The `OCID`__ of the Database Management private endpoint. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The id of this DbManagementPrivateEndpointSummary. @@ -124,7 +126,9 @@ def id(self): def id(self, id): """ Sets the id of this DbManagementPrivateEndpointSummary. - The OCID of the Database Management private endpoint. + The `OCID`__ of the Database Management private endpoint. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param id: The id of this DbManagementPrivateEndpointSummary. @@ -136,7 +140,7 @@ def id(self, id): def name(self): """ **[Required]** Gets the name of this DbManagementPrivateEndpointSummary. - The display name of the private endpoint. + The display name of the Database Management private endpoint. :return: The name of this DbManagementPrivateEndpointSummary. @@ -148,7 +152,7 @@ def name(self): def name(self, name): """ Sets the name of this DbManagementPrivateEndpointSummary. - The display name of the private endpoint. + The display name of the Database Management private endpoint. :param name: The name of this DbManagementPrivateEndpointSummary. @@ -160,7 +164,9 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DbManagementPrivateEndpointSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The compartment_id of this DbManagementPrivateEndpointSummary. @@ -172,7 +178,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DbManagementPrivateEndpointSummary. - The OCID of the compartment. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this DbManagementPrivateEndpointSummary. @@ -184,7 +192,9 @@ def compartment_id(self, compartment_id): def vcn_id(self): """ **[Required]** Gets the vcn_id of this DbManagementPrivateEndpointSummary. - The OCID of the VCN. + The `OCID`__ of the VCN. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The vcn_id of this DbManagementPrivateEndpointSummary. @@ -196,7 +206,9 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this DbManagementPrivateEndpointSummary. - The OCID of the VCN. + The `OCID`__ of the VCN. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param vcn_id: The vcn_id of this DbManagementPrivateEndpointSummary. @@ -208,7 +220,9 @@ def vcn_id(self, vcn_id): def subnet_id(self): """ **[Required]** Gets the subnet_id of this DbManagementPrivateEndpointSummary. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :return: The subnet_id of this DbManagementPrivateEndpointSummary. @@ -220,7 +234,9 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this DbManagementPrivateEndpointSummary. - The OCID of the subnet. + The `OCID`__ of the subnet. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this DbManagementPrivateEndpointSummary. @@ -284,7 +300,7 @@ def time_created(self, time_created): def lifecycle_state(self): """ Gets the lifecycle_state of this DbManagementPrivateEndpointSummary. - The current state of the private endpoint. + The current lifecycle state of the private endpoint. 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'. @@ -299,7 +315,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this DbManagementPrivateEndpointSummary. - The current state of the private endpoint. + The current lifecycle state of the private endpoint. :param lifecycle_state: The lifecycle_state of this DbManagementPrivateEndpointSummary. diff --git a/src/oci/database_management/models/drop_sql_tuning_task_details.py b/src/oci/database_management/models/drop_sql_tuning_task_details.py new file mode 100644 index 0000000000..f232a42c73 --- /dev/null +++ b/src/oci/database_management/models/drop_sql_tuning_task_details.py @@ -0,0 +1,105 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 DropSqlTuningTaskDetails(object): + """ + Request to drop a SQL tuning task. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DropSqlTuningTaskDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param task_id: + The value to assign to the task_id property of this DropSqlTuningTaskDetails. + :type task_id: int + + :param credential_details: + The value to assign to the credential_details property of this DropSqlTuningTaskDetails. + :type credential_details: oci.database_management.models.SqlTuningTaskCredentialDetails + + """ + self.swagger_types = { + 'task_id': 'int', + 'credential_details': 'SqlTuningTaskCredentialDetails' + } + + self.attribute_map = { + 'task_id': 'taskId', + 'credential_details': 'credentialDetails' + } + + self._task_id = None + self._credential_details = None + + @property + def task_id(self): + """ + **[Required]** Gets the task_id of this DropSqlTuningTaskDetails. + The identifier of the task being dropped. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The task_id of this DropSqlTuningTaskDetails. + :rtype: int + """ + return self._task_id + + @task_id.setter + def task_id(self, task_id): + """ + Sets the task_id of this DropSqlTuningTaskDetails. + The identifier of the task being dropped. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param task_id: The task_id of this DropSqlTuningTaskDetails. + :type: int + """ + self._task_id = task_id + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this DropSqlTuningTaskDetails. + + :return: The credential_details of this DropSqlTuningTaskDetails. + :rtype: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this DropSqlTuningTaskDetails. + + :param credential_details: The credential_details of this DropSqlTuningTaskDetails. + :type: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + self._credential_details = credential_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/database_management/models/execution_plan_stats_comparision.py b/src/oci/database_management/models/execution_plan_stats_comparision.py new file mode 100644 index 0000000000..81e39bc806 --- /dev/null +++ b/src/oci/database_management/models/execution_plan_stats_comparision.py @@ -0,0 +1,93 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ExecutionPlanStatsComparision(object): + """ + The comparision report of SQL execution plans' statistics between the original plan and modified plan. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ExecutionPlanStatsComparision object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param original: + The value to assign to the original property of this ExecutionPlanStatsComparision. + :type original: oci.database_management.models.SqlTuningTaskPlanStats + + :param modified: + The value to assign to the modified property of this ExecutionPlanStatsComparision. + :type modified: oci.database_management.models.SqlTuningTaskPlanStats + + """ + self.swagger_types = { + 'original': 'SqlTuningTaskPlanStats', + 'modified': 'SqlTuningTaskPlanStats' + } + + self.attribute_map = { + 'original': 'original', + 'modified': 'modified' + } + + self._original = None + self._modified = None + + @property + def original(self): + """ + **[Required]** Gets the original of this ExecutionPlanStatsComparision. + + :return: The original of this ExecutionPlanStatsComparision. + :rtype: oci.database_management.models.SqlTuningTaskPlanStats + """ + return self._original + + @original.setter + def original(self, original): + """ + Sets the original of this ExecutionPlanStatsComparision. + + :param original: The original of this ExecutionPlanStatsComparision. + :type: oci.database_management.models.SqlTuningTaskPlanStats + """ + self._original = original + + @property + def modified(self): + """ + **[Required]** Gets the modified of this ExecutionPlanStatsComparision. + + :return: The modified of this ExecutionPlanStatsComparision. + :rtype: oci.database_management.models.SqlTuningTaskPlanStats + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this ExecutionPlanStatsComparision. + + :param modified: The modified of this ExecutionPlanStatsComparision. + :type: oci.database_management.models.SqlTuningTaskPlanStats + """ + self._modified = modified + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/failed_connections_aggregate_metrics.py b/src/oci/database_management/models/failed_connections_aggregate_metrics.py new file mode 100644 index 0000000000..3c41961c18 --- /dev/null +++ b/src/oci/database_management/models/failed_connections_aggregate_metrics.py @@ -0,0 +1,66 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 FailedConnectionsAggregateMetrics(object): + """ + The failed connection metrics for Autonomous Databases on Shared Exadata Infrastructure. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FailedConnectionsAggregateMetrics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param failed_connections: + The value to assign to the failed_connections property of this FailedConnectionsAggregateMetrics. + :type failed_connections: oci.database_management.models.MetricDataPoint + + """ + self.swagger_types = { + 'failed_connections': 'MetricDataPoint' + } + + self.attribute_map = { + 'failed_connections': 'failedConnections' + } + + self._failed_connections = None + + @property + def failed_connections(self): + """ + Gets the failed_connections of this FailedConnectionsAggregateMetrics. + + :return: The failed_connections of this FailedConnectionsAggregateMetrics. + :rtype: oci.database_management.models.MetricDataPoint + """ + return self._failed_connections + + @failed_connections.setter + def failed_connections(self, failed_connections): + """ + Sets the failed_connections of this FailedConnectionsAggregateMetrics. + + :param failed_connections: The failed_connections of this FailedConnectionsAggregateMetrics. + :type: oci.database_management.models.MetricDataPoint + """ + self._failed_connections = failed_connections + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/fleet_status_by_category.py b/src/oci/database_management/models/fleet_status_by_category.py index 8a7bdbdd05..c87d1505b6 100644 --- a/src/oci/database_management/models/fleet_status_by_category.py +++ b/src/oci/database_management/models/fleet_status_by_category.py @@ -29,6 +29,14 @@ class FleetStatusByCategory(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a FleetStatusByCategory. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a FleetStatusByCategory. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a FleetStatusByCategory. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,38 @@ class FleetStatusByCategory(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a FleetStatusByCategory. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a FleetStatusByCategory. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "ONPREMISE" + DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "BM" + DEPLOYMENT_TYPE_BM = "BM" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "VM" + DEPLOYMENT_TYPE_VM = "VM" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "EXADATA" + DEPLOYMENT_TYPE_EXADATA = "EXADATA" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "EXADATA_CC" + DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + + #: A constant which can be used with the deployment_type property of a FleetStatusByCategory. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + def __init__(self, **kwargs): """ Initializes a new FleetStatusByCategory object with values from keyword arguments. @@ -48,16 +88,22 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this FleetStatusByCategory. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this FleetStatusByCategory. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str + :param deployment_type: + The value to assign to the deployment_type property of this FleetStatusByCategory. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type deployment_type: str + :param inventory_count: The value to assign to the inventory_count property of this FleetStatusByCategory. :type inventory_count: int @@ -66,17 +112,20 @@ def __init__(self, **kwargs): self.swagger_types = { 'database_type': 'str', 'database_sub_type': 'str', + 'deployment_type': 'str', 'inventory_count': 'int' } self.attribute_map = { 'database_type': 'databaseType', 'database_sub_type': 'databaseSubType', + 'deployment_type': 'deploymentType', 'inventory_count': 'inventoryCount' } self._database_type = None self._database_sub_type = None + self._deployment_type = None self._inventory_count = None @property @@ -85,7 +134,7 @@ def database_type(self): Gets the database_type of this FleetStatusByCategory. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -104,7 +153,7 @@ def database_type(self, database_type): :param database_type: The database_type of this FleetStatusByCategory. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -113,9 +162,10 @@ def database_type(self, database_type): def database_sub_type(self): """ Gets the database_sub_type of this FleetStatusByCategory. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -128,17 +178,48 @@ def database_sub_type(self): def database_sub_type(self, database_sub_type): """ Sets the database_sub_type of this FleetStatusByCategory. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. :param database_sub_type: The database_sub_type of this FleetStatusByCategory. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type + @property + def deployment_type(self): + """ + Gets the deployment_type of this FleetStatusByCategory. + The infrastructure used to deploy the Oracle Database. + + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The deployment_type of this FleetStatusByCategory. + :rtype: str + """ + return self._deployment_type + + @deployment_type.setter + def deployment_type(self, deployment_type): + """ + Sets the deployment_type of this FleetStatusByCategory. + The infrastructure used to deploy the Oracle Database. + + + :param deployment_type: The deployment_type of this FleetStatusByCategory. + :type: str + """ + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] + if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): + deployment_type = 'UNKNOWN_ENUM_VALUE' + self._deployment_type = deployment_type + @property def inventory_count(self): """ diff --git a/src/oci/database_management/models/job.py b/src/oci/database_management/models/job.py index 362834b095..7572a491ee 100644 --- a/src/oci/database_management/models/job.py +++ b/src/oci/database_management/models/job.py @@ -25,6 +25,14 @@ class Job(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a Job. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a Job. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the schedule_type property of a Job. #: This constant has a value of "IMMEDIATE" SCHEDULE_TYPE_IMMEDIATE = "IMMEDIATE" @@ -84,7 +92,7 @@ def __init__(self, **kwargs): :param database_sub_type: The value to assign to the database_sub_type property of this Job. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str @@ -392,7 +400,7 @@ def database_sub_type(self): Gets the database_sub_type of this Job. The subtype of the Oracle Database where the job has to be executed. Applicable only when managedDatabaseGroupId is provided. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -411,7 +419,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this Job. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type diff --git a/src/oci/database_management/models/job_database.py b/src/oci/database_management/models/job_database.py index bfa5e29d3b..0738246f26 100644 --- a/src/oci/database_management/models/job_database.py +++ b/src/oci/database_management/models/job_database.py @@ -29,6 +29,14 @@ class JobDatabase(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a JobDatabase. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a JobDatabase. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a JobDatabase. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class JobDatabase(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a JobDatabase. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a JobDatabase. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a JobDatabase. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,26 @@ class JobDatabase(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a JobDatabase. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + + #: A constant which can be used with the workload_type property of a JobDatabase. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a JobDatabase. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a JobDatabase. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a JobDatabase. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + def __init__(self, **kwargs): """ Initializes a new JobDatabase object with values from keyword arguments. @@ -76,19 +112,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this JobDatabase. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this JobDatabase. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this JobDatabase. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -96,6 +132,12 @@ def __init__(self, **kwargs): The value to assign to the is_cluster property of this JobDatabase. :type is_cluster: bool + :param workload_type: + The value to assign to the workload_type property of this JobDatabase. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + """ self.swagger_types = { 'id': 'str', @@ -103,7 +145,8 @@ def __init__(self, **kwargs): 'database_type': 'str', 'database_sub_type': 'str', 'deployment_type': 'str', - 'is_cluster': 'bool' + 'is_cluster': 'bool', + 'workload_type': 'str' } self.attribute_map = { @@ -112,7 +155,8 @@ def __init__(self, **kwargs): 'database_type': 'databaseType', 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', - 'is_cluster': 'isCluster' + 'is_cluster': 'isCluster', + 'workload_type': 'workloadType' } self._id = None @@ -121,6 +165,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._is_cluster = None + self._workload_type = None @property def id(self): @@ -180,7 +225,7 @@ def database_type(self): Gets the database_type of this JobDatabase. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -199,7 +244,7 @@ def database_type(self, database_type): :param database_type: The database_type of this JobDatabase. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -210,7 +255,7 @@ def database_sub_type(self): Gets the database_sub_type of this JobDatabase. The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -229,7 +274,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this JobDatabase. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -240,7 +285,7 @@ def deployment_type(self): Gets the deployment_type of this JobDatabase. A list of the supported infrastructure that can be used to deploy the database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -259,7 +304,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this JobDatabase. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -288,6 +333,36 @@ def is_cluster(self, is_cluster): """ self._is_cluster = is_cluster + @property + def workload_type(self): + """ + Gets the workload_type of this JobDatabase. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this JobDatabase. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this JobDatabase. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this JobDatabase. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/database_management/models/job_execution.py b/src/oci/database_management/models/job_execution.py index 76e9c6ba1a..22261a7b08 100644 --- a/src/oci/database_management/models/job_execution.py +++ b/src/oci/database_management/models/job_execution.py @@ -29,6 +29,14 @@ class JobExecution(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a JobExecution. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a JobExecution. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a JobExecution. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class JobExecution(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a JobExecution. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a JobExecution. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a JobExecution. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,26 @@ class JobExecution(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a JobExecution. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + + #: A constant which can be used with the workload_type property of a JobExecution. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a JobExecution. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a JobExecution. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a JobExecution. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + #: A constant which can be used with the status property of a JobExecution. #: This constant has a value of "SUCCEEDED" STATUS_SUCCEEDED = "SUCCEEDED" @@ -104,19 +140,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this JobExecution. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this JobExecution. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this JobExecution. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -124,6 +160,12 @@ def __init__(self, **kwargs): The value to assign to the is_cluster property of this JobExecution. :type is_cluster: bool + :param workload_type: + The value to assign to the workload_type property of this JobExecution. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param job_id: The value to assign to the job_id property of this JobExecution. :type job_id: str @@ -182,6 +224,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'str', 'deployment_type': 'str', 'is_cluster': 'bool', + 'workload_type': 'str', 'job_id': 'str', 'job_name': 'str', 'job_run_id': 'str', @@ -206,6 +249,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', 'is_cluster': 'isCluster', + 'workload_type': 'workloadType', 'job_id': 'jobId', 'job_name': 'jobName', 'job_run_id': 'jobRunId', @@ -229,6 +273,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._is_cluster = None + self._workload_type = None self._job_id = None self._job_name = None self._job_run_id = None @@ -403,7 +448,7 @@ def database_type(self): Gets the database_type of this JobExecution. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -422,7 +467,7 @@ def database_type(self, database_type): :param database_type: The database_type of this JobExecution. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -433,7 +478,7 @@ def database_sub_type(self): Gets the database_sub_type of this JobExecution. The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -452,7 +497,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this JobExecution. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -463,7 +508,7 @@ def deployment_type(self): Gets the deployment_type of this JobExecution. A list of the supported infrastructure that can be used to deploy the database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -482,7 +527,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this JobExecution. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -511,6 +556,36 @@ def is_cluster(self, is_cluster): """ self._is_cluster = is_cluster + @property + def workload_type(self): + """ + Gets the workload_type of this JobExecution. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this JobExecution. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this JobExecution. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this JobExecution. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def job_id(self): """ diff --git a/src/oci/database_management/models/job_execution_summary.py b/src/oci/database_management/models/job_execution_summary.py index bbba91c58d..e0abd79494 100644 --- a/src/oci/database_management/models/job_execution_summary.py +++ b/src/oci/database_management/models/job_execution_summary.py @@ -29,6 +29,14 @@ class JobExecutionSummary(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a JobExecutionSummary. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a JobExecutionSummary. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a JobExecutionSummary. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class JobExecutionSummary(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a JobExecutionSummary. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a JobExecutionSummary. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a JobExecutionSummary. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,26 @@ class JobExecutionSummary(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a JobExecutionSummary. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + + #: A constant which can be used with the workload_type property of a JobExecutionSummary. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a JobExecutionSummary. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a JobExecutionSummary. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a JobExecutionSummary. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + def __init__(self, **kwargs): """ Initializes a new JobExecutionSummary object with values from keyword arguments. @@ -92,19 +128,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this JobExecutionSummary. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this JobExecutionSummary. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this JobExecutionSummary. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -112,6 +148,12 @@ def __init__(self, **kwargs): The value to assign to the is_cluster property of this JobExecutionSummary. :type is_cluster: bool + :param workload_type: + The value to assign to the workload_type property of this JobExecutionSummary. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param job_id: The value to assign to the job_id property of this JobExecutionSummary. :type job_id: str @@ -144,6 +186,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'str', 'deployment_type': 'str', 'is_cluster': 'bool', + 'workload_type': 'str', 'job_id': 'str', 'job_name': 'str', 'status': 'str', @@ -162,6 +205,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', 'is_cluster': 'isCluster', + 'workload_type': 'workloadType', 'job_id': 'jobId', 'job_name': 'jobName', 'status': 'status', @@ -179,6 +223,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._is_cluster = None + self._workload_type = None self._job_id = None self._job_name = None self._status = None @@ -347,7 +392,7 @@ def database_type(self): Gets the database_type of this JobExecutionSummary. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -366,7 +411,7 @@ def database_type(self, database_type): :param database_type: The database_type of this JobExecutionSummary. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -377,7 +422,7 @@ def database_sub_type(self): Gets the database_sub_type of this JobExecutionSummary. The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -396,7 +441,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this JobExecutionSummary. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -407,7 +452,7 @@ def deployment_type(self): Gets the deployment_type of this JobExecutionSummary. A list of the supported infrastructure that can be used to deploy the database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -426,7 +471,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this JobExecutionSummary. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -455,6 +500,36 @@ def is_cluster(self, is_cluster): """ self._is_cluster = is_cluster + @property + def workload_type(self): + """ + Gets the workload_type of this JobExecutionSummary. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this JobExecutionSummary. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this JobExecutionSummary. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this JobExecutionSummary. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def job_id(self): """ diff --git a/src/oci/database_management/models/job_summary.py b/src/oci/database_management/models/job_summary.py index 12a1f22322..0b73756281 100644 --- a/src/oci/database_management/models/job_summary.py +++ b/src/oci/database_management/models/job_summary.py @@ -25,6 +25,14 @@ class JobSummary(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a JobSummary. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a JobSummary. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the job_type property of a JobSummary. #: This constant has a value of "SQL" JOB_TYPE_SQL = "SQL" @@ -60,7 +68,7 @@ def __init__(self, **kwargs): :param database_sub_type: The value to assign to the database_sub_type property of this JobSummary. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str @@ -317,7 +325,7 @@ def database_sub_type(self): Gets the database_sub_type of this JobSummary. The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -336,7 +344,7 @@ def database_sub_type(self, database_sub_type): :param database_sub_type: The database_sub_type of this JobSummary. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type diff --git a/src/oci/database_management/models/managed_database.py b/src/oci/database_management/models/managed_database.py index a460583f9b..1aa6aeab7e 100644 --- a/src/oci/database_management/models/managed_database.py +++ b/src/oci/database_management/models/managed_database.py @@ -29,6 +29,14 @@ class ManagedDatabase(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a ManagedDatabase. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a ManagedDatabase. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a ManagedDatabase. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class ManagedDatabase(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a ManagedDatabase. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a ManagedDatabase. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a ManagedDatabase. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,10 @@ class ManagedDatabase(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a ManagedDatabase. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + #: A constant which can be used with the management_option property of a ManagedDatabase. #: This constant has a value of "BASIC" MANAGEMENT_OPTION_BASIC = "BASIC" @@ -69,6 +89,22 @@ class ManagedDatabase(object): #: This constant has a value of "ADVANCED" MANAGEMENT_OPTION_ADVANCED = "ADVANCED" + #: A constant which can be used with the workload_type property of a ManagedDatabase. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a ManagedDatabase. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a ManagedDatabase. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a ManagedDatabase. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + #: A constant which can be used with the database_status property of a ManagedDatabase. #: This constant has a value of "UP" DATABASE_STATUS_UP = "UP" @@ -100,19 +136,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this ManagedDatabase. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this ManagedDatabase. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this ManagedDatabase. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -122,6 +158,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type management_option: str + :param workload_type: + The value to assign to the workload_type property of this ManagedDatabase. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param is_cluster: The value to assign to the is_cluster property of this ManagedDatabase. :type is_cluster: bool @@ -181,6 +223,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'str', 'deployment_type': 'str', 'management_option': 'str', + 'workload_type': 'str', 'is_cluster': 'bool', 'parent_container_id': 'str', 'managed_database_groups': 'list[ParentGroup]', @@ -203,6 +246,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', 'management_option': 'managementOption', + 'workload_type': 'workloadType', 'is_cluster': 'isCluster', 'parent_container_id': 'parentContainerId', 'managed_database_groups': 'managedDatabaseGroups', @@ -224,6 +268,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._management_option = None + self._workload_type = None self._is_cluster = None self._parent_container_id = None self._managed_database_groups = None @@ -323,7 +368,7 @@ def database_type(self): **[Required]** Gets the database_type of this ManagedDatabase. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -342,7 +387,7 @@ def database_type(self, database_type): :param database_type: The database_type of this ManagedDatabase. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -351,9 +396,10 @@ def database_type(self, database_type): def database_sub_type(self): """ **[Required]** Gets the database_sub_type of this ManagedDatabase. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -366,13 +412,14 @@ def database_sub_type(self): def database_sub_type(self, database_sub_type): """ Sets the database_sub_type of this ManagedDatabase. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. :param database_sub_type: The database_sub_type of this ManagedDatabase. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -383,7 +430,7 @@ def deployment_type(self): Gets the deployment_type of this ManagedDatabase. The infrastructure used to deploy the Oracle Database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -402,7 +449,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this ManagedDatabase. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -437,6 +484,36 @@ def management_option(self, management_option): management_option = 'UNKNOWN_ENUM_VALUE' self._management_option = management_option + @property + def workload_type(self): + """ + Gets the workload_type of this ManagedDatabase. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this ManagedDatabase. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this ManagedDatabase. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this ManagedDatabase. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def is_cluster(self): """ diff --git a/src/oci/database_management/models/managed_database_summary.py b/src/oci/database_management/models/managed_database_summary.py index fd710154d5..4f9991a891 100644 --- a/src/oci/database_management/models/managed_database_summary.py +++ b/src/oci/database_management/models/managed_database_summary.py @@ -29,6 +29,14 @@ class ManagedDatabaseSummary(object): #: This constant has a value of "CLOUD_RAC" DATABASE_TYPE_CLOUD_RAC = "CLOUD_RAC" + #: A constant which can be used with the database_type property of a ManagedDatabaseSummary. + #: This constant has a value of "SHARED" + DATABASE_TYPE_SHARED = "SHARED" + + #: A constant which can be used with the database_type property of a ManagedDatabaseSummary. + #: This constant has a value of "DEDICATED" + DATABASE_TYPE_DEDICATED = "DEDICATED" + #: A constant which can be used with the database_sub_type property of a ManagedDatabaseSummary. #: This constant has a value of "CDB" DATABASE_SUB_TYPE_CDB = "CDB" @@ -41,6 +49,14 @@ class ManagedDatabaseSummary(object): #: This constant has a value of "NON_CDB" DATABASE_SUB_TYPE_NON_CDB = "NON_CDB" + #: A constant which can be used with the database_sub_type property of a ManagedDatabaseSummary. + #: This constant has a value of "ACD" + DATABASE_SUB_TYPE_ACD = "ACD" + + #: A constant which can be used with the database_sub_type property of a ManagedDatabaseSummary. + #: This constant has a value of "ADB" + DATABASE_SUB_TYPE_ADB = "ADB" + #: A constant which can be used with the deployment_type property of a ManagedDatabaseSummary. #: This constant has a value of "ONPREMISE" DEPLOYMENT_TYPE_ONPREMISE = "ONPREMISE" @@ -61,6 +77,10 @@ class ManagedDatabaseSummary(object): #: This constant has a value of "EXADATA_CC" DEPLOYMENT_TYPE_EXADATA_CC = "EXADATA_CC" + #: A constant which can be used with the deployment_type property of a ManagedDatabaseSummary. + #: This constant has a value of "AUTONOMOUS" + DEPLOYMENT_TYPE_AUTONOMOUS = "AUTONOMOUS" + #: A constant which can be used with the management_option property of a ManagedDatabaseSummary. #: This constant has a value of "BASIC" MANAGEMENT_OPTION_BASIC = "BASIC" @@ -69,6 +89,22 @@ class ManagedDatabaseSummary(object): #: This constant has a value of "ADVANCED" MANAGEMENT_OPTION_ADVANCED = "ADVANCED" + #: A constant which can be used with the workload_type property of a ManagedDatabaseSummary. + #: This constant has a value of "OLTP" + WORKLOAD_TYPE_OLTP = "OLTP" + + #: A constant which can be used with the workload_type property of a ManagedDatabaseSummary. + #: This constant has a value of "DW" + WORKLOAD_TYPE_DW = "DW" + + #: A constant which can be used with the workload_type property of a ManagedDatabaseSummary. + #: This constant has a value of "AJD" + WORKLOAD_TYPE_AJD = "AJD" + + #: A constant which can be used with the workload_type property of a ManagedDatabaseSummary. + #: This constant has a value of "APEX" + WORKLOAD_TYPE_APEX = "APEX" + def __init__(self, **kwargs): """ Initializes a new ManagedDatabaseSummary object with values from keyword arguments. @@ -88,19 +124,19 @@ def __init__(self, **kwargs): :param database_type: The value to assign to the database_type property of this ManagedDatabaseSummary. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_type: str :param database_sub_type: The value to assign to the database_sub_type property of this ManagedDatabaseSummary. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str :param deployment_type: The value to assign to the deployment_type property of this ManagedDatabaseSummary. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type deployment_type: str @@ -110,6 +146,12 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type management_option: str + :param workload_type: + The value to assign to the workload_type property of this ManagedDatabaseSummary. + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type workload_type: str + :param is_cluster: The value to assign to the is_cluster property of this ManagedDatabaseSummary. :type is_cluster: bool @@ -131,6 +173,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'str', 'deployment_type': 'str', 'management_option': 'str', + 'workload_type': 'str', 'is_cluster': 'bool', 'parent_container_id': 'str', 'time_created': 'datetime' @@ -144,6 +187,7 @@ def __init__(self, **kwargs): 'database_sub_type': 'databaseSubType', 'deployment_type': 'deploymentType', 'management_option': 'managementOption', + 'workload_type': 'workloadType', 'is_cluster': 'isCluster', 'parent_container_id': 'parentContainerId', 'time_created': 'timeCreated' @@ -156,6 +200,7 @@ def __init__(self, **kwargs): self._database_sub_type = None self._deployment_type = None self._management_option = None + self._workload_type = None self._is_cluster = None self._parent_container_id = None self._time_created = None @@ -246,7 +291,7 @@ def database_type(self): **[Required]** Gets the database_type of this ManagedDatabaseSummary. The type of Oracle Database installation. - Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -265,7 +310,7 @@ def database_type(self, database_type): :param database_type: The database_type of this ManagedDatabaseSummary. :type: str """ - allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC"] + allowed_values = ["EXTERNAL_SIDB", "EXTERNAL_RAC", "CLOUD_SIDB", "CLOUD_RAC", "SHARED", "DEDICATED"] if not value_allowed_none_or_none_sentinel(database_type, allowed_values): database_type = 'UNKNOWN_ENUM_VALUE' self._database_type = database_type @@ -274,9 +319,10 @@ def database_type(self, database_type): def database_sub_type(self): """ **[Required]** Gets the database_sub_type of this ManagedDatabaseSummary. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -289,13 +335,14 @@ def database_sub_type(self): def database_sub_type(self, database_sub_type): """ Sets the database_sub_type of this ManagedDatabaseSummary. - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. + The subtype of the Oracle Database. Indicates whether the database is a Container Database, + Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. :param database_sub_type: The database_sub_type of this ManagedDatabaseSummary. :type: str """ - allowed_values = ["CDB", "PDB", "NON_CDB"] + allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"] if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values): database_sub_type = 'UNKNOWN_ENUM_VALUE' self._database_sub_type = database_sub_type @@ -306,7 +353,7 @@ def deployment_type(self): Gets the deployment_type of this ManagedDatabaseSummary. The infrastructure used to deploy the Oracle Database. - Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -325,7 +372,7 @@ def deployment_type(self, deployment_type): :param deployment_type: The deployment_type of this ManagedDatabaseSummary. :type: str """ - allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC"] + allowed_values = ["ONPREMISE", "BM", "VM", "EXADATA", "EXADATA_CC", "AUTONOMOUS"] if not value_allowed_none_or_none_sentinel(deployment_type, allowed_values): deployment_type = 'UNKNOWN_ENUM_VALUE' self._deployment_type = deployment_type @@ -360,6 +407,36 @@ def management_option(self, management_option): management_option = 'UNKNOWN_ENUM_VALUE' self._management_option = management_option + @property + def workload_type(self): + """ + Gets the workload_type of this ManagedDatabaseSummary. + The workload type of the Autonomous Database. + + Allowed values for this property are: "OLTP", "DW", "AJD", "APEX", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The workload_type of this ManagedDatabaseSummary. + :rtype: str + """ + return self._workload_type + + @workload_type.setter + def workload_type(self, workload_type): + """ + Sets the workload_type of this ManagedDatabaseSummary. + The workload type of the Autonomous Database. + + + :param workload_type: The workload_type of this ManagedDatabaseSummary. + :type: str + """ + allowed_values = ["OLTP", "DW", "AJD", "APEX"] + if not value_allowed_none_or_none_sentinel(workload_type, allowed_values): + workload_type = 'UNKNOWN_ENUM_VALUE' + self._workload_type = workload_type + @property def is_cluster(self): """ diff --git a/src/oci/database_management/models/object_privilege_collection.py b/src/oci/database_management/models/object_privilege_collection.py new file mode 100644 index 0000000000..95cbbcb028 --- /dev/null +++ b/src/oci/database_management/models/object_privilege_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ObjectPrivilegeCollection(object): + """ + A collection of ObjectPrivileges granted to the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectPrivilegeCollection 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 ObjectPrivilegeCollection. + :type items: list[oci.database_management.models.ObjectPrivilegeSummary] + + """ + self.swagger_types = { + 'items': 'list[ObjectPrivilegeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ObjectPrivilegeCollection. + An array of User resources. + + + :return: The items of this ObjectPrivilegeCollection. + :rtype: list[oci.database_management.models.ObjectPrivilegeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ObjectPrivilegeCollection. + An array of User resources. + + + :param items: The items of this ObjectPrivilegeCollection. + :type: list[oci.database_management.models.ObjectPrivilegeSummary] + """ + 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/database_management/models/object_privilege_summary.py b/src/oci/database_management/models/object_privilege_summary.py new file mode 100644 index 0000000000..ad10070d58 --- /dev/null +++ b/src/oci/database_management/models/object_privilege_summary.py @@ -0,0 +1,386 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ObjectPrivilegeSummary(object): + """ + Summary of objectPrivileges. + """ + + #: A constant which can be used with the hierarchy property of a ObjectPrivilegeSummary. + #: This constant has a value of "YES" + HIERARCHY_YES = "YES" + + #: A constant which can be used with the hierarchy property of a ObjectPrivilegeSummary. + #: This constant has a value of "NO" + HIERARCHY_NO = "NO" + + #: A constant which can be used with the grant_option property of a ObjectPrivilegeSummary. + #: This constant has a value of "YES" + GRANT_OPTION_YES = "YES" + + #: A constant which can be used with the grant_option property of a ObjectPrivilegeSummary. + #: This constant has a value of "NO" + GRANT_OPTION_NO = "NO" + + #: A constant which can be used with the common property of a ObjectPrivilegeSummary. + #: This constant has a value of "YES" + COMMON_YES = "YES" + + #: A constant which can be used with the common property of a ObjectPrivilegeSummary. + #: This constant has a value of "NO" + COMMON_NO = "NO" + + #: A constant which can be used with the inherited property of a ObjectPrivilegeSummary. + #: This constant has a value of "YES" + INHERITED_YES = "YES" + + #: A constant which can be used with the inherited property of a ObjectPrivilegeSummary. + #: This constant has a value of "NO" + INHERITED_NO = "NO" + + def __init__(self, **kwargs): + """ + Initializes a new ObjectPrivilegeSummary 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 ObjectPrivilegeSummary. + :type name: str + + :param schema_type: + The value to assign to the schema_type property of this ObjectPrivilegeSummary. + :type schema_type: str + + :param owner: + The value to assign to the owner property of this ObjectPrivilegeSummary. + :type owner: str + + :param grantor: + The value to assign to the grantor property of this ObjectPrivilegeSummary. + :type grantor: str + + :param hierarchy: + The value to assign to the hierarchy property of this ObjectPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type hierarchy: str + + :param object: + The value to assign to the object property of this ObjectPrivilegeSummary. + :type object: str + + :param grant_option: + The value to assign to the grant_option property of this ObjectPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type grant_option: str + + :param common: + The value to assign to the common property of this ObjectPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type common: str + + :param inherited: + The value to assign to the inherited property of this ObjectPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type inherited: str + + """ + self.swagger_types = { + 'name': 'str', + 'schema_type': 'str', + 'owner': 'str', + 'grantor': 'str', + 'hierarchy': 'str', + 'object': 'str', + 'grant_option': 'str', + 'common': 'str', + 'inherited': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'schema_type': 'schemaType', + 'owner': 'owner', + 'grantor': 'grantor', + 'hierarchy': 'hierarchy', + 'object': 'object', + 'grant_option': 'grantOption', + 'common': 'common', + 'inherited': 'inherited' + } + + self._name = None + self._schema_type = None + self._owner = None + self._grantor = None + self._hierarchy = None + self._object = None + self._grant_option = None + self._common = None + self._inherited = None + + @property + def name(self): + """ + Gets the name of this ObjectPrivilegeSummary. + The name of the privilege on the object. + + + :return: The name of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ObjectPrivilegeSummary. + The name of the privilege on the object. + + + :param name: The name of this ObjectPrivilegeSummary. + :type: str + """ + self._name = name + + @property + def schema_type(self): + """ + Gets the schema_type of this ObjectPrivilegeSummary. + The type of the object. + + + :return: The schema_type of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._schema_type + + @schema_type.setter + def schema_type(self, schema_type): + """ + Sets the schema_type of this ObjectPrivilegeSummary. + The type of the object. + + + :param schema_type: The schema_type of this ObjectPrivilegeSummary. + :type: str + """ + self._schema_type = schema_type + + @property + def owner(self): + """ + Gets the owner of this ObjectPrivilegeSummary. + The owner of the object. + + + :return: The owner of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this ObjectPrivilegeSummary. + The owner of the object. + + + :param owner: The owner of this ObjectPrivilegeSummary. + :type: str + """ + self._owner = owner + + @property + def grantor(self): + """ + Gets the grantor of this ObjectPrivilegeSummary. + The name of the user who performed the grant + + + :return: The grantor of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._grantor + + @grantor.setter + def grantor(self, grantor): + """ + Sets the grantor of this ObjectPrivilegeSummary. + The name of the user who performed the grant + + + :param grantor: The grantor of this ObjectPrivilegeSummary. + :type: str + """ + self._grantor = grantor + + @property + def hierarchy(self): + """ + Gets the hierarchy of this ObjectPrivilegeSummary. + Indicates whether the privilege was granted with the HIERARCHY OPTION (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The hierarchy of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._hierarchy + + @hierarchy.setter + def hierarchy(self, hierarchy): + """ + Sets the hierarchy of this ObjectPrivilegeSummary. + Indicates whether the privilege was granted with the HIERARCHY OPTION (YES) or not (NO) + + + :param hierarchy: The hierarchy of this ObjectPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(hierarchy, allowed_values): + hierarchy = 'UNKNOWN_ENUM_VALUE' + self._hierarchy = hierarchy + + @property + def object(self): + """ + Gets the object of this ObjectPrivilegeSummary. + The name of the object. The object can be any object, including tables, packages, indexes, sequences, and so on. + + + :return: The object of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._object + + @object.setter + def object(self, object): + """ + Sets the object of this ObjectPrivilegeSummary. + The name of the object. The object can be any object, including tables, packages, indexes, sequences, and so on. + + + :param object: The object of this ObjectPrivilegeSummary. + :type: str + """ + self._object = object + + @property + def grant_option(self): + """ + Gets the grant_option of this ObjectPrivilegeSummary. + Indicates whether the privilege was granted with the GRANT OPTION (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The grant_option of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._grant_option + + @grant_option.setter + def grant_option(self, grant_option): + """ + Sets the grant_option of this ObjectPrivilegeSummary. + Indicates whether the privilege was granted with the GRANT OPTION (YES) or not (NO) + + + :param grant_option: The grant_option of this ObjectPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(grant_option, allowed_values): + grant_option = 'UNKNOWN_ENUM_VALUE' + self._grant_option = grant_option + + @property + def common(self): + """ + Gets the common of this ObjectPrivilegeSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The common of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._common + + @common.setter + def common(self, common): + """ + Sets the common of this ObjectPrivilegeSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + + :param common: The common of this ObjectPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(common, allowed_values): + common = 'UNKNOWN_ENUM_VALUE' + self._common = common + + @property + def inherited(self): + """ + Gets the inherited of this ObjectPrivilegeSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The inherited of this ObjectPrivilegeSummary. + :rtype: str + """ + return self._inherited + + @inherited.setter + def inherited(self, inherited): + """ + Sets the inherited of this ObjectPrivilegeSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + + :param inherited: The inherited of this ObjectPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(inherited, allowed_values): + inherited = 'UNKNOWN_ENUM_VALUE' + self._inherited = inherited + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/pdb_metrics.py b/src/oci/database_management/models/pdb_metrics.py index d1bc5fab61..b8c039f65d 100644 --- a/src/oci/database_management/models/pdb_metrics.py +++ b/src/oci/database_management/models/pdb_metrics.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PdbMetrics(object): """ - The summary of Pdb's and it's resource usage metrics (CPU, IO, Storage and Active sessions) for a specified Container database. + The summary of Pluggable Databases (PDBs) and their resource usage metrics, within a specific Container Database (CDB). """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def database_usage_metrics(self): """ **[Required]** Gets the database_usage_metrics of this PdbMetrics. - The summary of Pdb's and it's resource usage metrics (CPU, IO, Storage and Active sessions) for a specified Container database. + A summary of PDBs and their resource usage metrics such as CPU, User I/O, and Storage, within a specific CDB. :return: The database_usage_metrics of this PdbMetrics. @@ -49,7 +49,7 @@ def database_usage_metrics(self): def database_usage_metrics(self, database_usage_metrics): """ Sets the database_usage_metrics of this PdbMetrics. - The summary of Pdb's and it's resource usage metrics (CPU, IO, Storage and Active sessions) for a specified Container database. + A summary of PDBs and their resource usage metrics such as CPU, User I/O, and Storage, within a specific CDB. :param database_usage_metrics: The database_usage_metrics of this PdbMetrics. diff --git a/src/oci/database_management/models/proxied_for_user_collection.py b/src/oci/database_management/models/proxied_for_user_collection.py new file mode 100644 index 0000000000..04f2bb2e2c --- /dev/null +++ b/src/oci/database_management/models/proxied_for_user_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ProxiedForUserCollection(object): + """ + A collection of ProxiedForUsers granted to the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ProxiedForUserCollection 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 ProxiedForUserCollection. + :type items: list[oci.database_management.models.ProxiedForUserSummary] + + """ + self.swagger_types = { + 'items': 'list[ProxiedForUserSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ProxiedForUserCollection. + An array of User resources. + + + :return: The items of this ProxiedForUserCollection. + :rtype: list[oci.database_management.models.ProxiedForUserSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ProxiedForUserCollection. + An array of User resources. + + + :param items: The items of this ProxiedForUserCollection. + :type: list[oci.database_management.models.ProxiedForUserSummary] + """ + 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/database_management/models/proxied_for_user_summary.py b/src/oci/database_management/models/proxied_for_user_summary.py new file mode 100644 index 0000000000..f336a903a8 --- /dev/null +++ b/src/oci/database_management/models/proxied_for_user_summary.py @@ -0,0 +1,172 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ProxiedForUserSummary(object): + """ + A collection of Users for which the current user acts as proxy. + """ + + #: A constant which can be used with the authentication property of a ProxiedForUserSummary. + #: This constant has a value of "YES" + AUTHENTICATION_YES = "YES" + + #: A constant which can be used with the authentication property of a ProxiedForUserSummary. + #: This constant has a value of "NO" + AUTHENTICATION_NO = "NO" + + #: A constant which can be used with the flags property of a ProxiedForUserSummary. + #: This constant has a value of "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES" + FLAGS_PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES = "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES" + + #: A constant which can be used with the flags property of a ProxiedForUserSummary. + #: This constant has a value of "NO_CLIENT_ROLES_MAY_BE_ACTIVATED" + FLAGS_NO_CLIENT_ROLES_MAY_BE_ACTIVATED = "NO_CLIENT_ROLES_MAY_BE_ACTIVATED" + + #: A constant which can be used with the flags property of a ProxiedForUserSummary. + #: This constant has a value of "PROXY_MAY_ACTIVATE_ROLE" + FLAGS_PROXY_MAY_ACTIVATE_ROLE = "PROXY_MAY_ACTIVATE_ROLE" + + #: A constant which can be used with the flags property of a ProxiedForUserSummary. + #: This constant has a value of "PROXY_MAY_NOT_ACTIVATE_ROLE" + FLAGS_PROXY_MAY_NOT_ACTIVATE_ROLE = "PROXY_MAY_NOT_ACTIVATE_ROLE" + + def __init__(self, **kwargs): + """ + Initializes a new ProxiedForUserSummary 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 ProxiedForUserSummary. + :type name: str + + :param authentication: + The value to assign to the authentication property of this ProxiedForUserSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type authentication: str + + :param flags: + The value to assign to the flags property of this ProxiedForUserSummary. + Allowed values for this property are: "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type flags: str + + """ + self.swagger_types = { + 'name': 'str', + 'authentication': 'str', + 'flags': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'authentication': 'authentication', + 'flags': 'flags' + } + + self._name = None + self._authentication = None + self._flags = None + + @property + def name(self): + """ + Gets the name of this ProxiedForUserSummary. + The name of a proxy user or name of the user who the proxy user can act as + + + :return: The name of this ProxiedForUserSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ProxiedForUserSummary. + The name of a proxy user or name of the user who the proxy user can act as + + + :param name: The name of this ProxiedForUserSummary. + :type: str + """ + self._name = name + + @property + def authentication(self): + """ + Gets the authentication of this ProxiedForUserSummary. + Indicates whether the proxy is required to supply the client credentials (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The authentication of this ProxiedForUserSummary. + :rtype: str + """ + return self._authentication + + @authentication.setter + def authentication(self, authentication): + """ + Sets the authentication of this ProxiedForUserSummary. + Indicates whether the proxy is required to supply the client credentials (YES) or not (NO) + + + :param authentication: The authentication of this ProxiedForUserSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(authentication, allowed_values): + authentication = 'UNKNOWN_ENUM_VALUE' + self._authentication = authentication + + @property + def flags(self): + """ + Gets the flags of this ProxiedForUserSummary. + Flags associated with the proxy/client pair + + Allowed values for this property are: "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The flags of this ProxiedForUserSummary. + :rtype: str + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this ProxiedForUserSummary. + Flags associated with the proxy/client pair + + + :param flags: The flags of this ProxiedForUserSummary. + :type: str + """ + allowed_values = ["PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE"] + if not value_allowed_none_or_none_sentinel(flags, allowed_values): + flags = 'UNKNOWN_ENUM_VALUE' + self._flags = flags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/proxy_user_collection.py b/src/oci/database_management/models/proxy_user_collection.py new file mode 100644 index 0000000000..9972461f52 --- /dev/null +++ b/src/oci/database_management/models/proxy_user_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ProxyUserCollection(object): + """ + A collection of proxy users for the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ProxyUserCollection 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 ProxyUserCollection. + :type items: list[oci.database_management.models.ProxyUserSummary] + + """ + self.swagger_types = { + 'items': 'list[ProxyUserSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ProxyUserCollection. + An array of User resources. + + + :return: The items of this ProxyUserCollection. + :rtype: list[oci.database_management.models.ProxyUserSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ProxyUserCollection. + An array of User resources. + + + :param items: The items of this ProxyUserCollection. + :type: list[oci.database_management.models.ProxyUserSummary] + """ + 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/database_management/models/proxy_user_summary.py b/src/oci/database_management/models/proxy_user_summary.py new file mode 100644 index 0000000000..a5bb331277 --- /dev/null +++ b/src/oci/database_management/models/proxy_user_summary.py @@ -0,0 +1,172 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ProxyUserSummary(object): + """ + Summary of proxy user + """ + + #: A constant which can be used with the authentication property of a ProxyUserSummary. + #: This constant has a value of "YES" + AUTHENTICATION_YES = "YES" + + #: A constant which can be used with the authentication property of a ProxyUserSummary. + #: This constant has a value of "NO" + AUTHENTICATION_NO = "NO" + + #: A constant which can be used with the flags property of a ProxyUserSummary. + #: This constant has a value of "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES" + FLAGS_PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES = "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES" + + #: A constant which can be used with the flags property of a ProxyUserSummary. + #: This constant has a value of "NO_CLIENT_ROLES_MAY_BE_ACTIVATED" + FLAGS_NO_CLIENT_ROLES_MAY_BE_ACTIVATED = "NO_CLIENT_ROLES_MAY_BE_ACTIVATED" + + #: A constant which can be used with the flags property of a ProxyUserSummary. + #: This constant has a value of "PROXY_MAY_ACTIVATE_ROLE" + FLAGS_PROXY_MAY_ACTIVATE_ROLE = "PROXY_MAY_ACTIVATE_ROLE" + + #: A constant which can be used with the flags property of a ProxyUserSummary. + #: This constant has a value of "PROXY_MAY_NOT_ACTIVATE_ROLE" + FLAGS_PROXY_MAY_NOT_ACTIVATE_ROLE = "PROXY_MAY_NOT_ACTIVATE_ROLE" + + def __init__(self, **kwargs): + """ + Initializes a new ProxyUserSummary 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 ProxyUserSummary. + :type name: str + + :param authentication: + The value to assign to the authentication property of this ProxyUserSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type authentication: str + + :param flags: + The value to assign to the flags property of this ProxyUserSummary. + Allowed values for this property are: "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type flags: str + + """ + self.swagger_types = { + 'name': 'str', + 'authentication': 'str', + 'flags': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'authentication': 'authentication', + 'flags': 'flags' + } + + self._name = None + self._authentication = None + self._flags = None + + @property + def name(self): + """ + Gets the name of this ProxyUserSummary. + The name of a proxy user or name of the user who the proxy user can act as + + + :return: The name of this ProxyUserSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ProxyUserSummary. + The name of a proxy user or name of the user who the proxy user can act as + + + :param name: The name of this ProxyUserSummary. + :type: str + """ + self._name = name + + @property + def authentication(self): + """ + Gets the authentication of this ProxyUserSummary. + Indicates whether the proxy is required to supply the client credentials (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The authentication of this ProxyUserSummary. + :rtype: str + """ + return self._authentication + + @authentication.setter + def authentication(self, authentication): + """ + Sets the authentication of this ProxyUserSummary. + Indicates whether the proxy is required to supply the client credentials (YES) or not (NO) + + + :param authentication: The authentication of this ProxyUserSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(authentication, allowed_values): + authentication = 'UNKNOWN_ENUM_VALUE' + self._authentication = authentication + + @property + def flags(self): + """ + Gets the flags of this ProxyUserSummary. + Flags associated with the proxy/client pair + + Allowed values for this property are: "PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The flags of this ProxyUserSummary. + :rtype: str + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this ProxyUserSummary. + Flags associated with the proxy/client pair + + + :param flags: The flags of this ProxyUserSummary. + :type: str + """ + allowed_values = ["PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES", "NO_CLIENT_ROLES_MAY_BE_ACTIVATED", "PROXY_MAY_ACTIVATE_ROLE", "PROXY_MAY_NOT_ACTIVATE_ROLE"] + if not value_allowed_none_or_none_sentinel(flags, allowed_values): + flags = 'UNKNOWN_ENUM_VALUE' + self._flags = flags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/role_collection.py b/src/oci/database_management/models/role_collection.py new file mode 100644 index 0000000000..a1ff8db5a2 --- /dev/null +++ b/src/oci/database_management/models/role_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 RoleCollection(object): + """ + A collection of Roles granted to the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RoleCollection 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 RoleCollection. + :type items: list[oci.database_management.models.RoleSummary] + + """ + self.swagger_types = { + 'items': 'list[RoleSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this RoleCollection. + An array of User resources. + + + :return: The items of this RoleCollection. + :rtype: list[oci.database_management.models.RoleSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this RoleCollection. + An array of User resources. + + + :param items: The items of this RoleCollection. + :type: list[oci.database_management.models.RoleSummary] + """ + 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/database_management/models/role_summary.py b/src/oci/database_management/models/role_summary.py new file mode 100644 index 0000000000..9e32cb47a9 --- /dev/null +++ b/src/oci/database_management/models/role_summary.py @@ -0,0 +1,309 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 RoleSummary(object): + """ + Summary of each role. + """ + + #: A constant which can be used with the admin_option property of a RoleSummary. + #: This constant has a value of "YES" + ADMIN_OPTION_YES = "YES" + + #: A constant which can be used with the admin_option property of a RoleSummary. + #: This constant has a value of "NO" + ADMIN_OPTION_NO = "NO" + + #: A constant which can be used with the delegate_option property of a RoleSummary. + #: This constant has a value of "YES" + DELEGATE_OPTION_YES = "YES" + + #: A constant which can be used with the delegate_option property of a RoleSummary. + #: This constant has a value of "NO" + DELEGATE_OPTION_NO = "NO" + + #: A constant which can be used with the default_role property of a RoleSummary. + #: This constant has a value of "YES" + DEFAULT_ROLE_YES = "YES" + + #: A constant which can be used with the default_role property of a RoleSummary. + #: This constant has a value of "NO" + DEFAULT_ROLE_NO = "NO" + + #: A constant which can be used with the common property of a RoleSummary. + #: This constant has a value of "YES" + COMMON_YES = "YES" + + #: A constant which can be used with the common property of a RoleSummary. + #: This constant has a value of "NO" + COMMON_NO = "NO" + + #: A constant which can be used with the inherited property of a RoleSummary. + #: This constant has a value of "YES" + INHERITED_YES = "YES" + + #: A constant which can be used with the inherited property of a RoleSummary. + #: This constant has a value of "NO" + INHERITED_NO = "NO" + + def __init__(self, **kwargs): + """ + Initializes a new RoleSummary 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 RoleSummary. + :type name: str + + :param admin_option: + The value to assign to the admin_option property of this RoleSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type admin_option: str + + :param delegate_option: + The value to assign to the delegate_option property of this RoleSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type delegate_option: str + + :param default_role: + The value to assign to the default_role property of this RoleSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type default_role: str + + :param common: + The value to assign to the common property of this RoleSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type common: str + + :param inherited: + The value to assign to the inherited property of this RoleSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type inherited: str + + """ + self.swagger_types = { + 'name': 'str', + 'admin_option': 'str', + 'delegate_option': 'str', + 'default_role': 'str', + 'common': 'str', + 'inherited': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'admin_option': 'adminOption', + 'delegate_option': 'delegateOption', + 'default_role': 'defaultRole', + 'common': 'common', + 'inherited': 'inherited' + } + + self._name = None + self._admin_option = None + self._delegate_option = None + self._default_role = None + self._common = None + self._inherited = None + + @property + def name(self): + """ + Gets the name of this RoleSummary. + The name of a granted role + + + :return: The name of this RoleSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this RoleSummary. + The name of a granted role + + + :param name: The name of this RoleSummary. + :type: str + """ + self._name = name + + @property + def admin_option(self): + """ + Gets the admin_option of this RoleSummary. + Indicates whether the grant was with the ADMIN OPTION (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The admin_option of this RoleSummary. + :rtype: str + """ + return self._admin_option + + @admin_option.setter + def admin_option(self, admin_option): + """ + Sets the admin_option of this RoleSummary. + Indicates whether the grant was with the ADMIN OPTION (YES) or not (NO) + + + :param admin_option: The admin_option of this RoleSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(admin_option, allowed_values): + admin_option = 'UNKNOWN_ENUM_VALUE' + self._admin_option = admin_option + + @property + def delegate_option(self): + """ + Gets the delegate_option of this RoleSummary. + Indicates whether the grant was with the DELEGATE OPTION (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The delegate_option of this RoleSummary. + :rtype: str + """ + return self._delegate_option + + @delegate_option.setter + def delegate_option(self, delegate_option): + """ + Sets the delegate_option of this RoleSummary. + Indicates whether the grant was with the DELEGATE OPTION (YES) or not (NO) + + + :param delegate_option: The delegate_option of this RoleSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(delegate_option, allowed_values): + delegate_option = 'UNKNOWN_ENUM_VALUE' + self._delegate_option = delegate_option + + @property + def default_role(self): + """ + Gets the default_role of this RoleSummary. + Indicates whether the role is designated as a DEFAULT ROLE for the user (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The default_role of this RoleSummary. + :rtype: str + """ + return self._default_role + + @default_role.setter + def default_role(self, default_role): + """ + Sets the default_role of this RoleSummary. + Indicates whether the role is designated as a DEFAULT ROLE for the user (YES) or not (NO) + + + :param default_role: The default_role of this RoleSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(default_role, allowed_values): + default_role = 'UNKNOWN_ENUM_VALUE' + self._default_role = default_role + + @property + def common(self): + """ + Gets the common of this RoleSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The common of this RoleSummary. + :rtype: str + """ + return self._common + + @common.setter + def common(self, common): + """ + Sets the common of this RoleSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + + :param common: The common of this RoleSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(common, allowed_values): + common = 'UNKNOWN_ENUM_VALUE' + self._common = common + + @property + def inherited(self): + """ + Gets the inherited of this RoleSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The inherited of this RoleSummary. + :rtype: str + """ + return self._inherited + + @inherited.setter + def inherited(self, inherited): + """ + Sets the inherited of this RoleSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + + :param inherited: The inherited of this RoleSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(inherited, allowed_values): + inherited = 'UNKNOWN_ENUM_VALUE' + self._inherited = inherited + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_job.py b/src/oci/database_management/models/sql_job.py index 57eaae797b..b5c6bf3e24 100644 --- a/src/oci/database_management/models/sql_job.py +++ b/src/oci/database_management/models/sql_job.py @@ -77,7 +77,7 @@ def __init__(self, **kwargs): :param database_sub_type: The value to assign to the database_sub_type property of this SqlJob. - Allowed values for this property are: "CDB", "PDB", "NON_CDB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CDB", "PDB", "NON_CDB", "ACD", "ADB", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type database_sub_type: str diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_collection.py b/src/oci/database_management/models/sql_tuning_advisor_task_collection.py new file mode 100644 index 0000000000..b91ddc77f4 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskCollection(object): + """ + The SQL Tuning Advisor task list. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskCollection 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 SqlTuningAdvisorTaskCollection. + :type items: list[oci.database_management.models.SqlTuningAdvisorTaskSummary] + + """ + self.swagger_types = { + 'items': 'list[SqlTuningAdvisorTaskSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SqlTuningAdvisorTaskCollection. + A list of SQL Tuning Advisor tasks. + + + :return: The items of this SqlTuningAdvisorTaskCollection. + :rtype: list[oci.database_management.models.SqlTuningAdvisorTaskSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SqlTuningAdvisorTaskCollection. + A list of SQL Tuning Advisor tasks. + + + :param items: The items of this SqlTuningAdvisorTaskCollection. + :type: list[oci.database_management.models.SqlTuningAdvisorTaskSummary] + """ + 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/database_management/models/sql_tuning_advisor_task_finding_collection.py b/src/oci/database_management/models/sql_tuning_advisor_task_finding_collection.py new file mode 100644 index 0000000000..59c706f16a --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_finding_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskFindingCollection(object): + """ + The SQL Tuning Advisor task finding list. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskFindingCollection 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 SqlTuningAdvisorTaskFindingCollection. + :type items: list[oci.database_management.models.SqlTuningAdvisorTaskFindingSummary] + + """ + self.swagger_types = { + 'items': 'list[SqlTuningAdvisorTaskFindingSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SqlTuningAdvisorTaskFindingCollection. + An array of the findings for a tuning task. + + + :return: The items of this SqlTuningAdvisorTaskFindingCollection. + :rtype: list[oci.database_management.models.SqlTuningAdvisorTaskFindingSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SqlTuningAdvisorTaskFindingCollection. + An array of the findings for a tuning task. + + + :param items: The items of this SqlTuningAdvisorTaskFindingCollection. + :type: list[oci.database_management.models.SqlTuningAdvisorTaskFindingSummary] + """ + 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/database_management/models/sql_tuning_advisor_task_finding_summary.py b/src/oci/database_management/models/sql_tuning_advisor_task_finding_summary.py new file mode 100644 index 0000000000..4cbff15fa6 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_finding_summary.py @@ -0,0 +1,581 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskFindingSummary(object): + """ + A summary for all the findings of objects in a tuning task that match a given certain filter. + Includes what kind of findings were found, whether benefits were analyzed, and how many benefits can be obtained. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskFindingSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_advisor_task_id: + The value to assign to the sql_tuning_advisor_task_id property of this SqlTuningAdvisorTaskFindingSummary. + :type sql_tuning_advisor_task_id: int + + :param sql_tuning_advisor_task_object_id: + The value to assign to the sql_tuning_advisor_task_object_id property of this SqlTuningAdvisorTaskFindingSummary. + :type sql_tuning_advisor_task_object_id: int + + :param sql_tuning_advisor_task_object_execution_id: + The value to assign to the sql_tuning_advisor_task_object_execution_id property of this SqlTuningAdvisorTaskFindingSummary. + :type sql_tuning_advisor_task_object_execution_id: int + + :param sql_text: + The value to assign to the sql_text property of this SqlTuningAdvisorTaskFindingSummary. + :type sql_text: str + + :param parsing_schema: + The value to assign to the parsing_schema property of this SqlTuningAdvisorTaskFindingSummary. + :type parsing_schema: str + + :param sql_key: + The value to assign to the sql_key property of this SqlTuningAdvisorTaskFindingSummary. + :type sql_key: str + + :param db_time_benefit: + The value to assign to the db_time_benefit property of this SqlTuningAdvisorTaskFindingSummary. + :type db_time_benefit: float + + :param per_execution_percentage: + The value to assign to the per_execution_percentage property of this SqlTuningAdvisorTaskFindingSummary. + :type per_execution_percentage: int + + :param is_stats_finding_present: + The value to assign to the is_stats_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_stats_finding_present: bool + + :param is_sql_profile_finding_present: + The value to assign to the is_sql_profile_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_sql_profile_finding_present: bool + + :param is_sql_profile_finding_implemented: + The value to assign to the is_sql_profile_finding_implemented property of this SqlTuningAdvisorTaskFindingSummary. + :type is_sql_profile_finding_implemented: bool + + :param is_index_finding_present: + The value to assign to the is_index_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_index_finding_present: bool + + :param is_restructure_sql_finding_present: + The value to assign to the is_restructure_sql_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_restructure_sql_finding_present: bool + + :param is_alternative_plan_finding_present: + The value to assign to the is_alternative_plan_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_alternative_plan_finding_present: bool + + :param is_miscellaneous_finding_present: + The value to assign to the is_miscellaneous_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_miscellaneous_finding_present: bool + + :param is_error_finding_present: + The value to assign to the is_error_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_error_finding_present: bool + + :param is_timeout_finding_present: + The value to assign to the is_timeout_finding_present property of this SqlTuningAdvisorTaskFindingSummary. + :type is_timeout_finding_present: bool + + """ + self.swagger_types = { + 'sql_tuning_advisor_task_id': 'int', + 'sql_tuning_advisor_task_object_id': 'int', + 'sql_tuning_advisor_task_object_execution_id': 'int', + 'sql_text': 'str', + 'parsing_schema': 'str', + 'sql_key': 'str', + 'db_time_benefit': 'float', + 'per_execution_percentage': 'int', + 'is_stats_finding_present': 'bool', + 'is_sql_profile_finding_present': 'bool', + 'is_sql_profile_finding_implemented': 'bool', + 'is_index_finding_present': 'bool', + 'is_restructure_sql_finding_present': 'bool', + 'is_alternative_plan_finding_present': 'bool', + 'is_miscellaneous_finding_present': 'bool', + 'is_error_finding_present': 'bool', + 'is_timeout_finding_present': 'bool' + } + + self.attribute_map = { + 'sql_tuning_advisor_task_id': 'sqlTuningAdvisorTaskId', + 'sql_tuning_advisor_task_object_id': 'sqlTuningAdvisorTaskObjectId', + 'sql_tuning_advisor_task_object_execution_id': 'sqlTuningAdvisorTaskObjectExecutionId', + 'sql_text': 'sqlText', + 'parsing_schema': 'parsingSchema', + 'sql_key': 'sqlKey', + 'db_time_benefit': 'dbTimeBenefit', + 'per_execution_percentage': 'perExecutionPercentage', + 'is_stats_finding_present': 'isStatsFindingPresent', + 'is_sql_profile_finding_present': 'isSqlProfileFindingPresent', + 'is_sql_profile_finding_implemented': 'isSqlProfileFindingImplemented', + 'is_index_finding_present': 'isIndexFindingPresent', + 'is_restructure_sql_finding_present': 'isRestructureSqlFindingPresent', + 'is_alternative_plan_finding_present': 'isAlternativePlanFindingPresent', + 'is_miscellaneous_finding_present': 'isMiscellaneousFindingPresent', + 'is_error_finding_present': 'isErrorFindingPresent', + 'is_timeout_finding_present': 'isTimeoutFindingPresent' + } + + self._sql_tuning_advisor_task_id = None + self._sql_tuning_advisor_task_object_id = None + self._sql_tuning_advisor_task_object_execution_id = None + self._sql_text = None + self._parsing_schema = None + self._sql_key = None + self._db_time_benefit = None + self._per_execution_percentage = None + self._is_stats_finding_present = None + self._is_sql_profile_finding_present = None + self._is_sql_profile_finding_implemented = None + self._is_index_finding_present = None + self._is_restructure_sql_finding_present = None + self._is_alternative_plan_finding_present = None + self._is_miscellaneous_finding_present = None + self._is_error_finding_present = None + self._is_timeout_finding_present = None + + @property + def sql_tuning_advisor_task_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskFindingSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskFindingSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_id + + @sql_tuning_advisor_task_id.setter + def sql_tuning_advisor_task_id(self, sql_tuning_advisor_task_id): + """ + Sets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskFindingSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_id: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskFindingSummary. + :type: int + """ + self._sql_tuning_advisor_task_id = sql_tuning_advisor_task_id + + @property + def sql_tuning_advisor_task_object_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskFindingSummary. + Key of the object to which these recommendations apply. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskFindingSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_object_id + + @sql_tuning_advisor_task_object_id.setter + def sql_tuning_advisor_task_object_id(self, sql_tuning_advisor_task_object_id): + """ + Sets the sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskFindingSummary. + Key of the object to which these recommendations apply. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_object_id: The sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskFindingSummary. + :type: int + """ + self._sql_tuning_advisor_task_object_id = sql_tuning_advisor_task_object_id + + @property + def sql_tuning_advisor_task_object_execution_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_object_execution_id of this SqlTuningAdvisorTaskFindingSummary. + Execution id of the analyzed SQL object. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_object_execution_id of this SqlTuningAdvisorTaskFindingSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_object_execution_id + + @sql_tuning_advisor_task_object_execution_id.setter + def sql_tuning_advisor_task_object_execution_id(self, sql_tuning_advisor_task_object_execution_id): + """ + Sets the sql_tuning_advisor_task_object_execution_id of this SqlTuningAdvisorTaskFindingSummary. + Execution id of the analyzed SQL object. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_object_execution_id: The sql_tuning_advisor_task_object_execution_id of this SqlTuningAdvisorTaskFindingSummary. + :type: int + """ + self._sql_tuning_advisor_task_object_execution_id = sql_tuning_advisor_task_object_execution_id + + @property + def sql_text(self): + """ + **[Required]** Gets the sql_text of this SqlTuningAdvisorTaskFindingSummary. + Text of the SQL statement. + + + :return: The sql_text of this SqlTuningAdvisorTaskFindingSummary. + :rtype: str + """ + return self._sql_text + + @sql_text.setter + def sql_text(self, sql_text): + """ + Sets the sql_text of this SqlTuningAdvisorTaskFindingSummary. + Text of the SQL statement. + + + :param sql_text: The sql_text of this SqlTuningAdvisorTaskFindingSummary. + :type: str + """ + self._sql_text = sql_text + + @property + def parsing_schema(self): + """ + **[Required]** Gets the parsing_schema of this SqlTuningAdvisorTaskFindingSummary. + Parsing schema of the object. + + + :return: The parsing_schema of this SqlTuningAdvisorTaskFindingSummary. + :rtype: str + """ + return self._parsing_schema + + @parsing_schema.setter + def parsing_schema(self, parsing_schema): + """ + Sets the parsing_schema of this SqlTuningAdvisorTaskFindingSummary. + Parsing schema of the object. + + + :param parsing_schema: The parsing_schema of this SqlTuningAdvisorTaskFindingSummary. + :type: str + """ + self._parsing_schema = parsing_schema + + @property + def sql_key(self): + """ + **[Required]** Gets the sql_key of this SqlTuningAdvisorTaskFindingSummary. + Unique key of this SQL statement + + + :return: The sql_key of this SqlTuningAdvisorTaskFindingSummary. + :rtype: str + """ + return self._sql_key + + @sql_key.setter + def sql_key(self, sql_key): + """ + Sets the sql_key of this SqlTuningAdvisorTaskFindingSummary. + Unique key of this SQL statement + + + :param sql_key: The sql_key of this SqlTuningAdvisorTaskFindingSummary. + :type: str + """ + self._sql_key = sql_key + + @property + def db_time_benefit(self): + """ + Gets the db_time_benefit of this SqlTuningAdvisorTaskFindingSummary. + Time benefit in seconds for the highest-rated finding for this object. + + + :return: The db_time_benefit of this SqlTuningAdvisorTaskFindingSummary. + :rtype: float + """ + return self._db_time_benefit + + @db_time_benefit.setter + def db_time_benefit(self, db_time_benefit): + """ + Sets the db_time_benefit of this SqlTuningAdvisorTaskFindingSummary. + Time benefit in seconds for the highest-rated finding for this object. + + + :param db_time_benefit: The db_time_benefit of this SqlTuningAdvisorTaskFindingSummary. + :type: float + """ + self._db_time_benefit = db_time_benefit + + @property + def per_execution_percentage(self): + """ + Gets the per_execution_percentage of this SqlTuningAdvisorTaskFindingSummary. + The per-execution percentage benefit. + + + :return: The per_execution_percentage of this SqlTuningAdvisorTaskFindingSummary. + :rtype: int + """ + return self._per_execution_percentage + + @per_execution_percentage.setter + def per_execution_percentage(self, per_execution_percentage): + """ + Sets the per_execution_percentage of this SqlTuningAdvisorTaskFindingSummary. + The per-execution percentage benefit. + + + :param per_execution_percentage: The per_execution_percentage of this SqlTuningAdvisorTaskFindingSummary. + :type: int + """ + self._per_execution_percentage = per_execution_percentage + + @property + def is_stats_finding_present(self): + """ + Gets the is_stats_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a statistics recommendation was found for this SQL statement. + + + :return: The is_stats_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_stats_finding_present + + @is_stats_finding_present.setter + def is_stats_finding_present(self, is_stats_finding_present): + """ + Sets the is_stats_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a statistics recommendation was found for this SQL statement. + + + :param is_stats_finding_present: The is_stats_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_stats_finding_present = is_stats_finding_present + + @property + def is_sql_profile_finding_present(self): + """ + Gets the is_sql_profile_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a SQL Profile recommendation was found for this SQL statement. + + + :return: The is_sql_profile_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_sql_profile_finding_present + + @is_sql_profile_finding_present.setter + def is_sql_profile_finding_present(self, is_sql_profile_finding_present): + """ + Sets the is_sql_profile_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a SQL Profile recommendation was found for this SQL statement. + + + :param is_sql_profile_finding_present: The is_sql_profile_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_sql_profile_finding_present = is_sql_profile_finding_present + + @property + def is_sql_profile_finding_implemented(self): + """ + Gets the is_sql_profile_finding_implemented of this SqlTuningAdvisorTaskFindingSummary. + Whether a SQL Profile recommendation has been implemented for this SQL statement. + + + :return: The is_sql_profile_finding_implemented of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_sql_profile_finding_implemented + + @is_sql_profile_finding_implemented.setter + def is_sql_profile_finding_implemented(self, is_sql_profile_finding_implemented): + """ + Sets the is_sql_profile_finding_implemented of this SqlTuningAdvisorTaskFindingSummary. + Whether a SQL Profile recommendation has been implemented for this SQL statement. + + + :param is_sql_profile_finding_implemented: The is_sql_profile_finding_implemented of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_sql_profile_finding_implemented = is_sql_profile_finding_implemented + + @property + def is_index_finding_present(self): + """ + Gets the is_index_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether an index recommendation was found for this SQL statement. + + + :return: The is_index_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_index_finding_present + + @is_index_finding_present.setter + def is_index_finding_present(self, is_index_finding_present): + """ + Sets the is_index_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether an index recommendation was found for this SQL statement. + + + :param is_index_finding_present: The is_index_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_index_finding_present = is_index_finding_present + + @property + def is_restructure_sql_finding_present(self): + """ + Gets the is_restructure_sql_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a restructure SQL recommendation was found for this SQL statement. + + + :return: The is_restructure_sql_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_restructure_sql_finding_present + + @is_restructure_sql_finding_present.setter + def is_restructure_sql_finding_present(self, is_restructure_sql_finding_present): + """ + Sets the is_restructure_sql_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a restructure SQL recommendation was found for this SQL statement. + + + :param is_restructure_sql_finding_present: The is_restructure_sql_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_restructure_sql_finding_present = is_restructure_sql_finding_present + + @property + def is_alternative_plan_finding_present(self): + """ + Gets the is_alternative_plan_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether an alternative execution plan was found for this SQL statement. + + + :return: The is_alternative_plan_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_alternative_plan_finding_present + + @is_alternative_plan_finding_present.setter + def is_alternative_plan_finding_present(self, is_alternative_plan_finding_present): + """ + Sets the is_alternative_plan_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether an alternative execution plan was found for this SQL statement. + + + :param is_alternative_plan_finding_present: The is_alternative_plan_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_alternative_plan_finding_present = is_alternative_plan_finding_present + + @property + def is_miscellaneous_finding_present(self): + """ + Gets the is_miscellaneous_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a miscellaneous finding was found for this SQL statement. + + + :return: The is_miscellaneous_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_miscellaneous_finding_present + + @is_miscellaneous_finding_present.setter + def is_miscellaneous_finding_present(self, is_miscellaneous_finding_present): + """ + Sets the is_miscellaneous_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether a miscellaneous finding was found for this SQL statement. + + + :param is_miscellaneous_finding_present: The is_miscellaneous_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_miscellaneous_finding_present = is_miscellaneous_finding_present + + @property + def is_error_finding_present(self): + """ + Gets the is_error_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether there is an error in this SQL statement. + + + :return: The is_error_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_error_finding_present + + @is_error_finding_present.setter + def is_error_finding_present(self, is_error_finding_present): + """ + Sets the is_error_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether there is an error in this SQL statement. + + + :param is_error_finding_present: The is_error_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_error_finding_present = is_error_finding_present + + @property + def is_timeout_finding_present(self): + """ + Gets the is_timeout_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether the task timed out. + + + :return: The is_timeout_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :rtype: bool + """ + return self._is_timeout_finding_present + + @is_timeout_finding_present.setter + def is_timeout_finding_present(self, is_timeout_finding_present): + """ + Sets the is_timeout_finding_present of this SqlTuningAdvisorTaskFindingSummary. + Whether the task timed out. + + + :param is_timeout_finding_present: The is_timeout_finding_present of this SqlTuningAdvisorTaskFindingSummary. + :type: bool + """ + self._is_timeout_finding_present = is_timeout_finding_present + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_recommendation_collection.py b/src/oci/database_management/models/sql_tuning_advisor_task_recommendation_collection.py new file mode 100644 index 0000000000..ce96e4d56a --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_recommendation_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskRecommendationCollection(object): + """ + The SQL Tuning Advisor recommendations for a given SQL statement. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskRecommendationCollection 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 SqlTuningAdvisorTaskRecommendationCollection. + :type items: list[oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary] + + """ + self.swagger_types = { + 'items': 'list[SqlTuningAdvisorTaskRecommendationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SqlTuningAdvisorTaskRecommendationCollection. + A list of SQL Tuning Advisor recommendations. + + + :return: The items of this SqlTuningAdvisorTaskRecommendationCollection. + :rtype: list[oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SqlTuningAdvisorTaskRecommendationCollection. + A list of SQL Tuning Advisor recommendations. + + + :param items: The items of this SqlTuningAdvisorTaskRecommendationCollection. + :type: list[oci.database_management.models.SqlTuningAdvisorTaskRecommendationSummary] + """ + 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/database_management/models/sql_tuning_advisor_task_recommendation_summary.py b/src/oci/database_management/models/sql_tuning_advisor_task_recommendation_summary.py new file mode 100644 index 0000000000..ce74a7c33a --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_recommendation_summary.py @@ -0,0 +1,362 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskRecommendationSummary(object): + """ + A recommendation for a given object in a SQL Tuning Task. + """ + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "STATISTICS" + RECOMMENDATION_TYPE_STATISTICS = "STATISTICS" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "INDEX" + RECOMMENDATION_TYPE_INDEX = "INDEX" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "SQL_PROFILE" + RECOMMENDATION_TYPE_SQL_PROFILE = "SQL_PROFILE" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "RESTRUCTURE_SQL" + RECOMMENDATION_TYPE_RESTRUCTURE_SQL = "RESTRUCTURE_SQL" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "ALTERNATIVE_PLANS" + RECOMMENDATION_TYPE_ALTERNATIVE_PLANS = "ALTERNATIVE_PLANS" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "ERROR" + RECOMMENDATION_TYPE_ERROR = "ERROR" + + #: A constant which can be used with the recommendation_type property of a SqlTuningAdvisorTaskRecommendationSummary. + #: This constant has a value of "MISCELLANEOUS" + RECOMMENDATION_TYPE_MISCELLANEOUS = "MISCELLANEOUS" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskRecommendationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_advisor_task_id: + The value to assign to the sql_tuning_advisor_task_id property of this SqlTuningAdvisorTaskRecommendationSummary. + :type sql_tuning_advisor_task_id: int + + :param sql_tuning_advisor_task_object_id: + The value to assign to the sql_tuning_advisor_task_object_id property of this SqlTuningAdvisorTaskRecommendationSummary. + :type sql_tuning_advisor_task_object_id: int + + :param recommendation_key: + The value to assign to the recommendation_key property of this SqlTuningAdvisorTaskRecommendationSummary. + :type recommendation_key: int + + :param recommendation_type: + The value to assign to the recommendation_type property of this SqlTuningAdvisorTaskRecommendationSummary. + Allowed values for this property are: "STATISTICS", "INDEX", "SQL_PROFILE", "RESTRUCTURE_SQL", "ALTERNATIVE_PLANS", "ERROR", "MISCELLANEOUS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type recommendation_type: str + + :param finding: + The value to assign to the finding property of this SqlTuningAdvisorTaskRecommendationSummary. + :type finding: str + + :param recommendation: + The value to assign to the recommendation property of this SqlTuningAdvisorTaskRecommendationSummary. + :type recommendation: str + + :param rationale: + The value to assign to the rationale property of this SqlTuningAdvisorTaskRecommendationSummary. + :type rationale: str + + :param benefit: + The value to assign to the benefit property of this SqlTuningAdvisorTaskRecommendationSummary. + :type benefit: float + + :param implement_action_sql: + The value to assign to the implement_action_sql property of this SqlTuningAdvisorTaskRecommendationSummary. + :type implement_action_sql: str + + """ + self.swagger_types = { + 'sql_tuning_advisor_task_id': 'int', + 'sql_tuning_advisor_task_object_id': 'int', + 'recommendation_key': 'int', + 'recommendation_type': 'str', + 'finding': 'str', + 'recommendation': 'str', + 'rationale': 'str', + 'benefit': 'float', + 'implement_action_sql': 'str' + } + + self.attribute_map = { + 'sql_tuning_advisor_task_id': 'sqlTuningAdvisorTaskId', + 'sql_tuning_advisor_task_object_id': 'sqlTuningAdvisorTaskObjectId', + 'recommendation_key': 'recommendationKey', + 'recommendation_type': 'recommendationType', + 'finding': 'finding', + 'recommendation': 'recommendation', + 'rationale': 'rationale', + 'benefit': 'benefit', + 'implement_action_sql': 'implementActionSql' + } + + self._sql_tuning_advisor_task_id = None + self._sql_tuning_advisor_task_object_id = None + self._recommendation_key = None + self._recommendation_type = None + self._finding = None + self._recommendation = None + self._rationale = None + self._benefit = None + self._implement_action_sql = None + + @property + def sql_tuning_advisor_task_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskRecommendationSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_id + + @sql_tuning_advisor_task_id.setter + def sql_tuning_advisor_task_id(self, sql_tuning_advisor_task_id): + """ + Sets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskRecommendationSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_id: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskRecommendationSummary. + :type: int + """ + self._sql_tuning_advisor_task_id = sql_tuning_advisor_task_id + + @property + def sql_tuning_advisor_task_object_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskRecommendationSummary. + Key of the object to which these recommendations apply. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_object_id + + @sql_tuning_advisor_task_object_id.setter + def sql_tuning_advisor_task_object_id(self, sql_tuning_advisor_task_object_id): + """ + Sets the sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskRecommendationSummary. + Key of the object to which these recommendations apply. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_object_id: The sql_tuning_advisor_task_object_id of this SqlTuningAdvisorTaskRecommendationSummary. + :type: int + """ + self._sql_tuning_advisor_task_object_id = sql_tuning_advisor_task_object_id + + @property + def recommendation_key(self): + """ + **[Required]** Gets the recommendation_key of this SqlTuningAdvisorTaskRecommendationSummary. + Unique identifier of the recommendation in the scope of the task. + + + :return: The recommendation_key of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: int + """ + return self._recommendation_key + + @recommendation_key.setter + def recommendation_key(self, recommendation_key): + """ + Sets the recommendation_key of this SqlTuningAdvisorTaskRecommendationSummary. + Unique identifier of the recommendation in the scope of the task. + + + :param recommendation_key: The recommendation_key of this SqlTuningAdvisorTaskRecommendationSummary. + :type: int + """ + self._recommendation_key = recommendation_key + + @property + def recommendation_type(self): + """ + **[Required]** Gets the recommendation_type of this SqlTuningAdvisorTaskRecommendationSummary. + Type of recommendation + + Allowed values for this property are: "STATISTICS", "INDEX", "SQL_PROFILE", "RESTRUCTURE_SQL", "ALTERNATIVE_PLANS", "ERROR", "MISCELLANEOUS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The recommendation_type of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: str + """ + return self._recommendation_type + + @recommendation_type.setter + def recommendation_type(self, recommendation_type): + """ + Sets the recommendation_type of this SqlTuningAdvisorTaskRecommendationSummary. + Type of recommendation + + + :param recommendation_type: The recommendation_type of this SqlTuningAdvisorTaskRecommendationSummary. + :type: str + """ + allowed_values = ["STATISTICS", "INDEX", "SQL_PROFILE", "RESTRUCTURE_SQL", "ALTERNATIVE_PLANS", "ERROR", "MISCELLANEOUS"] + if not value_allowed_none_or_none_sentinel(recommendation_type, allowed_values): + recommendation_type = 'UNKNOWN_ENUM_VALUE' + self._recommendation_type = recommendation_type + + @property + def finding(self): + """ + Gets the finding of this SqlTuningAdvisorTaskRecommendationSummary. + Summary of the issue found for the SQL statement. + + + :return: The finding of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: str + """ + return self._finding + + @finding.setter + def finding(self, finding): + """ + Sets the finding of this SqlTuningAdvisorTaskRecommendationSummary. + Summary of the issue found for the SQL statement. + + + :param finding: The finding of this SqlTuningAdvisorTaskRecommendationSummary. + :type: str + """ + self._finding = finding + + @property + def recommendation(self): + """ + Gets the recommendation of this SqlTuningAdvisorTaskRecommendationSummary. + Particular recommendation for the finding. + + + :return: The recommendation of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: str + """ + return self._recommendation + + @recommendation.setter + def recommendation(self, recommendation): + """ + Sets the recommendation of this SqlTuningAdvisorTaskRecommendationSummary. + Particular recommendation for the finding. + + + :param recommendation: The recommendation of this SqlTuningAdvisorTaskRecommendationSummary. + :type: str + """ + self._recommendation = recommendation + + @property + def rationale(self): + """ + Gets the rationale of this SqlTuningAdvisorTaskRecommendationSummary. + Describes the reasoning behind the recommendation and how it relates to the finding. + + + :return: The rationale of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: str + """ + return self._rationale + + @rationale.setter + def rationale(self, rationale): + """ + Sets the rationale of this SqlTuningAdvisorTaskRecommendationSummary. + Describes the reasoning behind the recommendation and how it relates to the finding. + + + :param rationale: The rationale of this SqlTuningAdvisorTaskRecommendationSummary. + :type: str + """ + self._rationale = rationale + + @property + def benefit(self): + """ + Gets the benefit of this SqlTuningAdvisorTaskRecommendationSummary. + The percentage benefit of this implementation. + + + :return: The benefit of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: float + """ + return self._benefit + + @benefit.setter + def benefit(self, benefit): + """ + Sets the benefit of this SqlTuningAdvisorTaskRecommendationSummary. + The percentage benefit of this implementation. + + + :param benefit: The benefit of this SqlTuningAdvisorTaskRecommendationSummary. + :type: float + """ + self._benefit = benefit + + @property + def implement_action_sql(self): + """ + Gets the implement_action_sql of this SqlTuningAdvisorTaskRecommendationSummary. + Action sql to be implemented based on the recommendation result. + + + :return: The implement_action_sql of this SqlTuningAdvisorTaskRecommendationSummary. + :rtype: str + """ + return self._implement_action_sql + + @implement_action_sql.setter + def implement_action_sql(self, implement_action_sql): + """ + Sets the implement_action_sql of this SqlTuningAdvisorTaskRecommendationSummary. + Action sql to be implemented based on the recommendation result. + + + :param implement_action_sql: The implement_action_sql of this SqlTuningAdvisorTaskRecommendationSummary. + :type: str + """ + self._implement_action_sql = implement_action_sql + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_sql_execution_plan.py b/src/oci/database_management/models/sql_tuning_advisor_task_sql_execution_plan.py new file mode 100644 index 0000000000..8e32b8a382 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_sql_execution_plan.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSqlExecutionPlan(object): + """ + A SQL execution plan. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSqlExecutionPlan object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param plan: + The value to assign to the plan property of this SqlTuningAdvisorTaskSqlExecutionPlan. + :type plan: list[oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep] + + """ + self.swagger_types = { + 'plan': 'list[SqlTuningTaskSqlExecutionPlanStep]' + } + + self.attribute_map = { + 'plan': 'plan' + } + + self._plan = None + + @property + def plan(self): + """ + **[Required]** Gets the plan of this SqlTuningAdvisorTaskSqlExecutionPlan. + A SQL execution plan as a list of steps + + + :return: The plan of this SqlTuningAdvisorTaskSqlExecutionPlan. + :rtype: list[oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep] + """ + return self._plan + + @plan.setter + def plan(self, plan): + """ + Sets the plan of this SqlTuningAdvisorTaskSqlExecutionPlan. + A SQL execution plan as a list of steps + + + :param plan: The plan of this SqlTuningAdvisorTaskSqlExecutionPlan. + :type: list[oci.database_management.models.SqlTuningTaskSqlExecutionPlanStep] + """ + self._plan = plan + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary.py new file mode 100644 index 0000000000..8058be0262 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary.py @@ -0,0 +1,447 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummary(object): + """ + The summary for a SQL Tuning Advisor task. + """ + + #: A constant which can be used with the task_status property of a SqlTuningAdvisorTaskSummary. + #: This constant has a value of "COMPLETED" + TASK_STATUS_COMPLETED = "COMPLETED" + + #: A constant which can be used with the task_status property of a SqlTuningAdvisorTaskSummary. + #: This constant has a value of "INITIAL" + TASK_STATUS_INITIAL = "INITIAL" + + #: A constant which can be used with the task_status property of a SqlTuningAdvisorTaskSummary. + #: This constant has a value of "EXECUTING" + TASK_STATUS_EXECUTING = "EXECUTING" + + #: A constant which can be used with the task_status property of a SqlTuningAdvisorTaskSummary. + #: This constant has a value of "INTERRUPTED" + TASK_STATUS_INTERRUPTED = "INTERRUPTED" + + #: A constant which can be used with the task_status property of a SqlTuningAdvisorTaskSummary. + #: This constant has a value of "ERROR" + TASK_STATUS_ERROR = "ERROR" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_advisor_task_id: + The value to assign to the sql_tuning_advisor_task_id property of this SqlTuningAdvisorTaskSummary. + :type sql_tuning_advisor_task_id: int + + :param instance_id: + The value to assign to the instance_id property of this SqlTuningAdvisorTaskSummary. + :type instance_id: int + + :param name: + The value to assign to the name property of this SqlTuningAdvisorTaskSummary. + :type name: str + + :param description: + The value to assign to the description property of this SqlTuningAdvisorTaskSummary. + :type description: str + + :param owner: + The value to assign to the owner property of this SqlTuningAdvisorTaskSummary. + :type owner: str + + :param time_created: + The value to assign to the time_created property of this SqlTuningAdvisorTaskSummary. + :type time_created: datetime + + :param task_status: + The value to assign to the task_status property of this SqlTuningAdvisorTaskSummary. + Allowed values for this property are: "COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type task_status: str + + :param days_to_expire: + The value to assign to the days_to_expire property of this SqlTuningAdvisorTaskSummary. + :type days_to_expire: int + + :param time_execution_started: + The value to assign to the time_execution_started property of this SqlTuningAdvisorTaskSummary. + :type time_execution_started: datetime + + :param time_execution_ended: + The value to assign to the time_execution_ended property of this SqlTuningAdvisorTaskSummary. + :type time_execution_ended: datetime + + :param total_sql_statements: + The value to assign to the total_sql_statements property of this SqlTuningAdvisorTaskSummary. + :type total_sql_statements: int + + :param recommendation_count: + The value to assign to the recommendation_count property of this SqlTuningAdvisorTaskSummary. + :type recommendation_count: int + + """ + self.swagger_types = { + 'sql_tuning_advisor_task_id': 'int', + 'instance_id': 'int', + 'name': 'str', + 'description': 'str', + 'owner': 'str', + 'time_created': 'datetime', + 'task_status': 'str', + 'days_to_expire': 'int', + 'time_execution_started': 'datetime', + 'time_execution_ended': 'datetime', + 'total_sql_statements': 'int', + 'recommendation_count': 'int' + } + + self.attribute_map = { + 'sql_tuning_advisor_task_id': 'sqlTuningAdvisorTaskId', + 'instance_id': 'instanceId', + 'name': 'name', + 'description': 'description', + 'owner': 'owner', + 'time_created': 'timeCreated', + 'task_status': 'taskStatus', + 'days_to_expire': 'daysToExpire', + 'time_execution_started': 'timeExecutionStarted', + 'time_execution_ended': 'timeExecutionEnded', + 'total_sql_statements': 'totalSqlStatements', + 'recommendation_count': 'recommendationCount' + } + + self._sql_tuning_advisor_task_id = None + self._instance_id = None + self._name = None + self._description = None + self._owner = None + self._time_created = None + self._task_status = None + self._days_to_expire = None + self._time_execution_started = None + self._time_execution_ended = None + self._total_sql_statements = None + self._recommendation_count = None + + @property + def sql_tuning_advisor_task_id(self): + """ + **[Required]** Gets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskSummary. + :rtype: int + """ + return self._sql_tuning_advisor_task_id + + @sql_tuning_advisor_task_id.setter + def sql_tuning_advisor_task_id(self, sql_tuning_advisor_task_id): + """ + Sets the sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskSummary. + Unique identifier of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_advisor_task_id: The sql_tuning_advisor_task_id of this SqlTuningAdvisorTaskSummary. + :type: int + """ + self._sql_tuning_advisor_task_id = sql_tuning_advisor_task_id + + @property + def instance_id(self): + """ + Gets the instance_id of this SqlTuningAdvisorTaskSummary. + The instance id of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The instance_id of this SqlTuningAdvisorTaskSummary. + :rtype: int + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this SqlTuningAdvisorTaskSummary. + The instance id of the task. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param instance_id: The instance_id of this SqlTuningAdvisorTaskSummary. + :type: int + """ + self._instance_id = instance_id + + @property + def name(self): + """ + Gets the name of this SqlTuningAdvisorTaskSummary. + The name of the task. + + + :return: The name of this SqlTuningAdvisorTaskSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SqlTuningAdvisorTaskSummary. + The name of the task. + + + :param name: The name of this SqlTuningAdvisorTaskSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this SqlTuningAdvisorTaskSummary. + The description of the task. + + + :return: The description of this SqlTuningAdvisorTaskSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SqlTuningAdvisorTaskSummary. + The description of the task. + + + :param description: The description of this SqlTuningAdvisorTaskSummary. + :type: str + """ + self._description = description + + @property + def owner(self): + """ + Gets the owner of this SqlTuningAdvisorTaskSummary. + The owner of the task. + + + :return: The owner of this SqlTuningAdvisorTaskSummary. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this SqlTuningAdvisorTaskSummary. + The owner of the task. + + + :param owner: The owner of this SqlTuningAdvisorTaskSummary. + :type: str + """ + self._owner = owner + + @property + def time_created(self): + """ + Gets the time_created of this SqlTuningAdvisorTaskSummary. + Creation date of the task. + + + :return: The time_created of this SqlTuningAdvisorTaskSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this SqlTuningAdvisorTaskSummary. + Creation date of the task. + + + :param time_created: The time_created of this SqlTuningAdvisorTaskSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def task_status(self): + """ + Gets the task_status of this SqlTuningAdvisorTaskSummary. + The status of the task. + + Allowed values for this property are: "COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The task_status of this SqlTuningAdvisorTaskSummary. + :rtype: str + """ + return self._task_status + + @task_status.setter + def task_status(self, task_status): + """ + Sets the task_status of this SqlTuningAdvisorTaskSummary. + The status of the task. + + + :param task_status: The task_status of this SqlTuningAdvisorTaskSummary. + :type: str + """ + allowed_values = ["COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR"] + if not value_allowed_none_or_none_sentinel(task_status, allowed_values): + task_status = 'UNKNOWN_ENUM_VALUE' + self._task_status = task_status + + @property + def days_to_expire(self): + """ + Gets the days_to_expire of this SqlTuningAdvisorTaskSummary. + Days to expire the task. If the value equals -1 then the task has no expiration time (UNLIMITED). + + + :return: The days_to_expire of this SqlTuningAdvisorTaskSummary. + :rtype: int + """ + return self._days_to_expire + + @days_to_expire.setter + def days_to_expire(self, days_to_expire): + """ + Sets the days_to_expire of this SqlTuningAdvisorTaskSummary. + Days to expire the task. If the value equals -1 then the task has no expiration time (UNLIMITED). + + + :param days_to_expire: The days_to_expire of this SqlTuningAdvisorTaskSummary. + :type: int + """ + self._days_to_expire = days_to_expire + + @property + def time_execution_started(self): + """ + Gets the time_execution_started of this SqlTuningAdvisorTaskSummary. + Start timestamp of task execution. + + + :return: The time_execution_started of this SqlTuningAdvisorTaskSummary. + :rtype: datetime + """ + return self._time_execution_started + + @time_execution_started.setter + def time_execution_started(self, time_execution_started): + """ + Sets the time_execution_started of this SqlTuningAdvisorTaskSummary. + Start timestamp of task execution. + + + :param time_execution_started: The time_execution_started of this SqlTuningAdvisorTaskSummary. + :type: datetime + """ + self._time_execution_started = time_execution_started + + @property + def time_execution_ended(self): + """ + Gets the time_execution_ended of this SqlTuningAdvisorTaskSummary. + End timestamp of task execution. + + + :return: The time_execution_ended of this SqlTuningAdvisorTaskSummary. + :rtype: datetime + """ + return self._time_execution_ended + + @time_execution_ended.setter + def time_execution_ended(self, time_execution_ended): + """ + Sets the time_execution_ended of this SqlTuningAdvisorTaskSummary. + End timestamp of task execution. + + + :param time_execution_ended: The time_execution_ended of this SqlTuningAdvisorTaskSummary. + :type: datetime + """ + self._time_execution_ended = time_execution_ended + + @property + def total_sql_statements(self): + """ + Gets the total_sql_statements of this SqlTuningAdvisorTaskSummary. + The total number of SQL statements related to the SQL tuning advisor task. + + + :return: The total_sql_statements of this SqlTuningAdvisorTaskSummary. + :rtype: int + """ + return self._total_sql_statements + + @total_sql_statements.setter + def total_sql_statements(self, total_sql_statements): + """ + Sets the total_sql_statements of this SqlTuningAdvisorTaskSummary. + The total number of SQL statements related to the SQL tuning advisor task. + + + :param total_sql_statements: The total_sql_statements of this SqlTuningAdvisorTaskSummary. + :type: int + """ + self._total_sql_statements = total_sql_statements + + @property + def recommendation_count(self): + """ + Gets the recommendation_count of this SqlTuningAdvisorTaskSummary. + Number of recommendations produced. + + + :return: The recommendation_count of this SqlTuningAdvisorTaskSummary. + :rtype: int + """ + return self._recommendation_count + + @recommendation_count.setter + def recommendation_count(self, recommendation_count): + """ + Sets the recommendation_count of this SqlTuningAdvisorTaskSummary. + Number of recommendations produced. + + + :param recommendation_count: The recommendation_count of this SqlTuningAdvisorTaskSummary. + :type: int + """ + self._recommendation_count = recommendation_count + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_benefits.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_benefits.py new file mode 100644 index 0000000000..9584832413 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_benefits.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryFindingBenefits(object): + """ + The finding benefits data for the SQL Tuning Advisor summary report. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryFindingBenefits object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param db_time_before_recommended: + The value to assign to the db_time_before_recommended property of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type db_time_before_recommended: int + + :param db_time_after_recommended: + The value to assign to the db_time_after_recommended property of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type db_time_after_recommended: int + + :param db_time_before_implemented: + The value to assign to the db_time_before_implemented property of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type db_time_before_implemented: int + + :param db_time_after_implemented: + The value to assign to the db_time_after_implemented property of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type db_time_after_implemented: int + + """ + self.swagger_types = { + 'db_time_before_recommended': 'int', + 'db_time_after_recommended': 'int', + 'db_time_before_implemented': 'int', + 'db_time_after_implemented': 'int' + } + + self.attribute_map = { + 'db_time_before_recommended': 'dbTimeBeforeRecommended', + 'db_time_after_recommended': 'dbTimeAfterRecommended', + 'db_time_before_implemented': 'dbTimeBeforeImplemented', + 'db_time_after_implemented': 'dbTimeAfterImplemented' + } + + self._db_time_before_recommended = None + self._db_time_after_recommended = None + self._db_time_before_implemented = None + self._db_time_after_implemented = None + + @property + def db_time_before_recommended(self): + """ + **[Required]** Gets the db_time_before_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of Potential database time before SQL recommendations are implemented. + + + :return: The db_time_before_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :rtype: int + """ + return self._db_time_before_recommended + + @db_time_before_recommended.setter + def db_time_before_recommended(self, db_time_before_recommended): + """ + Sets the db_time_before_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of Potential database time before SQL recommendations are implemented. + + + :param db_time_before_recommended: The db_time_before_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type: int + """ + self._db_time_before_recommended = db_time_before_recommended + + @property + def db_time_after_recommended(self): + """ + **[Required]** Gets the db_time_after_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of Potential database time after SQL recommendations are implemented. + + + :return: The db_time_after_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :rtype: int + """ + return self._db_time_after_recommended + + @db_time_after_recommended.setter + def db_time_after_recommended(self, db_time_after_recommended): + """ + Sets the db_time_after_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of Potential database time after SQL recommendations are implemented. + + + :param db_time_after_recommended: The db_time_after_recommended of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type: int + """ + self._db_time_after_recommended = db_time_after_recommended + + @property + def db_time_before_implemented(self): + """ + **[Required]** Gets the db_time_before_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of database time benefit before SQL recommendations are implemented. + + + :return: The db_time_before_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :rtype: int + """ + return self._db_time_before_implemented + + @db_time_before_implemented.setter + def db_time_before_implemented(self, db_time_before_implemented): + """ + Sets the db_time_before_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of database time benefit before SQL recommendations are implemented. + + + :param db_time_before_implemented: The db_time_before_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type: int + """ + self._db_time_before_implemented = db_time_before_implemented + + @property + def db_time_after_implemented(self): + """ + **[Required]** Gets the db_time_after_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of database time benefit after SQL recommendations are implemented. + + + :return: The db_time_after_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :rtype: int + """ + return self._db_time_after_implemented + + @db_time_after_implemented.setter + def db_time_after_implemented(self, db_time_after_implemented): + """ + Sets the db_time_after_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + The count of database time benefit after SQL recommendations are implemented. + + + :param db_time_after_implemented: The db_time_after_implemented of this SqlTuningAdvisorTaskSummaryFindingBenefits. + :type: int + """ + self._db_time_after_implemented = db_time_after_implemented + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_counts.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_counts.py new file mode 100644 index 0000000000..1a0b603423 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_finding_counts.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryFindingCounts(object): + """ + The finding counts data for the SQL Tuning Advisor summary report. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryFindingCounts object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recommended_sql_profile: + The value to assign to the recommended_sql_profile property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type recommended_sql_profile: int + + :param implemented_sql_profile: + The value to assign to the implemented_sql_profile property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type implemented_sql_profile: int + + :param index: + The value to assign to the index property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type index: int + + :param restructure: + The value to assign to the restructure property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type restructure: int + + :param statistics: + The value to assign to the statistics property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type statistics: int + + :param alternate_plan: + The value to assign to the alternate_plan property of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type alternate_plan: int + + """ + self.swagger_types = { + 'recommended_sql_profile': 'int', + 'implemented_sql_profile': 'int', + 'index': 'int', + 'restructure': 'int', + 'statistics': 'int', + 'alternate_plan': 'int' + } + + self.attribute_map = { + 'recommended_sql_profile': 'recommendedSqlProfile', + 'implemented_sql_profile': 'implementedSqlProfile', + 'index': 'index', + 'restructure': 'restructure', + 'statistics': 'statistics', + 'alternate_plan': 'alternatePlan' + } + + self._recommended_sql_profile = None + self._implemented_sql_profile = None + self._index = None + self._restructure = None + self._statistics = None + self._alternate_plan = None + + @property + def recommended_sql_profile(self): + """ + **[Required]** Gets the recommended_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with recommended SQL profiles. + + + :return: The recommended_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._recommended_sql_profile + + @recommended_sql_profile.setter + def recommended_sql_profile(self, recommended_sql_profile): + """ + Sets the recommended_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with recommended SQL profiles. + + + :param recommended_sql_profile: The recommended_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._recommended_sql_profile = recommended_sql_profile + + @property + def implemented_sql_profile(self): + """ + **[Required]** Gets the implemented_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with implemented SQL profiles. + + + :return: The implemented_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._implemented_sql_profile + + @implemented_sql_profile.setter + def implemented_sql_profile(self, implemented_sql_profile): + """ + Sets the implemented_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with implemented SQL profiles. + + + :param implemented_sql_profile: The implemented_sql_profile of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._implemented_sql_profile = implemented_sql_profile + + @property + def index(self): + """ + **[Required]** Gets the index of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with index recommendations. + + + :return: The index of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._index + + @index.setter + def index(self, index): + """ + Sets the index of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with index recommendations. + + + :param index: The index of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._index = index + + @property + def restructure(self): + """ + **[Required]** Gets the restructure of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with restructure SQL recommendations. + + + :return: The restructure of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._restructure + + @restructure.setter + def restructure(self, restructure): + """ + Sets the restructure of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with restructure SQL recommendations. + + + :param restructure: The restructure of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._restructure = restructure + + @property + def statistics(self): + """ + **[Required]** Gets the statistics of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with stale/missing optimizer statistics recommendations. + + + :return: The statistics of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._statistics + + @statistics.setter + def statistics(self, statistics): + """ + Sets the statistics of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with stale/missing optimizer statistics recommendations. + + + :param statistics: The statistics of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._statistics = statistics + + @property + def alternate_plan(self): + """ + **[Required]** Gets the alternate_plan of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with alternative plan recommendations. + + + :return: The alternate_plan of this SqlTuningAdvisorTaskSummaryFindingCounts. + :rtype: int + """ + return self._alternate_plan + + @alternate_plan.setter + def alternate_plan(self, alternate_plan): + """ + Sets the alternate_plan of this SqlTuningAdvisorTaskSummaryFindingCounts. + The count of distinct SQL statements with alternative plan recommendations. + + + :param alternate_plan: The alternate_plan of this SqlTuningAdvisorTaskSummaryFindingCounts. + :type: int + """ + self._alternate_plan = alternate_plan + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report.py new file mode 100644 index 0000000000..4d84e18e72 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report.py @@ -0,0 +1,155 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReport(object): + """ + The content of the SQL Tuning Advisor summary report. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReport object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param task_info: + The value to assign to the task_info property of this SqlTuningAdvisorTaskSummaryReport. + :type task_info: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo + + :param statistics: + The value to assign to the statistics property of this SqlTuningAdvisorTaskSummaryReport. + :type statistics: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics + + :param object_stat_findings: + The value to assign to the object_stat_findings property of this SqlTuningAdvisorTaskSummaryReport. + :type object_stat_findings: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary] + + :param index_findings: + The value to assign to the index_findings property of this SqlTuningAdvisorTaskSummaryReport. + :type index_findings: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary] + + """ + self.swagger_types = { + 'task_info': 'SqlTuningAdvisorTaskSummaryReportTaskInfo', + 'statistics': 'SqlTuningAdvisorTaskSummaryReportStatistics', + 'object_stat_findings': 'list[SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary]', + 'index_findings': 'list[SqlTuningAdvisorTaskSummaryReportIndexFindingSummary]' + } + + self.attribute_map = { + 'task_info': 'taskInfo', + 'statistics': 'statistics', + 'object_stat_findings': 'objectStatFindings', + 'index_findings': 'indexFindings' + } + + self._task_info = None + self._statistics = None + self._object_stat_findings = None + self._index_findings = None + + @property + def task_info(self): + """ + **[Required]** Gets the task_info of this SqlTuningAdvisorTaskSummaryReport. + + :return: The task_info of this SqlTuningAdvisorTaskSummaryReport. + :rtype: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo + """ + return self._task_info + + @task_info.setter + def task_info(self, task_info): + """ + Sets the task_info of this SqlTuningAdvisorTaskSummaryReport. + + :param task_info: The task_info of this SqlTuningAdvisorTaskSummaryReport. + :type: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportTaskInfo + """ + self._task_info = task_info + + @property + def statistics(self): + """ + **[Required]** Gets the statistics of this SqlTuningAdvisorTaskSummaryReport. + + :return: The statistics of this SqlTuningAdvisorTaskSummaryReport. + :rtype: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics + """ + return self._statistics + + @statistics.setter + def statistics(self, statistics): + """ + Sets the statistics of this SqlTuningAdvisorTaskSummaryReport. + + :param statistics: The statistics of this SqlTuningAdvisorTaskSummaryReport. + :type: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatistics + """ + self._statistics = statistics + + @property + def object_stat_findings(self): + """ + Gets the object_stat_findings of this SqlTuningAdvisorTaskSummaryReport. + The list of object findings related to statistics. + + + :return: The object_stat_findings of this SqlTuningAdvisorTaskSummaryReport. + :rtype: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary] + """ + return self._object_stat_findings + + @object_stat_findings.setter + def object_stat_findings(self, object_stat_findings): + """ + Sets the object_stat_findings of this SqlTuningAdvisorTaskSummaryReport. + The list of object findings related to statistics. + + + :param object_stat_findings: The object_stat_findings of this SqlTuningAdvisorTaskSummaryReport. + :type: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary] + """ + self._object_stat_findings = object_stat_findings + + @property + def index_findings(self): + """ + Gets the index_findings of this SqlTuningAdvisorTaskSummaryReport. + The list of object findings related to indexes. + + + :return: The index_findings of this SqlTuningAdvisorTaskSummaryReport. + :rtype: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary] + """ + return self._index_findings + + @index_findings.setter + def index_findings(self, index_findings): + """ + Sets the index_findings of this SqlTuningAdvisorTaskSummaryReport. + The list of object findings related to indexes. + + + :param index_findings: The index_findings of this SqlTuningAdvisorTaskSummaryReport. + :type: list[oci.database_management.models.SqlTuningAdvisorTaskSummaryReportIndexFindingSummary] + """ + self._index_findings = index_findings + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.py new file mode 100644 index 0000000000..37d9f988f0 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_index_finding_summary.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReportIndexFindingSummary(object): + """ + A summary for all the index findings in a SQL Tuning Advisor task. Includes the index's hash value, table name, schema, index name, reference count and index columns + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReportIndexFindingSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param index_hash_value: + The value to assign to the index_hash_value property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type index_hash_value: int + + :param index_name: + The value to assign to the index_name property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type index_name: str + + :param table_name: + The value to assign to the table_name property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type table_name: str + + :param schema: + The value to assign to the schema property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type schema: str + + :param reference_count: + The value to assign to the reference_count property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type reference_count: int + + :param index_columns: + The value to assign to the index_columns property of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type index_columns: list[str] + + """ + self.swagger_types = { + 'index_hash_value': 'int', + 'index_name': 'str', + 'table_name': 'str', + 'schema': 'str', + 'reference_count': 'int', + 'index_columns': 'list[str]' + } + + self.attribute_map = { + 'index_hash_value': 'indexHashValue', + 'index_name': 'indexName', + 'table_name': 'tableName', + 'schema': 'schema', + 'reference_count': 'referenceCount', + 'index_columns': 'indexColumns' + } + + self._index_hash_value = None + self._index_name = None + self._table_name = None + self._schema = None + self._reference_count = None + self._index_columns = None + + @property + def index_hash_value(self): + """ + **[Required]** Gets the index_hash_value of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Numerical representation of the index. + + + :return: The index_hash_value of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: int + """ + return self._index_hash_value + + @index_hash_value.setter + def index_hash_value(self, index_hash_value): + """ + Sets the index_hash_value of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Numerical representation of the index. + + + :param index_hash_value: The index_hash_value of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: int + """ + self._index_hash_value = index_hash_value + + @property + def index_name(self): + """ + **[Required]** Gets the index_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Name of the index. + + + :return: The index_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: str + """ + return self._index_name + + @index_name.setter + def index_name(self, index_name): + """ + Sets the index_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Name of the index. + + + :param index_name: The index_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: str + """ + self._index_name = index_name + + @property + def table_name(self): + """ + **[Required]** Gets the table_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Table's name related to the index. + + + :return: The table_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: str + """ + return self._table_name + + @table_name.setter + def table_name(self, table_name): + """ + Sets the table_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Table's name related to the index. + + + :param table_name: The table_name of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: str + """ + self._table_name = table_name + + @property + def schema(self): + """ + **[Required]** Gets the schema of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Schema related to the index. + + + :return: The schema of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: str + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Schema related to the index. + + + :param schema: The schema of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: str + """ + self._schema = schema + + @property + def reference_count(self): + """ + **[Required]** Gets the reference_count of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + The number of times the index is referenced within the SQL Tuning advisor task findings. + + + :return: The reference_count of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: int + """ + return self._reference_count + + @reference_count.setter + def reference_count(self, reference_count): + """ + Sets the reference_count of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + The number of times the index is referenced within the SQL Tuning advisor task findings. + + + :param reference_count: The reference_count of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: int + """ + self._reference_count = reference_count + + @property + def index_columns(self): + """ + **[Required]** Gets the index_columns of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Columns of the index. + + + :return: The index_columns of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :rtype: list[str] + """ + return self._index_columns + + @index_columns.setter + def index_columns(self, index_columns): + """ + Sets the index_columns of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + Columns of the index. + + + :param index_columns: The index_columns of this SqlTuningAdvisorTaskSummaryReportIndexFindingSummary. + :type: list[str] + """ + self._index_columns = index_columns + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_object_stat_finding_summary.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_object_stat_finding_summary.py new file mode 100644 index 0000000000..8a1f9f8a25 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_object_stat_finding_summary.py @@ -0,0 +1,241 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary(object): + """ + A summary for all the statistic findings of an object in a SQL Tuning Advisor task. Includes the object's hash, name, type, schema, problem type and the object reference count. + """ + + #: A constant which can be used with the problem_type property of a SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + #: This constant has a value of "MISSING" + PROBLEM_TYPE_MISSING = "MISSING" + + #: A constant which can be used with the problem_type property of a SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + #: This constant has a value of "STALE" + PROBLEM_TYPE_STALE = "STALE" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param object_hash_value: + The value to assign to the object_hash_value property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type object_hash_value: int + + :param object_name: + The value to assign to the object_name property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type object_name: str + + :param object_type: + The value to assign to the object_type property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type object_type: str + + :param schema: + The value to assign to the schema property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type schema: str + + :param problem_type: + The value to assign to the problem_type property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Allowed values for this property are: "MISSING", "STALE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type problem_type: str + + :param reference_count: + The value to assign to the reference_count property of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type reference_count: int + + """ + self.swagger_types = { + 'object_hash_value': 'int', + 'object_name': 'str', + 'object_type': 'str', + 'schema': 'str', + 'problem_type': 'str', + 'reference_count': 'int' + } + + self.attribute_map = { + 'object_hash_value': 'objectHashValue', + 'object_name': 'objectName', + 'object_type': 'objectType', + 'schema': 'schema', + 'problem_type': 'problemType', + 'reference_count': 'referenceCount' + } + + self._object_hash_value = None + self._object_name = None + self._object_type = None + self._schema = None + self._problem_type = None + self._reference_count = None + + @property + def object_hash_value(self): + """ + **[Required]** Gets the object_hash_value of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Numerical representation of the object. + + + :return: The object_hash_value of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: int + """ + return self._object_hash_value + + @object_hash_value.setter + def object_hash_value(self, object_hash_value): + """ + Sets the object_hash_value of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Numerical representation of the object. + + + :param object_hash_value: The object_hash_value of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: int + """ + self._object_hash_value = object_hash_value + + @property + def object_name(self): + """ + **[Required]** Gets the object_name of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Name of the object. + + + :return: The object_name of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Name of the object. + + + :param object_name: The object_name of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: str + """ + self._object_name = object_name + + @property + def object_type(self): + """ + **[Required]** Gets the object_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Type of the object. + + + :return: The object_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: str + """ + return self._object_type + + @object_type.setter + def object_type(self, object_type): + """ + Sets the object_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Type of the object. + + + :param object_type: The object_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: str + """ + self._object_type = object_type + + @property + def schema(self): + """ + **[Required]** Gets the schema of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Schema of the object. + + + :return: The schema of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: str + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Schema of the object. + + + :param schema: The schema of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: str + """ + self._schema = schema + + @property + def problem_type(self): + """ + **[Required]** Gets the problem_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Type of statistics problem related to the object. + + Allowed values for this property are: "MISSING", "STALE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The problem_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: str + """ + return self._problem_type + + @problem_type.setter + def problem_type(self, problem_type): + """ + Sets the problem_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + Type of statistics problem related to the object. + + + :param problem_type: The problem_type of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: str + """ + allowed_values = ["MISSING", "STALE"] + if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): + problem_type = 'UNKNOWN_ENUM_VALUE' + self._problem_type = problem_type + + @property + def reference_count(self): + """ + **[Required]** Gets the reference_count of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + The number of the times the object is referenced within the SQL Tuning advisor task findings. + + + :return: The reference_count of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :rtype: int + """ + return self._reference_count + + @reference_count.setter + def reference_count(self, reference_count): + """ + Sets the reference_count of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + The number of the times the object is referenced within the SQL Tuning advisor task findings. + + + :param reference_count: The reference_count of this SqlTuningAdvisorTaskSummaryReportObjectStatFindingSummary. + :type: int + """ + self._reference_count = reference_count + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statement_counts.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statement_counts.py new file mode 100644 index 0000000000..a25a140f17 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statement_counts.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReportStatementCounts(object): + """ + The statement counts data for the SQL Tuning Advisor summary report. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReportStatementCounts object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param distinct_sql: + The value to assign to the distinct_sql property of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type distinct_sql: int + + :param total_sql: + The value to assign to the total_sql property of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type total_sql: int + + :param finding_count: + The value to assign to the finding_count property of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type finding_count: int + + :param error_count: + The value to assign to the error_count property of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type error_count: int + + """ + self.swagger_types = { + 'distinct_sql': 'int', + 'total_sql': 'int', + 'finding_count': 'int', + 'error_count': 'int' + } + + self.attribute_map = { + 'distinct_sql': 'distinctSql', + 'total_sql': 'totalSql', + 'finding_count': 'findingCount', + 'error_count': 'errorCount' + } + + self._distinct_sql = None + self._total_sql = None + self._finding_count = None + self._error_count = None + + @property + def distinct_sql(self): + """ + **[Required]** Gets the distinct_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements. + + + :return: The distinct_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :rtype: int + """ + return self._distinct_sql + + @distinct_sql.setter + def distinct_sql(self, distinct_sql): + """ + Sets the distinct_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements. + + + :param distinct_sql: The distinct_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type: int + """ + self._distinct_sql = distinct_sql + + @property + def total_sql(self): + """ + **[Required]** Gets the total_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The total count of SQL statements. + + + :return: The total_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :rtype: int + """ + return self._total_sql + + @total_sql.setter + def total_sql(self, total_sql): + """ + Sets the total_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The total count of SQL statements. + + + :param total_sql: The total_sql of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type: int + """ + self._total_sql = total_sql + + @property + def finding_count(self): + """ + **[Required]** Gets the finding_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements with findings. + + + :return: The finding_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :rtype: int + """ + return self._finding_count + + @finding_count.setter + def finding_count(self, finding_count): + """ + Sets the finding_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements with findings. + + + :param finding_count: The finding_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type: int + """ + self._finding_count = finding_count + + @property + def error_count(self): + """ + **[Required]** Gets the error_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements with errors. + + + :return: The error_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :rtype: int + """ + return self._error_count + + @error_count.setter + def error_count(self, error_count): + """ + Sets the error_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + The count of distinct SQL statements with errors. + + + :param error_count: The error_count of this SqlTuningAdvisorTaskSummaryReportStatementCounts. + :type: int + """ + self._error_count = error_count + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statistics.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statistics.py new file mode 100644 index 0000000000..7c1656b80c --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_statistics.py @@ -0,0 +1,120 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReportStatistics(object): + """ + Statistics of statements and findings for the SQL Tuning Advisor summary report. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReportStatistics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param statement_counts: + The value to assign to the statement_counts property of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type statement_counts: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts + + :param finding_counts: + The value to assign to the finding_counts property of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type finding_counts: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts + + :param finding_benefits: + The value to assign to the finding_benefits property of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type finding_benefits: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits + + """ + self.swagger_types = { + 'statement_counts': 'SqlTuningAdvisorTaskSummaryReportStatementCounts', + 'finding_counts': 'SqlTuningAdvisorTaskSummaryFindingCounts', + 'finding_benefits': 'SqlTuningAdvisorTaskSummaryFindingBenefits' + } + + self.attribute_map = { + 'statement_counts': 'statementCounts', + 'finding_counts': 'findingCounts', + 'finding_benefits': 'findingBenefits' + } + + self._statement_counts = None + self._finding_counts = None + self._finding_benefits = None + + @property + def statement_counts(self): + """ + **[Required]** Gets the statement_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :return: The statement_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + :rtype: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts + """ + return self._statement_counts + + @statement_counts.setter + def statement_counts(self, statement_counts): + """ + Sets the statement_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :param statement_counts: The statement_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type: oci.database_management.models.SqlTuningAdvisorTaskSummaryReportStatementCounts + """ + self._statement_counts = statement_counts + + @property + def finding_counts(self): + """ + **[Required]** Gets the finding_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :return: The finding_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + :rtype: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts + """ + return self._finding_counts + + @finding_counts.setter + def finding_counts(self, finding_counts): + """ + Sets the finding_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :param finding_counts: The finding_counts of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingCounts + """ + self._finding_counts = finding_counts + + @property + def finding_benefits(self): + """ + **[Required]** Gets the finding_benefits of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :return: The finding_benefits of this SqlTuningAdvisorTaskSummaryReportStatistics. + :rtype: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits + """ + return self._finding_benefits + + @finding_benefits.setter + def finding_benefits(self, finding_benefits): + """ + Sets the finding_benefits of this SqlTuningAdvisorTaskSummaryReportStatistics. + + :param finding_benefits: The finding_benefits of this SqlTuningAdvisorTaskSummaryReportStatistics. + :type: oci.database_management.models.SqlTuningAdvisorTaskSummaryFindingBenefits + """ + self._finding_benefits = finding_benefits + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.py b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.py new file mode 100644 index 0000000000..1f8bf8f798 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.py @@ -0,0 +1,319 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningAdvisorTaskSummaryReportTaskInfo(object): + """ + SQL Tuning advisor task general info. + """ + + #: A constant which can be used with the status property of a SqlTuningAdvisorTaskSummaryReportTaskInfo. + #: This constant has a value of "COMPLETED" + STATUS_COMPLETED = "COMPLETED" + + #: A constant which can be used with the status property of a SqlTuningAdvisorTaskSummaryReportTaskInfo. + #: This constant has a value of "INITIAL" + STATUS_INITIAL = "INITIAL" + + #: A constant which can be used with the status property of a SqlTuningAdvisorTaskSummaryReportTaskInfo. + #: This constant has a value of "EXECUTING" + STATUS_EXECUTING = "EXECUTING" + + #: A constant which can be used with the status property of a SqlTuningAdvisorTaskSummaryReportTaskInfo. + #: This constant has a value of "INTERRUPTED" + STATUS_INTERRUPTED = "INTERRUPTED" + + #: A constant which can be used with the status property of a SqlTuningAdvisorTaskSummaryReportTaskInfo. + #: This constant has a value of "ERROR" + STATUS_ERROR = "ERROR" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningAdvisorTaskSummaryReportTaskInfo 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 SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type id: int + + :param name: + The value to assign to the name property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type name: str + + :param description: + The value to assign to the description property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type description: str + + :param owner: + The value to assign to the owner property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type owner: str + + :param status: + The value to assign to the status property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + Allowed values for this property are: "COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param time_started: + The value to assign to the time_started property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type time_started: datetime + + :param time_ended: + The value to assign to the time_ended property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type time_ended: datetime + + :param running_time: + The value to assign to the running_time property of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type running_time: int + + """ + self.swagger_types = { + 'id': 'int', + 'name': 'str', + 'description': 'str', + 'owner': 'str', + 'status': 'str', + 'time_started': 'datetime', + 'time_ended': 'datetime', + 'running_time': 'int' + } + + self.attribute_map = { + 'id': 'id', + 'name': 'name', + 'description': 'description', + 'owner': 'owner', + 'status': 'status', + 'time_started': 'timeStarted', + 'time_ended': 'timeEnded', + 'running_time': 'runningTime' + } + + self._id = None + self._name = None + self._description = None + self._owner = None + self._status = None + self._time_started = None + self._time_ended = None + self._running_time = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task id. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The id of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task id. It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param id: The id of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: int + """ + self._id = id + + @property + def name(self): + """ + **[Required]** Gets the name of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task name. + + + :return: The name of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task name. + + + :param name: The name of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task description. Not defined on Auto SQL Tuning tasks. + + + :return: The description of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task description. Not defined on Auto SQL Tuning tasks. + + + :param description: The description of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: str + """ + self._description = description + + @property + def owner(self): + """ + **[Required]** Gets the owner of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task user owner. + + + :return: The owner of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: str + """ + return self._owner + + @owner.setter + def owner(self, owner): + """ + Sets the owner of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task user owner. + + + :param owner: The owner of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: str + """ + self._owner = owner + + @property + def status(self): + """ + Gets the status of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task status. Not defined on Auto SQL Tuning tasks. + + Allowed values for this property are: "COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The SQL Tuning Advisor task status. Not defined on Auto SQL Tuning tasks. + + + :param status: The status of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: str + """ + allowed_values = ["COMPLETED", "INITIAL", "EXECUTING", "INTERRUPTED", "ERROR"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + Start timestamp of task execution. + + + :return: The time_started of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + Start timestamp of task execution. + + + :param time_started: The time_started of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: datetime + """ + self._time_started = time_started + + @property + def time_ended(self): + """ + **[Required]** Gets the time_ended of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + End timestamp of task execution. + + + :return: The time_ended of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: datetime + """ + return self._time_ended + + @time_ended.setter + def time_ended(self, time_ended): + """ + Sets the time_ended of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + End timestamp of task execution. + + + :param time_ended: The time_ended of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: datetime + """ + self._time_ended = time_ended + + @property + def running_time(self): + """ + Gets the running_time of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The total running time in seconds. Not defined on Auto SQL Tuning tasks. + + + :return: The running_time of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :rtype: int + """ + return self._running_time + + @running_time.setter + def running_time(self, running_time): + """ + Sets the running_time of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + The total running time in seconds. Not defined on Auto SQL Tuning tasks. + + + :param running_time: The running_time of this SqlTuningAdvisorTaskSummaryReportTaskInfo. + :type: int + """ + self._running_time = running_time + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_credential_details.py b/src/oci/database_management/models/sql_tuning_task_credential_details.py new file mode 100644 index 0000000000..0fd373c38c --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_credential_details.py @@ -0,0 +1,187 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningTaskCredentialDetails(object): + """ + The credential to be used to connect to the database. + """ + + #: A constant which can be used with the sql_tuning_task_credential_type property of a SqlTuningTaskCredentialDetails. + #: This constant has a value of "SECRET" + SQL_TUNING_TASK_CREDENTIAL_TYPE_SECRET = "SECRET" + + #: A constant which can be used with the sql_tuning_task_credential_type property of a SqlTuningTaskCredentialDetails. + #: This constant has a value of "PASSWORD" + SQL_TUNING_TASK_CREDENTIAL_TYPE_PASSWORD = "PASSWORD" + + #: A constant which can be used with the role property of a SqlTuningTaskCredentialDetails. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a SqlTuningTaskCredentialDetails. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskCredentialDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.database_management.models.SqlTuningTaskSecretCredentialDetails` + * :class:`~oci.database_management.models.SqlTuningTaskPasswordCredentialDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_task_credential_type: + The value to assign to the sql_tuning_task_credential_type property of this SqlTuningTaskCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_task_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningTaskCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningTaskCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + """ + self.swagger_types = { + 'sql_tuning_task_credential_type': 'str', + 'username': 'str', + 'role': 'str' + } + + self.attribute_map = { + 'sql_tuning_task_credential_type': 'sqlTuningTaskCredentialType', + 'username': 'username', + 'role': 'role' + } + + self._sql_tuning_task_credential_type = None + self._username = None + self._role = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['sqlTuningTaskCredentialType'] + + if type == 'SECRET': + return 'SqlTuningTaskSecretCredentialDetails' + + if type == 'PASSWORD': + return 'SqlTuningTaskPasswordCredentialDetails' + else: + return 'SqlTuningTaskCredentialDetails' + + @property + def sql_tuning_task_credential_type(self): + """ + **[Required]** Gets the sql_tuning_task_credential_type of this SqlTuningTaskCredentialDetails. + The type pf the credential for SQL tuning task. + + Allowed values for this property are: "SECRET", "PASSWORD" + + + :return: The sql_tuning_task_credential_type of this SqlTuningTaskCredentialDetails. + :rtype: str + """ + return self._sql_tuning_task_credential_type + + @sql_tuning_task_credential_type.setter + def sql_tuning_task_credential_type(self, sql_tuning_task_credential_type): + """ + Sets the sql_tuning_task_credential_type of this SqlTuningTaskCredentialDetails. + The type pf the credential for SQL tuning task. + + + :param sql_tuning_task_credential_type: The sql_tuning_task_credential_type of this SqlTuningTaskCredentialDetails. + :type: str + """ + allowed_values = ["SECRET", "PASSWORD"] + if not value_allowed_none_or_none_sentinel(sql_tuning_task_credential_type, allowed_values): + raise ValueError( + "Invalid value for `sql_tuning_task_credential_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._sql_tuning_task_credential_type = sql_tuning_task_credential_type + + @property + def username(self): + """ + **[Required]** Gets the username of this SqlTuningTaskCredentialDetails. + The user to connect to the database. + + + :return: The username of this SqlTuningTaskCredentialDetails. + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """ + Sets the username of this SqlTuningTaskCredentialDetails. + The user to connect to the database. + + + :param username: The username of this SqlTuningTaskCredentialDetails. + :type: str + """ + self._username = username + + @property + def role(self): + """ + **[Required]** Gets the role of this SqlTuningTaskCredentialDetails. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA" + + + :return: The role of this SqlTuningTaskCredentialDetails. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this SqlTuningTaskCredentialDetails. + The role of the database user. + + + :param role: The role of this SqlTuningTaskCredentialDetails. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + raise ValueError( + "Invalid value for `role`, must be None or one of {0}" + .format(allowed_values) + ) + self._role = role + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_password_credential_details.py b/src/oci/database_management/models/sql_tuning_task_password_credential_details.py new file mode 100644 index 0000000000..c931cacf83 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_password_credential_details.py @@ -0,0 +1,95 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 .sql_tuning_task_credential_details import SqlTuningTaskCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningTaskPasswordCredentialDetails(SqlTuningTaskCredentialDetails): + """ + User provides a password to be used to connect to the database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskPasswordCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.SqlTuningTaskPasswordCredentialDetails.sql_tuning_task_credential_type` attribute + of this class is ``PASSWORD`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_task_credential_type: + The value to assign to the sql_tuning_task_credential_type property of this SqlTuningTaskPasswordCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_task_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningTaskPasswordCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningTaskPasswordCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param password: + The value to assign to the password property of this SqlTuningTaskPasswordCredentialDetails. + :type password: str + + """ + self.swagger_types = { + 'sql_tuning_task_credential_type': 'str', + 'username': 'str', + 'role': 'str', + 'password': 'str' + } + + self.attribute_map = { + 'sql_tuning_task_credential_type': 'sqlTuningTaskCredentialType', + 'username': 'username', + 'role': 'role', + 'password': 'password' + } + + self._sql_tuning_task_credential_type = None + self._username = None + self._role = None + self._password = None + self._sql_tuning_task_credential_type = 'PASSWORD' + + @property + def password(self): + """ + **[Required]** Gets the password of this SqlTuningTaskPasswordCredentialDetails. + The database user's password encoded using BASE64 scheme. + + + :return: The password of this SqlTuningTaskPasswordCredentialDetails. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this SqlTuningTaskPasswordCredentialDetails. + The database user's password encoded using BASE64 scheme. + + + :param password: The password of this SqlTuningTaskPasswordCredentialDetails. + :type: str + """ + self._password = password + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_plan_stats.py b/src/oci/database_management/models/sql_tuning_task_plan_stats.py new file mode 100644 index 0000000000..f993837896 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_plan_stats.py @@ -0,0 +1,150 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningTaskPlanStats(object): + """ + The statistics of an SQL execution plan. + """ + + #: A constant which can be used with the plan_status property of a SqlTuningTaskPlanStats. + #: This constant has a value of "COMPLETE" + PLAN_STATUS_COMPLETE = "COMPLETE" + + #: A constant which can be used with the plan_status property of a SqlTuningTaskPlanStats. + #: This constant has a value of "PARTIAL" + PLAN_STATUS_PARTIAL = "PARTIAL" + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskPlanStats object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param plan_type: + The value to assign to the plan_type property of this SqlTuningTaskPlanStats. + :type plan_type: str + + :param plan_stats: + The value to assign to the plan_stats property of this SqlTuningTaskPlanStats. + :type plan_stats: dict(str, float) + + :param plan_status: + The value to assign to the plan_status property of this SqlTuningTaskPlanStats. + Allowed values for this property are: "COMPLETE", "PARTIAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type plan_status: str + + """ + self.swagger_types = { + 'plan_type': 'str', + 'plan_stats': 'dict(str, float)', + 'plan_status': 'str' + } + + self.attribute_map = { + 'plan_type': 'planType', + 'plan_stats': 'planStats', + 'plan_status': 'planStatus' + } + + self._plan_type = None + self._plan_stats = None + self._plan_status = None + + @property + def plan_type(self): + """ + **[Required]** Gets the plan_type of this SqlTuningTaskPlanStats. + The type of the plan for the original or the new plan with profile/index etc. + + + :return: The plan_type of this SqlTuningTaskPlanStats. + :rtype: str + """ + return self._plan_type + + @plan_type.setter + def plan_type(self, plan_type): + """ + Sets the plan_type of this SqlTuningTaskPlanStats. + The type of the plan for the original or the new plan with profile/index etc. + + + :param plan_type: The plan_type of this SqlTuningTaskPlanStats. + :type: str + """ + self._plan_type = plan_type + + @property + def plan_stats(self): + """ + **[Required]** Gets the plan_stats of this SqlTuningTaskPlanStats. + A map contains the statistics for the SQL execution using the plan. + The key of the map is the metric's name. The value of the map is the metric's value. + + + :return: The plan_stats of this SqlTuningTaskPlanStats. + :rtype: dict(str, float) + """ + return self._plan_stats + + @plan_stats.setter + def plan_stats(self, plan_stats): + """ + Sets the plan_stats of this SqlTuningTaskPlanStats. + A map contains the statistics for the SQL execution using the plan. + The key of the map is the metric's name. The value of the map is the metric's value. + + + :param plan_stats: The plan_stats of this SqlTuningTaskPlanStats. + :type: dict(str, float) + """ + self._plan_stats = plan_stats + + @property + def plan_status(self): + """ + **[Required]** Gets the plan_status of this SqlTuningTaskPlanStats. + The status of the execution using the plan. + + Allowed values for this property are: "COMPLETE", "PARTIAL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The plan_status of this SqlTuningTaskPlanStats. + :rtype: str + """ + return self._plan_status + + @plan_status.setter + def plan_status(self, plan_status): + """ + Sets the plan_status of this SqlTuningTaskPlanStats. + The status of the execution using the plan. + + + :param plan_status: The plan_status of this SqlTuningTaskPlanStats. + :type: str + """ + allowed_values = ["COMPLETE", "PARTIAL"] + if not value_allowed_none_or_none_sentinel(plan_status, allowed_values): + plan_status = 'UNKNOWN_ENUM_VALUE' + self._plan_status = plan_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/database_management/models/sql_tuning_task_return.py b/src/oci/database_management/models/sql_tuning_task_return.py new file mode 100644 index 0000000000..6510d342b6 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_return.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningTaskReturn(object): + """ + The returned object for starting/cloning a SQL tuning advisor task. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskReturn object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_task_id: + The value to assign to the sql_tuning_task_id property of this SqlTuningTaskReturn. + :type sql_tuning_task_id: int + + """ + self.swagger_types = { + 'sql_tuning_task_id': 'int' + } + + self.attribute_map = { + 'sql_tuning_task_id': 'sqlTuningTaskId' + } + + self._sql_tuning_task_id = None + + @property + def sql_tuning_task_id(self): + """ + **[Required]** Gets the sql_tuning_task_id of this SqlTuningTaskReturn. + The identifier of the task being cloned. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The sql_tuning_task_id of this SqlTuningTaskReturn. + :rtype: int + """ + return self._sql_tuning_task_id + + @sql_tuning_task_id.setter + def sql_tuning_task_id(self, sql_tuning_task_id): + """ + Sets the sql_tuning_task_id of this SqlTuningTaskReturn. + The identifier of the task being cloned. This is not the `OCID`__. + It can be retrieved from the following endpoint + :func:`list_sql_tuning_advisor_tasks` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param sql_tuning_task_id: The sql_tuning_task_id of this SqlTuningTaskReturn. + :type: int + """ + self._sql_tuning_task_id = sql_tuning_task_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_secret_credential_details.py b/src/oci/database_management/models/sql_tuning_task_secret_credential_details.py new file mode 100644 index 0000000000..fd00255a85 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_secret_credential_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 .sql_tuning_task_credential_details import SqlTuningTaskCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SqlTuningTaskSecretCredentialDetails(SqlTuningTaskCredentialDetails): + """ + User provides a secret OCID, which will be used to retrieve the password to connect to the database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskSecretCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.SqlTuningTaskSecretCredentialDetails.sql_tuning_task_credential_type` attribute + of this class is ``SECRET`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_tuning_task_credential_type: + The value to assign to the sql_tuning_task_credential_type property of this SqlTuningTaskSecretCredentialDetails. + Allowed values for this property are: "SECRET", "PASSWORD" + :type sql_tuning_task_credential_type: str + + :param username: + The value to assign to the username property of this SqlTuningTaskSecretCredentialDetails. + :type username: str + + :param role: + The value to assign to the role property of this SqlTuningTaskSecretCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param password_secret_id: + The value to assign to the password_secret_id property of this SqlTuningTaskSecretCredentialDetails. + :type password_secret_id: str + + """ + self.swagger_types = { + 'sql_tuning_task_credential_type': 'str', + 'username': 'str', + 'role': 'str', + 'password_secret_id': 'str' + } + + self.attribute_map = { + 'sql_tuning_task_credential_type': 'sqlTuningTaskCredentialType', + 'username': 'username', + 'role': 'role', + 'password_secret_id': 'passwordSecretId' + } + + self._sql_tuning_task_credential_type = None + self._username = None + self._role = None + self._password_secret_id = None + self._sql_tuning_task_credential_type = 'SECRET' + + @property + def password_secret_id(self): + """ + **[Required]** Gets the password_secret_id of this SqlTuningTaskSecretCredentialDetails. + The `OCID`__ of the Secret + where the database password is stored. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The password_secret_id of this SqlTuningTaskSecretCredentialDetails. + :rtype: str + """ + return self._password_secret_id + + @password_secret_id.setter + def password_secret_id(self, password_secret_id): + """ + Sets the password_secret_id of this SqlTuningTaskSecretCredentialDetails. + The `OCID`__ of the Secret + where the database password is stored. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param password_secret_id: The password_secret_id of this SqlTuningTaskSecretCredentialDetails. + :type: str + """ + self._password_secret_id = password_secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_sql_detail.py b/src/oci/database_management/models/sql_tuning_task_sql_detail.py new file mode 100644 index 0000000000..dddd3f4403 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_sql_detail.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningTaskSqlDetail(object): + """ + The detail of the SQL statements on which SQL tuning is performed. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskSqlDetail object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sql_id: + The value to assign to the sql_id property of this SqlTuningTaskSqlDetail. + :type sql_id: str + + """ + self.swagger_types = { + 'sql_id': 'str' + } + + self.attribute_map = { + 'sql_id': 'sqlId' + } + + self._sql_id = None + + @property + def sql_id(self): + """ + **[Required]** Gets the sql_id of this SqlTuningTaskSqlDetail. + The identifier of a SQL statement. + + + :return: The sql_id of this SqlTuningTaskSqlDetail. + :rtype: str + """ + return self._sql_id + + @sql_id.setter + def sql_id(self, sql_id): + """ + Sets the sql_id of this SqlTuningTaskSqlDetail. + The identifier of a SQL statement. + + + :param sql_id: The sql_id of this SqlTuningTaskSqlDetail. + :type: str + """ + self._sql_id = sql_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/sql_tuning_task_sql_execution_plan_step.py b/src/oci/database_management/models/sql_tuning_task_sql_execution_plan_step.py new file mode 100644 index 0000000000..42c7450378 --- /dev/null +++ b/src/oci/database_management/models/sql_tuning_task_sql_execution_plan_step.py @@ -0,0 +1,960 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningTaskSqlExecutionPlanStep(object): + """ + A step of a SQL execution plan. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SqlTuningTaskSqlExecutionPlanStep object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param plan_hash_value: + The value to assign to the plan_hash_value property of this SqlTuningTaskSqlExecutionPlanStep. + :type plan_hash_value: int + + :param step_id: + The value to assign to the step_id property of this SqlTuningTaskSqlExecutionPlanStep. + :type step_id: int + + :param parent_step_id: + The value to assign to the parent_step_id property of this SqlTuningTaskSqlExecutionPlanStep. + :type parent_step_id: int + + :param position: + The value to assign to the position property of this SqlTuningTaskSqlExecutionPlanStep. + :type position: int + + :param operation: + The value to assign to the operation property of this SqlTuningTaskSqlExecutionPlanStep. + :type operation: str + + :param options: + The value to assign to the options property of this SqlTuningTaskSqlExecutionPlanStep. + :type options: str + + :param optimizer_mode: + The value to assign to the optimizer_mode property of this SqlTuningTaskSqlExecutionPlanStep. + :type optimizer_mode: str + + :param cost: + The value to assign to the cost property of this SqlTuningTaskSqlExecutionPlanStep. + :type cost: float + + :param cardinality: + The value to assign to the cardinality property of this SqlTuningTaskSqlExecutionPlanStep. + :type cardinality: int + + :param bytes: + The value to assign to the bytes property of this SqlTuningTaskSqlExecutionPlanStep. + :type bytes: int + + :param cpu_cost: + The value to assign to the cpu_cost property of this SqlTuningTaskSqlExecutionPlanStep. + :type cpu_cost: float + + :param io_cost: + The value to assign to the io_cost property of this SqlTuningTaskSqlExecutionPlanStep. + :type io_cost: float + + :param temp_space: + The value to assign to the temp_space property of this SqlTuningTaskSqlExecutionPlanStep. + :type temp_space: int + + :param time: + The value to assign to the time property of this SqlTuningTaskSqlExecutionPlanStep. + :type time: int + + :param object_node: + The value to assign to the object_node property of this SqlTuningTaskSqlExecutionPlanStep. + :type object_node: str + + :param object_owner: + The value to assign to the object_owner property of this SqlTuningTaskSqlExecutionPlanStep. + :type object_owner: str + + :param object_name: + The value to assign to the object_name property of this SqlTuningTaskSqlExecutionPlanStep. + :type object_name: str + + :param object_position: + The value to assign to the object_position property of this SqlTuningTaskSqlExecutionPlanStep. + :type object_position: int + + :param object_type: + The value to assign to the object_type property of this SqlTuningTaskSqlExecutionPlanStep. + :type object_type: str + + :param partition_start: + The value to assign to the partition_start property of this SqlTuningTaskSqlExecutionPlanStep. + :type partition_start: str + + :param partition_stop: + The value to assign to the partition_stop property of this SqlTuningTaskSqlExecutionPlanStep. + :type partition_stop: str + + :param partition_id: + The value to assign to the partition_id property of this SqlTuningTaskSqlExecutionPlanStep. + :type partition_id: int + + :param remarks: + The value to assign to the remarks property of this SqlTuningTaskSqlExecutionPlanStep. + :type remarks: str + + :param number_of_search_column: + The value to assign to the number_of_search_column property of this SqlTuningTaskSqlExecutionPlanStep. + :type number_of_search_column: int + + :param other: + The value to assign to the other property of this SqlTuningTaskSqlExecutionPlanStep. + :type other: str + + :param other_tag: + The value to assign to the other_tag property of this SqlTuningTaskSqlExecutionPlanStep. + :type other_tag: str + + :param attribute: + The value to assign to the attribute property of this SqlTuningTaskSqlExecutionPlanStep. + :type attribute: str + + :param access_predicates: + The value to assign to the access_predicates property of this SqlTuningTaskSqlExecutionPlanStep. + :type access_predicates: str + + :param filter_predicates: + The value to assign to the filter_predicates property of this SqlTuningTaskSqlExecutionPlanStep. + :type filter_predicates: str + + """ + self.swagger_types = { + 'plan_hash_value': 'int', + 'step_id': 'int', + 'parent_step_id': 'int', + 'position': 'int', + 'operation': 'str', + 'options': 'str', + 'optimizer_mode': 'str', + 'cost': 'float', + 'cardinality': 'int', + 'bytes': 'int', + 'cpu_cost': 'float', + 'io_cost': 'float', + 'temp_space': 'int', + 'time': 'int', + 'object_node': 'str', + 'object_owner': 'str', + 'object_name': 'str', + 'object_position': 'int', + 'object_type': 'str', + 'partition_start': 'str', + 'partition_stop': 'str', + 'partition_id': 'int', + 'remarks': 'str', + 'number_of_search_column': 'int', + 'other': 'str', + 'other_tag': 'str', + 'attribute': 'str', + 'access_predicates': 'str', + 'filter_predicates': 'str' + } + + self.attribute_map = { + 'plan_hash_value': 'planHashValue', + 'step_id': 'stepId', + 'parent_step_id': 'parentStepId', + 'position': 'position', + 'operation': 'operation', + 'options': 'options', + 'optimizer_mode': 'optimizerMode', + 'cost': 'cost', + 'cardinality': 'cardinality', + 'bytes': 'bytes', + 'cpu_cost': 'cpuCost', + 'io_cost': 'ioCost', + 'temp_space': 'tempSpace', + 'time': 'time', + 'object_node': 'objectNode', + 'object_owner': 'objectOwner', + 'object_name': 'objectName', + 'object_position': 'objectPosition', + 'object_type': 'objectType', + 'partition_start': 'partitionStart', + 'partition_stop': 'partitionStop', + 'partition_id': 'partitionId', + 'remarks': 'remarks', + 'number_of_search_column': 'numberOfSearchColumn', + 'other': 'other', + 'other_tag': 'otherTag', + 'attribute': 'attribute', + 'access_predicates': 'accessPredicates', + 'filter_predicates': 'filterPredicates' + } + + self._plan_hash_value = None + self._step_id = None + self._parent_step_id = None + self._position = None + self._operation = None + self._options = None + self._optimizer_mode = None + self._cost = None + self._cardinality = None + self._bytes = None + self._cpu_cost = None + self._io_cost = None + self._temp_space = None + self._time = None + self._object_node = None + self._object_owner = None + self._object_name = None + self._object_position = None + self._object_type = None + self._partition_start = None + self._partition_stop = None + self._partition_id = None + self._remarks = None + self._number_of_search_column = None + self._other = None + self._other_tag = None + self._attribute = None + self._access_predicates = None + self._filter_predicates = None + + @property + def plan_hash_value(self): + """ + Gets the plan_hash_value of this SqlTuningTaskSqlExecutionPlanStep. + Numerical representation of the execution plan + + + :return: The plan_hash_value of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._plan_hash_value + + @plan_hash_value.setter + def plan_hash_value(self, plan_hash_value): + """ + Sets the plan_hash_value of this SqlTuningTaskSqlExecutionPlanStep. + Numerical representation of the execution plan + + + :param plan_hash_value: The plan_hash_value of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._plan_hash_value = plan_hash_value + + @property + def step_id(self): + """ + Gets the step_id of this SqlTuningTaskSqlExecutionPlanStep. + Identification number for this step in the execution plan. It is unique within the execution plan. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The step_id of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._step_id + + @step_id.setter + def step_id(self, step_id): + """ + Sets the step_id of this SqlTuningTaskSqlExecutionPlanStep. + Identification number for this step in the execution plan. It is unique within the execution plan. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param step_id: The step_id of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._step_id = step_id + + @property + def parent_step_id(self): + """ + Gets the parent_step_id of this SqlTuningTaskSqlExecutionPlanStep. + ID of the next step that operates on the results of this step. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The parent_step_id of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._parent_step_id + + @parent_step_id.setter + def parent_step_id(self, parent_step_id): + """ + Sets the parent_step_id of this SqlTuningTaskSqlExecutionPlanStep. + ID of the next step that operates on the results of this step. + It is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param parent_step_id: The parent_step_id of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._parent_step_id = parent_step_id + + @property + def position(self): + """ + Gets the position of this SqlTuningTaskSqlExecutionPlanStep. + Order of processing for steps with the same parent ID. + + + :return: The position of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this SqlTuningTaskSqlExecutionPlanStep. + Order of processing for steps with the same parent ID. + + + :param position: The position of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._position = position + + @property + def operation(self): + """ + Gets the operation of this SqlTuningTaskSqlExecutionPlanStep. + Name of the operation performed at this step + + + :return: The operation of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._operation + + @operation.setter + def operation(self, operation): + """ + Sets the operation of this SqlTuningTaskSqlExecutionPlanStep. + Name of the operation performed at this step + + + :param operation: The operation of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._operation = operation + + @property + def options(self): + """ + Gets the options of this SqlTuningTaskSqlExecutionPlanStep. + Options used for the operation performed at this step. + + + :return: The options of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._options + + @options.setter + def options(self, options): + """ + Sets the options of this SqlTuningTaskSqlExecutionPlanStep. + Options used for the operation performed at this step. + + + :param options: The options of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._options = options + + @property + def optimizer_mode(self): + """ + Gets the optimizer_mode of this SqlTuningTaskSqlExecutionPlanStep. + Current mode of the optimizer, such as all_rows, first_rows_n (where n = 1, 10, 100, 1000 etc). + + + :return: The optimizer_mode of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._optimizer_mode + + @optimizer_mode.setter + def optimizer_mode(self, optimizer_mode): + """ + Sets the optimizer_mode of this SqlTuningTaskSqlExecutionPlanStep. + Current mode of the optimizer, such as all_rows, first_rows_n (where n = 1, 10, 100, 1000 etc). + + + :param optimizer_mode: The optimizer_mode of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._optimizer_mode = optimizer_mode + + @property + def cost(self): + """ + Gets the cost of this SqlTuningTaskSqlExecutionPlanStep. + Cost of the current operation estimated by the cost-based optimizer (CBO). + + + :return: The cost of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: float + """ + return self._cost + + @cost.setter + def cost(self, cost): + """ + Sets the cost of this SqlTuningTaskSqlExecutionPlanStep. + Cost of the current operation estimated by the cost-based optimizer (CBO). + + + :param cost: The cost of this SqlTuningTaskSqlExecutionPlanStep. + :type: float + """ + self._cost = cost + + @property + def cardinality(self): + """ + Gets the cardinality of this SqlTuningTaskSqlExecutionPlanStep. + Number of rows returned by the current operation (estimated by the CBO). + + + :return: The cardinality of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._cardinality + + @cardinality.setter + def cardinality(self, cardinality): + """ + Sets the cardinality of this SqlTuningTaskSqlExecutionPlanStep. + Number of rows returned by the current operation (estimated by the CBO). + + + :param cardinality: The cardinality of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._cardinality = cardinality + + @property + def bytes(self): + """ + Gets the bytes of this SqlTuningTaskSqlExecutionPlanStep. + Number of bytes returned by the current operation. + + + :return: The bytes of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._bytes + + @bytes.setter + def bytes(self, bytes): + """ + Sets the bytes of this SqlTuningTaskSqlExecutionPlanStep. + Number of bytes returned by the current operation. + + + :param bytes: The bytes of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._bytes = bytes + + @property + def cpu_cost(self): + """ + Gets the cpu_cost of this SqlTuningTaskSqlExecutionPlanStep. + The CPU cost of the current operation. + + + :return: The cpu_cost of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: float + """ + return self._cpu_cost + + @cpu_cost.setter + def cpu_cost(self, cpu_cost): + """ + Sets the cpu_cost of this SqlTuningTaskSqlExecutionPlanStep. + The CPU cost of the current operation. + + + :param cpu_cost: The cpu_cost of this SqlTuningTaskSqlExecutionPlanStep. + :type: float + """ + self._cpu_cost = cpu_cost + + @property + def io_cost(self): + """ + Gets the io_cost of this SqlTuningTaskSqlExecutionPlanStep. + The I/O cost of the current operation. + + + :return: The io_cost of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: float + """ + return self._io_cost + + @io_cost.setter + def io_cost(self, io_cost): + """ + Sets the io_cost of this SqlTuningTaskSqlExecutionPlanStep. + The I/O cost of the current operation. + + + :param io_cost: The io_cost of this SqlTuningTaskSqlExecutionPlanStep. + :type: float + """ + self._io_cost = io_cost + + @property + def temp_space(self): + """ + Gets the temp_space of this SqlTuningTaskSqlExecutionPlanStep. + Temporary space usage (in bytes) of the operation (sort or hash-join) as estimated by the CBO. + + + :return: The temp_space of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._temp_space + + @temp_space.setter + def temp_space(self, temp_space): + """ + Sets the temp_space of this SqlTuningTaskSqlExecutionPlanStep. + Temporary space usage (in bytes) of the operation (sort or hash-join) as estimated by the CBO. + + + :param temp_space: The temp_space of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._temp_space = temp_space + + @property + def time(self): + """ + Gets the time of this SqlTuningTaskSqlExecutionPlanStep. + Elapsed time (in seconds) of the operation as estimated by the CBO. + + + :return: The time of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._time + + @time.setter + def time(self, time): + """ + Sets the time of this SqlTuningTaskSqlExecutionPlanStep. + Elapsed time (in seconds) of the operation as estimated by the CBO. + + + :param time: The time of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._time = time + + @property + def object_node(self): + """ + Gets the object_node of this SqlTuningTaskSqlExecutionPlanStep. + Name of the database link used to reference the object. + + + :return: The object_node of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._object_node + + @object_node.setter + def object_node(self, object_node): + """ + Sets the object_node of this SqlTuningTaskSqlExecutionPlanStep. + Name of the database link used to reference the object. + + + :param object_node: The object_node of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._object_node = object_node + + @property + def object_owner(self): + """ + Gets the object_owner of this SqlTuningTaskSqlExecutionPlanStep. + Owner of the object. + + + :return: The object_owner of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._object_owner + + @object_owner.setter + def object_owner(self, object_owner): + """ + Sets the object_owner of this SqlTuningTaskSqlExecutionPlanStep. + Owner of the object. + + + :param object_owner: The object_owner of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._object_owner = object_owner + + @property + def object_name(self): + """ + Gets the object_name of this SqlTuningTaskSqlExecutionPlanStep. + Name of the object. + + + :return: The object_name of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this SqlTuningTaskSqlExecutionPlanStep. + Name of the object. + + + :param object_name: The object_name of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._object_name = object_name + + @property + def object_position(self): + """ + Gets the object_position of this SqlTuningTaskSqlExecutionPlanStep. + Numbered position of the object name in the original SQL statement. + + + :return: The object_position of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._object_position + + @object_position.setter + def object_position(self, object_position): + """ + Sets the object_position of this SqlTuningTaskSqlExecutionPlanStep. + Numbered position of the object name in the original SQL statement. + + + :param object_position: The object_position of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._object_position = object_position + + @property + def object_type(self): + """ + Gets the object_type of this SqlTuningTaskSqlExecutionPlanStep. + Descriptive modifier that further describes the type of object. + + + :return: The object_type of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._object_type + + @object_type.setter + def object_type(self, object_type): + """ + Sets the object_type of this SqlTuningTaskSqlExecutionPlanStep. + Descriptive modifier that further describes the type of object. + + + :param object_type: The object_type of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._object_type = object_type + + @property + def partition_start(self): + """ + Gets the partition_start of this SqlTuningTaskSqlExecutionPlanStep. + A step may get data from a range of partitions of a partitioned object, such table or index, + based on predicates and sorting order. The partionStart is the starting partition of the range. + The partitionStop is the ending partition of the range + + + :return: The partition_start of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._partition_start + + @partition_start.setter + def partition_start(self, partition_start): + """ + Sets the partition_start of this SqlTuningTaskSqlExecutionPlanStep. + A step may get data from a range of partitions of a partitioned object, such table or index, + based on predicates and sorting order. The partionStart is the starting partition of the range. + The partitionStop is the ending partition of the range + + + :param partition_start: The partition_start of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._partition_start = partition_start + + @property + def partition_stop(self): + """ + Gets the partition_stop of this SqlTuningTaskSqlExecutionPlanStep. + A step may get data from a range of partitions of a partitioned object, such table or index, + based on predicates and sorting order. The partionStart is the starting partition of the range. + The partitionStop is the ending partition of the range + + + :return: The partition_stop of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._partition_stop + + @partition_stop.setter + def partition_stop(self, partition_stop): + """ + Sets the partition_stop of this SqlTuningTaskSqlExecutionPlanStep. + A step may get data from a range of partitions of a partitioned object, such table or index, + based on predicates and sorting order. The partionStart is the starting partition of the range. + The partitionStop is the ending partition of the range + + + :param partition_stop: The partition_stop of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._partition_stop = partition_stop + + @property + def partition_id(self): + """ + Gets the partition_id of this SqlTuningTaskSqlExecutionPlanStep. + The id of the step in the execution plan that has computed the pair of values of the partitionStart and partitionStop + + + :return: The partition_id of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._partition_id + + @partition_id.setter + def partition_id(self, partition_id): + """ + Sets the partition_id of this SqlTuningTaskSqlExecutionPlanStep. + The id of the step in the execution plan that has computed the pair of values of the partitionStart and partitionStop + + + :param partition_id: The partition_id of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._partition_id = partition_id + + @property + def remarks(self): + """ + Gets the remarks of this SqlTuningTaskSqlExecutionPlanStep. + Place for comments that can be added to the steps of the execution plan. + + + :return: The remarks of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._remarks + + @remarks.setter + def remarks(self, remarks): + """ + Sets the remarks of this SqlTuningTaskSqlExecutionPlanStep. + Place for comments that can be added to the steps of the execution plan. + + + :param remarks: The remarks of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._remarks = remarks + + @property + def number_of_search_column(self): + """ + Gets the number_of_search_column of this SqlTuningTaskSqlExecutionPlanStep. + Number of index columns with start and stop keys (that is, the number of columns with matching predicates) + + + :return: The number_of_search_column of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: int + """ + return self._number_of_search_column + + @number_of_search_column.setter + def number_of_search_column(self, number_of_search_column): + """ + Sets the number_of_search_column of this SqlTuningTaskSqlExecutionPlanStep. + Number of index columns with start and stop keys (that is, the number of columns with matching predicates) + + + :param number_of_search_column: The number_of_search_column of this SqlTuningTaskSqlExecutionPlanStep. + :type: int + """ + self._number_of_search_column = number_of_search_column + + @property + def other(self): + """ + Gets the other of this SqlTuningTaskSqlExecutionPlanStep. + Information about parallel execution servers and parallel queries + + + :return: The other of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._other + + @other.setter + def other(self, other): + """ + Sets the other of this SqlTuningTaskSqlExecutionPlanStep. + Information about parallel execution servers and parallel queries + + + :param other: The other of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._other = other + + @property + def other_tag(self): + """ + Gets the other_tag of this SqlTuningTaskSqlExecutionPlanStep. + Describes the function of the SQL text in the OTHER column. + + + :return: The other_tag of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._other_tag + + @other_tag.setter + def other_tag(self, other_tag): + """ + Sets the other_tag of this SqlTuningTaskSqlExecutionPlanStep. + Describes the function of the SQL text in the OTHER column. + + + :param other_tag: The other_tag of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._other_tag = other_tag + + @property + def attribute(self): + """ + Gets the attribute of this SqlTuningTaskSqlExecutionPlanStep. + Text string identifying the type of the execution plan. + + + :return: The attribute of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._attribute + + @attribute.setter + def attribute(self, attribute): + """ + Sets the attribute of this SqlTuningTaskSqlExecutionPlanStep. + Text string identifying the type of the execution plan. + + + :param attribute: The attribute of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._attribute = attribute + + @property + def access_predicates(self): + """ + Gets the access_predicates of this SqlTuningTaskSqlExecutionPlanStep. + Predicates used to locate rows in an access structure. For example, + start or stop predicates for an index range scan. + + + :return: The access_predicates of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._access_predicates + + @access_predicates.setter + def access_predicates(self, access_predicates): + """ + Sets the access_predicates of this SqlTuningTaskSqlExecutionPlanStep. + Predicates used to locate rows in an access structure. For example, + start or stop predicates for an index range scan. + + + :param access_predicates: The access_predicates of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._access_predicates = access_predicates + + @property + def filter_predicates(self): + """ + Gets the filter_predicates of this SqlTuningTaskSqlExecutionPlanStep. + Predicates used to filter rows before producing them. + + + :return: The filter_predicates of this SqlTuningTaskSqlExecutionPlanStep. + :rtype: str + """ + return self._filter_predicates + + @filter_predicates.setter + def filter_predicates(self, filter_predicates): + """ + Sets the filter_predicates of this SqlTuningTaskSqlExecutionPlanStep. + Predicates used to filter rows before producing them. + + + :param filter_predicates: The filter_predicates of this SqlTuningTaskSqlExecutionPlanStep. + :type: str + """ + self._filter_predicates = filter_predicates + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/start_sql_tuning_task_details.py b/src/oci/database_management/models/start_sql_tuning_task_details.py new file mode 100644 index 0000000000..3ac09c587b --- /dev/null +++ b/src/oci/database_management/models/start_sql_tuning_task_details.py @@ -0,0 +1,337 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 StartSqlTuningTaskDetails(object): + """ + Request to start a SQL tuning task + """ + + #: A constant which can be used with the scope property of a StartSqlTuningTaskDetails. + #: This constant has a value of "LIMITED" + SCOPE_LIMITED = "LIMITED" + + #: A constant which can be used with the scope property of a StartSqlTuningTaskDetails. + #: This constant has a value of "COMPREHENSIVE" + SCOPE_COMPREHENSIVE = "COMPREHENSIVE" + + def __init__(self, **kwargs): + """ + Initializes a new StartSqlTuningTaskDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param task_name: + The value to assign to the task_name property of this StartSqlTuningTaskDetails. + :type task_name: str + + :param task_description: + The value to assign to the task_description property of this StartSqlTuningTaskDetails. + :type task_description: str + + :param credential_details: + The value to assign to the credential_details property of this StartSqlTuningTaskDetails. + :type credential_details: oci.database_management.models.SqlTuningTaskCredentialDetails + + :param total_time_limit_in_minutes: + The value to assign to the total_time_limit_in_minutes property of this StartSqlTuningTaskDetails. + :type total_time_limit_in_minutes: int + + :param scope: + The value to assign to the scope property of this StartSqlTuningTaskDetails. + Allowed values for this property are: "LIMITED", "COMPREHENSIVE" + :type scope: str + + :param statement_time_limit_in_minutes: + The value to assign to the statement_time_limit_in_minutes property of this StartSqlTuningTaskDetails. + :type statement_time_limit_in_minutes: int + + :param sql_details: + The value to assign to the sql_details property of this StartSqlTuningTaskDetails. + :type sql_details: list[oci.database_management.models.SqlTuningTaskSqlDetail] + + :param time_started: + The value to assign to the time_started property of this StartSqlTuningTaskDetails. + :type time_started: datetime + + :param time_ended: + The value to assign to the time_ended property of this StartSqlTuningTaskDetails. + :type time_ended: datetime + + """ + self.swagger_types = { + 'task_name': 'str', + 'task_description': 'str', + 'credential_details': 'SqlTuningTaskCredentialDetails', + 'total_time_limit_in_minutes': 'int', + 'scope': 'str', + 'statement_time_limit_in_minutes': 'int', + 'sql_details': 'list[SqlTuningTaskSqlDetail]', + 'time_started': 'datetime', + 'time_ended': 'datetime' + } + + self.attribute_map = { + 'task_name': 'taskName', + 'task_description': 'taskDescription', + 'credential_details': 'credentialDetails', + 'total_time_limit_in_minutes': 'totalTimeLimitInMinutes', + 'scope': 'scope', + 'statement_time_limit_in_minutes': 'statementTimeLimitInMinutes', + 'sql_details': 'sqlDetails', + 'time_started': 'timeStarted', + 'time_ended': 'timeEnded' + } + + self._task_name = None + self._task_description = None + self._credential_details = None + self._total_time_limit_in_minutes = None + self._scope = None + self._statement_time_limit_in_minutes = None + self._sql_details = None + self._time_started = None + self._time_ended = None + + @property + def task_name(self): + """ + **[Required]** Gets the task_name of this StartSqlTuningTaskDetails. + The name of the SQL tuning task. The name is unique per user in a database, and it is case sensitive. + + + :return: The task_name of this StartSqlTuningTaskDetails. + :rtype: str + """ + return self._task_name + + @task_name.setter + def task_name(self, task_name): + """ + Sets the task_name of this StartSqlTuningTaskDetails. + The name of the SQL tuning task. The name is unique per user in a database, and it is case sensitive. + + + :param task_name: The task_name of this StartSqlTuningTaskDetails. + :type: str + """ + self._task_name = task_name + + @property + def task_description(self): + """ + Gets the task_description of this StartSqlTuningTaskDetails. + The description of the SQL tuning task. + + + :return: The task_description of this StartSqlTuningTaskDetails. + :rtype: str + """ + return self._task_description + + @task_description.setter + def task_description(self, task_description): + """ + Sets the task_description of this StartSqlTuningTaskDetails. + The description of the SQL tuning task. + + + :param task_description: The task_description of this StartSqlTuningTaskDetails. + :type: str + """ + self._task_description = task_description + + @property + def credential_details(self): + """ + **[Required]** Gets the credential_details of this StartSqlTuningTaskDetails. + + :return: The credential_details of this StartSqlTuningTaskDetails. + :rtype: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + return self._credential_details + + @credential_details.setter + def credential_details(self, credential_details): + """ + Sets the credential_details of this StartSqlTuningTaskDetails. + + :param credential_details: The credential_details of this StartSqlTuningTaskDetails. + :type: oci.database_management.models.SqlTuningTaskCredentialDetails + """ + self._credential_details = credential_details + + @property + def total_time_limit_in_minutes(self): + """ + **[Required]** Gets the total_time_limit_in_minutes of this StartSqlTuningTaskDetails. + The time limit for running the SQL tuning task. + + + :return: The total_time_limit_in_minutes of this StartSqlTuningTaskDetails. + :rtype: int + """ + return self._total_time_limit_in_minutes + + @total_time_limit_in_minutes.setter + def total_time_limit_in_minutes(self, total_time_limit_in_minutes): + """ + Sets the total_time_limit_in_minutes of this StartSqlTuningTaskDetails. + The time limit for running the SQL tuning task. + + + :param total_time_limit_in_minutes: The total_time_limit_in_minutes of this StartSqlTuningTaskDetails. + :type: int + """ + self._total_time_limit_in_minutes = total_time_limit_in_minutes + + @property + def scope(self): + """ + **[Required]** Gets the scope of this StartSqlTuningTaskDetails. + The scope for the SQL tuning task. For LIMITED scope, the SQL profile recommendation + is excluded, so the task is faster. For COMPREHENSIVE scope, the SQL profile recommendation + is included. + + Allowed values for this property are: "LIMITED", "COMPREHENSIVE" + + + :return: The scope of this StartSqlTuningTaskDetails. + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """ + Sets the scope of this StartSqlTuningTaskDetails. + The scope for the SQL tuning task. For LIMITED scope, the SQL profile recommendation + is excluded, so the task is faster. For COMPREHENSIVE scope, the SQL profile recommendation + is included. + + + :param scope: The scope of this StartSqlTuningTaskDetails. + :type: str + """ + allowed_values = ["LIMITED", "COMPREHENSIVE"] + if not value_allowed_none_or_none_sentinel(scope, allowed_values): + raise ValueError( + "Invalid value for `scope`, must be None or one of {0}" + .format(allowed_values) + ) + self._scope = scope + + @property + def statement_time_limit_in_minutes(self): + """ + Gets the statement_time_limit_in_minutes of this StartSqlTuningTaskDetails. + The time limit per SQL statement in minutes. This is for task with COMPREHENSIVE scope. + Per statement time limit should not be larger than the total time limit. + + + :return: The statement_time_limit_in_minutes of this StartSqlTuningTaskDetails. + :rtype: int + """ + return self._statement_time_limit_in_minutes + + @statement_time_limit_in_minutes.setter + def statement_time_limit_in_minutes(self, statement_time_limit_in_minutes): + """ + Sets the statement_time_limit_in_minutes of this StartSqlTuningTaskDetails. + The time limit per SQL statement in minutes. This is for task with COMPREHENSIVE scope. + Per statement time limit should not be larger than the total time limit. + + + :param statement_time_limit_in_minutes: The statement_time_limit_in_minutes of this StartSqlTuningTaskDetails. + :type: int + """ + self._statement_time_limit_in_minutes = statement_time_limit_in_minutes + + @property + def sql_details(self): + """ + **[Required]** Gets the sql_details of this StartSqlTuningTaskDetails. + The array of the details of SQL statments on which the tuning is performed. + + + :return: The sql_details of this StartSqlTuningTaskDetails. + :rtype: list[oci.database_management.models.SqlTuningTaskSqlDetail] + """ + return self._sql_details + + @sql_details.setter + def sql_details(self, sql_details): + """ + Sets the sql_details of this StartSqlTuningTaskDetails. + The array of the details of SQL statments on which the tuning is performed. + + + :param sql_details: The sql_details of this StartSqlTuningTaskDetails. + :type: list[oci.database_management.models.SqlTuningTaskSqlDetail] + """ + self._sql_details = sql_details + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this StartSqlTuningTaskDetails. + The start time of the period, in which SQL statements are running. + + + :return: The time_started of this StartSqlTuningTaskDetails. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this StartSqlTuningTaskDetails. + The start time of the period, in which SQL statements are running. + + + :param time_started: The time_started of this StartSqlTuningTaskDetails. + :type: datetime + """ + self._time_started = time_started + + @property + def time_ended(self): + """ + **[Required]** Gets the time_ended of this StartSqlTuningTaskDetails. + The end time of the period, in which SQL statements are running. + + + :return: The time_ended of this StartSqlTuningTaskDetails. + :rtype: datetime + """ + return self._time_ended + + @time_ended.setter + def time_ended(self, time_ended): + """ + Sets the time_ended of this StartSqlTuningTaskDetails. + The end time of the period, in which SQL statements are running. + + + :param time_ended: The time_ended of this StartSqlTuningTaskDetails. + :type: datetime + """ + self._time_ended = time_ended + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/statements_aggregate_metrics.py b/src/oci/database_management/models/statements_aggregate_metrics.py new file mode 100644 index 0000000000..09fd01a88e --- /dev/null +++ b/src/oci/database_management/models/statements_aggregate_metrics.py @@ -0,0 +1,93 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 StatementsAggregateMetrics(object): + """ + The queued and running statement metrics for Autonomous Databases. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StatementsAggregateMetrics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param queued_statements: + The value to assign to the queued_statements property of this StatementsAggregateMetrics. + :type queued_statements: oci.database_management.models.MetricDataPoint + + :param running_statements: + The value to assign to the running_statements property of this StatementsAggregateMetrics. + :type running_statements: oci.database_management.models.MetricDataPoint + + """ + self.swagger_types = { + 'queued_statements': 'MetricDataPoint', + 'running_statements': 'MetricDataPoint' + } + + self.attribute_map = { + 'queued_statements': 'queuedStatements', + 'running_statements': 'runningStatements' + } + + self._queued_statements = None + self._running_statements = None + + @property + def queued_statements(self): + """ + Gets the queued_statements of this StatementsAggregateMetrics. + + :return: The queued_statements of this StatementsAggregateMetrics. + :rtype: oci.database_management.models.MetricDataPoint + """ + return self._queued_statements + + @queued_statements.setter + def queued_statements(self, queued_statements): + """ + Sets the queued_statements of this StatementsAggregateMetrics. + + :param queued_statements: The queued_statements of this StatementsAggregateMetrics. + :type: oci.database_management.models.MetricDataPoint + """ + self._queued_statements = queued_statements + + @property + def running_statements(self): + """ + Gets the running_statements of this StatementsAggregateMetrics. + + :return: The running_statements of this StatementsAggregateMetrics. + :rtype: oci.database_management.models.MetricDataPoint + """ + return self._running_statements + + @running_statements.setter + def running_statements(self, running_statements): + """ + Sets the running_statements of this StatementsAggregateMetrics. + + :param running_statements: The running_statements of this StatementsAggregateMetrics. + :type: oci.database_management.models.MetricDataPoint + """ + self._running_statements = running_statements + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/system_privilege_collection.py b/src/oci/database_management/models/system_privilege_collection.py new file mode 100644 index 0000000000..b7f8e55ad8 --- /dev/null +++ b/src/oci/database_management/models/system_privilege_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SystemPrivilegeCollection(object): + """ + A collection of SystemPrivileges granted to the current User. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SystemPrivilegeCollection 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 SystemPrivilegeCollection. + :type items: list[oci.database_management.models.SystemPrivilegeSummary] + + """ + self.swagger_types = { + 'items': 'list[SystemPrivilegeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SystemPrivilegeCollection. + An array of User resources. + + + :return: The items of this SystemPrivilegeCollection. + :rtype: list[oci.database_management.models.SystemPrivilegeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SystemPrivilegeCollection. + An array of User resources. + + + :param items: The items of this SystemPrivilegeCollection. + :type: list[oci.database_management.models.SystemPrivilegeSummary] + """ + 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/database_management/models/system_privilege_summary.py b/src/oci/database_management/models/system_privilege_summary.py new file mode 100644 index 0000000000..767e5285c2 --- /dev/null +++ b/src/oci/database_management/models/system_privilege_summary.py @@ -0,0 +1,215 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SystemPrivilegeSummary(object): + """ + Summary of SystemPrivileges. + """ + + #: A constant which can be used with the admin_option property of a SystemPrivilegeSummary. + #: This constant has a value of "YES" + ADMIN_OPTION_YES = "YES" + + #: A constant which can be used with the admin_option property of a SystemPrivilegeSummary. + #: This constant has a value of "NO" + ADMIN_OPTION_NO = "NO" + + #: A constant which can be used with the common property of a SystemPrivilegeSummary. + #: This constant has a value of "YES" + COMMON_YES = "YES" + + #: A constant which can be used with the common property of a SystemPrivilegeSummary. + #: This constant has a value of "NO" + COMMON_NO = "NO" + + #: A constant which can be used with the inherited property of a SystemPrivilegeSummary. + #: This constant has a value of "YES" + INHERITED_YES = "YES" + + #: A constant which can be used with the inherited property of a SystemPrivilegeSummary. + #: This constant has a value of "NO" + INHERITED_NO = "NO" + + def __init__(self, **kwargs): + """ + Initializes a new SystemPrivilegeSummary 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 SystemPrivilegeSummary. + :type name: str + + :param admin_option: + The value to assign to the admin_option property of this SystemPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type admin_option: str + + :param common: + The value to assign to the common property of this SystemPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type common: str + + :param inherited: + The value to assign to the inherited property of this SystemPrivilegeSummary. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type inherited: str + + """ + self.swagger_types = { + 'name': 'str', + 'admin_option': 'str', + 'common': 'str', + 'inherited': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'admin_option': 'adminOption', + 'common': 'common', + 'inherited': 'inherited' + } + + self._name = None + self._admin_option = None + self._common = None + self._inherited = None + + @property + def name(self): + """ + Gets the name of this SystemPrivilegeSummary. + The name of a system privilege + + + :return: The name of this SystemPrivilegeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SystemPrivilegeSummary. + The name of a system privilege + + + :param name: The name of this SystemPrivilegeSummary. + :type: str + """ + self._name = name + + @property + def admin_option(self): + """ + Gets the admin_option of this SystemPrivilegeSummary. + Indicates whether the grant was with the ADMIN option (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The admin_option of this SystemPrivilegeSummary. + :rtype: str + """ + return self._admin_option + + @admin_option.setter + def admin_option(self, admin_option): + """ + Sets the admin_option of this SystemPrivilegeSummary. + Indicates whether the grant was with the ADMIN option (YES) or not (NO) + + + :param admin_option: The admin_option of this SystemPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(admin_option, allowed_values): + admin_option = 'UNKNOWN_ENUM_VALUE' + self._admin_option = admin_option + + @property + def common(self): + """ + Gets the common of this SystemPrivilegeSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The common of this SystemPrivilegeSummary. + :rtype: str + """ + return self._common + + @common.setter + def common(self, common): + """ + Sets the common of this SystemPrivilegeSummary. + Indicates how the grant was made. Possible values: + YES if the role was granted commonly (CONTAINER=ALL was used) + NO if the role was granted locally (CONTAINER=ALL was not used) + + + :param common: The common of this SystemPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(common, allowed_values): + common = 'UNKNOWN_ENUM_VALUE' + self._common = common + + @property + def inherited(self): + """ + Gets the inherited of this SystemPrivilegeSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The inherited of this SystemPrivilegeSummary. + :rtype: str + """ + return self._inherited + + @inherited.setter + def inherited(self, inherited): + """ + Sets the inherited of this SystemPrivilegeSummary. + Indicates whether the role grant was inherited from another container (YES) or not (NO) + + + :param inherited: The inherited of this SystemPrivilegeSummary. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(inherited, allowed_values): + inherited = 'UNKNOWN_ENUM_VALUE' + self._inherited = inherited + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/tablespace.py b/src/oci/database_management/models/tablespace.py index bec0a658d1..94ec580363 100644 --- a/src/oci/database_management/models/tablespace.py +++ b/src/oci/database_management/models/tablespace.py @@ -600,7 +600,7 @@ def name(self, name): def type(self): """ **[Required]** Gets the type of this Tablespace. - The type of the tablespace. + The type of tablespace. Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY" @@ -614,7 +614,7 @@ def type(self): def type(self, type): """ Sets the type of this Tablespace. - The type of the tablespace. + The type of tablespace. :param type: The type of this Tablespace. @@ -664,7 +664,7 @@ def status(self, status): def block_size_bytes(self): """ Gets the block_size_bytes of this Tablespace. - The tablespace block size in bytes. + The tablespace block size. :return: The block_size_bytes of this Tablespace. @@ -676,7 +676,7 @@ def block_size_bytes(self): def block_size_bytes(self, block_size_bytes): """ Sets the block_size_bytes of this Tablespace. - The tablespace block size in bytes. + The tablespace block size. :param block_size_bytes: The block_size_bytes of this Tablespace. @@ -1040,7 +1040,7 @@ def compress_for(self, compress_for): def default_in_memory(self): """ Gets the default_in_memory of this Tablespace. - Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace. Allowed values for this property are: "ENABLED", "DISABLED" @@ -1054,7 +1054,7 @@ def default_in_memory(self): def default_in_memory(self, default_in_memory): """ Sets the default_in_memory of this Tablespace. - Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace. :param default_in_memory: The default_in_memory of this Tablespace. @@ -1072,7 +1072,7 @@ def default_in_memory(self, default_in_memory): def default_in_memory_priority(self): """ Gets the default_in_memory_priority of this Tablespace. - Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace. Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE" @@ -1086,7 +1086,7 @@ def default_in_memory_priority(self): def default_in_memory_priority(self, default_in_memory_priority): """ Sets the default_in_memory_priority of this Tablespace. - Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace. :param default_in_memory_priority: The default_in_memory_priority of this Tablespace. @@ -1104,7 +1104,7 @@ def default_in_memory_priority(self, default_in_memory_priority): def default_in_memory_distribute(self): """ Gets the default_in_memory_distribute of this Tablespace. - Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION" @@ -1118,7 +1118,7 @@ def default_in_memory_distribute(self): def default_in_memory_distribute(self, default_in_memory_distribute): """ Sets the default_in_memory_distribute of this Tablespace. - Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. :param default_in_memory_distribute: The default_in_memory_distribute of this Tablespace. @@ -1136,7 +1136,7 @@ def default_in_memory_distribute(self, default_in_memory_distribute): def default_in_memory_compression(self): """ Gets the default_in_memory_compression of this Tablespace. - Indicates the default compression level for the IM column store for this tablespace. + Indicates the default compression level for the IM column store for the tablespace. Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH" @@ -1150,7 +1150,7 @@ def default_in_memory_compression(self): def default_in_memory_compression(self, default_in_memory_compression): """ Sets the default_in_memory_compression of this Tablespace. - Indicates the default compression level for the IM column store for this tablespace. + Indicates the default compression level for the IM column store for the tablespace. :param default_in_memory_compression: The default_in_memory_compression of this Tablespace. @@ -1320,7 +1320,7 @@ def default_cell_memory(self, default_cell_memory): def default_in_memory_service(self): """ Gets the default_in_memory_service of this Tablespace. - Indicates how the IM column store is populated on various instances by default for this tablespace. + Indicates how the IM column store is populated on various instances by default for the tablespace. Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED" @@ -1334,7 +1334,7 @@ def default_in_memory_service(self): def default_in_memory_service(self, default_in_memory_service): """ Sets the default_in_memory_service of this Tablespace. - Indicates how the IM column store is populated on various instances by default for this tablespace. + Indicates how the IM column store is populated on various instances by default for the tablespace. :param default_in_memory_service: The default_in_memory_service of this Tablespace. @@ -1352,7 +1352,7 @@ def default_in_memory_service(self, default_in_memory_service): def default_in_memory_service_name(self): """ Gets the default_in_memory_service_name of this Tablespace. - Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. :return: The default_in_memory_service_name of this Tablespace. @@ -1364,7 +1364,7 @@ def default_in_memory_service_name(self): def default_in_memory_service_name(self, default_in_memory_service_name): """ Sets the default_in_memory_service_name of this Tablespace. - Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. :param default_in_memory_service_name: The default_in_memory_service_name of this Tablespace. @@ -1456,7 +1456,7 @@ def temp_group(self, temp_group): def max_size_kb(self): """ Gets the max_size_kb of this Tablespace. - The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace. :return: The max_size_kb of this Tablespace. @@ -1468,7 +1468,7 @@ def max_size_kb(self): def max_size_kb(self, max_size_kb): """ Sets the max_size_kb of this Tablespace. - The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace. :param max_size_kb: The max_size_kb of this Tablespace. @@ -1528,7 +1528,7 @@ def user_size_kb(self, user_size_kb): def free_space_kb(self): """ Gets the free_space_kb of this Tablespace. - The free space available in this tablespace in KB. + The free space available in the tablespace in KB. :return: The free_space_kb of this Tablespace. @@ -1540,7 +1540,7 @@ def free_space_kb(self): def free_space_kb(self, free_space_kb): """ Sets the free_space_kb of this Tablespace. - The free space available in this tablespace in KB. + The free space available in the tablespace in KB. :param free_space_kb: The free_space_kb of this Tablespace. @@ -1624,7 +1624,7 @@ def used_percent_allocated(self, used_percent_allocated): def datafiles(self): """ Gets the datafiles of this Tablespace. - A list of the datafiles associated with the tablespace. + A list of the data files associated with the tablespace. :return: The datafiles of this Tablespace. @@ -1636,7 +1636,7 @@ def datafiles(self): def datafiles(self, datafiles): """ Sets the datafiles of this Tablespace. - A list of the datafiles associated with the tablespace. + A list of the data files associated with the tablespace. :param datafiles: The datafiles of this Tablespace. diff --git a/src/oci/database_management/models/tablespace_summary.py b/src/oci/database_management/models/tablespace_summary.py index 7b2973ea50..2655a20135 100644 --- a/src/oci/database_management/models/tablespace_summary.py +++ b/src/oci/database_management/models/tablespace_summary.py @@ -620,7 +620,7 @@ def name(self, name): def type(self): """ **[Required]** Gets the type of this TablespaceSummary. - The type of the tablespace. + The type of tablespace. Allowed values for this property are: "UNDO", "LOST_WRITE_PROTECTION", "PERMANENT", "TEMPORARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -635,7 +635,7 @@ def type(self): def type(self, type): """ Sets the type of this TablespaceSummary. - The type of the tablespace. + The type of tablespace. :param type: The type of this TablespaceSummary. @@ -680,7 +680,7 @@ def status(self, status): def block_size_bytes(self): """ Gets the block_size_bytes of this TablespaceSummary. - The tablespace block size in bytes. + The tablespace block size. :return: The block_size_bytes of this TablespaceSummary. @@ -692,7 +692,7 @@ def block_size_bytes(self): def block_size_bytes(self, block_size_bytes): """ Sets the block_size_bytes of this TablespaceSummary. - The tablespace block size in bytes. + The tablespace block size. :param block_size_bytes: The block_size_bytes of this TablespaceSummary. @@ -1040,7 +1040,7 @@ def compress_for(self, compress_for): def default_in_memory(self): """ Gets the default_in_memory of this TablespaceSummary. - Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace. 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'. @@ -1055,7 +1055,7 @@ def default_in_memory(self): def default_in_memory(self, default_in_memory): """ Sets the default_in_memory of this TablespaceSummary. - Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in this tablespace. + Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace. :param default_in_memory: The default_in_memory of this TablespaceSummary. @@ -1070,7 +1070,7 @@ def default_in_memory(self, default_in_memory): def default_in_memory_priority(self): """ Gets the default_in_memory_priority of this TablespaceSummary. - Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace. Allowed values for this property are: "LOW", "MEDIUM", "HIGH", "CRITICAL", "NONE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1085,7 +1085,7 @@ def default_in_memory_priority(self): def default_in_memory_priority(self, default_in_memory_priority): """ Sets the default_in_memory_priority of this TablespaceSummary. - Indicates the default priority for In-Memory Column Store (IM column store) population for this tablespace. + Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace. :param default_in_memory_priority: The default_in_memory_priority of this TablespaceSummary. @@ -1100,7 +1100,7 @@ def default_in_memory_priority(self, default_in_memory_priority): def default_in_memory_distribute(self): """ Gets the default_in_memory_distribute of this TablespaceSummary. - Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. Allowed values for this property are: "AUTO", "BY_ROWID_RANGE", "BY_PARTITION", "BY_SUBPARTITION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1115,7 +1115,7 @@ def default_in_memory_distribute(self): def default_in_memory_distribute(self, default_in_memory_distribute): """ Sets the default_in_memory_distribute of this TablespaceSummary. - Indicates how the IM column store is distributed by default for this tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. + Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment. :param default_in_memory_distribute: The default_in_memory_distribute of this TablespaceSummary. @@ -1130,7 +1130,7 @@ def default_in_memory_distribute(self, default_in_memory_distribute): def default_in_memory_compression(self): """ Gets the default_in_memory_compression of this TablespaceSummary. - Indicates the default compression level for the IM column store for this tablespace. + Indicates the default compression level for the IM column store for the tablespace. Allowed values for this property are: "NO_MEMCOMPRESS", "FOR_DML", "FOR_QUERY_LOW", "FOR_QUERY_HIGH", "FOR_CAPACITY_LOW", "FOR_CAPACITY_HIGH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1145,7 +1145,7 @@ def default_in_memory_compression(self): def default_in_memory_compression(self, default_in_memory_compression): """ Sets the default_in_memory_compression of this TablespaceSummary. - Indicates the default compression level for the IM column store for this tablespace. + Indicates the default compression level for the IM column store for the tablespace. :param default_in_memory_compression: The default_in_memory_compression of this TablespaceSummary. @@ -1304,7 +1304,7 @@ def default_cell_memory(self, default_cell_memory): def default_in_memory_service(self): """ Gets the default_in_memory_service of this TablespaceSummary. - Indicates how the IM column store is populated on various instances by default for this tablespace. + Indicates how the IM column store is populated on various instances by default for the tablespace. Allowed values for this property are: "DEFAULT", "NONE", "ALL", "USER_DEFINED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1319,7 +1319,7 @@ def default_in_memory_service(self): def default_in_memory_service(self, default_in_memory_service): """ Sets the default_in_memory_service of this TablespaceSummary. - Indicates how the IM column store is populated on various instances by default for this tablespace. + Indicates how the IM column store is populated on various instances by default for the tablespace. :param default_in_memory_service: The default_in_memory_service of this TablespaceSummary. @@ -1334,7 +1334,7 @@ def default_in_memory_service(self, default_in_memory_service): def default_in_memory_service_name(self): """ Gets the default_in_memory_service_name of this TablespaceSummary. - Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. :return: The default_in_memory_service_name of this TablespaceSummary. @@ -1346,7 +1346,7 @@ def default_in_memory_service_name(self): def default_in_memory_service_name(self, default_in_memory_service_name): """ Sets the default_in_memory_service_name of this TablespaceSummary. - Indicates the service name for the service on which the IM column store should be populated by default for this tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. + Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null. :param default_in_memory_service_name: The default_in_memory_service_name of this TablespaceSummary. @@ -1436,7 +1436,7 @@ def temp_group(self, temp_group): def max_size_kb(self): """ Gets the max_size_kb of this TablespaceSummary. - The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace. :return: The max_size_kb of this TablespaceSummary. @@ -1448,7 +1448,7 @@ def max_size_kb(self): def max_size_kb(self, max_size_kb): """ Sets the max_size_kb of this TablespaceSummary. - The maximum tablespace size in KB. If the tablespace contains any datafiles with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its datafiles is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only datafiles with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all datafiles in the tablespace. + The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace. :param max_size_kb: The max_size_kb of this TablespaceSummary. @@ -1508,7 +1508,7 @@ def user_size_kb(self, user_size_kb): def free_space_kb(self): """ Gets the free_space_kb of this TablespaceSummary. - The free space available in this tablespace in KB. + The free space available in the tablespace in KB. :return: The free_space_kb of this TablespaceSummary. @@ -1520,7 +1520,7 @@ def free_space_kb(self): def free_space_kb(self, free_space_kb): """ Sets the free_space_kb of this TablespaceSummary. - The free space available in this tablespace in KB. + The free space available in the tablespace in KB. :param free_space_kb: The free_space_kb of this TablespaceSummary. @@ -1604,7 +1604,7 @@ def used_percent_allocated(self, used_percent_allocated): def datafiles(self): """ Gets the datafiles of this TablespaceSummary. - A list of the datafiles associated with the tablespace. + A list of the data files associated with the tablespace. :return: The datafiles of this TablespaceSummary. @@ -1616,7 +1616,7 @@ def datafiles(self): def datafiles(self, datafiles): """ Sets the datafiles of this TablespaceSummary. - A list of the datafiles associated with the tablespace. + A list of the data files associated with the tablespace. :param datafiles: The datafiles of this TablespaceSummary. diff --git a/src/oci/database_management/models/update_db_management_private_endpoint_details.py b/src/oci/database_management/models/update_db_management_private_endpoint_details.py index 446ef622fc..0331f0cebb 100644 --- a/src/oci/database_management/models/update_db_management_private_endpoint_details.py +++ b/src/oci/database_management/models/update_db_management_private_endpoint_details.py @@ -99,7 +99,7 @@ def description(self, description): def nsg_ids(self): """ Gets the nsg_ids of this UpdateDbManagementPrivateEndpointDetails. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :return: The nsg_ids of this UpdateDbManagementPrivateEndpointDetails. @@ -111,7 +111,7 @@ def nsg_ids(self): def nsg_ids(self, nsg_ids): """ Sets the nsg_ids of this UpdateDbManagementPrivateEndpointDetails. - The OCIDs of the network security groups that the private endpoint belongs to. + The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. :param nsg_ids: The nsg_ids of this UpdateDbManagementPrivateEndpointDetails. diff --git a/src/oci/database_management/models/user.py b/src/oci/database_management/models/user.py new file mode 100644 index 0000000000..690e4db930 --- /dev/null +++ b/src/oci/database_management/models/user.py @@ -0,0 +1,1009 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 User(object): + """ + The summary of a specific User. + """ + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "OPEN" + STATUS_OPEN = "OPEN" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED" + STATUS_EXPIRED = "EXPIRED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_GRACE" + STATUS_EXPIRED_GRACE = "EXPIRED_GRACE" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "LOCKED" + STATUS_LOCKED = "LOCKED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "LOCKED_TIMED" + STATUS_LOCKED_TIMED = "LOCKED_TIMED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_AND_LOCKED" + STATUS_EXPIRED_AND_LOCKED = "EXPIRED_AND_LOCKED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_GRACE_AND_LOCKED" + STATUS_EXPIRED_GRACE_AND_LOCKED = "EXPIRED_GRACE_AND_LOCKED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_AND_LOCKED_TIMED" + STATUS_EXPIRED_AND_LOCKED_TIMED = "EXPIRED_AND_LOCKED_TIMED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_GRACE_AND_LOCKED_TIMED" + STATUS_EXPIRED_GRACE_AND_LOCKED_TIMED = "EXPIRED_GRACE_AND_LOCKED_TIMED" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "OPEN_AND_IN_ROLLOVER" + STATUS_OPEN_AND_IN_ROLLOVER = "OPEN_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_AND_IN_ROLLOVER" + STATUS_EXPIRED_AND_IN_ROLLOVER = "EXPIRED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "LOCKED_AND_IN_ROLLOVER" + STATUS_LOCKED_AND_IN_ROLLOVER = "LOCKED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER" + STATUS_EXPIRED_AND_LOCKED_AND_IN_ROLLOVER = "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "LOCKED_TIMED_AND_IN_ROLLOVER" + STATUS_LOCKED_TIMED_AND_IN_ROLLOVER = "LOCKED_TIMED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a User. + #: This constant has a value of "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL" + STATUS_EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL = "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL" + + #: A constant which can be used with the editions_enabled property of a User. + #: This constant has a value of "YES" + EDITIONS_ENABLED_YES = "YES" + + #: A constant which can be used with the editions_enabled property of a User. + #: This constant has a value of "NO" + EDITIONS_ENABLED_NO = "NO" + + #: A constant which can be used with the authentication property of a User. + #: This constant has a value of "NONE" + AUTHENTICATION_NONE = "NONE" + + #: A constant which can be used with the authentication property of a User. + #: This constant has a value of "EXTERNAL" + AUTHENTICATION_EXTERNAL = "EXTERNAL" + + #: A constant which can be used with the authentication property of a User. + #: This constant has a value of "GLOBAL" + AUTHENTICATION_GLOBAL = "GLOBAL" + + #: A constant which can be used with the authentication property of a User. + #: This constant has a value of "PASSWORD" + AUTHENTICATION_PASSWORD = "PASSWORD" + + #: A constant which can be used with the proxy_connect property of a User. + #: This constant has a value of "YES" + PROXY_CONNECT_YES = "YES" + + #: A constant which can be used with the proxy_connect property of a User. + #: This constant has a value of "NO" + PROXY_CONNECT_NO = "NO" + + #: A constant which can be used with the common property of a User. + #: This constant has a value of "YES" + COMMON_YES = "YES" + + #: A constant which can be used with the common property of a User. + #: This constant has a value of "NO" + COMMON_NO = "NO" + + #: A constant which can be used with the oracle_maintained property of a User. + #: This constant has a value of "YES" + ORACLE_MAINTAINED_YES = "YES" + + #: A constant which can be used with the oracle_maintained property of a User. + #: This constant has a value of "NO" + ORACLE_MAINTAINED_NO = "NO" + + #: A constant which can be used with the inherited property of a User. + #: This constant has a value of "YES" + INHERITED_YES = "YES" + + #: A constant which can be used with the inherited property of a User. + #: This constant has a value of "NO" + INHERITED_NO = "NO" + + #: A constant which can be used with the implicit property of a User. + #: This constant has a value of "YES" + IMPLICIT_YES = "YES" + + #: A constant which can be used with the implicit property of a User. + #: This constant has a value of "NO" + IMPLICIT_NO = "NO" + + #: A constant which can be used with the all_shared property of a User. + #: This constant has a value of "YES" + ALL_SHARED_YES = "YES" + + #: A constant which can be used with the all_shared property of a User. + #: This constant has a value of "NO" + ALL_SHARED_NO = "NO" + + #: A constant which can be used with the external_shared property of a User. + #: This constant has a value of "YES" + EXTERNAL_SHARED_YES = "YES" + + #: A constant which can be used with the external_shared property of a User. + #: This constant has a value of "NO" + EXTERNAL_SHARED_NO = "NO" + + def __init__(self, **kwargs): + """ + Initializes a new User 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 User. + :type name: str + + :param status: + The value to assign to the status property of this User. + Allowed values for this property are: "OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param time_locked: + The value to assign to the time_locked property of this User. + :type time_locked: datetime + + :param time_expiring: + The value to assign to the time_expiring property of this User. + :type time_expiring: datetime + + :param default_tablespace: + The value to assign to the default_tablespace property of this User. + :type default_tablespace: str + + :param temp_tablespace: + The value to assign to the temp_tablespace property of this User. + :type temp_tablespace: str + + :param local_temp_tablespace: + The value to assign to the local_temp_tablespace property of this User. + :type local_temp_tablespace: str + + :param time_created: + The value to assign to the time_created property of this User. + :type time_created: datetime + + :param profile: + The value to assign to the profile property of this User. + :type profile: str + + :param consumer_group: + The value to assign to the consumer_group property of this User. + :type consumer_group: str + + :param external_name: + The value to assign to the external_name property of this User. + :type external_name: str + + :param password_versions: + The value to assign to the password_versions property of this User. + :type password_versions: str + + :param editions_enabled: + The value to assign to the editions_enabled property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type editions_enabled: str + + :param authentication: + The value to assign to the authentication property of this User. + Allowed values for this property are: "NONE", "EXTERNAL", "GLOBAL", "PASSWORD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type authentication: str + + :param proxy_connect: + The value to assign to the proxy_connect property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type proxy_connect: str + + :param common: + The value to assign to the common property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type common: str + + :param time_last_login: + The value to assign to the time_last_login property of this User. + :type time_last_login: datetime + + :param oracle_maintained: + The value to assign to the oracle_maintained property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type oracle_maintained: str + + :param inherited: + The value to assign to the inherited property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type inherited: str + + :param default_collation: + The value to assign to the default_collation property of this User. + :type default_collation: str + + :param implicit: + The value to assign to the implicit property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type implicit: str + + :param all_shared: + The value to assign to the all_shared property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type all_shared: str + + :param external_shared: + The value to assign to the external_shared property of this User. + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type external_shared: str + + :param time_password_changed: + The value to assign to the time_password_changed property of this User. + :type time_password_changed: datetime + + """ + self.swagger_types = { + 'name': 'str', + 'status': 'str', + 'time_locked': 'datetime', + 'time_expiring': 'datetime', + 'default_tablespace': 'str', + 'temp_tablespace': 'str', + 'local_temp_tablespace': 'str', + 'time_created': 'datetime', + 'profile': 'str', + 'consumer_group': 'str', + 'external_name': 'str', + 'password_versions': 'str', + 'editions_enabled': 'str', + 'authentication': 'str', + 'proxy_connect': 'str', + 'common': 'str', + 'time_last_login': 'datetime', + 'oracle_maintained': 'str', + 'inherited': 'str', + 'default_collation': 'str', + 'implicit': 'str', + 'all_shared': 'str', + 'external_shared': 'str', + 'time_password_changed': 'datetime' + } + + self.attribute_map = { + 'name': 'name', + 'status': 'status', + 'time_locked': 'timeLocked', + 'time_expiring': 'timeExpiring', + 'default_tablespace': 'defaultTablespace', + 'temp_tablespace': 'tempTablespace', + 'local_temp_tablespace': 'localTempTablespace', + 'time_created': 'timeCreated', + 'profile': 'profile', + 'consumer_group': 'consumerGroup', + 'external_name': 'externalName', + 'password_versions': 'passwordVersions', + 'editions_enabled': 'editionsEnabled', + 'authentication': 'authentication', + 'proxy_connect': 'proxyConnect', + 'common': 'common', + 'time_last_login': 'timeLastLogin', + 'oracle_maintained': 'oracleMaintained', + 'inherited': 'inherited', + 'default_collation': 'defaultCollation', + 'implicit': 'implicit', + 'all_shared': 'allShared', + 'external_shared': 'externalShared', + 'time_password_changed': 'timePasswordChanged' + } + + self._name = None + self._status = None + self._time_locked = None + self._time_expiring = None + self._default_tablespace = None + self._temp_tablespace = None + self._local_temp_tablespace = None + self._time_created = None + self._profile = None + self._consumer_group = None + self._external_name = None + self._password_versions = None + self._editions_enabled = None + self._authentication = None + self._proxy_connect = None + self._common = None + self._time_last_login = None + self._oracle_maintained = None + self._inherited = None + self._default_collation = None + self._implicit = None + self._all_shared = None + self._external_shared = None + self._time_password_changed = None + + @property + def name(self): + """ + **[Required]** Gets the name of this User. + The name of the User. + + + :return: The name of this User. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this User. + The name of the User. + + + :param name: The name of this User. + :type: str + """ + self._name = name + + @property + def status(self): + """ + **[Required]** Gets the status of this User. + The account status of the User + + Allowed values for this property are: "OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this User. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this User. + The account status of the User + + + :param status: The status of this User. + :type: str + """ + allowed_values = ["OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def time_locked(self): + """ + Gets the time_locked of this User. + The date the account was locked if account status was LOCKED. + + + :return: The time_locked of this User. + :rtype: datetime + """ + return self._time_locked + + @time_locked.setter + def time_locked(self, time_locked): + """ + Sets the time_locked of this User. + The date the account was locked if account status was LOCKED. + + + :param time_locked: The time_locked of this User. + :type: datetime + """ + self._time_locked = time_locked + + @property + def time_expiring(self): + """ + Gets the time_expiring of this User. + The date of expiration of the account + + + :return: The time_expiring of this User. + :rtype: datetime + """ + return self._time_expiring + + @time_expiring.setter + def time_expiring(self, time_expiring): + """ + Sets the time_expiring of this User. + The date of expiration of the account + + + :param time_expiring: The time_expiring of this User. + :type: datetime + """ + self._time_expiring = time_expiring + + @property + def default_tablespace(self): + """ + **[Required]** Gets the default_tablespace of this User. + The default tablespace for data. + + + :return: The default_tablespace of this User. + :rtype: str + """ + return self._default_tablespace + + @default_tablespace.setter + def default_tablespace(self, default_tablespace): + """ + Sets the default_tablespace of this User. + The default tablespace for data. + + + :param default_tablespace: The default_tablespace of this User. + :type: str + """ + self._default_tablespace = default_tablespace + + @property + def temp_tablespace(self): + """ + **[Required]** Gets the temp_tablespace of this User. + The name of the default tablespace for temporary tables or the name of a tablespace group. + + + :return: The temp_tablespace of this User. + :rtype: str + """ + return self._temp_tablespace + + @temp_tablespace.setter + def temp_tablespace(self, temp_tablespace): + """ + Sets the temp_tablespace of this User. + The name of the default tablespace for temporary tables or the name of a tablespace group. + + + :param temp_tablespace: The temp_tablespace of this User. + :type: str + """ + self._temp_tablespace = temp_tablespace + + @property + def local_temp_tablespace(self): + """ + Gets the local_temp_tablespace of this User. + The default local temporary tablespace for the User. + + + :return: The local_temp_tablespace of this User. + :rtype: str + """ + return self._local_temp_tablespace + + @local_temp_tablespace.setter + def local_temp_tablespace(self, local_temp_tablespace): + """ + Sets the local_temp_tablespace of this User. + The default local temporary tablespace for the User. + + + :param local_temp_tablespace: The local_temp_tablespace of this User. + :type: str + """ + self._local_temp_tablespace = local_temp_tablespace + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this User. + The User creation date. + + + :return: The time_created of this User. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this User. + The User creation date. + + + :param time_created: The time_created of this User. + :type: datetime + """ + self._time_created = time_created + + @property + def profile(self): + """ + **[Required]** Gets the profile of this User. + The User resource profile name. + + + :return: The profile of this User. + :rtype: str + """ + return self._profile + + @profile.setter + def profile(self, profile): + """ + Sets the profile of this User. + The User resource profile name. + + + :param profile: The profile of this User. + :type: str + """ + self._profile = profile + + @property + def consumer_group(self): + """ + Gets the consumer_group of this User. + The initial resource consumer group for the User. + + + :return: The consumer_group of this User. + :rtype: str + """ + return self._consumer_group + + @consumer_group.setter + def consumer_group(self, consumer_group): + """ + Sets the consumer_group of this User. + The initial resource consumer group for the User. + + + :param consumer_group: The consumer_group of this User. + :type: str + """ + self._consumer_group = consumer_group + + @property + def external_name(self): + """ + Gets the external_name of this User. + The external name of User. + + + :return: The external_name of this User. + :rtype: str + """ + return self._external_name + + @external_name.setter + def external_name(self, external_name): + """ + Sets the external_name of this User. + The external name of User. + + + :param external_name: The external_name of this User. + :type: str + """ + self._external_name = external_name + + @property + def password_versions(self): + """ + Gets the password_versions of this User. + The list of versions of the password hashes (also known as \"verifiers\") existing for the account. + + + :return: The password_versions of this User. + :rtype: str + """ + return self._password_versions + + @password_versions.setter + def password_versions(self, password_versions): + """ + Sets the password_versions of this User. + The list of versions of the password hashes (also known as \"verifiers\") existing for the account. + + + :param password_versions: The password_versions of this User. + :type: str + """ + self._password_versions = password_versions + + @property + def editions_enabled(self): + """ + Gets the editions_enabled of this User. + Indicates whether editions have been enabled for the corresponding user (Y) or not (N) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The editions_enabled of this User. + :rtype: str + """ + return self._editions_enabled + + @editions_enabled.setter + def editions_enabled(self, editions_enabled): + """ + Sets the editions_enabled of this User. + Indicates whether editions have been enabled for the corresponding user (Y) or not (N) + + + :param editions_enabled: The editions_enabled of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(editions_enabled, allowed_values): + editions_enabled = 'UNKNOWN_ENUM_VALUE' + self._editions_enabled = editions_enabled + + @property + def authentication(self): + """ + Gets the authentication of this User. + The authentication mechanism for the user + + Allowed values for this property are: "NONE", "EXTERNAL", "GLOBAL", "PASSWORD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The authentication of this User. + :rtype: str + """ + return self._authentication + + @authentication.setter + def authentication(self, authentication): + """ + Sets the authentication of this User. + The authentication mechanism for the user + + + :param authentication: The authentication of this User. + :type: str + """ + allowed_values = ["NONE", "EXTERNAL", "GLOBAL", "PASSWORD"] + if not value_allowed_none_or_none_sentinel(authentication, allowed_values): + authentication = 'UNKNOWN_ENUM_VALUE' + self._authentication = authentication + + @property + def proxy_connect(self): + """ + Gets the proxy_connect of this User. + Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges + for this account (that is, by users who have been granted the \"connect through\" privilege for this account). + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The proxy_connect of this User. + :rtype: str + """ + return self._proxy_connect + + @proxy_connect.setter + def proxy_connect(self, proxy_connect): + """ + Sets the proxy_connect of this User. + Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges + for this account (that is, by users who have been granted the \"connect through\" privilege for this account). + + + :param proxy_connect: The proxy_connect of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(proxy_connect, allowed_values): + proxy_connect = 'UNKNOWN_ENUM_VALUE' + self._proxy_connect = proxy_connect + + @property + def common(self): + """ + Gets the common of this User. + Indicates whether a given user is common(Y) or local(N). + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The common of this User. + :rtype: str + """ + return self._common + + @common.setter + def common(self, common): + """ + Sets the common of this User. + Indicates whether a given user is common(Y) or local(N). + + + :param common: The common of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(common, allowed_values): + common = 'UNKNOWN_ENUM_VALUE' + self._common = common + + @property + def time_last_login(self): + """ + Gets the time_last_login of this User. + The time of the last user login. + This column is not populated when a user connects to the database with administrative privileges, that is, AS { SYSASM | SYSBACKUP | SYSDBA | SYSDG | SYSOPER | SYSRAC | SYSKM }. + + + :return: The time_last_login of this User. + :rtype: datetime + """ + return self._time_last_login + + @time_last_login.setter + def time_last_login(self, time_last_login): + """ + Sets the time_last_login of this User. + The time of the last user login. + This column is not populated when a user connects to the database with administrative privileges, that is, AS { SYSASM | SYSBACKUP | SYSDBA | SYSDG | SYSOPER | SYSRAC | SYSKM }. + + + :param time_last_login: The time_last_login of this User. + :type: datetime + """ + self._time_last_login = time_last_login + + @property + def oracle_maintained(self): + """ + Gets the oracle_maintained of this User. + Indicates whether the user was created, and is maintained, by Oracle-supplied scripts (such as catalog.sql or catproc.sql). + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The oracle_maintained of this User. + :rtype: str + """ + return self._oracle_maintained + + @oracle_maintained.setter + def oracle_maintained(self, oracle_maintained): + """ + Sets the oracle_maintained of this User. + Indicates whether the user was created, and is maintained, by Oracle-supplied scripts (such as catalog.sql or catproc.sql). + + + :param oracle_maintained: The oracle_maintained of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(oracle_maintained, allowed_values): + oracle_maintained = 'UNKNOWN_ENUM_VALUE' + self._oracle_maintained = oracle_maintained + + @property + def inherited(self): + """ + Gets the inherited of this User. + Indicates whether the user definition was inherited from another container (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The inherited of this User. + :rtype: str + """ + return self._inherited + + @inherited.setter + def inherited(self, inherited): + """ + Sets the inherited of this User. + Indicates whether the user definition was inherited from another container (YES) or not (NO) + + + :param inherited: The inherited of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(inherited, allowed_values): + inherited = 'UNKNOWN_ENUM_VALUE' + self._inherited = inherited + + @property + def default_collation(self): + """ + Gets the default_collation of this User. + The default collation for the user\u2019s schema. + + + :return: The default_collation of this User. + :rtype: str + """ + return self._default_collation + + @default_collation.setter + def default_collation(self, default_collation): + """ + Sets the default_collation of this User. + The default collation for the user\u2019s schema. + + + :param default_collation: The default_collation of this User. + :type: str + """ + self._default_collation = default_collation + + @property + def implicit(self): + """ + Gets the implicit of this User. + Indicates whether this user is a common user created by an implicit application (YES) or not (NO) + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The implicit of this User. + :rtype: str + """ + return self._implicit + + @implicit.setter + def implicit(self, implicit): + """ + Sets the implicit of this User. + Indicates whether this user is a common user created by an implicit application (YES) or not (NO) + + + :param implicit: The implicit of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(implicit, allowed_values): + implicit = 'UNKNOWN_ENUM_VALUE' + self._implicit = implicit + + @property + def all_shared(self): + """ + Gets the all_shared of this User. + In a sharded database, the value in this column indicates whether the user was created with shard DDL enabled. + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The all_shared of this User. + :rtype: str + """ + return self._all_shared + + @all_shared.setter + def all_shared(self, all_shared): + """ + Sets the all_shared of this User. + In a sharded database, the value in this column indicates whether the user was created with shard DDL enabled. + + + :param all_shared: The all_shared of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(all_shared, allowed_values): + all_shared = 'UNKNOWN_ENUM_VALUE' + self._all_shared = all_shared + + @property + def external_shared(self): + """ + Gets the external_shared of this User. + In a federated sharded database, indicates whether the user is an external shard user (YES) or not (NO). + + Allowed values for this property are: "YES", "NO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The external_shared of this User. + :rtype: str + """ + return self._external_shared + + @external_shared.setter + def external_shared(self, external_shared): + """ + Sets the external_shared of this User. + In a federated sharded database, indicates whether the user is an external shard user (YES) or not (NO). + + + :param external_shared: The external_shared of this User. + :type: str + """ + allowed_values = ["YES", "NO"] + if not value_allowed_none_or_none_sentinel(external_shared, allowed_values): + external_shared = 'UNKNOWN_ENUM_VALUE' + self._external_shared = external_shared + + @property + def time_password_changed(self): + """ + Gets the time_password_changed of this User. + The date on which the user's password was last set. + This column is populated only when the value of the AUTHENTICATION_TYPE column is PASSWORD. Otherwise, this column is null. + + + :return: The time_password_changed of this User. + :rtype: datetime + """ + return self._time_password_changed + + @time_password_changed.setter + def time_password_changed(self, time_password_changed): + """ + Sets the time_password_changed of this User. + The date on which the user's password was last set. + This column is populated only when the value of the AUTHENTICATION_TYPE column is PASSWORD. Otherwise, this column is null. + + + :param time_password_changed: The time_password_changed of this User. + :type: datetime + """ + self._time_password_changed = time_password_changed + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/user_collection.py b/src/oci/database_management/models/user_collection.py new file mode 100644 index 0000000000..5426ce1624 --- /dev/null +++ b/src/oci/database_management/models/user_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 UserCollection(object): + """ + A collection of Users for a specific database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UserCollection 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 UserCollection. + :type items: list[oci.database_management.models.UserSummary] + + """ + self.swagger_types = { + 'items': 'list[UserSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this UserCollection. + An array of User resources. + + + :return: The items of this UserCollection. + :rtype: list[oci.database_management.models.UserSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this UserCollection. + An array of User resources. + + + :param items: The items of this UserCollection. + :type: list[oci.database_management.models.UserSummary] + """ + 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/database_management/models/user_summary.py b/src/oci/database_management/models/user_summary.py new file mode 100644 index 0000000000..8c4ebc2e42 --- /dev/null +++ b/src/oci/database_management/models/user_summary.py @@ -0,0 +1,324 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 UserSummary(object): + """ + The summary of a specific User. + """ + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "OPEN" + STATUS_OPEN = "OPEN" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED" + STATUS_EXPIRED = "EXPIRED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_GRACE" + STATUS_EXPIRED_GRACE = "EXPIRED_GRACE" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "LOCKED" + STATUS_LOCKED = "LOCKED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "LOCKED_TIMED" + STATUS_LOCKED_TIMED = "LOCKED_TIMED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_AND_LOCKED" + STATUS_EXPIRED_AND_LOCKED = "EXPIRED_AND_LOCKED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_GRACE_AND_LOCKED" + STATUS_EXPIRED_GRACE_AND_LOCKED = "EXPIRED_GRACE_AND_LOCKED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_AND_LOCKED_TIMED" + STATUS_EXPIRED_AND_LOCKED_TIMED = "EXPIRED_AND_LOCKED_TIMED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_GRACE_AND_LOCKED_TIMED" + STATUS_EXPIRED_GRACE_AND_LOCKED_TIMED = "EXPIRED_GRACE_AND_LOCKED_TIMED" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "OPEN_AND_IN_ROLLOVER" + STATUS_OPEN_AND_IN_ROLLOVER = "OPEN_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_AND_IN_ROLLOVER" + STATUS_EXPIRED_AND_IN_ROLLOVER = "EXPIRED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "LOCKED_AND_IN_ROLLOVER" + STATUS_LOCKED_AND_IN_ROLLOVER = "LOCKED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER" + STATUS_EXPIRED_AND_LOCKED_AND_IN_ROLLOVER = "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "LOCKED_TIMED_AND_IN_ROLLOVER" + STATUS_LOCKED_TIMED_AND_IN_ROLLOVER = "LOCKED_TIMED_AND_IN_ROLLOVER" + + #: A constant which can be used with the status property of a UserSummary. + #: This constant has a value of "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL" + STATUS_EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL = "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL" + + def __init__(self, **kwargs): + """ + Initializes a new UserSummary 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 UserSummary. + :type name: str + + :param status: + The value to assign to the status property of this UserSummary. + Allowed values for this property are: "OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param time_expiring: + The value to assign to the time_expiring property of this UserSummary. + :type time_expiring: datetime + + :param default_tablespace: + The value to assign to the default_tablespace property of this UserSummary. + :type default_tablespace: str + + :param temp_tablespace: + The value to assign to the temp_tablespace property of this UserSummary. + :type temp_tablespace: str + + :param time_created: + The value to assign to the time_created property of this UserSummary. + :type time_created: datetime + + :param profile: + The value to assign to the profile property of this UserSummary. + :type profile: str + + """ + self.swagger_types = { + 'name': 'str', + 'status': 'str', + 'time_expiring': 'datetime', + 'default_tablespace': 'str', + 'temp_tablespace': 'str', + 'time_created': 'datetime', + 'profile': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'status': 'status', + 'time_expiring': 'timeExpiring', + 'default_tablespace': 'defaultTablespace', + 'temp_tablespace': 'tempTablespace', + 'time_created': 'timeCreated', + 'profile': 'profile' + } + + self._name = None + self._status = None + self._time_expiring = None + self._default_tablespace = None + self._temp_tablespace = None + self._time_created = None + self._profile = None + + @property + def name(self): + """ + **[Required]** Gets the name of this UserSummary. + The name of the User. + + + :return: The name of this UserSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UserSummary. + The name of the User. + + + :param name: The name of this UserSummary. + :type: str + """ + self._name = name + + @property + def status(self): + """ + **[Required]** Gets the status of this UserSummary. + The account status of the User + + Allowed values for this property are: "OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this UserSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UserSummary. + The account status of the User + + + :param status: The status of this UserSummary. + :type: str + """ + allowed_values = ["OPEN", "EXPIRED", "EXPIRED_GRACE", "LOCKED", "LOCKED_TIMED", "EXPIRED_AND_LOCKED", "EXPIRED_GRACE_AND_LOCKED", "EXPIRED_AND_LOCKED_TIMED", "EXPIRED_GRACE_AND_LOCKED_TIMED", "OPEN_AND_IN_ROLLOVER", "EXPIRED_AND_IN_ROLLOVER", "LOCKED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_AND_IN_ROLLOVER", "LOCKED_TIMED_AND_IN_ROLLOVER", "EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def time_expiring(self): + """ + Gets the time_expiring of this UserSummary. + The date of expiration of the account + + + :return: The time_expiring of this UserSummary. + :rtype: datetime + """ + return self._time_expiring + + @time_expiring.setter + def time_expiring(self, time_expiring): + """ + Sets the time_expiring of this UserSummary. + The date of expiration of the account + + + :param time_expiring: The time_expiring of this UserSummary. + :type: datetime + """ + self._time_expiring = time_expiring + + @property + def default_tablespace(self): + """ + **[Required]** Gets the default_tablespace of this UserSummary. + The default tablespace for data. + + + :return: The default_tablespace of this UserSummary. + :rtype: str + """ + return self._default_tablespace + + @default_tablespace.setter + def default_tablespace(self, default_tablespace): + """ + Sets the default_tablespace of this UserSummary. + The default tablespace for data. + + + :param default_tablespace: The default_tablespace of this UserSummary. + :type: str + """ + self._default_tablespace = default_tablespace + + @property + def temp_tablespace(self): + """ + **[Required]** Gets the temp_tablespace of this UserSummary. + The name of the default tablespace for temporary tables or the name of a tablespace group. + + + :return: The temp_tablespace of this UserSummary. + :rtype: str + """ + return self._temp_tablespace + + @temp_tablespace.setter + def temp_tablespace(self, temp_tablespace): + """ + Sets the temp_tablespace of this UserSummary. + The name of the default tablespace for temporary tables or the name of a tablespace group. + + + :param temp_tablespace: The temp_tablespace of this UserSummary. + :type: str + """ + self._temp_tablespace = temp_tablespace + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this UserSummary. + The User creation date. + + + :return: The time_created of this UserSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this UserSummary. + The User creation date. + + + :param time_created: The time_created of this UserSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def profile(self): + """ + **[Required]** Gets the profile of this UserSummary. + The User resource profile name. + + + :return: The profile of this UserSummary. + :rtype: str + """ + return self._profile + + @profile.setter + def profile(self, profile): + """ + Sets the profile of this UserSummary. + The User resource profile name. + + + :param profile: The profile of this UserSummary. + :type: str + """ + self._profile = profile + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/work_request.py b/src/oci/database_management/models/work_request.py index d34241ecee..0a8c014e2e 100644 --- a/src/oci/database_management/models/work_request.py +++ b/src/oci/database_management/models/work_request.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequest(object): """ - A description of workrequest status + A description of the work request status. """ #: A constant which can be used with the operation_type property of a WorkRequest. @@ -153,10 +153,9 @@ def id(self, id): 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. + 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 that are not in the same compartment, + then the system picks the primary resource whose compartment should be used. :return: The compartment_id of this WorkRequest. @@ -168,10 +167,9 @@ def compartment_id(self): 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. + 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 that are not in the same compartment, + then the system picks the primary resource whose compartment should be used. :param compartment_id: The compartment_id of this WorkRequest. @@ -183,7 +181,7 @@ def compartment_id(self, compartment_id): def operation_type(self): """ **[Required]** Gets the operation_type of this WorkRequest. - Type of the work request + The type of work request. Allowed values for this property are: "CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT", "DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -198,7 +196,7 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this WorkRequest. - Type of the work request + The type of work request. :param operation_type: The operation_type of this WorkRequest. @@ -213,7 +211,7 @@ def operation_type(self, operation_type): def status(self): """ **[Required]** Gets the status of this WorkRequest. - Status of current work request. + The status of the current work request. 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'. @@ -228,7 +226,7 @@ def status(self): def status(self, status): """ Sets the status of this WorkRequest. - Status of current work request. + The status of the current work request. :param status: The status of this WorkRequest. @@ -243,7 +241,7 @@ def status(self, status): def percent_complete(self): """ **[Required]** Gets the percent_complete of this WorkRequest. - Percentage of the request completed. + The completed percentage of the operation tracked by the work request. :return: The percent_complete of this WorkRequest. @@ -255,7 +253,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this WorkRequest. - Percentage of the request completed. + The completed percentage of the operation tracked by the work request. :param percent_complete: The percent_complete of this WorkRequest. @@ -267,9 +265,9 @@ def percent_complete(self, percent_complete): 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. - The precision for this time object is milliseconds. + The date and time the work request was accepted, as described in + `RFC 3339`__. + The precision for this time object in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -283,9 +281,9 @@ def time_accepted(self): 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. - The precision for this time object is milliseconds. + The date and time the work request was accepted, as described in + `RFC 3339`__. + The precision for this time object in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -299,8 +297,8 @@ def time_accepted(self, time_accepted): 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. The precision for this time object is milliseconds. + The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -314,8 +312,8 @@ def time_started(self): 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. The precision for this time object is milliseconds. + The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -329,8 +327,8 @@ def time_started(self, time_started): def time_finished(self): """ Gets the time_finished of this WorkRequest. - The date and time the object was finished, as described in `RFC 3339`__. - The precision for this time object is milliseconds. + The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -344,8 +342,8 @@ def time_finished(self): 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`__. - The precision for this time object is milliseconds. + The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 diff --git a/src/oci/database_management/models/work_request_collection.py b/src/oci/database_management/models/work_request_collection.py index 048c74adfe..eba32a3f36 100644 --- a/src/oci/database_management/models/work_request_collection.py +++ b/src/oci/database_management/models/work_request_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestCollection(object): """ - Lists all work requests in a given compartment. Contains WorkRequestSummary items. + Lists all work requests in a specific compartment. This contains WorkRequestSummary items. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestCollection. - Collection of work requests + A collection of work requests. :return: The items of this WorkRequestCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestCollection. - Collection of work requests + A collection of work requests. :param items: The items of this WorkRequestCollection. diff --git a/src/oci/database_management/models/work_request_error.py b/src/oci/database_management/models/work_request_error.py index 17237773a4..bf4e15a296 100644 --- a/src/oci/database_management/models/work_request_error.py +++ b/src/oci/database_management/models/work_request_error.py @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this WorkRequestError. - The identifier of the work request erorr. + The identifier of the work request error. :return: The id of this WorkRequestError. @@ -84,7 +84,7 @@ def id(self): def id(self, id): """ Sets the id of this WorkRequestError. - The identifier of the work request erorr. + The identifier of the work request error. :param id: The id of this WorkRequestError. @@ -120,8 +120,8 @@ def work_request_id(self, work_request_id): 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) + A machine-usable code for the error that occurred. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :return: The code of this WorkRequestError. @@ -133,8 +133,8 @@ def code(self): 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) + A machine-usable code for the error that occurred. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :param code: The code of this WorkRequestError. @@ -146,7 +146,7 @@ def code(self, code): def message(self): """ **[Required]** Gets the message of this WorkRequestError. - A human readable description of the issue encountered. + A human-readable description of the issue that occurred. :return: The message of this WorkRequestError. @@ -158,7 +158,7 @@ def message(self): def message(self, message): """ Sets the message of this WorkRequestError. - A human readable description of the issue encountered. + A human-readable description of the issue that occurred. :param message: The message of this WorkRequestError. @@ -170,7 +170,7 @@ def message(self, message): def is_retryable(self): """ Gets the is_retryable of this WorkRequestError. - To determine the work request error is retryable or not + Determines if the work request error can be reproduced and tried again. :return: The is_retryable of this WorkRequestError. @@ -182,7 +182,7 @@ def is_retryable(self): def is_retryable(self, is_retryable): """ Sets the is_retryable of this WorkRequestError. - To determine the work request error is retryable or not + Determines if the work request error can be reproduced and tried again. :param is_retryable: The is_retryable of this WorkRequestError. @@ -194,8 +194,9 @@ def is_retryable(self, is_retryable): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestError. - The time the error occured. - An RFC3339 formatted datetime string. The precision for the time object is milliseconds. + The date and time the error occurred as described in `RFC 3339`__. The precision for the time object is in milliseconds. + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestError. @@ -207,8 +208,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestError. - The time the error occured. - An RFC3339 formatted datetime string. The precision for the time object is milliseconds. + The date and time the error occurred as described in `RFC 3339`__. The precision for the time object is in milliseconds. + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestError. diff --git a/src/oci/database_management/models/work_request_error_collection.py b/src/oci/database_management/models/work_request_error_collection.py index 48b3f8e52c..9ef2b81c5d 100644 --- a/src/oci/database_management/models/work_request_error_collection.py +++ b/src/oci/database_management/models/work_request_error_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestErrorCollection(object): """ - Results of a work request error search. Contains both WorkRequestError items and other data. + The results of a work request error search. This contains WorkRequestError items and other data. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestErrorCollection. - collection of work request errors + A collection of work request errors. :return: The items of this WorkRequestErrorCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestErrorCollection. - collection of work request errors + A collection of work request errors. :param items: The items of this WorkRequestErrorCollection. diff --git a/src/oci/database_management/models/work_request_log_entry.py b/src/oci/database_management/models/work_request_log_entry.py index 60edc3129f..0e9e16c191 100644 --- a/src/oci/database_management/models/work_request_log_entry.py +++ b/src/oci/database_management/models/work_request_log_entry.py @@ -106,7 +106,7 @@ def work_request_id(self, work_request_id): def message(self): """ **[Required]** Gets the message of this WorkRequestLogEntry. - Human-readable log message. + A human-readable log message. :return: The message of this WorkRequestLogEntry. @@ -118,7 +118,7 @@ def message(self): def message(self, message): """ Sets the message of this WorkRequestLogEntry. - Human-readable log message. + A human-readable log message. :param message: The message of this WorkRequestLogEntry. @@ -130,8 +130,9 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestLogEntry. - The time the log message was written. - An RFC3339 formatted datetime string. The precision for the time object is milliseconds. + The date and time the log message was written, described in `RFC 3339`__. The precision for the time object is in milliseconds. + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestLogEntry. @@ -143,8 +144,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestLogEntry. - The time the log message was written. - An RFC3339 formatted datetime string. The precision for the time object is milliseconds. + The date and time the log message was written, described in `RFC 3339`__. The precision for the time object is in milliseconds. + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestLogEntry. diff --git a/src/oci/database_management/models/work_request_log_entry_collection.py b/src/oci/database_management/models/work_request_log_entry_collection.py index 5bc20ce2fc..8070c60840 100644 --- a/src/oci/database_management/models/work_request_log_entry_collection.py +++ b/src/oci/database_management/models/work_request_log_entry_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestLogEntryCollection(object): """ - Results of a work request log search. Contains both WorkRequestLog items and other data. + The results of a work request log search. This contains WorkRequestLog items and other data. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestLogEntryCollection. - Collection of work request logs + A collection of work request logs. :return: The items of this WorkRequestLogEntryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestLogEntryCollection. - Collection of work request logs + A collection of work request logs. :param items: The items of this WorkRequestLogEntryCollection. diff --git a/src/oci/database_management/models/work_request_resource.py b/src/oci/database_management/models/work_request_resource.py index f8150bffbe..dad4678389 100644 --- a/src/oci/database_management/models/work_request_resource.py +++ b/src/oci/database_management/models/work_request_resource.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestResource(object): """ - A resource created or operated on by a work request. + The resource that is created or operated on by a work request. """ #: A constant which can be used with the action_type property of a WorkRequestResource. @@ -84,7 +84,7 @@ def __init__(self, **kwargs): def entity_type(self): """ **[Required]** Gets the entity_type of this WorkRequestResource. - The entity type the work request is affects. + The resource type the work request affects. :return: The entity_type of this WorkRequestResource. @@ -96,7 +96,7 @@ def entity_type(self): def entity_type(self, entity_type): """ Sets the entity_type of this WorkRequestResource. - The entity type the work request is affects. + The resource type the work request affects. :param entity_type: The entity_type of this WorkRequestResource. @@ -144,7 +144,7 @@ def action_type(self, action_type): def identifier(self): """ **[Required]** Gets the identifier of this WorkRequestResource. - The identifier of the resource the work request affects. + The OCID or other unique identifier of the resource the work request affects. :return: The identifier of this WorkRequestResource. @@ -156,7 +156,7 @@ def identifier(self): def identifier(self, identifier): """ Sets the identifier of this WorkRequestResource. - The identifier of the resource the work request affects. + The OCID or other unique identifier of the resource the work request affects. :param identifier: The identifier of this WorkRequestResource. @@ -168,7 +168,7 @@ def identifier(self, identifier): 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 + The URI path that is used in a GET request to access the resource metadata. :return: The entity_uri of this WorkRequestResource. @@ -180,7 +180,7 @@ def entity_uri(self): 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 + The URI path that is used in a GET request to access the resource metadata. :param entity_uri: The entity_uri of this WorkRequestResource. diff --git a/src/oci/database_management/models/work_request_summary.py b/src/oci/database_management/models/work_request_summary.py index 2d4da4599f..6a05a03a49 100644 --- a/src/oci/database_management/models/work_request_summary.py +++ b/src/oci/database_management/models/work_request_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestSummary(object): """ - A Summary of Work Request + A Summary of the work request. """ #: A constant which can be used with the operation_type property of a WorkRequestSummary. @@ -129,7 +129,7 @@ def __init__(self, **kwargs): def operation_type(self): """ **[Required]** Gets the operation_type of this WorkRequestSummary. - Type of the work request + The type of work request. Allowed values for this property are: "CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT", "DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -144,7 +144,7 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this WorkRequestSummary. - Type of the work request + The type of work request. :param operation_type: The operation_type of this WorkRequestSummary. @@ -159,7 +159,7 @@ def operation_type(self, operation_type): def status(self): """ **[Required]** Gets the status of this WorkRequestSummary. - Status of current work request. + The status of the current work request. 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'. @@ -174,7 +174,7 @@ def status(self): def status(self, status): """ Sets the status of this WorkRequestSummary. - Status of current work request. + The status of the current work request. :param status: The status of this WorkRequestSummary. @@ -213,10 +213,8 @@ def id(self, id): 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 + 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 that are not in the same compartment then the system picks the primary resource whose compartment should be used. :return: The compartment_id of this WorkRequestSummary. @@ -228,10 +226,8 @@ def compartment_id(self): 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 + 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 that are not in the same compartment then the system picks the primary resource whose compartment should be used. :param compartment_id: The compartment_id of this WorkRequestSummary. @@ -243,7 +239,7 @@ def compartment_id(self, compartment_id): def percent_complete(self): """ **[Required]** Gets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. + The completed percentage of the operation tracked by the work request. :return: The percent_complete of this WorkRequestSummary. @@ -255,7 +251,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. + The completed percentage of the operation tracked by the work request. :param percent_complete: The percent_complete of this WorkRequestSummary. @@ -267,9 +263,9 @@ def percent_complete(self, percent_complete): 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. - The precision for the time object is milliseconds. + The date and time the work request was accepted, as described in + `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -283,9 +279,9 @@ def time_accepted(self): 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. - The precision for the time object is milliseconds. + The date and time the work request was accepted, as described in + `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -299,8 +295,7 @@ def time_accepted(self, time_accepted): 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. The precision for the time object is milliseconds. + The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in `RFC 3339`__. The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -314,8 +309,7 @@ def time_started(self): 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. The precision for the time object is milliseconds. + The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in `RFC 3339`__. The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -329,8 +323,8 @@ def time_started(self, time_started): def time_finished(self): """ Gets the time_finished of this WorkRequestSummary. - The date and time the object was finished, as described in `RFC 3339`__. - The precision for the time object is milliseconds. + The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 @@ -344,8 +338,8 @@ def time_finished(self): 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`__. - The precision for the time object is milliseconds. + The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in `RFC 3339`__. + The precision for this time object is in milliseconds. __ https://tools.ietf.org/rfc/rfc3339 diff --git a/src/oci/database_management/sql_tuning_client.py b/src/oci/database_management/sql_tuning_client.py new file mode 100644 index 0000000000..3a937c0fa1 --- /dev/null +++ b/src/oci/database_management/sql_tuning_client.py @@ -0,0 +1,1211 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 database_management_type_mapping +missing = Sentinel("Missing") + + +class SqlTuningClient(object): + """ + Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics + for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and + running a SQL job on a Managed Database or Managed Database Group. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20201101', + 'service_endpoint_template': 'https://dbmgmt.{region}.oci.{secondLevelDomain}', + '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 + self.base_client = BaseClient("sql_tuning", config, signer, database_management_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def clone_sql_tuning_task(self, managed_database_id, clone_sql_tuning_task_details, **kwargs): + """ + Clone and start a SQL tuning task for a given SQL tuning task. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.CloneSqlTuningTaskDetails clone_sql_tuning_task_details: (required) + Detail inputs for cloning a SQL tuning task + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningTaskReturn` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use clone_sql_tuning_task API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/actions/cloneSqlTuningTask" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "clone_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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=clone_sql_tuning_task_details, + response_type="SqlTuningTaskReturn") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=clone_sql_tuning_task_details, + response_type="SqlTuningTaskReturn") + + def drop_sql_tuning_task(self, managed_database_id, drop_sql_tuning_task_details, **kwargs): + """ + Drop a SQL tuning task and its related results from the database. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.DropSqlTuningTaskDetails drop_sql_tuning_task_details: (required) + Detail inputs for dropping a SQL tuning task + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + 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`. + + :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 drop_sql_tuning_task API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/actions/dropSqlTuningTask" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "drop_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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=drop_sql_tuning_task_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=drop_sql_tuning_task_details) + + def get_execution_plan_stats_comparision(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + """ + A SQL tuning task may suggest new execution plan for a SQL. The API returns the + stats comparison report for the plans. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object id for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int execution_id: (required) + The execution id for an execution of a SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.ExecutionPlanStatsComparision` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_execution_plan_stats_comparision API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/executionPlanStatsComparision" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_execution_plan_stats_comparision got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "sqlObjectId": sql_object_id, + "executionId": execution_id + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ExecutionPlanStatsComparision") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ExecutionPlanStatsComparision") + + def get_sql_execution_plan(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, attribute, **kwargs): + """ + Retrieve a SQL execution plan for a SQL being tuned, for original or new plan + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object id for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str attribute: (required) + The attribute of the SQL execution plan. + + Allowed values are: "ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES" + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSqlExecutionPlan` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sql_execution_plan API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/sqlExecutionPlan" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_sql_execution_plan got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + attribute_allowed_values = ["ORIGINAL", "ORIGINAL_WITH_ADJUSTED_COST", "USING_SQL_PROFILE", "USING_NEW_INDICES"] + if attribute not in attribute_allowed_values: + raise ValueError( + "Invalid value for `attribute`, must be one of {0}".format(attribute_allowed_values) + ) + + query_params = { + "sqlObjectId": sql_object_id, + "attribute": attribute + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSqlExecutionPlan") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSqlExecutionPlan") + + def get_sql_tuning_advisor_task_summary_report(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + """ + Gets the summary report for the specific SQL Tuning Advisor task. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str search_period: (optional) + How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks. + + Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" + + :param datetime time_greater_than_or_equal_to: (optional) + The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. + + :param datetime time_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. + + :param int begin_exec_id_greater_than_or_equal_to: (optional) + The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + + :param int end_exec_id_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskSummaryReport` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sql_tuning_advisor_task_summary_report API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/summaryReport" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "search_period", + "time_greater_than_or_equal_to", + "time_less_than_or_equal_to", + "begin_exec_id_greater_than_or_equal_to", + "end_exec_id_less_than_or_equal_to", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_sql_tuning_advisor_task_summary_report got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'search_period' in kwargs: + search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] + if kwargs['search_period'] not in search_period_allowed_values: + raise ValueError( + "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) + ) + + query_params = { + "searchPeriod": kwargs.get("search_period", missing), + "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), + "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), + "beginExecIdGreaterThanOrEqualTo": kwargs.get("begin_exec_id_greater_than_or_equal_to", missing), + "endExecIdLessThanOrEqualTo": kwargs.get("end_exec_id_less_than_or_equal_to", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSummaryReport") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskSummaryReport") + + def list_sql_tuning_advisor_task_findings(self, managed_database_id, sql_tuning_advisor_task_id, **kwargs): + """ + Takes in a task id, and a finding/object type filter and applies some SQLs to find return the output. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int begin_exec_id: (optional) + The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. + + :param int end_exec_id: (optional) + The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. + + :param str search_period: (optional) + How far back the API will search for begin and end exec id, if not supplied. Unused if beginExecId and endExecId optional query params are both supplied. + + Allowed values are: "LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL" + + :param str finding_filter: (optional) + Filters which findings get shown in the report + + Allowed values are: "none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES" + + :param str stats_hash_filter: (optional) + The hash value of the object for the statistic finding search. + + :param str index_hash_filter: (optional) + The hash value of the index table name. + + :param str sort_by: (optional) + The possible sortBy values of an object's recommendations. + + Allowed values are: "DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskFindingCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_findings API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/findings" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "begin_exec_id", + "end_exec_id", + "search_period", + "finding_filter", + "stats_hash_filter", + "index_hash_filter", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_advisor_task_findings got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'search_period' in kwargs: + search_period_allowed_values = ["LAST_24HR", "LAST_7DAY", "LAST_31DAY", "SINCE_LAST", "ALL"] + if kwargs['search_period'] not in search_period_allowed_values: + raise ValueError( + "Invalid value for `search_period`, must be one of {0}".format(search_period_allowed_values) + ) + + if 'finding_filter' in kwargs: + finding_filter_allowed_values = ["none", "FINDINGS", "NOFINDINGS", "ERRORS", "PROFILES", "INDICES", "STATS", "RESTRUCTURE", "ALTERNATIVE", "AUTO_PROFILES", "OTHER_PROFILES"] + if kwargs['finding_filter'] not in finding_filter_allowed_values: + raise ValueError( + "Invalid value for `finding_filter`, must be one of {0}".format(finding_filter_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["DBTIME_BENEFIT", "PARSING_SCHEMA", "SQL_ID", "STATS", "PROFILES", "SQL_BENEFIT", "DATE", "INDICES", "RESTRUCTURE", "ALTERNATIVE", "MISC", "ERROR", "TIMEOUTS"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "beginExecId": kwargs.get("begin_exec_id", missing), + "endExecId": kwargs.get("end_exec_id", missing), + "searchPeriod": kwargs.get("search_period", missing), + "findingFilter": kwargs.get("finding_filter", missing), + "statsHashFilter": kwargs.get("stats_hash_filter", missing), + "indexHashFilter": kwargs.get("index_hash_filter", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskFindingCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskFindingCollection") + + def list_sql_tuning_advisor_task_recommendations(self, managed_database_id, sql_tuning_advisor_task_id, sql_object_id, execution_id, **kwargs): + """ + Takes in a task id and object id and returns the recommendations/findings. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_tuning_advisor_task_id: (required) + The SQL tuning task identifier. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int sql_object_id: (required) + The SQL object id for the SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param int execution_id: (required) + The execution id for an execution of a SQL tuning task. This is not the `OCID`__. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str sort_by: (optional) + The possible sortBy values of an object's recommendations. + + Allowed values are: "RECOMMENDATION_TYPE", "BENEFIT" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskRecommendationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sql_tuning_advisor_task_recommendations API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks/{sqlTuningAdvisorTaskId}/recommendations" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "sort_by", + "sort_order", + "page", + "limit", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_advisor_task_recommendations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "sqlTuningAdvisorTaskId": sql_tuning_advisor_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["RECOMMENDATION_TYPE", "BENEFIT"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "sqlObjectId": sql_object_id, + "executionId": execution_id, + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskRecommendationCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SqlTuningAdvisorTaskRecommendationCollection") + + def list_sql_tuning_advisor_tasks(self, managed_database_id, **kwargs): + """ + Lists the SQL Tuning Advisor tasks for the specified Managed Database. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str name: (optional) + The optional query parameter to filter the SQL Tuning Advisor task list by name. + + :param str status: (optional) + The optional query parameter to filter the SQL Tuning Advisor task list by status. + + Allowed values are: "INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR" + + :param datetime time_greater_than_or_equal_to: (optional) + The optional greater than or equal to query parameter to filter the timestamp. + + :param datetime time_less_than_or_equal_to: (optional) + The optional less than or equal to query parameter to filter the timestamp. + + :param str page: (optional) + The page token representing the page from where the next set of paginated results + are retrieved. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of records returned in the paginated response. + + :param str sort_by: (optional) + The option to sort the SQL Tuning advisor task summary data. + + Allowed values are: "NAME", "START_TIME" + + :param str sort_order: (optional) + The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order. Descending order is the default order. + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningAdvisorTaskCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sql_tuning_advisor_tasks API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/sqlTuningAdvisorTasks" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "name", + "status", + "time_greater_than_or_equal_to", + "time_less_than_or_equal_to", + "page", + "limit", + "sort_by", + "sort_order", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sql_tuning_advisor_tasks got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'status' in kwargs: + status_allowed_values = ["INITIAL", "EXECUTING", "INTERRUPTED", "COMPLETED", "ERROR"] + if kwargs['status'] not in status_allowed_values: + raise ValueError( + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["NAME", "START_TIME"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "status": kwargs.get("status", missing), + "timeGreaterThanOrEqualTo": kwargs.get("time_greater_than_or_equal_to", missing), + "timeLessThanOrEqualTo": kwargs.get("time_less_than_or_equal_to", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + 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="SqlTuningAdvisorTaskCollection") + 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="SqlTuningAdvisorTaskCollection") + + def start_sql_tuning_task(self, managed_database_id, start_sql_tuning_task_details, **kwargs): + """ + Start a SQL tuning task for a given set of SQLs from active session history + top SQLs. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.database_management.models.StartSqlTuningTaskDetails start_sql_tuning_task_details: (required) + Detail inputs for starting a SQL tuning task + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + 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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.SqlTuningTaskReturn` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use start_sql_tuning_task API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/actions/startSqlTuningTask" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "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( + "start_sql_tuning_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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=start_sql_tuning_task_details, + response_type="SqlTuningTaskReturn") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=start_sql_tuning_task_details, + response_type="SqlTuningTaskReturn") diff --git a/src/oci/database_management/sql_tuning_client_composite_operations.py b/src/oci/database_management/sql_tuning_client_composite_operations.py new file mode 100644 index 0000000000..ac6226df76 --- /dev/null +++ b/src/oci/database_management/sql_tuning_client_composite_operations.py @@ -0,0 +1,24 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 SqlTuningClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.database_management.SqlTuningClient` 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 SqlTuningClientCompositeOperations object + + :param SqlTuningClient client: + The service client which will be wrapped by this object + """ + self.client = client diff --git a/src/oci/devops/devops_client.py b/src/oci/devops/devops_client.py index 4190db0e11..af77dd8dcb 100644 --- a/src/oci/devops/devops_client.py +++ b/src/oci/devops/devops_client.py @@ -18,7 +18,7 @@ class DevopsClient(object): """ - Use the DevOps APIs to create a DevOps project to group the pipelines, add reference to target deployment environments, add artifacts to deploy, and create deployment pipelines needed to deploy your software. + Use the DevOps API to create DevOps projects, configure code repositories, add artifacts to deploy, build and test software applications, configure target deployment environments, and deploy software applications. For more information, see [DevOps](/Content/devops/using/home.htm). """ def __init__(self, config, **kwargs): @@ -121,7 +121,7 @@ def approve_deployment(self, deployment_id, approve_deployment_details, **kwargs :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -170,6 +170,8 @@ def approve_deployment(self, deployment_id, approve_deployment_details, **kwargs operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -195,11 +197,11 @@ def approve_deployment(self, deployment_id, approve_deployment_details, **kwargs def cancel_build_run(self, cancel_build_run_details, build_run_id, **kwargs): """ - Cancels the Build Run based on build run id provided in request + Cancels the build run based on the build run ID provided in the request. :param oci.devops.models.CancelBuildRunDetails cancel_build_run_details: (required) - Details the input parameters required to cancel a build run. + Parameter details required to cancel a build run. :param str build_run_id: (required) Unique build run identifier. @@ -216,7 +218,7 @@ def cancel_build_run(self, cancel_build_run_details, build_run_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -265,6 +267,8 @@ def cancel_build_run(self, cancel_build_run_details, build_run_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -311,7 +315,7 @@ def cancel_deployment(self, deployment_id, cancel_deployment_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -360,6 +364,8 @@ def cancel_deployment(self, deployment_id, cancel_deployment_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -406,7 +412,7 @@ def change_project_compartment(self, project_id, change_project_compartment_deta :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -455,6 +461,8 @@ def change_project_compartment(self, project_id, change_project_compartment_deta operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -478,11 +486,11 @@ def change_project_compartment(self, project_id, change_project_compartment_deta def create_build_pipeline(self, create_build_pipeline_details, **kwargs): """ - Creates a new BuildPipeline. + Creates a new build pipeline. :param oci.devops.models.CreateBuildPipelineDetails create_build_pipeline_details: (required) - Details for the new BuildPipeline. + Details for the new build pipeline. :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 earlier 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. @@ -493,7 +501,7 @@ def create_build_pipeline(self, create_build_pipeline_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -530,6 +538,8 @@ def create_build_pipeline(self, create_build_pipeline_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -553,11 +563,11 @@ def create_build_pipeline(self, create_build_pipeline_details, **kwargs): def create_build_pipeline_stage(self, create_build_pipeline_stage_details, **kwargs): """ - Creates a new Stage. + Creates a new stage. :param oci.devops.models.CreateBuildPipelineStageDetails create_build_pipeline_stage_details: (required) - Details for the new Stage. + Details for the new stage. :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 earlier 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. @@ -568,7 +578,7 @@ def create_build_pipeline_stage(self, create_build_pipeline_stage_details, **kwa :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -605,6 +615,8 @@ def create_build_pipeline_stage(self, create_build_pipeline_stage_details, **kwa 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): @@ -628,11 +640,11 @@ def create_build_pipeline_stage(self, create_build_pipeline_stage_details, **kwa def create_build_run(self, create_build_run_details, **kwargs): """ - Starts a build pipeline run for a predefined build pipeline + Starts a build pipeline run for a predefined build pipeline. :param oci.devops.models.CreateBuildRunDetails create_build_run_details: (required) - Details the input parameters required to create a new build run. + Parameter details required to create a new build run. :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 earlier 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. @@ -646,7 +658,7 @@ def create_build_run(self, create_build_run_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -685,6 +697,8 @@ def create_build_run(self, create_build_run_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -708,11 +722,11 @@ def create_build_run(self, create_build_run_details, **kwargs): def create_connection(self, create_connection_details, **kwargs): """ - Creates a new Connection. + Creates a new connection. :param oci.devops.models.CreateConnectionDetails create_connection_details: (required) - Details for the new Connection. + Details for the new connection. :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 earlier 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. @@ -723,7 +737,7 @@ def create_connection(self, create_connection_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -760,6 +774,8 @@ def create_connection(self, create_connection_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -798,7 +814,7 @@ def create_deploy_artifact(self, create_deploy_artifact_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -835,6 +851,8 @@ def create_deploy_artifact(self, create_deploy_artifact_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -873,7 +891,7 @@ def create_deploy_environment(self, create_deploy_environment_details, **kwargs) :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -910,6 +928,8 @@ def create_deploy_environment(self, create_deploy_environment_details, **kwargs) operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -948,7 +968,7 @@ def create_deploy_pipeline(self, create_deploy_pipeline_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -985,6 +1005,8 @@ def create_deploy_pipeline(self, create_deploy_pipeline_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1023,7 +1045,7 @@ def create_deploy_stage(self, create_deploy_stage_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1060,6 +1082,8 @@ def create_deploy_stage(self, create_deploy_stage_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1098,7 +1122,7 @@ def create_deployment(self, create_deployment_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1135,6 +1159,8 @@ def create_deployment(self, create_deployment_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1173,7 +1199,7 @@ def create_project(self, create_project_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1210,6 +1236,8 @@ def create_project(self, create_project_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1233,11 +1261,11 @@ def create_project(self, create_project_details, **kwargs): def create_repository(self, create_repository_details, **kwargs): """ - Creates a new Repository. + Creates a new repository. :param oci.devops.models.CreateRepositoryDetails create_repository_details: (required) - Details for the new Repository. + Details for the new repository. :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 earlier 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. @@ -1248,7 +1276,7 @@ def create_repository(self, create_repository_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1285,6 +1313,8 @@ def create_repository(self, create_repository_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1308,11 +1338,11 @@ def create_repository(self, create_repository_details, **kwargs): def create_trigger(self, create_trigger_details, **kwargs): """ - Creates a new Trigger. + Creates a new trigger. :param oci.devops.models.CreateTriggerDetails create_trigger_details: (required) - Details for the new Trigger. + Details for the new trigger. :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 earlier 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. @@ -1323,7 +1353,7 @@ def create_trigger(self, create_trigger_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1360,6 +1390,8 @@ def create_trigger(self, create_trigger_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1383,11 +1415,11 @@ def create_trigger(self, create_trigger_details, **kwargs): def delete_build_pipeline(self, build_pipeline_id, **kwargs): """ - Deletes a BuildPipeline resource by identifier + Deletes a build pipeline resource by identifier. :param str build_pipeline_id: (required) - unique BuildPipeline identifier + Unique build pipeline 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. @@ -1398,7 +1430,7 @@ def delete_build_pipeline(self, build_pipeline_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1445,6 +1477,8 @@ def delete_build_pipeline(self, build_pipeline_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1465,7 +1499,7 @@ def delete_build_pipeline(self, build_pipeline_id, **kwargs): def delete_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): """ - Deletes a Stage based on stage id provided in request + Deletes a stage based on the stage ID provided in the request. :param str build_pipeline_stage_id: (required) @@ -1480,7 +1514,7 @@ def delete_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1527,6 +1561,8 @@ def delete_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1547,11 +1583,11 @@ def delete_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): def delete_connection(self, connection_id, **kwargs): """ - Deletes a Connection resource by identifier + Deletes a connection resource by identifier. :param str connection_id: (required) - unique Connection identifier + Unique connection 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. @@ -1562,7 +1598,7 @@ def delete_connection(self, connection_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1609,6 +1645,8 @@ def delete_connection(self, connection_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1644,7 +1682,7 @@ def delete_deploy_artifact(self, deploy_artifact_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1691,6 +1729,8 @@ def delete_deploy_artifact(self, deploy_artifact_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1726,7 +1766,7 @@ def delete_deploy_environment(self, deploy_environment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1773,6 +1813,8 @@ def delete_deploy_environment(self, deploy_environment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1808,7 +1850,7 @@ def delete_deploy_pipeline(self, deploy_pipeline_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1855,6 +1897,8 @@ def delete_deploy_pipeline(self, deploy_pipeline_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1890,7 +1934,7 @@ def delete_deploy_stage(self, deploy_stage_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1937,6 +1981,8 @@ def delete_deploy_stage(self, deploy_stage_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1972,7 +2018,7 @@ def delete_project(self, project_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2019,6 +2065,8 @@ def delete_project(self, project_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2043,10 +2091,10 @@ def delete_ref(self, repository_id, ref_name, **kwargs): :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (required) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :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. @@ -2060,7 +2108,7 @@ def delete_ref(self, repository_id, ref_name, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2110,6 +2158,8 @@ def delete_ref(self, repository_id, ref_name, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2131,11 +2181,11 @@ def delete_ref(self, repository_id, ref_name, **kwargs): def delete_repository(self, repository_id, **kwargs): """ - Deletes a Repository resource by identifier + Deletes a repository resource by identifier. :param str repository_id: (required) - unique Repository identifier. + Unique repository 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. @@ -2146,7 +2196,7 @@ def delete_repository(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2193,6 +2243,8 @@ def delete_repository(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2213,11 +2265,11 @@ def delete_repository(self, repository_id, **kwargs): def delete_trigger(self, trigger_id, **kwargs): """ - Deletes a Trigger resource by identifier + Deletes a trigger resource by identifier. :param str trigger_id: (required) - unique Trigger identifier + Unique trigger 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. @@ -2228,7 +2280,7 @@ def delete_trigger(self, trigger_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2275,6 +2327,8 @@ def delete_trigger(self, trigger_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2295,11 +2349,11 @@ def delete_trigger(self, trigger_id, **kwargs): def get_build_pipeline(self, build_pipeline_id, **kwargs): """ - Gets a BuildPipeline by identifier + Retrieves a build pipeline by identifier. :param str build_pipeline_id: (required) - unique BuildPipeline identifier + Unique build pipeline identifier. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -2307,7 +2361,7 @@ def get_build_pipeline(self, build_pipeline_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2352,6 +2406,8 @@ def get_build_pipeline(self, build_pipeline_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2374,7 +2430,7 @@ def get_build_pipeline(self, build_pipeline_id, **kwargs): def get_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): """ - Gets a Stage based on the stage id provided in request + Retrieves a stage based on the stage ID provided in the request. :param str build_pipeline_stage_id: (required) @@ -2386,7 +2442,7 @@ def get_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2431,6 +2487,8 @@ def get_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2453,7 +2511,7 @@ def get_build_pipeline_stage(self, build_pipeline_stage_id, **kwargs): def get_build_run(self, build_run_id, **kwargs): """ - Returns the details of a build exection for a given build run id. + Returns the details of a build run for a given build run ID. :param str build_run_id: (required) @@ -2465,7 +2523,7 @@ def get_build_run(self, build_run_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2510,6 +2568,8 @@ def get_build_run(self, build_run_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2532,14 +2592,14 @@ def get_build_run(self, build_run_id, **kwargs): def get_commit(self, repository_id, commit_id, **kwargs): """ - Gets a Repository's Commit by commitId + Retrieves a repository's commit by commit ID. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str commit_id: (required) - A filter to return only resources that match the given commit Id. + A filter to return only resources that match the given commit ID. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -2547,7 +2607,7 @@ def get_commit(self, repository_id, commit_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2593,6 +2653,8 @@ def get_commit(self, repository_id, commit_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2615,20 +2677,20 @@ def get_commit(self, repository_id, commit_id, **kwargs): def get_commit_diff(self, repository_id, target_version, **kwargs): """ - Compares two revisions for their differences. Supports comparison between two refs or commits. + Compares two revisions for their differences. Supports comparison between two references or commits. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str target_version: (required) - The commit or ref name where changes are coming from + The commit or reference name where changes are coming from. :param str base_version: (optional) - The commit or ref name to compare changes against. If baseVersion is not provided, the diff will be gone against an empty tree. + The commit or reference name to compare changes against. If base version is not provided, the difference goes against an empty tree. :param bool is_comparison_from_merge_base: (optional) - boolean for whether to use merge base or most recent revision + Boolean value to indicate whether to use merge base or most recent revision. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -2636,7 +2698,7 @@ def get_commit_diff(self, repository_id, target_version, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2690,6 +2752,8 @@ def get_commit_diff(self, repository_id, target_version, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2714,11 +2778,11 @@ def get_commit_diff(self, repository_id, target_version, **kwargs): def get_connection(self, connection_id, **kwargs): """ - Gets a Connection by identifier + Retrieves a connection by identifier. :param str connection_id: (required) - unique Connection identifier + Unique connection identifier. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -2726,7 +2790,7 @@ def get_connection(self, connection_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2771,6 +2835,8 @@ def get_connection(self, connection_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2805,7 +2871,7 @@ def get_deploy_artifact(self, deploy_artifact_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2850,6 +2916,8 @@ def get_deploy_artifact(self, deploy_artifact_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2884,7 +2952,7 @@ def get_deploy_environment(self, deploy_environment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -2929,6 +2997,8 @@ def get_deploy_environment(self, deploy_environment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -2963,7 +3033,7 @@ def get_deploy_pipeline(self, deploy_pipeline_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3008,6 +3078,8 @@ def get_deploy_pipeline(self, deploy_pipeline_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3042,7 +3114,7 @@ def get_deploy_stage(self, deploy_stage_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3087,6 +3159,8 @@ def get_deploy_stage(self, deploy_stage_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3121,7 +3195,7 @@ def get_deployment(self, deployment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3166,6 +3240,8 @@ def get_deployment(self, deployment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3192,19 +3268,19 @@ def get_file_diff(self, repository_id, file_path, base_version, target_version, :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str file_path: (required) Path to a file within a repository. :param str base_version: (required) - The branch to compare changes against + The branch to compare changes against. :param str target_version: (required) - The branch where changes are coming from + The branch where changes are coming from. :param bool is_comparison_from_merge_base: (optional) - boolean for whether to use merge base or most recent revision + Boolean to indicate whether to use merge base or most recent revision. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -3212,7 +3288,7 @@ def get_file_diff(self, repository_id, file_path, base_version, target_version, :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3266,6 +3342,8 @@ def get_file_diff(self, repository_id, file_path, base_version, target_version, 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): @@ -3290,16 +3368,16 @@ def get_file_diff(self, repository_id, file_path, base_version, target_version, def get_mirror_record(self, repository_id, mirror_record_type, **kwargs): """ - Returns either current mirror record or last successful mirror record for a specific mirror repository + Returns either current mirror record or last successful mirror record for a specific mirror repository. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str mirror_record_type: (required) - The field of mirror record type. Only one mirror record type may be provided. + The field of mirror record type. Only one mirror record type can be provided: current - The current mirror record. - lastSuccessful - The last successful mirror record + lastSuccessful - The last successful mirror record. Allowed values are: "current", "lastSuccessful" @@ -3309,7 +3387,7 @@ def get_mirror_record(self, repository_id, mirror_record_type, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3355,6 +3433,8 @@ def get_mirror_record(self, repository_id, mirror_record_type, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3377,17 +3457,17 @@ def get_mirror_record(self, repository_id, mirror_record_type, **kwargs): def get_object(self, repository_id, **kwargs): """ - Get blob of specific branch name/commit id and file path + Retrieves blob of specific branch name/commit ID and file path. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str file_path: (optional) A filter to return only commits that affect any of the specified paths. :param str ref_name: (optional) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -3395,7 +3475,7 @@ def get_object(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3448,6 +3528,8 @@ def get_object(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3472,14 +3554,14 @@ def get_object(self, repository_id, **kwargs): def get_object_content(self, repository_id, sha, **kwargs): """ - Get contents of a specified Object + Retrieve contents of a specified object. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str sha: (required) - The SHA of a blob or tree + The SHA of a blob or tree. :param str file_path: (optional) A filter to return only commits that affect any of the specified paths. @@ -3490,7 +3572,7 @@ def get_object_content(self, repository_id, sha, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3542,6 +3624,8 @@ def get_object_content(self, repository_id, sha, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3578,7 +3662,7 @@ def get_project(self, project_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3623,6 +3707,8 @@ def get_project(self, project_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3645,14 +3731,14 @@ def get_project(self, project_id, **kwargs): def get_ref(self, repository_id, ref_name, **kwargs): """ - Gets a Repository's Ref by its name with preference for branches over tags if the name is ambiguous. Can be disambiguated by using full names like \"heads/\" or \"tags/\". + Retrieves a repository's reference by its name with preference for branches over tags if the name is ambiguous. This can be disambiguated by using full names like \"heads/\" or \"tags/\". :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (required) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -3660,7 +3746,7 @@ def get_ref(self, repository_id, ref_name, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3706,6 +3792,8 @@ def get_ref(self, repository_id, ref_name, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3728,24 +3816,24 @@ def get_ref(self, repository_id, ref_name, **kwargs): def get_repository(self, repository_id, **kwargs): """ - Gets a Repository by identifier + Retrieves a repository by identifier. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. :param list[str] fields: (optional) - Fields param can contain multiple flags useful in deciding the API functionality + Fields parameter can contain multiple flags useful in deciding the API functionality. Allowed values are: "branchCount", "commitCount", "sizeInBytes" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3804,6 +3892,8 @@ def get_repository(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3828,17 +3918,17 @@ def get_repository(self, repository_id, **kwargs): def get_repository_archive_content(self, repository_id, **kwargs): """ - Return the archived repository information + Returns the archived repository information. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (optional) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param str format: (optional) - The archive format query parm for download repo endpoint. + The archive format query parameter for downloading repository endpoint. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -3846,7 +3936,7 @@ def get_repository_archive_content(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -3899,6 +3989,8 @@ def get_repository_archive_content(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3923,20 +4015,20 @@ def get_repository_archive_content(self, repository_id, **kwargs): def get_repository_file_lines(self, repository_id, file_path, revision, **kwargs): """ - Get lines of a specified file. Supports starting line number and limit. + Retrieve lines of a specified file. Supports starting line number and limit. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str file_path: (required) Path to a file within a repository. :param str revision: (required) - Retrive file lines from specific revision. + Retrieve file lines from specific revision. :param int start_line_number: (optional) - Line number from where to start returning file lines. 1 indexed. + Line number from where to start returning file lines. :param int limit: (optional) The maximum number of items to return. @@ -3947,7 +4039,7 @@ def get_repository_file_lines(self, repository_id, file_path, revision, **kwargs :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4002,6 +4094,8 @@ def get_repository_file_lines(self, repository_id, file_path, revision, **kwargs operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4026,11 +4120,11 @@ def get_repository_file_lines(self, repository_id, file_path, revision, **kwargs def get_trigger(self, trigger_id, **kwargs): """ - Gets a Trigger by identifier + Retrieves a trigger by identifier. :param str trigger_id: (required) - unique Trigger identifier + Unique trigger identifier. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. @@ -4038,7 +4132,7 @@ def get_trigger(self, trigger_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4083,6 +4177,8 @@ def get_trigger(self, trigger_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4117,7 +4213,7 @@ def get_work_request(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4162,6 +4258,8 @@ def get_work_request(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4184,14 +4282,14 @@ def get_work_request(self, work_request_id, **kwargs): def list_authors(self, repository_id, **kwargs): """ - Get a list of all the authors + Retrieve a list of all the authors. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (optional) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param int limit: (optional) The maximum number of items to return. @@ -4210,7 +4308,7 @@ def list_authors(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4274,6 +4372,8 @@ def list_authors(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4298,20 +4398,20 @@ def list_authors(self, repository_id, **kwargs): def list_build_pipeline_stages(self, **kwargs): """ - Returns summary of list of all Stages in a compartment or buildPipeline + Returns a list of all stages in a compartment or build pipeline. :param str id: (optional) Unique identifier or OCID for listing a single resource by ID. :param str build_pipeline_id: (optional) - The ID of the parent build pipeline. + The OCID of the parent build pipeline. :param str compartment_id: (optional) The OCID of the compartment in which to list resources. :param str lifecycle_state: (optional) - A filter to return the stages that match with the given lifecycleState. + A filter to return the stages that matches the given lifecycle state. Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" @@ -4340,7 +4440,7 @@ def list_build_pipeline_stages(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4418,6 +4518,8 @@ def list_build_pipeline_stages(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4440,7 +4542,7 @@ def list_build_pipeline_stages(self, **kwargs): def list_build_pipelines(self, **kwargs): """ - Returns a list of BuildPipelines. + Returns a list of build pipelines. :param str id: (optional) @@ -4453,7 +4555,7 @@ def list_build_pipelines(self, **kwargs): The OCID of the compartment in which to list resources. :param str lifecycle_state: (optional) - A filter to return only BuildPipelines that matches the given lifecycleState + A filter to return only build pipelines that matches the given lifecycle state. Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" @@ -4482,7 +4584,7 @@ def list_build_pipelines(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4560,6 +4662,8 @@ def list_build_pipelines(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4582,7 +4686,7 @@ def list_build_pipelines(self, **kwargs): def list_build_runs(self, **kwargs): """ - Returns a list of build runs summary. + Returns a list of build run summary. :param str id: (optional) @@ -4601,7 +4705,7 @@ def list_build_runs(self, **kwargs): A filter to return only resources that match the entire display name given. :param str lifecycle_state: (optional) - A filter to return only Build Runs that matches the given lifecycleState. + A filter to return only build runs that matches the given lifecycle state. Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" @@ -4627,7 +4731,7 @@ def list_build_runs(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4707,6 +4811,8 @@ def list_build_runs(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4729,20 +4835,20 @@ def list_build_runs(self, **kwargs): def list_commit_diffs(self, repository_id, base_version, target_version, **kwargs): """ - Compares two revisions and lists the differences. Supports comparison between two refs or commits. + Compares two revisions and lists the differences. Supports comparison between two references or commits. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str base_version: (required) - The commit or ref name to compare changes against + The commit or reference name to compare changes against. :param str target_version: (required) - The commit or ref name where changes are coming from + The commit or reference name where changes are coming from. :param bool is_comparison_from_merge_base: (optional) - boolean for whether to use merge base or most recent revision + Boolean value to indicate whether to use merge base or most recent revision. :param int limit: (optional) The maximum number of items to return. @@ -4756,7 +4862,7 @@ def list_commit_diffs(self, repository_id, base_version, target_version, **kwarg :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4813,6 +4919,8 @@ def list_commit_diffs(self, repository_id, base_version, target_version, **kwarg 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): @@ -4837,17 +4945,17 @@ def list_commit_diffs(self, repository_id, base_version, target_version, **kwarg def list_commits(self, repository_id, **kwargs): """ - Returns a list of Commits. + Returns a list of commits. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (optional) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param str exclude_ref_name: (optional) - A filter to exclude commits that match the given Ref name. + A filter to exclude commits that match the given reference name. :param str file_path: (optional) A filter to return only commits that affect any of the specified paths. @@ -4876,7 +4984,7 @@ def list_commits(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -4943,6 +5051,8 @@ def list_commits(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4967,7 +5077,7 @@ def list_commits(self, repository_id, **kwargs): def list_connections(self, **kwargs): """ - Returns a list of Connections. + Returns a list of connections. :param str id: (optional) @@ -4980,7 +5090,7 @@ def list_connections(self, **kwargs): The OCID of the compartment in which to list resources. :param str lifecycle_state: (optional) - A filter to return only Connections that matches the given lifecycleState + A filter to return only connections that matches the given lifecycle state. Allowed values are: "ACTIVE" @@ -4988,7 +5098,7 @@ def list_connections(self, **kwargs): A filter to return only resources that match the entire display name given. :param str connection_type: (optional) - A filter to return only resources that match the connection type given. + A filter to return only resources that match the given connection type. Allowed values are: "GITHUB_ACCESS_TOKEN", "GITLAB_ACCESS_TOKEN" @@ -5014,7 +5124,7 @@ def list_connections(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5101,6 +5211,8 @@ def list_connections(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5165,7 +5277,7 @@ def list_deploy_artifacts(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5243,6 +5355,8 @@ def list_deploy_artifacts(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5307,7 +5421,7 @@ def list_deploy_environments(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5385,6 +5499,8 @@ def list_deploy_environments(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5449,7 +5565,7 @@ def list_deploy_pipelines(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5527,6 +5643,8 @@ def list_deploy_pipelines(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5591,7 +5709,7 @@ def list_deploy_stages(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5669,6 +5787,8 @@ def list_deploy_stages(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5746,7 +5866,7 @@ def list_deployments(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5830,6 +5950,8 @@ def list_deployments(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5852,11 +5974,11 @@ def list_deployments(self, **kwargs): def list_mirror_records(self, repository_id, **kwargs): """ - Returns a list of mirror entry in history within 30 days + Returns a list of mirror entry in history within 30 days. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param int limit: (optional) The maximum number of items to return. @@ -5875,7 +5997,7 @@ def list_mirror_records(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5937,6 +6059,8 @@ def list_mirror_records(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5961,18 +6085,18 @@ def list_mirror_records(self, repository_id, **kwargs): def list_paths(self, repository_id, **kwargs): """ - Fetches a list of files and directories in a repository. + Retrieves a list of files and directories in a repository. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref: (optional) - The name of branch/tag or commit hash it points to. If names conflict order of preference is commit > branch > tag. - You can disambiguate with \"heads/foobar\" and \"tags/foobar\". Repository's default branch will be used if left blank. + The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag. + You can disambiguate with \"heads/foobar\" and \"tags/foobar\". If left blank repository's default branch will be used. :param bool paths_in_subtree: (optional) - Flag to determine if files should be retrived recursively. false by default + Flag to determine if files must be retrived recursively. Flag is False by default. :param str folder_path: (optional) The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. @@ -6002,7 +6126,7 @@ def list_paths(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6081,6 +6205,8 @@ def list_paths(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6144,7 +6270,7 @@ def list_projects(self, compartment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6219,6 +6345,8 @@ def list_projects(self, compartment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6241,19 +6369,19 @@ def list_projects(self, compartment_id, **kwargs): def list_refs(self, repository_id, **kwargs): """ - Returns a list of Refs. + Returns a list of references. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_type: (optional) - Ref type to distinguish between branch and tag. If it is not specified, return all refs. + Reference type to distinguish between branch and tag. If it is not specified, all references are returned. Allowed values are: "BRANCH", "TAG" :param str commit_id: (optional) - Commit id in a repository + Commit ID in a repository. :param int limit: (optional) The maximum number of items to return. @@ -6262,7 +6390,7 @@ def list_refs(self, repository_id, **kwargs): The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param str ref_name: (optional) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param str sort_order: (optional) The sort order to use. Use either ascending or descending. @@ -6270,7 +6398,7 @@ def list_refs(self, repository_id, **kwargs): 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 refName is ascending. Default order for refType is ascending. If no value is specified refName is default. + The field to sort by. Only one sort order may be provided. Default order for reference name is ascending. Default order for reference type is ascending. If no value is specified reference name is default. Allowed values are: "refType", "refName" @@ -6280,7 +6408,7 @@ def list_refs(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6364,6 +6492,8 @@ def list_refs(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6388,7 +6518,7 @@ def list_refs(self, repository_id, **kwargs): def list_repositories(self, **kwargs): """ - Returns a list of Repositories given a compartmentId or a projectId. + Returns a list of repositories given a compartment ID or a project ID. :param str compartment_id: (optional) @@ -6398,10 +6528,10 @@ def list_repositories(self, **kwargs): unique project identifier :param str repository_id: (optional) - unique Repository identifier. + Unique repository identifier. :param str lifecycle_state: (optional) - A filter to return only resources their lifecycleState matches the given lifecycleState. + A filter to return only resources whose lifecycle state matches the given lifecycle state. Allowed values are: "ACTIVE", "CREATING", "DELETED" @@ -6420,7 +6550,7 @@ def list_repositories(self, **kwargs): 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 name is ascending. If no value is specified timeCreated is default. + The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for name is ascending. If no value is specified time created is default. Allowed values are: "timeCreated", "name" @@ -6430,7 +6560,7 @@ def list_repositories(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6508,6 +6638,8 @@ def list_repositories(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6530,7 +6662,7 @@ def list_repositories(self, **kwargs): def list_triggers(self, **kwargs): """ - Returns a list of Triggers. + Returns a list of triggers. :param str compartment_id: (optional) @@ -6540,7 +6672,7 @@ def list_triggers(self, **kwargs): unique project identifier :param str lifecycle_state: (optional) - A filter to return only Triggers that matches the given lifecycleState + A filter to return only triggers that matches the given lifecycle state. Allowed values are: "ACTIVE" @@ -6548,7 +6680,7 @@ def list_triggers(self, **kwargs): A filter to return only resources that match the entire display name given. :param str id: (optional) - unique Trigger identifier + Unique trigger identifier. :param int limit: (optional) The maximum number of items to return. @@ -6572,7 +6704,7 @@ def list_triggers(self, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6650,6 +6782,8 @@ def list_triggers(self, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6700,7 +6834,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6771,6 +6905,8 @@ def list_work_request_errors(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6823,7 +6959,7 @@ def list_work_request_logs(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -6894,6 +7030,8 @@ def list_work_request_logs(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -6957,7 +7095,7 @@ def list_work_requests(self, compartment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7032,6 +7170,8 @@ def list_work_requests(self, compartment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7054,11 +7194,11 @@ def list_work_requests(self, compartment_id, **kwargs): def mirror_repository(self, repository_id, **kwargs): """ - Synchronize a mirrored repository to the latest version from external providers + Synchronize a mirrored repository to the latest version from external providers. :param str repository_id: (required) - unique Repository identifier. + Unique repository 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. @@ -7069,7 +7209,7 @@ def mirror_repository(self, repository_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7116,6 +7256,8 @@ def mirror_repository(self, repository_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7136,17 +7278,17 @@ def mirror_repository(self, repository_id, **kwargs): def put_repository_ref(self, repository_id, ref_name, put_repository_ref_details, **kwargs): """ - Creates a new Ref or updates an existing one. + Creates a new reference or updates an existing one. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (required) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param oci.devops.models.PutRepositoryRefDetails put_repository_ref_details: (required) - The information to create a Ref with the type specified in the query + The information to create a reference with the type specified in the query. :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. @@ -7160,7 +7302,7 @@ def put_repository_ref(self, repository_id, ref_name, put_repository_ref_details :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7210,6 +7352,8 @@ def put_repository_ref(self, repository_id, ref_name, put_repository_ref_details operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7235,11 +7379,11 @@ def put_repository_ref(self, repository_id, ref_name, put_repository_ref_details def update_build_pipeline(self, build_pipeline_id, update_build_pipeline_details, **kwargs): """ - Updates the BuildPipeline + Updates the build pipeline. :param str build_pipeline_id: (required) - unique BuildPipeline identifier + Unique build pipeline identifier. :param oci.devops.models.UpdateBuildPipelineDetails update_build_pipeline_details: (required) The information to be updated. @@ -7253,7 +7397,7 @@ def update_build_pipeline(self, build_pipeline_id, update_build_pipeline_details :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7300,6 +7444,8 @@ def update_build_pipeline(self, build_pipeline_id, update_build_pipeline_details operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7324,7 +7470,7 @@ def update_build_pipeline(self, build_pipeline_id, update_build_pipeline_details def update_build_pipeline_stage(self, build_pipeline_stage_id, update_build_pipeline_stage_details, **kwargs): """ - Updates the Stage based on the stage id provided in request + Updates the stage based on the stage ID provided in the request. :param str build_pipeline_stage_id: (required) @@ -7342,7 +7488,7 @@ def update_build_pipeline_stage(self, build_pipeline_stage_id, update_build_pipe :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7389,6 +7535,8 @@ def update_build_pipeline_stage(self, build_pipeline_stage_id, update_build_pipe 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): @@ -7413,7 +7561,7 @@ def update_build_pipeline_stage(self, build_pipeline_stage_id, update_build_pipe def update_build_run(self, build_run_id, update_build_run_details, **kwargs): """ - Updates the BuildRun + Updates the build run. :param str build_run_id: (required) @@ -7431,7 +7579,7 @@ def update_build_run(self, build_run_id, update_build_run_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7478,6 +7626,8 @@ def update_build_run(self, build_run_id, update_build_run_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7502,11 +7652,11 @@ def update_build_run(self, build_run_id, update_build_run_details, **kwargs): def update_connection(self, connection_id, update_connection_details, **kwargs): """ - Updates the Connection + Updates the connection. :param str connection_id: (required) - unique Connection identifier + Unique connection identifier. :param oci.devops.models.UpdateConnectionDetails update_connection_details: (required) The information to be updated. @@ -7520,7 +7670,7 @@ def update_connection(self, connection_id, update_connection_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7567,6 +7717,8 @@ def update_connection(self, connection_id, update_connection_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7609,7 +7761,7 @@ def update_deploy_artifact(self, deploy_artifact_id, update_deploy_artifact_deta :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7656,6 +7808,8 @@ def update_deploy_artifact(self, deploy_artifact_id, update_deploy_artifact_deta operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7698,7 +7852,7 @@ def update_deploy_environment(self, deploy_environment_id, update_deploy_environ :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7745,6 +7899,8 @@ def update_deploy_environment(self, deploy_environment_id, update_deploy_environ 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): @@ -7787,7 +7943,7 @@ def update_deploy_pipeline(self, deploy_pipeline_id, update_deploy_pipeline_deta :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7834,6 +7990,8 @@ def update_deploy_pipeline(self, deploy_pipeline_id, update_deploy_pipeline_deta operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -7876,7 +8034,7 @@ def update_deploy_stage(self, deploy_stage_id, update_deploy_stage_details, **kw :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -7923,6 +8081,8 @@ def update_deploy_stage(self, deploy_stage_id, update_deploy_stage_details, **kw 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): @@ -7965,7 +8125,7 @@ def update_deployment(self, deployment_id, update_deployment_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -8012,6 +8172,8 @@ def update_deployment(self, deployment_id, update_deployment_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -8054,7 +8216,7 @@ def update_project(self, project_id, update_project_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -8101,6 +8263,8 @@ def update_project(self, project_id, update_project_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -8125,11 +8289,11 @@ def update_project(self, project_id, update_project_details, **kwargs): def update_repository(self, repository_id, update_repository_details, **kwargs): """ - Updates the Repository + Updates the repository. :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param oci.devops.models.UpdateRepositoryDetails update_repository_details: (required) The information to be updated. @@ -8143,7 +8307,7 @@ def update_repository(self, repository_id, update_repository_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -8190,6 +8354,8 @@ def update_repository(self, repository_id, update_repository_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -8214,11 +8380,11 @@ def update_repository(self, repository_id, update_repository_details, **kwargs): def update_trigger(self, trigger_id, update_trigger_details, **kwargs): """ - Updates the Trigger + Updates the trigger. :param str trigger_id: (required) - unique Trigger identifier + Unique trigger identifier. :param oci.devops.models.UpdateTriggerDetails update_trigger_details: (required) The information to be updated. @@ -8232,7 +8398,7 @@ def update_trigger(self, trigger_id, update_trigger_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -8279,6 +8445,8 @@ def update_trigger(self, trigger_id, update_trigger_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): diff --git a/src/oci/devops/devops_client_composite_operations.py b/src/oci/devops/devops_client_composite_operations.py index 34bb911331..915721946e 100644 --- a/src/oci/devops/devops_client_composite_operations.py +++ b/src/oci/devops/devops_client_composite_operations.py @@ -70,7 +70,7 @@ def cancel_build_run_and_wait_for_state(self, cancel_build_run_details, build_ru to enter the given state(s). :param oci.devops.models.CancelBuildRunDetails cancel_build_run_details: (required) - Details the input parameters required to cancel a build run. + Parameter details required to cancel a build run. :param str build_run_id: (required) Unique build run identifier. @@ -193,7 +193,7 @@ def create_build_pipeline_and_wait_for_state(self, create_build_pipeline_details to enter the given state(s). :param oci.devops.models.CreateBuildPipelineDetails create_build_pipeline_details: (required) - Details for the new BuildPipeline. + Details for the new build pipeline. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -231,7 +231,7 @@ def create_build_pipeline_stage_and_wait_for_state(self, create_build_pipeline_s to enter the given state(s). :param oci.devops.models.CreateBuildPipelineStageDetails create_build_pipeline_stage_details: (required) - Details for the new Stage. + Details for the new stage. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -269,7 +269,7 @@ def create_build_run_and_wait_for_state(self, create_build_run_details, wait_for to enter the given state(s). :param oci.devops.models.CreateBuildRunDetails create_build_run_details: (required) - Details the input parameters required to create a new build run. + Parameter details required to create a new build run. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.BuildRun.lifecycle_state` @@ -307,7 +307,7 @@ def create_connection_and_wait_for_state(self, create_connection_details, wait_f to enter the given state(s). :param oci.devops.models.CreateConnectionDetails create_connection_details: (required) - Details for the new Connection. + Details for the new connection. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -573,7 +573,7 @@ def create_repository_and_wait_for_state(self, create_repository_details, wait_f to enter the given state(s). :param oci.devops.models.CreateRepositoryDetails create_repository_details: (required) - Details for the new Repository. + Details for the new repository. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -611,7 +611,7 @@ def create_trigger_and_wait_for_state(self, create_trigger_details, wait_for_sta to enter the given state(s). :param oci.devops.models.CreateTriggerDetails create_trigger_details: (required) - Details for the new Trigger. + Details for the new trigger. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -649,7 +649,7 @@ def delete_build_pipeline_and_wait_for_state(self, build_pipeline_id, wait_for_s to enter the given state(s). :param str build_pipeline_id: (required) - unique BuildPipeline identifier + Unique build pipeline identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -741,7 +741,7 @@ def delete_connection_and_wait_for_state(self, connection_id, wait_for_states=[] to enter the given state(s). :param str connection_id: (required) - unique Connection identifier + Unique connection identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1017,10 +1017,10 @@ def delete_ref_and_wait_for_state(self, repository_id, ref_name, wait_for_states to enter the given state(s). :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (required) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1066,7 +1066,7 @@ def delete_repository_and_wait_for_state(self, repository_id, wait_for_states=[] to enter the given state(s). :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1112,7 +1112,7 @@ def delete_trigger_and_wait_for_state(self, trigger_id, wait_for_states=[], oper to enter the given state(s). :param str trigger_id: (required) - unique Trigger identifier + Unique trigger identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1158,7 +1158,7 @@ def mirror_repository_and_wait_for_state(self, repository_id, wait_for_states=[] to enter the given state(s). :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1196,13 +1196,13 @@ def put_repository_ref_and_wait_for_state(self, repository_id, ref_name, put_rep to enter the given state(s). :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param str ref_name: (required) - A filter to return only resources that match the given Ref name. + A filter to return only resources that match the given reference name. :param oci.devops.models.PutRepositoryRefDetails put_repository_ref_details: (required) - The information to create a Ref with the type specified in the query + The information to create a reference with the type specified in the query. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.devops.models.WorkRequest.status` @@ -1240,7 +1240,7 @@ def update_build_pipeline_and_wait_for_state(self, build_pipeline_id, update_bui to enter the given state(s). :param str build_pipeline_id: (required) - unique BuildPipeline identifier + Unique build pipeline identifier. :param oci.devops.models.UpdateBuildPipelineDetails update_build_pipeline_details: (required) The information to be updated. @@ -1363,7 +1363,7 @@ def update_connection_and_wait_for_state(self, connection_id, update_connection_ to enter the given state(s). :param str connection_id: (required) - unique Connection identifier + Unique connection identifier. :param oci.devops.models.UpdateConnectionDetails update_connection_details: (required) The information to be updated. @@ -1650,7 +1650,7 @@ def update_repository_and_wait_for_state(self, repository_id, update_repository_ to enter the given state(s). :param str repository_id: (required) - unique Repository identifier. + Unique repository identifier. :param oci.devops.models.UpdateRepositoryDetails update_repository_details: (required) The information to be updated. @@ -1691,7 +1691,7 @@ def update_trigger_and_wait_for_state(self, trigger_id, update_trigger_details, to enter the given state(s). :param str trigger_id: (required) - unique Trigger identifier + Unique trigger identifier. :param oci.devops.models.UpdateTriggerDetails update_trigger_details: (required) The information to be updated. diff --git a/src/oci/devops/models/build_outputs.py b/src/oci/devops/models/build_outputs.py index 5ccfd04745..f2a0dadcf5 100644 --- a/src/oci/devops/models/build_outputs.py +++ b/src/oci/devops/models/build_outputs.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildOutputs(object): """ - Outputs from the Build + Outputs from the build. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/build_pipeline.py b/src/oci/devops/models/build_pipeline.py index a19d261a9c..6b0ed7f800 100644 --- a/src/oci/devops/models/build_pipeline.py +++ b/src/oci/devops/models/build_pipeline.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipeline(object): """ - A set of stages whose predecessor relation forms a directed acyclic graph. + A set of stages forming a directed acyclic graph that defines the build process. """ #: A constant which can be used with the lifecycle_state property of a BuildPipeline. @@ -151,7 +151,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this BuildPipeline. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildPipeline. @@ -163,7 +163,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildPipeline. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildPipeline. @@ -175,7 +175,7 @@ def id(self, id): def description(self): """ Gets the description of this BuildPipeline. - Optional description about the BuildPipeline + Optional description about the build pipeline. :return: The description of this BuildPipeline. @@ -187,7 +187,7 @@ def description(self): def description(self, description): """ Sets the description of this BuildPipeline. - Optional description about the BuildPipeline + Optional description about the build pipeline. :param description: The description of this BuildPipeline. @@ -199,7 +199,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this BuildPipeline. - BuildPipeline identifier which can be renamed and is not necessarily unique + Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildPipeline. @@ -211,7 +211,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildPipeline. - BuildPipeline identifier which can be renamed and is not necessarily unique + Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildPipeline. @@ -223,7 +223,7 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BuildPipeline. - Compartment Identifier + The OCID of the compartment where the build pipeline is created. :return: The compartment_id of this BuildPipeline. @@ -235,7 +235,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildPipeline. - Compartment Identifier + The OCID of the compartment where the build pipeline is created. :param compartment_id: The compartment_id of this BuildPipeline. @@ -247,7 +247,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ **[Required]** Gets the project_id of this BuildPipeline. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildPipeline. @@ -259,7 +259,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildPipeline. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildPipeline. @@ -271,7 +271,9 @@ def project_id(self, project_id): def time_created(self): """ Gets the time_created of this BuildPipeline. - The time the BuildPipeline was created. An RFC3339 formatted datetime string + The time the build pipeline was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildPipeline. @@ -283,7 +285,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildPipeline. - The time the BuildPipeline was created. An RFC3339 formatted datetime string + The time the build pipeline was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildPipeline. @@ -295,7 +299,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildPipeline. - The time at which the BuildPipeline was updated. An RFC3339 formatted datetime string + The time the build pipeline was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildPipeline. @@ -307,7 +313,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildPipeline. - The time at which the BuildPipeline was updated. An RFC3339 formatted datetime string + The time the build pipeline was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildPipeline. @@ -319,7 +327,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildPipeline. - The current state of the BuildPipeline. + The current state of the build pipeline. 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'. @@ -334,7 +342,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildPipeline. - The current state of the BuildPipeline. + The current state of the build pipeline. :param lifecycle_state: The lifecycle_state of this BuildPipeline. diff --git a/src/oci/devops/models/build_pipeline_collection.py b/src/oci/devops/models/build_pipeline_collection.py index 588038f229..6c22bede3b 100644 --- a/src/oci/devops/models/build_pipeline_collection.py +++ b/src/oci/devops/models/build_pipeline_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineCollection(object): """ - Results of an pipeline search. + Results of a pipeline search. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildPipelineCollection. - Array of BuildPipelineSummary items. + Array of build pipeline summary items. :return: The items of this BuildPipelineCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildPipelineCollection. - Array of BuildPipelineSummary items. + Array of build pipeline summary items. :param items: The items of this BuildPipelineCollection. diff --git a/src/oci/devops/models/build_pipeline_parameter.py b/src/oci/devops/models/build_pipeline_parameter.py index 6ad009aba3..f01acc44e1 100644 --- a/src/oci/devops/models/build_pipeline_parameter.py +++ b/src/oci/devops/models/build_pipeline_parameter.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineParameter(object): """ - Parameter name for which the values will be supplied at the time of BuildRun. + Parameter name for which the values will be supplied at the time of running the build. """ def __init__(self, **kwargs): @@ -51,8 +51,8 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this BuildPipelineParameter. - Name of the parameter (Case-sensitive). - Example: 'Pipeline_param' is not same as 'pipeline_Param' + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. + Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' :return: The name of this BuildPipelineParameter. @@ -64,8 +64,8 @@ def name(self): def name(self, name): """ Sets the name of this BuildPipelineParameter. - Name of the parameter (Case-sensitive). - Example: 'Pipeline_param' is not same as 'pipeline_Param' + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. + Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' :param name: The name of this BuildPipelineParameter. @@ -77,7 +77,7 @@ def name(self, name): def default_value(self): """ Gets the default_value of this BuildPipelineParameter. - Default value of the parameter + Default value of the parameter. :return: The default_value of this BuildPipelineParameter. @@ -89,7 +89,7 @@ def default_value(self): def default_value(self, default_value): """ Sets the default_value of this BuildPipelineParameter. - Default value of the parameter + Default value of the parameter. :param default_value: The default_value of this BuildPipelineParameter. @@ -101,7 +101,7 @@ def default_value(self, default_value): def description(self): """ Gets the description of this BuildPipelineParameter. - Description of the parameter + Description of the parameter. :return: The description of this BuildPipelineParameter. @@ -113,7 +113,7 @@ def description(self): def description(self, description): """ Sets the description of this BuildPipelineParameter. - Description of the parameter + Description of the parameter. :param description: The description of this BuildPipelineParameter. diff --git a/src/oci/devops/models/build_pipeline_parameter_collection.py b/src/oci/devops/models/build_pipeline_parameter_collection.py index bb66760f5d..5f5687402f 100644 --- a/src/oci/devops/models/build_pipeline_parameter_collection.py +++ b/src/oci/devops/models/build_pipeline_parameter_collection.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class BuildPipelineParameterCollection(object): """ - Specifies list of parameters present in BuildPipeline. - In case of UPDATE operation, replaces existing parameters list. Merging with existing parameters is not supported. + Specifies list of parameters present in a build pipeline. + An UPDATE operation replaces the existing parameters list entirely. """ def __init__(self, **kwargs): @@ -38,7 +38,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildPipelineParameterCollection. - List of Parameters defined for a BuildPipeline. + List of parameters defined for a build pipeline. :return: The items of this BuildPipelineParameterCollection. @@ -50,7 +50,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildPipelineParameterCollection. - List of Parameters defined for a BuildPipeline. + List of parameters defined for a build pipeline. :param items: The items of this BuildPipelineParameterCollection. diff --git a/src/oci/devops/models/build_pipeline_stage.py b/src/oci/devops/models/build_pipeline_stage.py index 2ccb4fd182..0cecfa583f 100644 --- a/src/oci/devops/models/build_pipeline_stage.py +++ b/src/oci/devops/models/build_pipeline_stage.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class BuildPipelineStage(object): """ - A single step in a BuildPipeline. A stage takes a specific designated action. There are - many types of stages. For eg. `Build` stage, `Deliver Artifact` Stage. + A single node in a build pipeline. A stage takes a specific designated action. + There are many types of stages such as 'Build' and 'Deliver Artifacts'. """ #: A constant which can be used with the build_pipeline_stage_type property of a BuildPipelineStage. @@ -209,7 +209,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this BuildPipelineStage. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildPipelineStage. @@ -221,7 +221,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildPipelineStage. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildPipelineStage. @@ -233,7 +233,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this BuildPipelineStage. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildPipelineStage. @@ -245,7 +245,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildPipelineStage. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildPipelineStage. @@ -257,7 +257,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this BuildPipelineStage. - Optional description about the BuildStage + Optional description about the build stage. :return: The description of this BuildPipelineStage. @@ -269,7 +269,7 @@ def description(self): def description(self, description): """ Sets the description of this BuildPipelineStage. - Optional description about the BuildStage + Optional description about the build stage. :param description: The description of this BuildPipelineStage. @@ -281,7 +281,7 @@ def description(self, description): def project_id(self): """ **[Required]** Gets the project_id of this BuildPipelineStage. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildPipelineStage. @@ -293,7 +293,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildPipelineStage. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildPipelineStage. @@ -305,7 +305,7 @@ def project_id(self, project_id): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this BuildPipelineStage. - Build Pipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this BuildPipelineStage. @@ -317,7 +317,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this BuildPipelineStage. - Build Pipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this BuildPipelineStage. @@ -329,7 +329,7 @@ def build_pipeline_id(self, build_pipeline_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BuildPipelineStage. - Compartment Identifier + The OCID of the compartment where the pipeline is created. :return: The compartment_id of this BuildPipelineStage. @@ -341,7 +341,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildPipelineStage. - Compartment Identifier + The OCID of the compartment where the pipeline is created. :param compartment_id: The compartment_id of this BuildPipelineStage. @@ -353,8 +353,7 @@ def compartment_id(self, compartment_id): def build_pipeline_stage_type(self): """ **[Required]** Gets the build_pipeline_stage_type of this BuildPipelineStage. - List of stage types. It includes 'Wait stage', 'Build Stage', 'Deliver Artifact Stage' - and 'Trigger Deployment Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. Allowed values for this property are: "WAIT", "BUILD", "DELIVER_ARTIFACT", "TRIGGER_DEPLOYMENT_PIPELINE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -369,8 +368,7 @@ def build_pipeline_stage_type(self): def build_pipeline_stage_type(self, build_pipeline_stage_type): """ Sets the build_pipeline_stage_type of this BuildPipelineStage. - List of stage types. It includes 'Wait stage', 'Build Stage', 'Deliver Artifact Stage' - and 'Trigger Deployment Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. :param build_pipeline_stage_type: The build_pipeline_stage_type of this BuildPipelineStage. @@ -385,7 +383,9 @@ def build_pipeline_stage_type(self, build_pipeline_stage_type): def time_created(self): """ Gets the time_created of this BuildPipelineStage. - The time at which the Stage was created. An RFC3339 formatted datetime string + The time the stage was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildPipelineStage. @@ -397,7 +397,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildPipelineStage. - The time at which the Stage was created. An RFC3339 formatted datetime string + The time the stage was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildPipelineStage. @@ -409,7 +411,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildPipelineStage. - The time at which the Stage was updated. An RFC3339 formatted datetime string + The time the stage was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildPipelineStage. @@ -421,7 +425,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildPipelineStage. - The time at which the Stage was updated. An RFC3339 formatted datetime string + The time the stage was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildPipelineStage. @@ -433,7 +439,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildPipelineStage. - The current state of the Stage. + The current state of the stage. 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'. @@ -448,7 +454,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildPipelineStage. - The current state of the Stage. + The current state of the stage. :param lifecycle_state: The lifecycle_state of this BuildPipelineStage. diff --git a/src/oci/devops/models/build_pipeline_stage_collection.py b/src/oci/devops/models/build_pipeline_stage_collection.py index c97427c155..c6c247b767 100644 --- a/src/oci/devops/models/build_pipeline_stage_collection.py +++ b/src/oci/devops/models/build_pipeline_stage_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineStageCollection(object): """ - Result of a stages search. + Result of a stage search. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildPipelineStageCollection. - Summary of list of stages found for the search + Summary of the list of stages found for the search. :return: The items of this BuildPipelineStageCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildPipelineStageCollection. - Summary of list of stages found for the search + Summary of the list of stages found for the search. :param items: The items of this BuildPipelineStageCollection. diff --git a/src/oci/devops/models/build_pipeline_stage_predecessor.py b/src/oci/devops/models/build_pipeline_stage_predecessor.py index a99a5732ed..47779d6c1d 100644 --- a/src/oci/devops/models/build_pipeline_stage_predecessor.py +++ b/src/oci/devops/models/build_pipeline_stage_predecessor.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this BuildPipelineStagePredecessor. - The id of the predecessor stage. If a stages is the first stage in the pipeline, then the id is the pipeline's id. + The ID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's ID. :return: The id of this BuildPipelineStagePredecessor. @@ -49,7 +49,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildPipelineStagePredecessor. - The id of the predecessor stage. If a stages is the first stage in the pipeline, then the id is the pipeline's id. + The ID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's ID. :param id: The id of this BuildPipelineStagePredecessor. diff --git a/src/oci/devops/models/build_pipeline_stage_predecessor_collection.py b/src/oci/devops/models/build_pipeline_stage_predecessor_collection.py index 32f9b360fd..2f392da124 100644 --- a/src/oci/devops/models/build_pipeline_stage_predecessor_collection.py +++ b/src/oci/devops/models/build_pipeline_stage_predecessor_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineStagePredecessorCollection(object): """ - The containing collection for the predecessors of a Stage. + The collection containing the predecessors of a stage. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildPipelineStagePredecessorCollection. - A list of BuildPipelineStagePredecessors for a stage. + A list of build pipeline stage predecessors for a stage. :return: The items of this BuildPipelineStagePredecessorCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildPipelineStagePredecessorCollection. - A list of BuildPipelineStagePredecessors for a stage. + A list of build pipeline stage predecessors for a stage. :param items: The items of this BuildPipelineStagePredecessorCollection. diff --git a/src/oci/devops/models/build_pipeline_stage_run_progress.py b/src/oci/devops/models/build_pipeline_stage_run_progress.py index dc86cc8cc0..70dfa336e0 100644 --- a/src/oci/devops/models/build_pipeline_stage_run_progress.py +++ b/src/oci/devops/models/build_pipeline_stage_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineStageRunProgress(object): """ - The details about the run progress of a Stage in a BuildRun. + The details about the run progress of a stage in a build run. """ #: A constant which can be used with the status property of a BuildPipelineStageRunProgress. @@ -134,7 +134,7 @@ def get_subtype(object_dictionary): def stage_display_name(self): """ Gets the stage_display_name of this BuildPipelineStageRunProgress. - BuildRun identifier which can be renamed and is not necessarily unique + Build Run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The stage_display_name of this BuildPipelineStageRunProgress. @@ -146,7 +146,7 @@ def stage_display_name(self): def stage_display_name(self, stage_display_name): """ Sets the stage_display_name of this BuildPipelineStageRunProgress. - BuildRun identifier which can be renamed and is not necessarily unique + Build Run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param stage_display_name: The stage_display_name of this BuildPipelineStageRunProgress. @@ -158,7 +158,7 @@ def stage_display_name(self, stage_display_name): def build_pipeline_stage_type(self): """ Gets the build_pipeline_stage_type of this BuildPipelineStageRunProgress. - Stage sub types. + Stage types. :return: The build_pipeline_stage_type of this BuildPipelineStageRunProgress. @@ -170,7 +170,7 @@ def build_pipeline_stage_type(self): def build_pipeline_stage_type(self, build_pipeline_stage_type): """ Sets the build_pipeline_stage_type of this BuildPipelineStageRunProgress. - Stage sub types. + Stage types. :param build_pipeline_stage_type: The build_pipeline_stage_type of this BuildPipelineStageRunProgress. @@ -182,7 +182,7 @@ def build_pipeline_stage_type(self, build_pipeline_stage_type): def build_pipeline_stage_id(self): """ Gets the build_pipeline_stage_id of this BuildPipelineStageRunProgress. - Stage id + The stage OCID. :return: The build_pipeline_stage_id of this BuildPipelineStageRunProgress. @@ -194,7 +194,7 @@ def build_pipeline_stage_id(self): def build_pipeline_stage_id(self, build_pipeline_stage_id): """ Sets the build_pipeline_stage_id of this BuildPipelineStageRunProgress. - Stage id + The stage OCID. :param build_pipeline_stage_id: The build_pipeline_stage_id of this BuildPipelineStageRunProgress. @@ -206,7 +206,9 @@ def build_pipeline_stage_id(self, build_pipeline_stage_id): def time_started(self): """ Gets the time_started of this BuildPipelineStageRunProgress. - The time the Stage was started executing. An RFC3339 formatted datetime string + The time the stage started executing. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_started of this BuildPipelineStageRunProgress. @@ -218,7 +220,9 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this BuildPipelineStageRunProgress. - The time the Stage was started executing. An RFC3339 formatted datetime string + The time the stage started executing. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_started: The time_started of this BuildPipelineStageRunProgress. @@ -230,7 +234,9 @@ def time_started(self, time_started): def time_finished(self): """ Gets the time_finished of this BuildPipelineStageRunProgress. - The time the Stage was finished executing. An RFC3339 formatted datetime string + The time the stage finished executing. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_finished of this BuildPipelineStageRunProgress. @@ -242,7 +248,9 @@ def time_finished(self): def time_finished(self, time_finished): """ Sets the time_finished of this BuildPipelineStageRunProgress. - The time the Stage was finished executing. An RFC3339 formatted datetime string + The time the stage finished executing. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_finished: The time_finished of this BuildPipelineStageRunProgress. @@ -254,7 +262,7 @@ def time_finished(self, time_finished): def status(self): """ Gets the status of this BuildPipelineStageRunProgress. - The current status of the Stage. + The current status of the stage. 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'. @@ -269,7 +277,7 @@ def status(self): def status(self, status): """ Sets the status of this BuildPipelineStageRunProgress. - The current status of the Stage. + The current status of the stage. :param status: The status of this BuildPipelineStageRunProgress. diff --git a/src/oci/devops/models/build_pipeline_stage_summary.py b/src/oci/devops/models/build_pipeline_stage_summary.py index 215eddc7dc..04f645d0ff 100644 --- a/src/oci/devops/models/build_pipeline_stage_summary.py +++ b/src/oci/devops/models/build_pipeline_stage_summary.py @@ -164,7 +164,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this BuildPipelineStageSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildPipelineStageSummary. @@ -176,7 +176,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildPipelineStageSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildPipelineStageSummary. @@ -188,7 +188,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this BuildPipelineStageSummary. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildPipelineStageSummary. @@ -200,7 +200,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildPipelineStageSummary. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildPipelineStageSummary. @@ -212,7 +212,7 @@ def display_name(self, display_name): def project_id(self): """ **[Required]** Gets the project_id of this BuildPipelineStageSummary. - Build Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildPipelineStageSummary. @@ -224,7 +224,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildPipelineStageSummary. - Build Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildPipelineStageSummary. @@ -236,7 +236,7 @@ def project_id(self, project_id): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this BuildPipelineStageSummary. - Build Pipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this BuildPipelineStageSummary. @@ -248,7 +248,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this BuildPipelineStageSummary. - Build Pipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this BuildPipelineStageSummary. @@ -260,7 +260,7 @@ def build_pipeline_id(self, build_pipeline_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BuildPipelineStageSummary. - Compartment Identifier + The OCID of the compartment where the pipeline is created. :return: The compartment_id of this BuildPipelineStageSummary. @@ -272,7 +272,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildPipelineStageSummary. - Compartment Identifier + The OCID of the compartment where the pipeline is created. :param compartment_id: The compartment_id of this BuildPipelineStageSummary. @@ -284,8 +284,7 @@ def compartment_id(self, compartment_id): def build_pipeline_stage_type(self): """ **[Required]** Gets the build_pipeline_stage_type of this BuildPipelineStageSummary. - Stages sub types. It can be either of the following stages - 'Wait Stage', 'Trigger Deployment Stage', - 'Build Stage', 'Deliver Artificat Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. :return: The build_pipeline_stage_type of this BuildPipelineStageSummary. @@ -297,8 +296,7 @@ def build_pipeline_stage_type(self): def build_pipeline_stage_type(self, build_pipeline_stage_type): """ Sets the build_pipeline_stage_type of this BuildPipelineStageSummary. - Stages sub types. It can be either of the following stages - 'Wait Stage', 'Trigger Deployment Stage', - 'Build Stage', 'Deliver Artificat Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. :param build_pipeline_stage_type: The build_pipeline_stage_type of this BuildPipelineStageSummary. @@ -310,7 +308,9 @@ def build_pipeline_stage_type(self, build_pipeline_stage_type): def time_created(self): """ Gets the time_created of this BuildPipelineStageSummary. - The time at which the Stage was created. An RFC3339 formatted datetime string + The time the stage was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildPipelineStageSummary. @@ -322,7 +322,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildPipelineStageSummary. - The time at which the Stage was created. An RFC3339 formatted datetime string + The time the stage was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildPipelineStageSummary. @@ -334,7 +336,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildPipelineStageSummary. - The time at which the Stage was updated. An RFC3339 formatted datetime string + The time the stage was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildPipelineStageSummary. @@ -346,7 +350,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildPipelineStageSummary. - The time at which the Stage was updated. An RFC3339 formatted datetime string + The time the stage was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildPipelineStageSummary. @@ -358,7 +364,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildPipelineStageSummary. - The current state of the Stage. + The current state of the stage. :return: The lifecycle_state of this BuildPipelineStageSummary. @@ -370,7 +376,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildPipelineStageSummary. - The current state of the Stage. + The current state of the stage. :param lifecycle_state: The lifecycle_state of this BuildPipelineStageSummary. @@ -406,7 +412,7 @@ def lifecycle_details(self, lifecycle_details): def description(self): """ Gets the description of this BuildPipelineStageSummary. - Optional description about the BuildStage + Optional description about the build stage. :return: The description of this BuildPipelineStageSummary. @@ -418,7 +424,7 @@ def description(self): def description(self, description): """ Sets the description of this BuildPipelineStageSummary. - Optional description about the BuildStage + Optional description about the build stage. :param description: The description of this BuildPipelineStageSummary. diff --git a/src/oci/devops/models/build_pipeline_summary.py b/src/oci/devops/models/build_pipeline_summary.py index 169ec38c4a..68441861a3 100644 --- a/src/oci/devops/models/build_pipeline_summary.py +++ b/src/oci/devops/models/build_pipeline_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildPipelineSummary(object): """ - Summary of the BuildPipeline. + Summary of the build pipeline. """ def __init__(self, **kwargs): @@ -114,7 +114,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this BuildPipelineSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildPipelineSummary. @@ -126,7 +126,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildPipelineSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildPipelineSummary. @@ -138,7 +138,7 @@ def id(self, id): def description(self): """ Gets the description of this BuildPipelineSummary. - Optional description about the BuildPipeline + Optional description about the build pipeline. :return: The description of this BuildPipelineSummary. @@ -150,7 +150,7 @@ def description(self): def description(self, description): """ Sets the description of this BuildPipelineSummary. - Optional description about the BuildPipeline + Optional description about the build pipeline. :param description: The description of this BuildPipelineSummary. @@ -162,7 +162,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this BuildPipelineSummary. - BuildPipeline identifier which can be renamed and is not necessarily unique. + Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildPipelineSummary. @@ -174,7 +174,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildPipelineSummary. - BuildPipeline identifier which can be renamed and is not necessarily unique. + Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildPipelineSummary. @@ -186,7 +186,7 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BuildPipelineSummary. - Compartment Identifier + The OCID of the compartment where the build pipeline is created. :return: The compartment_id of this BuildPipelineSummary. @@ -198,7 +198,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildPipelineSummary. - Compartment Identifier + The OCID of the compartment where the build pipeline is created. :param compartment_id: The compartment_id of this BuildPipelineSummary. @@ -210,7 +210,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ **[Required]** Gets the project_id of this BuildPipelineSummary. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildPipelineSummary. @@ -222,7 +222,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildPipelineSummary. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildPipelineSummary. @@ -234,7 +234,9 @@ def project_id(self, project_id): def time_created(self): """ Gets the time_created of this BuildPipelineSummary. - The time the the BuildPipeline was created. An RFC3339 formatted datetime string + The time the build pipeline was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildPipelineSummary. @@ -246,7 +248,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildPipelineSummary. - The time the the BuildPipeline was created. An RFC3339 formatted datetime string + The time the build pipeline was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildPipelineSummary. @@ -258,7 +262,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildPipelineSummary. - The time the BuildPipeline was updated. An RFC3339 formatted datetime string + The time the build pipeline was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildPipelineSummary. @@ -270,7 +276,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildPipelineSummary. - The time the BuildPipeline was updated. An RFC3339 formatted datetime string + The time the build pipeline was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildPipelineSummary. @@ -282,7 +290,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildPipelineSummary. - The current state of the BuildPipeline. + The current state of the build pipeline. :return: The lifecycle_state of this BuildPipelineSummary. @@ -294,7 +302,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildPipelineSummary. - The current state of the BuildPipeline. + The current state of the build pipeline. :param lifecycle_state: The lifecycle_state of this BuildPipelineSummary. diff --git a/src/oci/devops/models/build_run.py b/src/oci/devops/models/build_run.py index bf5d2c46e7..829b37fb79 100644 --- a/src/oci/devops/models/build_run.py +++ b/src/oci/devops/models/build_run.py @@ -10,7 +10,9 @@ @init_model_state_from_kwargs class BuildRun(object): """ - Each time we attempt to run a BuildPipeline we create one BuildRun. A BuildRun may be happening now, or it may be a record of the run that happened in the past. The set of BuildRuns constitutes a BuildPipeline's history. + Each time you attempt to run a build pipeline you create one build run. + A build can be running currently, or it can be a record of the run that happened in the past. + The set of build runs constitutes a build pipeline's history. """ #: A constant which can be used with the lifecycle_state property of a BuildRun. @@ -175,7 +177,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this BuildRun. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildRun. @@ -187,7 +189,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildRun. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildRun. @@ -199,7 +201,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this BuildRun. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildRun. @@ -211,7 +213,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildRun. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildRun. @@ -223,7 +225,7 @@ def display_name(self, display_name): def compartment_id(self): """ Gets the compartment_id of this BuildRun. - Compartment Identifier + The OCID of the compartment where the build is running. :return: The compartment_id of this BuildRun. @@ -235,7 +237,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildRun. - Compartment Identifier + The OCID of the compartment where the build is running. :param compartment_id: The compartment_id of this BuildRun. @@ -247,7 +249,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ Gets the project_id of this BuildRun. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildRun. @@ -259,7 +261,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildRun. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildRun. @@ -271,7 +273,7 @@ def project_id(self, project_id): def build_pipeline_id(self): """ Gets the build_pipeline_id of this BuildRun. - Pipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this BuildRun. @@ -283,7 +285,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this BuildRun. - Pipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this BuildRun. @@ -335,7 +337,9 @@ def build_run_arguments(self, build_run_arguments): def time_created(self): """ Gets the time_created of this BuildRun. - The time the the BuildRun was created. An RFC3339 formatted datetime string + The time the build run was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildRun. @@ -347,7 +351,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildRun. - The time the the BuildRun was created. An RFC3339 formatted datetime string + The time the build run was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildRun. @@ -359,7 +365,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildRun. - The time the BuildRun was updated. An RFC3339 formatted datetime string + The time the build run was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildRun. @@ -371,7 +379,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildRun. - The time the BuildRun was updated. An RFC3339 formatted datetime string + The time the build run was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildRun. @@ -383,7 +393,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildRun. - The current state of the BuildRun. + The current state of the build run. 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'. @@ -398,7 +408,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildRun. - The current state of the BuildRun. + The current state of the build run. :param lifecycle_state: The lifecycle_state of this BuildRun. diff --git a/src/oci/devops/models/build_run_argument.py b/src/oci/devops/models/build_run_argument.py index 9499112b55..044ce06564 100644 --- a/src/oci/devops/models/build_run_argument.py +++ b/src/oci/devops/models/build_run_argument.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunArgument(object): """ - Values for pipeline parameters to be supplied at the time of run. + Values for pipeline parameters to be supplied at the time of running the build. """ def __init__(self, **kwargs): @@ -44,7 +44,8 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this BuildRunArgument. - Name of the parameter (Case-sensitive). + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. + Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' :return: The name of this BuildRunArgument. @@ -56,7 +57,8 @@ def name(self): def name(self, name): """ Sets the name of this BuildRunArgument. - Name of the parameter (Case-sensitive). + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. + Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' :param name: The name of this BuildRunArgument. @@ -68,7 +70,7 @@ def name(self, name): def value(self): """ **[Required]** Gets the value of this BuildRunArgument. - value of the argument + Value of the argument. :return: The value of this BuildRunArgument. @@ -80,7 +82,7 @@ def value(self): def value(self, value): """ Sets the value of this BuildRunArgument. - value of the argument + Value of the argument. :param value: The value of this BuildRunArgument. diff --git a/src/oci/devops/models/build_run_argument_collection.py b/src/oci/devops/models/build_run_argument_collection.py index 907a7718cd..319348693c 100644 --- a/src/oci/devops/models/build_run_argument_collection.py +++ b/src/oci/devops/models/build_run_argument_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunArgumentCollection(object): """ - Specifies list of arguments passed along with the BuildRun. + Specifies list of arguments passed along with the build run. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildRunArgumentCollection. - List of arguments provided at the time of BuildRun. + List of arguments provided at the time of running the build. :return: The items of this BuildRunArgumentCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildRunArgumentCollection. - List of arguments provided at the time of BuildRun. + List of arguments provided at the time of running the build. :param items: The items of this BuildRunArgumentCollection. diff --git a/src/oci/devops/models/build_run_progress.py b/src/oci/devops/models/build_run_progress.py index e80ab4b16b..10e3b1d9a5 100644 --- a/src/oci/devops/models/build_run_progress.py +++ b/src/oci/devops/models/build_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunProgress(object): """ - The run progress details of a BuildRun. + The run progress details of a build run. """ def __init__(self, **kwargs): @@ -51,7 +51,9 @@ def __init__(self, **kwargs): def time_started(self): """ Gets the time_started of this BuildRunProgress. - The time the the BuildRun is started. An RFC3339 formatted datetime string + The time the build run started. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_started of this BuildRunProgress. @@ -63,7 +65,9 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this BuildRunProgress. - The time the the BuildRun is started. An RFC3339 formatted datetime string + The time the build run started. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_started: The time_started of this BuildRunProgress. @@ -75,7 +79,9 @@ def time_started(self, time_started): def time_finished(self): """ Gets the time_finished of this BuildRunProgress. - The time the BuildRun is finished. An RFC3339 formatted datetime string + The time the build run finished. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_finished of this BuildRunProgress. @@ -87,7 +93,9 @@ def time_finished(self): def time_finished(self, time_finished): """ Sets the time_finished of this BuildRunProgress. - The time the BuildRun is finished. An RFC3339 formatted datetime string + The time the build run finished. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_finished: The time_finished of this BuildRunProgress. @@ -99,7 +107,7 @@ def time_finished(self, time_finished): def build_pipeline_stage_run_progress(self): """ Gets the build_pipeline_stage_run_progress of this BuildRunProgress. - Map of stage OCIDs to BuildPipelineStageRunProgress model. + Map of stage OCIDs to build pipeline stage run progress model. :return: The build_pipeline_stage_run_progress of this BuildRunProgress. @@ -111,7 +119,7 @@ def build_pipeline_stage_run_progress(self): def build_pipeline_stage_run_progress(self, build_pipeline_stage_run_progress): """ Sets the build_pipeline_stage_run_progress of this BuildRunProgress. - Map of stage OCIDs to BuildPipelineStageRunProgress model. + Map of stage OCIDs to build pipeline stage run progress model. :param build_pipeline_stage_run_progress: The build_pipeline_stage_run_progress of this BuildRunProgress. diff --git a/src/oci/devops/models/build_run_progress_summary.py b/src/oci/devops/models/build_run_progress_summary.py index ffb7633e7b..292efb2bc1 100644 --- a/src/oci/devops/models/build_run_progress_summary.py +++ b/src/oci/devops/models/build_run_progress_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunProgressSummary(object): """ - The summary run progress details of a BuildRun. + The summary run progress details of a build run. """ def __init__(self, **kwargs): @@ -44,7 +44,9 @@ def __init__(self, **kwargs): def time_started(self): """ Gets the time_started of this BuildRunProgressSummary. - The time the the BuildRun is started. An RFC3339 formatted datetime string + The time the build run started. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_started of this BuildRunProgressSummary. @@ -56,7 +58,9 @@ def time_started(self): def time_started(self, time_started): """ Sets the time_started of this BuildRunProgressSummary. - The time the the BuildRun is started. An RFC3339 formatted datetime string + The time the build run started. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_started: The time_started of this BuildRunProgressSummary. @@ -68,7 +72,9 @@ def time_started(self, time_started): def time_finished(self): """ Gets the time_finished of this BuildRunProgressSummary. - The time the BuildRun is finished. An RFC3339 formatted datetime string + The time the build run finished. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_finished of this BuildRunProgressSummary. @@ -80,7 +86,9 @@ def time_finished(self): def time_finished(self, time_finished): """ Sets the time_finished of this BuildRunProgressSummary. - The time the BuildRun is finished. An RFC3339 formatted datetime string + The time the build run finished. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_finished: The time_finished of this BuildRunProgressSummary. diff --git a/src/oci/devops/models/build_run_source.py b/src/oci/devops/models/build_run_source.py index 14d9fcbd27..98adb70fa4 100644 --- a/src/oci/devops/models/build_run_source.py +++ b/src/oci/devops/models/build_run_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunSource(object): """ - The source from which this Build Run was triggered + The source from which the build run is triggered. """ #: A constant which can be used with the source_type property of a BuildRunSource. @@ -84,7 +84,7 @@ def get_subtype(object_dictionary): def source_type(self): """ **[Required]** Gets the source_type of this BuildRunSource. - Source from which this build run was triggered + The source from which the build run is triggered. Allowed values for this property are: "MANUAL", "GITHUB", "GITLAB", "DEVOPS_CODE_REPOSITORY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -99,7 +99,7 @@ def source_type(self): def source_type(self, source_type): """ Sets the source_type of this BuildRunSource. - Source from which this build run was triggered + The source from which the build run is triggered. :param source_type: The source_type of this BuildRunSource. diff --git a/src/oci/devops/models/build_run_summary.py b/src/oci/devops/models/build_run_summary.py index 7153c5b19b..a3bc5ffd5a 100644 --- a/src/oci/devops/models/build_run_summary.py +++ b/src/oci/devops/models/build_run_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunSummary(object): """ - Summary of the BuildRun. + Summary of the build run. """ def __init__(self, **kwargs): @@ -142,7 +142,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this BuildRunSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this BuildRunSummary. @@ -154,7 +154,7 @@ def id(self): def id(self, id): """ Sets the id of this BuildRunSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this BuildRunSummary. @@ -166,7 +166,7 @@ def id(self, id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this BuildRunSummary. - Compartment Identifier + The OCID of the compartment where the build is running. :return: The compartment_id of this BuildRunSummary. @@ -178,7 +178,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this BuildRunSummary. - Compartment Identifier + The OCID of the compartment where the build is running. :param compartment_id: The compartment_id of this BuildRunSummary. @@ -190,7 +190,7 @@ def compartment_id(self, compartment_id): def display_name(self): """ Gets the display_name of this BuildRunSummary. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this BuildRunSummary. @@ -202,7 +202,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this BuildRunSummary. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this BuildRunSummary. @@ -214,7 +214,7 @@ def display_name(self, display_name): def project_id(self): """ **[Required]** Gets the project_id of this BuildRunSummary. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this BuildRunSummary. @@ -226,7 +226,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this BuildRunSummary. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this BuildRunSummary. @@ -238,7 +238,7 @@ def project_id(self, project_id): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this BuildRunSummary. - Pipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this BuildRunSummary. @@ -250,7 +250,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this BuildRunSummary. - Pipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this BuildRunSummary. @@ -322,7 +322,9 @@ def build_run_progress_summary(self, build_run_progress_summary): def time_created(self): """ Gets the time_created of this BuildRunSummary. - The time the the BuildRun was created. An RFC3339 formatted datetime string + The time the build run was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this BuildRunSummary. @@ -334,7 +336,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this BuildRunSummary. - The time the the BuildRun was created. An RFC3339 formatted datetime string + The time the build run was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this BuildRunSummary. @@ -346,7 +350,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this BuildRunSummary. - The time the BuildRun was updated. An RFC3339 formatted datetime string + The time the build run was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this BuildRunSummary. @@ -358,7 +364,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this BuildRunSummary. - The time the BuildRun was updated. An RFC3339 formatted datetime string + The time the build run was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this BuildRunSummary. @@ -370,7 +378,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this BuildRunSummary. - The current state of the BuildRun. + The current state of the build run. :return: The lifecycle_state of this BuildRunSummary. @@ -382,7 +390,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this BuildRunSummary. - The current state of the BuildRun. + The current state of the build run. :param lifecycle_state: The lifecycle_state of this BuildRunSummary. diff --git a/src/oci/devops/models/build_run_summary_collection.py b/src/oci/devops/models/build_run_summary_collection.py index 7dc32f3b05..2ff22a2076 100644 --- a/src/oci/devops/models/build_run_summary_collection.py +++ b/src/oci/devops/models/build_run_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildRunSummaryCollection(object): """ - List of BuildRunSummary. + List of build run summary. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildRunSummaryCollection. - Array of BuildRunSummary items. + Array of build run summary items. :return: The items of this BuildRunSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildRunSummaryCollection. - Array of BuildRunSummary items. + Array of build run summary items. :param items: The items of this BuildRunSummaryCollection. diff --git a/src/oci/devops/models/build_source.py b/src/oci/devops/models/build_source.py index e4a8b2bdb0..6f9d50ee87 100644 --- a/src/oci/devops/models/build_source.py +++ b/src/oci/devops/models/build_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildSource(object): """ - Build Source required for Build Stage. + Build source required for the Build stage. """ #: A constant which can be used with the connection_type property of a BuildSource. @@ -97,7 +97,7 @@ def get_subtype(object_dictionary): def name(self): """ **[Required]** Gets the name of this BuildSource. - Name of the Build source. This must be unique within a BuildSourceCollection. The name can be used by customers to locate the working directory pertinent to this repository. + Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. :return: The name of this BuildSource. @@ -109,7 +109,7 @@ def name(self): def name(self, name): """ Sets the name of this BuildSource. - Name of the Build source. This must be unique within a BuildSourceCollection. The name can be used by customers to locate the working directory pertinent to this repository. + Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. :param name: The name of this BuildSource. @@ -121,7 +121,7 @@ def name(self, name): def connection_type(self): """ **[Required]** Gets the connection_type of this BuildSource. - The type of Source Provider. + The type of source provider. Allowed values for this property are: "GITHUB", "GITLAB", "DEVOPS_CODE_REPOSITORY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -136,7 +136,7 @@ def connection_type(self): def connection_type(self, connection_type): """ Sets the connection_type of this BuildSource. - The type of Source Provider. + The type of source provider. :param connection_type: The connection_type of this BuildSource. @@ -151,7 +151,7 @@ def connection_type(self, connection_type): def repository_url(self): """ **[Required]** Gets the repository_url of this BuildSource. - Url for repository + URL for the repository. :return: The repository_url of this BuildSource. @@ -163,7 +163,7 @@ def repository_url(self): def repository_url(self, repository_url): """ Sets the repository_url of this BuildSource. - Url for repository + URL for the repository. :param repository_url: The repository_url of this BuildSource. @@ -175,7 +175,7 @@ def repository_url(self, repository_url): def branch(self): """ **[Required]** Gets the branch of this BuildSource. - branch name + Branch name. :return: The branch of this BuildSource. @@ -187,7 +187,7 @@ def branch(self): def branch(self, branch): """ Sets the branch of this BuildSource. - branch name + Branch name. :param branch: The branch of this BuildSource. diff --git a/src/oci/devops/models/build_source_collection.py b/src/oci/devops/models/build_source_collection.py index 465e96c301..b4608043ba 100644 --- a/src/oci/devops/models/build_source_collection.py +++ b/src/oci/devops/models/build_source_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildSourceCollection(object): """ - Collection of Build Sources. + Collection of build sources. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this BuildSourceCollection. - Collection of Build sources. In case of UPDATE operation, replaces existing Build sources list. Merging with existing Build Sources is not supported. + Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported. :return: The items of this BuildSourceCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this BuildSourceCollection. - Collection of Build sources. In case of UPDATE operation, replaces existing Build sources list. Merging with existing Build Sources is not supported. + Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported. :param items: The items of this BuildSourceCollection. diff --git a/src/oci/devops/models/build_stage.py b/src/oci/devops/models/build_stage.py index 8fab9ee6a9..4f2ebe6ee5 100644 --- a/src/oci/devops/models/build_stage.py +++ b/src/oci/devops/models/build_stage.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildStage(BuildPipelineStage): """ - Specifies the build Stage. + Specifies the build stage. """ #: A constant which can be used with the image property of a BuildStage. @@ -182,7 +182,7 @@ def __init__(self, **kwargs): def image(self): """ **[Required]** Gets the image of this BuildStage. - Image name for the Build Environment + Image name for the build environment. Allowed values for this property are: "OL7_X86_64_STANDARD_10", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -197,7 +197,7 @@ def image(self): def image(self, image): """ Sets the image of this BuildStage. - Image name for the Build Environment + Image name for the build environment. :param image: The image of this BuildStage. @@ -212,7 +212,7 @@ def image(self, image): def build_spec_file(self): """ Gets the build_spec_file of this BuildStage. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :return: The build_spec_file of this BuildStage. @@ -224,7 +224,7 @@ def build_spec_file(self): def build_spec_file(self, build_spec_file): """ Sets the build_spec_file of this BuildStage. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :param build_spec_file: The build_spec_file of this BuildStage. @@ -236,7 +236,7 @@ def build_spec_file(self, build_spec_file): def stage_execution_timeout_in_seconds(self): """ Gets the stage_execution_timeout_in_seconds of this BuildStage. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :return: The stage_execution_timeout_in_seconds of this BuildStage. @@ -248,7 +248,7 @@ def stage_execution_timeout_in_seconds(self): def stage_execution_timeout_in_seconds(self, stage_execution_timeout_in_seconds): """ Sets the stage_execution_timeout_in_seconds of this BuildStage. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :param stage_execution_timeout_in_seconds: The stage_execution_timeout_in_seconds of this BuildStage. @@ -280,7 +280,7 @@ def build_source_collection(self, build_source_collection): def primary_build_source(self): """ Gets the primary_build_source of this BuildStage. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source. :return: The primary_build_source of this BuildStage. @@ -292,7 +292,7 @@ def primary_build_source(self): def primary_build_source(self, primary_build_source): """ Sets the primary_build_source of this BuildStage. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source. :param primary_build_source: The primary_build_source of this BuildStage. diff --git a/src/oci/devops/models/build_stage_run_progress.py b/src/oci/devops/models/build_stage_run_progress.py index da6862a723..d8540e13ed 100644 --- a/src/oci/devops/models/build_stage_run_progress.py +++ b/src/oci/devops/models/build_stage_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildStageRunProgress(BuildPipelineStageRunProgress): """ - Specifies the Run details for Build Stage. + Specifies the run details for Build stage. """ #: A constant which can be used with the image property of a BuildStageRunProgress. @@ -318,7 +318,7 @@ def primary_build_source(self, primary_build_source): def steps(self): """ Gets the steps of this BuildStageRunProgress. - The details about all the steps in a Build Stage + The details about all the steps in a Build stage :return: The steps of this BuildStageRunProgress. @@ -330,7 +330,7 @@ def steps(self): def steps(self, steps): """ Sets the steps of this BuildStageRunProgress. - The details about all the steps in a Build Stage + The details about all the steps in a Build stage :param steps: The steps of this BuildStageRunProgress. diff --git a/src/oci/devops/models/build_stage_run_step.py b/src/oci/devops/models/build_stage_run_step.py index 973b9ae968..3f4c533432 100644 --- a/src/oci/devops/models/build_stage_run_step.py +++ b/src/oci/devops/models/build_stage_run_step.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildStageRunStep(object): """ - The details about each step in Build Stage. + The details about each step in a Build stage. """ #: A constant which can be used with the state property of a BuildStageRunStep. diff --git a/src/oci/devops/models/build_stage_summary.py b/src/oci/devops/models/build_stage_summary.py index 946dc1ac33..0b16496512 100644 --- a/src/oci/devops/models/build_stage_summary.py +++ b/src/oci/devops/models/build_stage_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BuildStageSummary(BuildPipelineStageSummary): """ - Specifies the Build Stage. + Specifies the build stage. """ def __init__(self, **kwargs): @@ -172,7 +172,7 @@ def __init__(self, **kwargs): def image(self): """ **[Required]** Gets the image of this BuildStageSummary. - Image for the Build Environment + Image for the build environment. :return: The image of this BuildStageSummary. @@ -184,7 +184,7 @@ def image(self): def image(self, image): """ Sets the image of this BuildStageSummary. - Image for the Build Environment + Image for the build environment. :param image: The image of this BuildStageSummary. @@ -196,7 +196,7 @@ def image(self, image): def build_spec_file(self): """ Gets the build_spec_file of this BuildStageSummary. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :return: The build_spec_file of this BuildStageSummary. @@ -208,7 +208,7 @@ def build_spec_file(self): def build_spec_file(self, build_spec_file): """ Sets the build_spec_file of this BuildStageSummary. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :param build_spec_file: The build_spec_file of this BuildStageSummary. @@ -220,7 +220,7 @@ def build_spec_file(self, build_spec_file): def stage_execution_timeout_in_seconds(self): """ Gets the stage_execution_timeout_in_seconds of this BuildStageSummary. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :return: The stage_execution_timeout_in_seconds of this BuildStageSummary. @@ -232,7 +232,7 @@ def stage_execution_timeout_in_seconds(self): def stage_execution_timeout_in_seconds(self, stage_execution_timeout_in_seconds): """ Sets the stage_execution_timeout_in_seconds of this BuildStageSummary. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :param stage_execution_timeout_in_seconds: The stage_execution_timeout_in_seconds of this BuildStageSummary. @@ -264,7 +264,7 @@ def build_source_collection(self, build_source_collection): def primary_build_source(self): """ Gets the primary_build_source of this BuildStageSummary. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :return: The primary_build_source of this BuildStageSummary. @@ -276,7 +276,7 @@ def primary_build_source(self): def primary_build_source(self, primary_build_source): """ Sets the primary_build_source of this BuildStageSummary. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :param primary_build_source: The primary_build_source of this BuildStageSummary. diff --git a/src/oci/devops/models/cancel_build_run_details.py b/src/oci/devops/models/cancel_build_run_details.py index 196e151dcd..8c6a39c536 100644 --- a/src/oci/devops/models/cancel_build_run_details.py +++ b/src/oci/devops/models/cancel_build_run_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CancelBuildRunDetails(object): """ - The information about cancel BuildRun. + Information about canceling the build run. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def reason(self): """ **[Required]** Gets the reason of this CancelBuildRunDetails. - The reason for canceling the run. + The reason for canceling the build run. :return: The reason of this CancelBuildRunDetails. @@ -49,7 +49,7 @@ def reason(self): def reason(self, reason): """ Sets the reason of this CancelBuildRunDetails. - The reason for canceling the run. + The reason for canceling the build run. :param reason: The reason of this CancelBuildRunDetails. diff --git a/src/oci/devops/models/commit_info.py b/src/oci/devops/models/commit_info.py index 0bb52a9f10..63bee9eb71 100644 --- a/src/oci/devops/models/commit_info.py +++ b/src/oci/devops/models/commit_info.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CommitInfo(object): """ - Commit details that need to be used for the BuildRun + Commit details that need to be used for the build run. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def repository_url(self): """ **[Required]** Gets the repository_url of this CommitInfo. - Repository URL + Repository URL. :return: The repository_url of this CommitInfo. @@ -63,7 +63,7 @@ def repository_url(self): def repository_url(self, repository_url): """ Sets the repository_url of this CommitInfo. - Repository URL + Repository URL. :param repository_url: The repository_url of this CommitInfo. @@ -99,7 +99,7 @@ def repository_branch(self, repository_branch): def commit_hash(self): """ **[Required]** Gets the commit_hash of this CommitInfo. - Commit Hash pertinent to the repository URL and Branch specified. + Commit hash pertinent to the repository URL and the specified branch. :return: The commit_hash of this CommitInfo. @@ -111,7 +111,7 @@ def commit_hash(self): def commit_hash(self, commit_hash): """ Sets the commit_hash of this CommitInfo. - Commit Hash pertinent to the repository URL and Branch specified. + Commit hash pertinent to the repository URL and the specified branch. :param commit_hash: The commit_hash of this CommitInfo. diff --git a/src/oci/devops/models/connection.py b/src/oci/devops/models/connection.py index bfce1cf4e8..acd1c24669 100644 --- a/src/oci/devops/models/connection.py +++ b/src/oci/devops/models/connection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Connection(object): """ - The properties that define a connection + The properties that define a connection to external repositories. """ #: A constant which can be used with the connection_type property of a Connection. @@ -151,7 +151,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this Connection. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this Connection. @@ -163,7 +163,7 @@ def id(self): def id(self, id): """ Sets the id of this Connection. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this Connection. @@ -175,7 +175,7 @@ def id(self, id): def description(self): """ Gets the description of this Connection. - Optional description about the connection + Optional description about the connection. :return: The description of this Connection. @@ -187,7 +187,7 @@ def description(self): def description(self, description): """ Sets the description of this Connection. - Optional description about the connection + Optional description about the connection. :param description: The description of this Connection. @@ -199,7 +199,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this Connection. - Connection identifier which can be renamed and is not necessarily unique + Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this Connection. @@ -211,7 +211,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Connection. - Connection identifier which can be renamed and is not necessarily unique + Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this Connection. @@ -223,7 +223,7 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Connection. - Compartment Identifier + The OCID of the compartment containing the connection. :return: The compartment_id of this Connection. @@ -235,7 +235,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Connection. - Compartment Identifier + The OCID of the compartment containing the connection. :param compartment_id: The compartment_id of this Connection. @@ -247,7 +247,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ **[Required]** Gets the project_id of this Connection. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this Connection. @@ -259,7 +259,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this Connection. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this Connection. @@ -301,7 +301,9 @@ def connection_type(self, connection_type): def time_created(self): """ Gets the time_created of this Connection. - The time the Connection was created. An RFC3339 formatted datetime string + The time the connection was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this Connection. @@ -313,7 +315,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this Connection. - The time the Connection was created. An RFC3339 formatted datetime string + The time the connection was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this Connection. @@ -325,7 +329,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this Connection. - The time at which the Connection was updated. An RFC3339 formatted datetime string + The time the connection was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this Connection. @@ -337,7 +343,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this Connection. - The time at which the Connection was updated. An RFC3339 formatted datetime string + The time the connection was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this Connection. @@ -349,7 +357,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this Connection. - The current state of the Connection. + The current state of the connection. Allowed values for this property are: "ACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -364,7 +372,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this Connection. - The current state of the Connection. + The current state of the connection. :param lifecycle_state: The lifecycle_state of this Connection. diff --git a/src/oci/devops/models/connection_summary.py b/src/oci/devops/models/connection_summary.py index 7217ca5194..495ab4c94a 100644 --- a/src/oci/devops/models/connection_summary.py +++ b/src/oci/devops/models/connection_summary.py @@ -135,7 +135,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this ConnectionSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this ConnectionSummary. @@ -147,7 +147,7 @@ def id(self): def id(self, id): """ Sets the id of this ConnectionSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this ConnectionSummary. @@ -159,7 +159,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this ConnectionSummary. - Connection identifier which can be renamed and is not necessarily unique. + Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this ConnectionSummary. @@ -171,7 +171,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ConnectionSummary. - Connection identifier which can be renamed and is not necessarily unique. + Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this ConnectionSummary. @@ -183,7 +183,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ConnectionSummary. - Optional description about the connection + Optional description about the connection. :return: The description of this ConnectionSummary. @@ -195,7 +195,7 @@ def description(self): def description(self, description): """ Sets the description of this ConnectionSummary. - Optional description about the connection + Optional description about the connection. :param description: The description of this ConnectionSummary. @@ -207,7 +207,7 @@ def description(self, description): def compartment_id(self): """ **[Required]** Gets the compartment_id of this ConnectionSummary. - Compartment Identifier + The OCID of the compartment containing the connection. :return: The compartment_id of this ConnectionSummary. @@ -219,7 +219,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this ConnectionSummary. - Compartment Identifier + The OCID of the compartment containing the connection. :param compartment_id: The compartment_id of this ConnectionSummary. @@ -231,7 +231,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ **[Required]** Gets the project_id of this ConnectionSummary. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this ConnectionSummary. @@ -243,7 +243,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this ConnectionSummary. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this ConnectionSummary. @@ -279,7 +279,9 @@ def connection_type(self, connection_type): def time_created(self): """ Gets the time_created of this ConnectionSummary. - The time the the connection was created. An RFC3339 formatted datetime string + The time the connection was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this ConnectionSummary. @@ -291,7 +293,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this ConnectionSummary. - The time the the connection was created. An RFC3339 formatted datetime string + The time the connection was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this ConnectionSummary. @@ -303,7 +307,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this ConnectionSummary. - The time the connection was updated. An RFC3339 formatted daservertetime string + The time the connection was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this ConnectionSummary. @@ -315,7 +321,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this ConnectionSummary. - The time the connection was updated. An RFC3339 formatted daservertetime string + The time the connection was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this ConnectionSummary. diff --git a/src/oci/devops/models/container_registry_delivered_artifact.py b/src/oci/devops/models/container_registry_delivered_artifact.py index 59d8270617..39f8792d5f 100644 --- a/src/oci/devops/models/container_registry_delivered_artifact.py +++ b/src/oci/devops/models/container_registry_delivered_artifact.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ContainerRegistryDeliveredArtifact(DeliveredArtifact): """ - Details of OCIR Artifact delivered via DeliverArtifactStage. + Details of the container registry artifacts delivered through the Deliver Artifacts stage. """ def __init__(self, **kwargs): @@ -68,7 +68,7 @@ def __init__(self, **kwargs): def delivered_artifact_hash(self): """ **[Required]** Gets the delivered_artifact_hash of this ContainerRegistryDeliveredArtifact. - The Hash of the OCIR artifact pushed by the DeliverArtifactStage + The hash of the container registry artifact pushed by the Deliver Artifacts stage. :return: The delivered_artifact_hash of this ContainerRegistryDeliveredArtifact. @@ -80,7 +80,7 @@ def delivered_artifact_hash(self): def delivered_artifact_hash(self, delivered_artifact_hash): """ Sets the delivered_artifact_hash of this ContainerRegistryDeliveredArtifact. - The Hash of the OCIR artifact pushed by the DeliverArtifactStage + The hash of the container registry artifact pushed by the Deliver Artifacts stage. :param delivered_artifact_hash: The delivered_artifact_hash of this ContainerRegistryDeliveredArtifact. diff --git a/src/oci/devops/models/create_absolute_wait_criteria_details.py b/src/oci/devops/models/create_absolute_wait_criteria_details.py index 0af51a4624..817a70e897 100644 --- a/src/oci/devops/models/create_absolute_wait_criteria_details.py +++ b/src/oci/devops/models/create_absolute_wait_criteria_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateAbsoluteWaitCriteriaDetails(CreateWaitCriteriaDetails): """ - Specifies the absolute wait criteria, user can specify fixed length of wait duration. + Specifies the absolute wait criteria. You can specify fixed length of wait duration. """ def __init__(self, **kwargs): @@ -48,8 +48,8 @@ def wait_duration(self): """ **[Required]** Gets the wait_duration of this CreateAbsoluteWaitCriteriaDetails. The absolute wait duration. - Minimum waitDuration should be 5 seconds. - Maximum waitDuration can be up to 2 days. + Minimum wait duration must be 5 seconds. + Maximum wait duration can be up to 2 days. :return: The wait_duration of this CreateAbsoluteWaitCriteriaDetails. @@ -62,8 +62,8 @@ def wait_duration(self, wait_duration): """ Sets the wait_duration of this CreateAbsoluteWaitCriteriaDetails. The absolute wait duration. - Minimum waitDuration should be 5 seconds. - Maximum waitDuration can be up to 2 days. + Minimum wait duration must be 5 seconds. + Maximum wait duration can be up to 2 days. :param wait_duration: The wait_duration of this CreateAbsoluteWaitCriteriaDetails. diff --git a/src/oci/devops/models/create_build_pipeline_details.py b/src/oci/devops/models/create_build_pipeline_details.py index eacce6d745..4189396f20 100644 --- a/src/oci/devops/models/create_build_pipeline_details.py +++ b/src/oci/devops/models/create_build_pipeline_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateBuildPipelineDetails(object): """ - The information about new BuildPipeline to be created. + Information about the new build pipeline to be created. """ def __init__(self, **kwargs): @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def description(self): """ Gets the description of this CreateBuildPipelineDetails. - Optional description about the BuildPipeline + Optional description about the build pipeline. :return: The description of this CreateBuildPipelineDetails. @@ -84,7 +84,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateBuildPipelineDetails. - Optional description about the BuildPipeline + Optional description about the build pipeline. :param description: The description of this CreateBuildPipelineDetails. @@ -96,7 +96,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this CreateBuildPipelineDetails. - BuildPipeline display name + Build pipeline display name. Avoid entering confidential information. :return: The display_name of this CreateBuildPipelineDetails. @@ -108,7 +108,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateBuildPipelineDetails. - BuildPipeline display name + Build pipeline display name. Avoid entering confidential information. :param display_name: The display_name of this CreateBuildPipelineDetails. @@ -120,7 +120,7 @@ def display_name(self, display_name): def project_id(self): """ **[Required]** Gets the project_id of this CreateBuildPipelineDetails. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this CreateBuildPipelineDetails. @@ -132,7 +132,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this CreateBuildPipelineDetails. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this CreateBuildPipelineDetails. diff --git a/src/oci/devops/models/create_build_pipeline_stage_details.py b/src/oci/devops/models/create_build_pipeline_stage_details.py index d25d2b94c6..02c2f751de 100644 --- a/src/oci/devops/models/create_build_pipeline_stage_details.py +++ b/src/oci/devops/models/create_build_pipeline_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateBuildPipelineStageDetails(object): """ - The information about new Stage. + The information about a new stage. """ def __init__(self, **kwargs): @@ -108,7 +108,7 @@ def get_subtype(object_dictionary): def display_name(self): """ Gets the display_name of this CreateBuildPipelineStageDetails. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this CreateBuildPipelineStageDetails. @@ -120,7 +120,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateBuildPipelineStageDetails. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this CreateBuildPipelineStageDetails. @@ -132,7 +132,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this CreateBuildPipelineStageDetails. - Optional description about the Stage + Optional description about the stage. :return: The description of this CreateBuildPipelineStageDetails. @@ -144,7 +144,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateBuildPipelineStageDetails. - Optional description about the Stage + Optional description about the stage. :param description: The description of this CreateBuildPipelineStageDetails. @@ -156,8 +156,7 @@ def description(self, description): def build_pipeline_stage_type(self): """ **[Required]** Gets the build_pipeline_stage_type of this CreateBuildPipelineStageDetails. - List of stage types. It includes 'Wait stage', 'Build Stage', 'Deliver Artifact Stage' and - 'Trigger Deployment Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. :return: The build_pipeline_stage_type of this CreateBuildPipelineStageDetails. @@ -169,8 +168,7 @@ def build_pipeline_stage_type(self): def build_pipeline_stage_type(self, build_pipeline_stage_type): """ Sets the build_pipeline_stage_type of this CreateBuildPipelineStageDetails. - List of stage types. It includes 'Wait stage', 'Build Stage', 'Deliver Artifact Stage' and - 'Trigger Deployment Stage'. + Defines the stage type, which is one of the following: Build, Deliver Artifacts, Wait, and Trigger Deployment. :param build_pipeline_stage_type: The build_pipeline_stage_type of this CreateBuildPipelineStageDetails. @@ -182,7 +180,7 @@ def build_pipeline_stage_type(self, build_pipeline_stage_type): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this CreateBuildPipelineStageDetails. - buildPipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this CreateBuildPipelineStageDetails. @@ -194,7 +192,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this CreateBuildPipelineStageDetails. - buildPipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this CreateBuildPipelineStageDetails. diff --git a/src/oci/devops/models/create_build_run_details.py b/src/oci/devops/models/create_build_run_details.py index 985681a3fb..0239c7c094 100644 --- a/src/oci/devops/models/create_build_run_details.py +++ b/src/oci/devops/models/create_build_run_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateBuildRunDetails(object): """ - The information about new BuildRun. + Information about the new build run. """ def __init__(self, **kwargs): @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this CreateBuildRunDetails. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this CreateBuildRunDetails. @@ -84,7 +84,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateBuildRunDetails. - BuildRun identifier which can be renamed and is not necessarily unique + Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this CreateBuildRunDetails. @@ -96,7 +96,7 @@ def display_name(self, display_name): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this CreateBuildRunDetails. - Pipeline Identifier + The OCID of the build pipeline. :return: The build_pipeline_id of this CreateBuildRunDetails. @@ -108,7 +108,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this CreateBuildRunDetails. - Pipeline Identifier + The OCID of the build pipeline. :param build_pipeline_id: The build_pipeline_id of this CreateBuildRunDetails. diff --git a/src/oci/devops/models/create_build_stage_details.py b/src/oci/devops/models/create_build_stage_details.py index 822aa611ff..8a23fb12fd 100644 --- a/src/oci/devops/models/create_build_stage_details.py +++ b/src/oci/devops/models/create_build_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateBuildStageDetails(CreateBuildPipelineStageDetails): """ - Specifies the Build Stage. + Specifies the build stage. """ def __init__(self, **kwargs): @@ -116,7 +116,7 @@ def __init__(self, **kwargs): def image(self): """ **[Required]** Gets the image of this CreateBuildStageDetails. - Image name for the Build Environment + Image name for the build environment :return: The image of this CreateBuildStageDetails. @@ -128,7 +128,7 @@ def image(self): def image(self, image): """ Sets the image of this CreateBuildStageDetails. - Image name for the Build Environment + Image name for the build environment :param image: The image of this CreateBuildStageDetails. @@ -140,7 +140,7 @@ def image(self, image): def build_spec_file(self): """ Gets the build_spec_file of this CreateBuildStageDetails. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :return: The build_spec_file of this CreateBuildStageDetails. @@ -152,7 +152,7 @@ def build_spec_file(self): def build_spec_file(self, build_spec_file): """ Sets the build_spec_file of this CreateBuildStageDetails. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :param build_spec_file: The build_spec_file of this CreateBuildStageDetails. @@ -164,7 +164,7 @@ def build_spec_file(self, build_spec_file): def stage_execution_timeout_in_seconds(self): """ Gets the stage_execution_timeout_in_seconds of this CreateBuildStageDetails. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :return: The stage_execution_timeout_in_seconds of this CreateBuildStageDetails. @@ -176,7 +176,7 @@ def stage_execution_timeout_in_seconds(self): def stage_execution_timeout_in_seconds(self, stage_execution_timeout_in_seconds): """ Sets the stage_execution_timeout_in_seconds of this CreateBuildStageDetails. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :param stage_execution_timeout_in_seconds: The stage_execution_timeout_in_seconds of this CreateBuildStageDetails. @@ -208,7 +208,7 @@ def build_source_collection(self, build_source_collection): def primary_build_source(self): """ Gets the primary_build_source of this CreateBuildStageDetails. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :return: The primary_build_source of this CreateBuildStageDetails. @@ -220,7 +220,7 @@ def primary_build_source(self): def primary_build_source(self, primary_build_source): """ Sets the primary_build_source of this CreateBuildStageDetails. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :param primary_build_source: The primary_build_source of this CreateBuildStageDetails. diff --git a/src/oci/devops/models/create_connection_details.py b/src/oci/devops/models/create_connection_details.py index 5cf7c0c0e7..9991dcea70 100644 --- a/src/oci/devops/models/create_connection_details.py +++ b/src/oci/devops/models/create_connection_details.py @@ -93,7 +93,7 @@ def get_subtype(object_dictionary): def description(self): """ Gets the description of this CreateConnectionDetails. - Optional description about the Connection + Optional description about the connection. :return: The description of this CreateConnectionDetails. @@ -105,7 +105,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateConnectionDetails. - Optional description about the Connection + Optional description about the connection. :param description: The description of this CreateConnectionDetails. @@ -117,7 +117,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this CreateConnectionDetails. - Optional Connection display name + Optional connection display name. Avoid entering confidential information. :return: The display_name of this CreateConnectionDetails. @@ -129,7 +129,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateConnectionDetails. - Optional Connection display name + Optional connection display name. Avoid entering confidential information. :param display_name: The display_name of this CreateConnectionDetails. @@ -141,7 +141,7 @@ def display_name(self, display_name): def project_id(self): """ **[Required]** Gets the project_id of this CreateConnectionDetails. - Project Identifier + The OCID of the DevOps project. :return: The project_id of this CreateConnectionDetails. @@ -153,7 +153,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this CreateConnectionDetails. - Project Identifier + The OCID of the DevOps project. :param project_id: The project_id of this CreateConnectionDetails. diff --git a/src/oci/devops/models/create_deliver_artifact_stage_details.py b/src/oci/devops/models/create_deliver_artifact_stage_details.py index 06cc70c015..8cbd1a8ce5 100644 --- a/src/oci/devops/models/create_deliver_artifact_stage_details.py +++ b/src/oci/devops/models/create_deliver_artifact_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateDeliverArtifactStageDetails(CreateBuildPipelineStageDetails): """ - Specifies the DeliverArtifact Stage. + Specifies the Deliver Artifacts stage. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/create_devops_code_repository_trigger_details.py b/src/oci/devops/models/create_devops_code_repository_trigger_details.py index 1c0be16e6b..c05c6fb874 100644 --- a/src/oci/devops/models/create_devops_code_repository_trigger_details.py +++ b/src/oci/devops/models/create_devops_code_repository_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateDevopsCodeRepositoryTriggerDetails(CreateTriggerDetails): """ - The Trigger for Devops-Repository as the caller + The trigger for DevOps code repository as the caller. """ def __init__(self, **kwargs): @@ -88,7 +88,7 @@ def __init__(self, **kwargs): def repository_id(self): """ Gets the repository_id of this CreateDevopsCodeRepositoryTriggerDetails. - The Devops Code Repository Id + The OCID of the DevOps code repository. :return: The repository_id of this CreateDevopsCodeRepositoryTriggerDetails. @@ -100,7 +100,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this CreateDevopsCodeRepositoryTriggerDetails. - The Devops Code Repository Id + The OCID of the DevOps code repository. :param repository_id: The repository_id of this CreateDevopsCodeRepositoryTriggerDetails. diff --git a/src/oci/devops/models/create_github_access_token_connection_details.py b/src/oci/devops/models/create_github_access_token_connection_details.py index 115799738b..f03d64a8e0 100644 --- a/src/oci/devops/models/create_github_access_token_connection_details.py +++ b/src/oci/devops/models/create_github_access_token_connection_details.py @@ -82,7 +82,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this CreateGithubAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this CreateGithubAccessTokenConnectionDetails. @@ -94,7 +94,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this CreateGithubAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this CreateGithubAccessTokenConnectionDetails. diff --git a/src/oci/devops/models/create_github_trigger_details.py b/src/oci/devops/models/create_github_trigger_details.py index 7f42552666..5e38c7ee21 100644 --- a/src/oci/devops/models/create_github_trigger_details.py +++ b/src/oci/devops/models/create_github_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateGithubTriggerDetails(CreateTriggerDetails): """ - The Trigger for Github as the caller + The trigger for GitHub as the caller. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/create_gitlab_access_token_connection_details.py b/src/oci/devops/models/create_gitlab_access_token_connection_details.py index f1fe49bf2a..4fa9a1911c 100644 --- a/src/oci/devops/models/create_gitlab_access_token_connection_details.py +++ b/src/oci/devops/models/create_gitlab_access_token_connection_details.py @@ -82,7 +82,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this CreateGitlabAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this CreateGitlabAccessTokenConnectionDetails. @@ -94,7 +94,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this CreateGitlabAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this CreateGitlabAccessTokenConnectionDetails. diff --git a/src/oci/devops/models/create_gitlab_trigger_details.py b/src/oci/devops/models/create_gitlab_trigger_details.py index dfee54c80b..1552e92404 100644 --- a/src/oci/devops/models/create_gitlab_trigger_details.py +++ b/src/oci/devops/models/create_gitlab_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateGitlabTriggerDetails(CreateTriggerDetails): """ - The Trigger for Github as the caller + The trigger for GitLab as the caller. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/create_repository_details.py b/src/oci/devops/models/create_repository_details.py index fcd8b61161..9fdf411b4d 100644 --- a/src/oci/devops/models/create_repository_details.py +++ b/src/oci/devops/models/create_repository_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateRepositoryDetails(object): """ - The information about new Repository. + Information about the new repository. """ def __init__(self, **kwargs): @@ -110,7 +110,7 @@ def name(self, name): def project_id(self): """ **[Required]** Gets the project_id of this CreateRepositoryDetails. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :return: The project_id of this CreateRepositoryDetails. @@ -122,7 +122,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this CreateRepositoryDetails. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :param project_id: The project_id of this CreateRepositoryDetails. @@ -158,7 +158,7 @@ def default_branch(self, default_branch): def repository_type(self): """ Gets the repository_type of this CreateRepositoryDetails. - Type of repository + Type of repository. :return: The repository_type of this CreateRepositoryDetails. @@ -170,7 +170,7 @@ def repository_type(self): def repository_type(self, repository_type): """ Sets the repository_type of this CreateRepositoryDetails. - Type of repository + Type of repository. :param repository_type: The repository_type of this CreateRepositoryDetails. @@ -202,7 +202,7 @@ def mirror_repository_config(self, mirror_repository_config): def description(self): """ Gets the description of this CreateRepositoryDetails. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :return: The description of this CreateRepositoryDetails. @@ -214,7 +214,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateRepositoryDetails. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :param description: The description of this CreateRepositoryDetails. diff --git a/src/oci/devops/models/create_trigger_deployment_stage_details.py b/src/oci/devops/models/create_trigger_deployment_stage_details.py index 909bbbeeb5..a195541071 100644 --- a/src/oci/devops/models/create_trigger_deployment_stage_details.py +++ b/src/oci/devops/models/create_trigger_deployment_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateTriggerDeploymentStageDetails(CreateBuildPipelineStageDetails): """ - Specifies Trigger Deployment Pipleline stage which runs another pipeline of the application. + Specifies the Trigger Deployment stage, which runs another pipeline of the application. """ def __init__(self, **kwargs): @@ -95,7 +95,7 @@ def __init__(self, **kwargs): def deploy_pipeline_id(self): """ **[Required]** Gets the deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :return: The deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. @@ -107,7 +107,7 @@ def deploy_pipeline_id(self): def deploy_pipeline_id(self, deploy_pipeline_id): """ Sets the deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :param deploy_pipeline_id: The deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. @@ -119,7 +119,7 @@ def deploy_pipeline_id(self, deploy_pipeline_id): def is_pass_all_parameters_enabled(self): """ **[Required]** Gets the is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :return: The is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. @@ -131,7 +131,7 @@ def is_pass_all_parameters_enabled(self): def is_pass_all_parameters_enabled(self, is_pass_all_parameters_enabled): """ Sets the is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :param is_pass_all_parameters_enabled: The is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. diff --git a/src/oci/devops/models/create_trigger_details.py b/src/oci/devops/models/create_trigger_details.py index a5514c7c50..998e95d69b 100644 --- a/src/oci/devops/models/create_trigger_details.py +++ b/src/oci/devops/models/create_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateTriggerDetails(object): """ - The information about new Trigger. + Information about the new trigger. """ def __init__(self, **kwargs): @@ -104,7 +104,7 @@ def get_subtype(object_dictionary): def display_name(self): """ Gets the display_name of this CreateTriggerDetails. - Name of the Trigger + Trigger display name. Avoid entering confidential information. :return: The display_name of this CreateTriggerDetails. @@ -116,7 +116,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateTriggerDetails. - Name of the Trigger + Trigger display name. Avoid entering confidential information. :param display_name: The display_name of this CreateTriggerDetails. @@ -128,7 +128,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this CreateTriggerDetails. - Optional description about the Trigger + Optional description about the trigger. :return: The description of this CreateTriggerDetails. @@ -140,7 +140,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateTriggerDetails. - Optional description about the Trigger + Optional description about the trigger. :param description: The description of this CreateTriggerDetails. @@ -152,7 +152,7 @@ def description(self, description): def project_id(self): """ **[Required]** Gets the project_id of this CreateTriggerDetails. - Project to which the Trigger will belong + The OCID of the DevOps project to which the trigger belongs to. :return: The project_id of this CreateTriggerDetails. @@ -164,7 +164,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this CreateTriggerDetails. - Project to which the Trigger will belong + The OCID of the DevOps project to which the trigger belongs to. :param project_id: The project_id of this CreateTriggerDetails. @@ -176,7 +176,7 @@ def project_id(self, project_id): def trigger_source(self): """ **[Required]** Gets the trigger_source of this CreateTriggerDetails. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :return: The trigger_source of this CreateTriggerDetails. @@ -188,7 +188,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this CreateTriggerDetails. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :param trigger_source: The trigger_source of this CreateTriggerDetails. @@ -200,7 +200,7 @@ def trigger_source(self, trigger_source): def actions(self): """ **[Required]** Gets the actions of this CreateTriggerDetails. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :return: The actions of this CreateTriggerDetails. @@ -212,7 +212,7 @@ def actions(self): def actions(self, actions): """ Sets the actions of this CreateTriggerDetails. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :param actions: The actions of this CreateTriggerDetails. diff --git a/src/oci/devops/models/create_wait_criteria_details.py b/src/oci/devops/models/create_wait_criteria_details.py index 96d100309c..d95cc600c3 100644 --- a/src/oci/devops/models/create_wait_criteria_details.py +++ b/src/oci/devops/models/create_wait_criteria_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateWaitCriteriaDetails(object): """ - Specifies wait criteria for wait stage. + Specifies wait criteria for the Wait stage. """ #: A constant which can be used with the wait_type property of a CreateWaitCriteriaDetails. @@ -59,7 +59,7 @@ def get_subtype(object_dictionary): def wait_type(self): """ **[Required]** Gets the wait_type of this CreateWaitCriteriaDetails. - wait criteria sub type + Wait criteria type. Allowed values for this property are: "ABSOLUTE_WAIT" @@ -73,7 +73,7 @@ def wait_type(self): def wait_type(self, wait_type): """ Sets the wait_type of this CreateWaitCriteriaDetails. - wait criteria sub type + Wait criteria type. :param wait_type: The wait_type of this CreateWaitCriteriaDetails. diff --git a/src/oci/devops/models/create_wait_stage_details.py b/src/oci/devops/models/create_wait_stage_details.py index 1531c35f35..c2065d3925 100644 --- a/src/oci/devops/models/create_wait_stage_details.py +++ b/src/oci/devops/models/create_wait_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateWaitStageDetails(CreateBuildPipelineStageDetails): """ - Specifies the Wait Stage. User can specify variable wait times or an absolute duration. + Specifies the Wait stage. You can specify variable wait times or an absolute duration. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/deliver_artifact.py b/src/oci/devops/models/deliver_artifact.py index 6aea657299..e8f49b22ba 100644 --- a/src/oci/devops/models/deliver_artifact.py +++ b/src/oci/devops/models/deliver_artifact.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliverArtifact(object): """ - Artifact info that need to be pushed to the artifactory stores. + Artifact information that need to be pushed to the artifactory stores. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def artifact_name(self): """ **[Required]** Gets the artifact_name of this DeliverArtifact. - Name of the artifact specified in the build_spec.yml file. + Name of the artifact specified in the build_spec.yaml file. :return: The artifact_name of this DeliverArtifact. @@ -56,7 +56,7 @@ def artifact_name(self): def artifact_name(self, artifact_name): """ Sets the artifact_name of this DeliverArtifact. - Name of the artifact specified in the build_spec.yml file. + Name of the artifact specified in the build_spec.yaml file. :param artifact_name: The artifact_name of this DeliverArtifact. @@ -68,7 +68,7 @@ def artifact_name(self, artifact_name): def artifact_id(self): """ **[Required]** Gets the artifact_id of this DeliverArtifact. - Artifact Identifier which contains the Artifact Definition. + Artifact identifier that contains the artifact definition. :return: The artifact_id of this DeliverArtifact. @@ -80,7 +80,7 @@ def artifact_id(self): def artifact_id(self, artifact_id): """ Sets the artifact_id of this DeliverArtifact. - Artifact Identifier which contains the Artifact Definition. + Artifact identifier that contains the artifact definition. :param artifact_id: The artifact_id of this DeliverArtifact. diff --git a/src/oci/devops/models/deliver_artifact_collection.py b/src/oci/devops/models/deliver_artifact_collection.py index 9c2231400c..aeb075e36a 100644 --- a/src/oci/devops/models/deliver_artifact_collection.py +++ b/src/oci/devops/models/deliver_artifact_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliverArtifactCollection(object): """ - Specifies an array of Artifacts that need to be pushed to the artifactory stores. + Specifies an array of artifacts that need to be pushed to the artifactory stores. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this DeliverArtifactCollection. - Collection of Artifacts that were generated in the Build Stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. + Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. :return: The items of this DeliverArtifactCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this DeliverArtifactCollection. - Collection of Artifacts that were generated in the Build Stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. + Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. :param items: The items of this DeliverArtifactCollection. diff --git a/src/oci/devops/models/deliver_artifact_stage.py b/src/oci/devops/models/deliver_artifact_stage.py index 681540bdd2..e8631f9141 100644 --- a/src/oci/devops/models/deliver_artifact_stage.py +++ b/src/oci/devops/models/deliver_artifact_stage.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliverArtifactStage(BuildPipelineStage): """ - Specifies the DeliverArtifact Stage. + Specifies the Deliver Artifacts stage. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/deliver_artifact_stage_run_progress.py b/src/oci/devops/models/deliver_artifact_stage_run_progress.py index d713a127f9..660bc14037 100644 --- a/src/oci/devops/models/deliver_artifact_stage_run_progress.py +++ b/src/oci/devops/models/deliver_artifact_stage_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliverArtifactStageRunProgress(BuildPipelineStageRunProgress): """ - Specifies DeliverArtifact stage specific exeution details. + Specifies Deliver Artifacts stage specific run details. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/deliver_artifact_stage_summary.py b/src/oci/devops/models/deliver_artifact_stage_summary.py index 5233e06272..3005d40f8a 100644 --- a/src/oci/devops/models/deliver_artifact_stage_summary.py +++ b/src/oci/devops/models/deliver_artifact_stage_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliverArtifactStageSummary(BuildPipelineStageSummary): """ - Specifies the DeliverArtifact Stage. + Specifies the Deliver Artifacts stage. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/delivered_artifact.py b/src/oci/devops/models/delivered_artifact.py index 38bb9fd4e1..ff56ad26a2 100644 --- a/src/oci/devops/models/delivered_artifact.py +++ b/src/oci/devops/models/delivered_artifact.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliveredArtifact(object): """ - Details of the Artifact delivered via DeliverArtifactStage. + Details of the artifacts delivered through the Deliver Artifacts stage. """ #: A constant which can be used with the artifact_type property of a DeliveredArtifact. @@ -82,7 +82,7 @@ def get_subtype(object_dictionary): def deploy_artifact_id(self): """ **[Required]** Gets the deploy_artifact_id of this DeliveredArtifact. - The OCID of the deploy artifact definition + The OCID of the deployment artifact definition. :return: The deploy_artifact_id of this DeliveredArtifact. @@ -94,7 +94,7 @@ def deploy_artifact_id(self): def deploy_artifact_id(self, deploy_artifact_id): """ Sets the deploy_artifact_id of this DeliveredArtifact. - The OCID of the deploy artifact definition + The OCID of the deployment artifact definition. :param deploy_artifact_id: The deploy_artifact_id of this DeliveredArtifact. @@ -106,7 +106,7 @@ def deploy_artifact_id(self, deploy_artifact_id): def output_artifact_name(self): """ **[Required]** Gets the output_artifact_name of this DeliveredArtifact. - Name of the output artifact defined in the build spec + Name of the output artifact defined in the build specification file. :return: The output_artifact_name of this DeliveredArtifact. @@ -118,7 +118,7 @@ def output_artifact_name(self): def output_artifact_name(self, output_artifact_name): """ Sets the output_artifact_name of this DeliveredArtifact. - Name of the output artifact defined in the build spec + Name of the output artifact defined in the build specification file. :param output_artifact_name: The output_artifact_name of this DeliveredArtifact. @@ -130,7 +130,7 @@ def output_artifact_name(self, output_artifact_name): def artifact_type(self): """ **[Required]** Gets the artifact_type of this DeliveredArtifact. - Type of Artifact Delivered + Type of artifact delivered. Allowed values for this property are: "GENERIC_ARTIFACT", "OCIR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -145,7 +145,7 @@ def artifact_type(self): def artifact_type(self, artifact_type): """ Sets the artifact_type of this DeliveredArtifact. - Type of Artifact Delivered + Type of artifact delivered. :param artifact_type: The artifact_type of this DeliveredArtifact. diff --git a/src/oci/devops/models/delivered_artifact_collection.py b/src/oci/devops/models/delivered_artifact_collection.py index 26db5daec4..c907bc3d53 100644 --- a/src/oci/devops/models/delivered_artifact_collection.py +++ b/src/oci/devops/models/delivered_artifact_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeliveredArtifactCollection(object): """ - Specifies the list of Artifacts delivered via DeliverArtifactStage + Specifies the list of artifacts delivered through the Deliver Artifacts stage. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this DeliveredArtifactCollection. - List of Artifacts delivered via DeliverArtifactStage + List of artifacts delivered through the Deliver Artifacts stage. :return: The items of this DeliveredArtifactCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this DeliveredArtifactCollection. - List of Artifacts delivered via DeliverArtifactStage + List of artifacts delivered through the Deliver Artifacts stage. :param items: The items of this DeliveredArtifactCollection. diff --git a/src/oci/devops/models/devops_code_repository_build_run_source.py b/src/oci/devops/models/devops_code_repository_build_run_source.py index 8d27e3319c..b61343e6e7 100644 --- a/src/oci/devops/models/devops_code_repository_build_run_source.py +++ b/src/oci/devops/models/devops_code_repository_build_run_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryBuildRunSource(BuildRunSource): """ - Specifies details of build run through Devops Code Repository. + Specifies details of build run through DevOps code repository. """ def __init__(self, **kwargs): @@ -61,7 +61,7 @@ def __init__(self, **kwargs): def trigger_id(self): """ **[Required]** Gets the trigger_id of this DevopsCodeRepositoryBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :return: The trigger_id of this DevopsCodeRepositoryBuildRunSource. @@ -73,7 +73,7 @@ def trigger_id(self): def trigger_id(self, trigger_id): """ Sets the trigger_id of this DevopsCodeRepositoryBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :param trigger_id: The trigger_id of this DevopsCodeRepositoryBuildRunSource. @@ -105,7 +105,7 @@ def trigger_info(self, trigger_info): def repository_id(self): """ **[Required]** Gets the repository_id of this DevopsCodeRepositoryBuildRunSource. - The Devops Code Repository RepoId that invoked this build run + The DevOps code repository identifier that invoked the build run. :return: The repository_id of this DevopsCodeRepositoryBuildRunSource. @@ -117,7 +117,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this DevopsCodeRepositoryBuildRunSource. - The Devops Code Repository RepoId that invoked this build run + The DevOps code repository identifier that invoked the build run. :param repository_id: The repository_id of this DevopsCodeRepositoryBuildRunSource. diff --git a/src/oci/devops/models/devops_code_repository_build_source.py b/src/oci/devops/models/devops_code_repository_build_source.py index 4e1f6c26e1..e06e735967 100644 --- a/src/oci/devops/models/devops_code_repository_build_source.py +++ b/src/oci/devops/models/devops_code_repository_build_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryBuildSource(BuildSource): """ - Devops Code Repository Build Source for Build Stage + DevOps code repository build source for Build stage. """ def __init__(self, **kwargs): @@ -68,7 +68,7 @@ def __init__(self, **kwargs): def repository_id(self): """ **[Required]** Gets the repository_id of this DevopsCodeRepositoryBuildSource. - The Devops Code Repository Id + The DevOps code repository ID. :return: The repository_id of this DevopsCodeRepositoryBuildSource. @@ -80,7 +80,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this DevopsCodeRepositoryBuildSource. - The Devops Code Repository Id + The DevOps code repository ID. :param repository_id: The repository_id of this DevopsCodeRepositoryBuildSource. diff --git a/src/oci/devops/models/devops_code_repository_filter.py b/src/oci/devops/models/devops_code_repository_filter.py index 6a37d0bf89..2126f55734 100644 --- a/src/oci/devops/models/devops_code_repository_filter.py +++ b/src/oci/devops/models/devops_code_repository_filter.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryFilter(Filter): """ - The filter for Gitlab events + The filter for GitLab events. """ #: A constant which can be used with the events property of a DevopsCodeRepositoryFilter. @@ -59,7 +59,7 @@ def __init__(self, **kwargs): def events(self): """ Gets the events of this DevopsCodeRepositoryFilter. - The events, only support PUSH at this time + The events only support PUSH. Allowed values for items in this list are: "PUSH", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -74,7 +74,7 @@ def events(self): def events(self, events): """ Sets the events of this DevopsCodeRepositoryFilter. - The events, only support PUSH at this time + The events only support PUSH. :param events: The events of this DevopsCodeRepositoryFilter. diff --git a/src/oci/devops/models/devops_code_repository_filter_attributes.py b/src/oci/devops/models/devops_code_repository_filter_attributes.py index ccbf10d77b..5a5b4c5cf1 100644 --- a/src/oci/devops/models/devops_code_repository_filter_attributes.py +++ b/src/oci/devops/models/devops_code_repository_filter_attributes.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryFilterAttributes(object): """ - Attributes to filter Devops Code Repository events + Attributes to filter DevOps code repository events. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def head_ref(self): """ Gets the head_ref of this DevopsCodeRepositoryFilterAttributes. - Branch for push event + Branch for push event. :return: The head_ref of this DevopsCodeRepositoryFilterAttributes. @@ -49,7 +49,7 @@ def head_ref(self): def head_ref(self, head_ref): """ Sets the head_ref of this DevopsCodeRepositoryFilterAttributes. - Branch for push event + Branch for push event. :param head_ref: The head_ref of this DevopsCodeRepositoryFilterAttributes. diff --git a/src/oci/devops/models/devops_code_repository_trigger.py b/src/oci/devops/models/devops_code_repository_trigger.py index 7368754b76..463f99c093 100644 --- a/src/oci/devops/models/devops_code_repository_trigger.py +++ b/src/oci/devops/models/devops_code_repository_trigger.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryTrigger(Trigger): """ - Trigger specific to OCI Devops Repository Service + Trigger specific to OCI DevOps Code Repository service. """ def __init__(self, **kwargs): @@ -139,7 +139,7 @@ def __init__(self, **kwargs): def repository_id(self): """ **[Required]** Gets the repository_id of this DevopsCodeRepositoryTrigger. - The OCID of OCI Devops Repository + The OCID of the DevOps code repository. :return: The repository_id of this DevopsCodeRepositoryTrigger. @@ -151,7 +151,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this DevopsCodeRepositoryTrigger. - The OCID of OCI Devops Repository + The OCID of the DevOps code repository. :param repository_id: The repository_id of this DevopsCodeRepositoryTrigger. diff --git a/src/oci/devops/models/devops_code_repository_trigger_create_result.py b/src/oci/devops/models/devops_code_repository_trigger_create_result.py index afdef5f9f1..21f48a669b 100644 --- a/src/oci/devops/models/devops_code_repository_trigger_create_result.py +++ b/src/oci/devops/models/devops_code_repository_trigger_create_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryTriggerCreateResult(TriggerCreateResult): """ - Trigger Create response specific to Gitlab + Trigger create response specific to GitLab. """ def __init__(self, **kwargs): @@ -137,7 +137,7 @@ def __init__(self, **kwargs): def repository_id(self): """ **[Required]** Gets the repository_id of this DevopsCodeRepositoryTriggerCreateResult. - The id of the OCI Devops Repository + The OCID of the DevOps code repository. :return: The repository_id of this DevopsCodeRepositoryTriggerCreateResult. @@ -149,7 +149,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this DevopsCodeRepositoryTriggerCreateResult. - The id of the OCI Devops Repository + The OCID of the DevOps code repository. :param repository_id: The repository_id of this DevopsCodeRepositoryTriggerCreateResult. diff --git a/src/oci/devops/models/devops_code_repository_trigger_summary.py b/src/oci/devops/models/devops_code_repository_trigger_summary.py index f61c3b88e8..d63a4e4dcc 100644 --- a/src/oci/devops/models/devops_code_repository_trigger_summary.py +++ b/src/oci/devops/models/devops_code_repository_trigger_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DevopsCodeRepositoryTriggerSummary(TriggerSummary): """ - Summary of the Devops Code Repository Trigger. + Summary of the DevOps code repository trigger. """ def __init__(self, **kwargs): @@ -130,7 +130,7 @@ def __init__(self, **kwargs): def repository_id(self): """ **[Required]** Gets the repository_id of this DevopsCodeRepositoryTriggerSummary. - The OCID of OCI Devops Code Repository + The OCID of the DevOps code repository. :return: The repository_id of this DevopsCodeRepositoryTriggerSummary. @@ -142,7 +142,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this DevopsCodeRepositoryTriggerSummary. - The OCID of OCI Devops Code Repository + The OCID of the DevOps code repository. :param repository_id: The repository_id of this DevopsCodeRepositoryTriggerSummary. diff --git a/src/oci/devops/models/diff_chunk.py b/src/oci/devops/models/diff_chunk.py index a53894da68..9097f92b21 100644 --- a/src/oci/devops/models/diff_chunk.py +++ b/src/oci/devops/models/diff_chunk.py @@ -161,7 +161,7 @@ def target_span(self, target_span): def diff_sections(self): """ Gets the diff_sections of this DiffChunk. - List of DiffSection. + List of difference section. :return: The diff_sections of this DiffChunk. @@ -173,7 +173,7 @@ def diff_sections(self): def diff_sections(self, diff_sections): """ Sets the diff_sections of this DiffChunk. - List of DiffSection. + List of difference section. :param diff_sections: The diff_sections of this DiffChunk. diff --git a/src/oci/devops/models/diff_collection.py b/src/oci/devops/models/diff_collection.py index 2b4c9c14aa..cd7af4678e 100644 --- a/src/oci/devops/models/diff_collection.py +++ b/src/oci/devops/models/diff_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DiffCollection(object): """ - Result of a compare diff. + Result of a compare difference. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this DiffCollection. - List of objects describing diffs for all changed files. + List of objects describing differences for all changed files. :return: The items of this DiffCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this DiffCollection. - List of objects describing diffs for all changed files. + List of objects describing differences for all changed files. :param items: The items of this DiffCollection. diff --git a/src/oci/devops/models/diff_line_details.py b/src/oci/devops/models/diff_line_details.py index cf47c5d84e..5c5aba3db1 100644 --- a/src/oci/devops/models/diff_line_details.py +++ b/src/oci/devops/models/diff_line_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DiffLineDetails(object): """ - Details about a line within the diff. + Details about a line within the difference. """ #: A constant which can be used with the conflict_marker property of a DiffLineDetails. @@ -148,7 +148,7 @@ def line_content(self, line_content): def conflict_marker(self): """ Gets the conflict_marker of this DiffLineDetails. - Indicates whether a line in a conflicted section of the diff is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. + Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. Allowed values for this property are: "BASE", "TARGET", "MARKER", "NONE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -163,7 +163,7 @@ def conflict_marker(self): def conflict_marker(self, conflict_marker): """ Sets the conflict_marker of this DiffLineDetails. - Indicates whether a line in a conflicted section of the diff is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. + Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. :param conflict_marker: The conflict_marker of this DiffLineDetails. diff --git a/src/oci/devops/models/diff_response.py b/src/oci/devops/models/diff_response.py index e5642f2595..de4049d633 100644 --- a/src/oci/devops/models/diff_response.py +++ b/src/oci/devops/models/diff_response.py @@ -86,7 +86,7 @@ def __init__(self, **kwargs): def are_all_changes_included(self): """ Gets the are_all_changes_included of this DiffResponse. - Boolean for whether all changes are included in the response. + Boolean value to indicate if all changes are included in the response. :return: The are_all_changes_included of this DiffResponse. @@ -98,7 +98,7 @@ def are_all_changes_included(self): def are_all_changes_included(self, are_all_changes_included): """ Sets the are_all_changes_included of this DiffResponse. - Boolean for whether all changes are included in the response. + Boolean value to indicate if all changes are included in the response. :param are_all_changes_included: The are_all_changes_included of this DiffResponse. @@ -110,7 +110,7 @@ def are_all_changes_included(self, are_all_changes_included): def change_type_count(self): """ Gets the change_type_count of this DiffResponse. - Count of each type of change in diff. + Count of each type of change in difference. :return: The change_type_count of this DiffResponse. @@ -122,7 +122,7 @@ def change_type_count(self): def change_type_count(self, change_type_count): """ Sets the change_type_count of this DiffResponse. - Count of each type of change in diff. + Count of each type of change in difference. :param change_type_count: The change_type_count of this DiffResponse. @@ -206,7 +206,7 @@ def commits_behind_count(self, commits_behind_count): def added_lines_count(self): """ Gets the added_lines_count of this DiffResponse. - The number of lines added in whole diff. + The number of lines added in whole difference. :return: The added_lines_count of this DiffResponse. @@ -218,7 +218,7 @@ def added_lines_count(self): def added_lines_count(self, added_lines_count): """ Sets the added_lines_count of this DiffResponse. - The number of lines added in whole diff. + The number of lines added in whole difference. :param added_lines_count: The added_lines_count of this DiffResponse. @@ -230,7 +230,7 @@ def added_lines_count(self, added_lines_count): def deleted_lines_count(self): """ Gets the deleted_lines_count of this DiffResponse. - The number of lines deleted in whole diff. + The number of lines deleted in whole difference. :return: The deleted_lines_count of this DiffResponse. @@ -242,7 +242,7 @@ def deleted_lines_count(self): def deleted_lines_count(self, deleted_lines_count): """ Sets the deleted_lines_count of this DiffResponse. - The number of lines deleted in whole diff. + The number of lines deleted in whole difference. :param deleted_lines_count: The deleted_lines_count of this DiffResponse. @@ -254,7 +254,7 @@ def deleted_lines_count(self, deleted_lines_count): def changes(self): """ **[Required]** Gets the changes of this DiffResponse. - List of changes in the diff. + List of changes in the difference. :return: The changes of this DiffResponse. @@ -266,7 +266,7 @@ def changes(self): def changes(self, changes): """ Sets the changes of this DiffResponse. - List of changes in the diff. + List of changes in the difference. :param changes: The changes of this DiffResponse. diff --git a/src/oci/devops/models/diff_response_entry.py b/src/oci/devops/models/diff_response_entry.py index 8001fb4645..b51680896a 100644 --- a/src/oci/devops/models/diff_response_entry.py +++ b/src/oci/devops/models/diff_response_entry.py @@ -299,7 +299,7 @@ def url(self, url): def added_lines_count(self): """ Gets the added_lines_count of this DiffResponseEntry. - The number of lines added in whole diff. + The number of lines added in whole difference. :return: The added_lines_count of this DiffResponseEntry. @@ -311,7 +311,7 @@ def added_lines_count(self): def added_lines_count(self, added_lines_count): """ Sets the added_lines_count of this DiffResponseEntry. - The number of lines added in whole diff. + The number of lines added in whole difference. :param added_lines_count: The added_lines_count of this DiffResponseEntry. @@ -323,7 +323,7 @@ def added_lines_count(self, added_lines_count): def deleted_lines_count(self): """ Gets the deleted_lines_count of this DiffResponseEntry. - The number of lines deleted in whole diff. + The number of lines deleted in whole difference. :return: The deleted_lines_count of this DiffResponseEntry. @@ -335,7 +335,7 @@ def deleted_lines_count(self): def deleted_lines_count(self, deleted_lines_count): """ Sets the deleted_lines_count of this DiffResponseEntry. - The number of lines deleted in whole diff. + The number of lines deleted in whole difference. :param deleted_lines_count: The deleted_lines_count of this DiffResponseEntry. diff --git a/src/oci/devops/models/diff_section.py b/src/oci/devops/models/diff_section.py index 9394cf14f0..e36d2df713 100644 --- a/src/oci/devops/models/diff_section.py +++ b/src/oci/devops/models/diff_section.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DiffSection(object): """ - Details about a section of changes within a DiffChunk. + Details about a section of changes within a difference chunk. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/diff_summary.py b/src/oci/devops/models/diff_summary.py index 5a006cc0a0..82b7d04564 100644 --- a/src/oci/devops/models/diff_summary.py +++ b/src/oci/devops/models/diff_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DiffSummary(object): """ - Response object for showing diffs for a file between two revisions. + Response object for showing differences for a file between two revisions. """ def __init__(self, **kwargs): @@ -100,7 +100,7 @@ def __init__(self, **kwargs): def old_path(self): """ Gets the old_path of this DiffSummary. - The path on the baseVersion to the changed object. + The path on the base version to the changed object. :return: The old_path of this DiffSummary. @@ -112,7 +112,7 @@ def old_path(self): def old_path(self, old_path): """ Sets the old_path of this DiffSummary. - The path on the baseVersion to the changed object. + The path on the base version to the changed object. :param old_path: The old_path of this DiffSummary. @@ -124,7 +124,7 @@ def old_path(self, old_path): def new_path(self): """ Gets the new_path of this DiffSummary. - The path on the targetVersion to the changed object. + The path on the target version to the changed object. :return: The new_path of this DiffSummary. @@ -136,7 +136,7 @@ def new_path(self): def new_path(self, new_path): """ Sets the new_path of this DiffSummary. - The path on the targetVersion to the changed object. + The path on the target version to the changed object. :param new_path: The new_path of this DiffSummary. @@ -148,7 +148,7 @@ def new_path(self, new_path): def old_id(self): """ Gets the old_id of this DiffSummary. - The ID of the changed object on the baseVersion. + The ID of the changed object on the base version. :return: The old_id of this DiffSummary. @@ -160,7 +160,7 @@ def old_id(self): def old_id(self, old_id): """ Sets the old_id of this DiffSummary. - The ID of the changed object on the baseVersion. + The ID of the changed object on the base version. :param old_id: The old_id of this DiffSummary. @@ -172,7 +172,7 @@ def old_id(self, old_id): def new_id(self): """ Gets the new_id of this DiffSummary. - The ID of the changed object on the targetVersion. + The ID of the changed object on the target version. :return: The new_id of this DiffSummary. @@ -184,7 +184,7 @@ def new_id(self): def new_id(self, new_id): """ Sets the new_id of this DiffSummary. - The ID of the changed object on the targetVersion. + The ID of the changed object on the target version. :param new_id: The new_id of this DiffSummary. diff --git a/src/oci/devops/models/exported_variable.py b/src/oci/devops/models/exported_variable.py index 3498d80a61..9d59a2442f 100644 --- a/src/oci/devops/models/exported_variable.py +++ b/src/oci/devops/models/exported_variable.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ExportedVariable(object): """ - Values for Exported variables. + Values for exported variables. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this ExportedVariable. - Name of the parameter (Case-sensitive). + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. :return: The name of this ExportedVariable. @@ -56,7 +56,7 @@ def name(self): def name(self, name): """ Sets the name of this ExportedVariable. - Name of the parameter (Case-sensitive). + Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. :param name: The name of this ExportedVariable. @@ -68,7 +68,7 @@ def name(self, name): def value(self): """ **[Required]** Gets the value of this ExportedVariable. - value of the argument + Value of the argument. :return: The value of this ExportedVariable. @@ -80,7 +80,7 @@ def value(self): def value(self, value): """ Sets the value of this ExportedVariable. - value of the argument + Value of the argument. :param value: The value of this ExportedVariable. diff --git a/src/oci/devops/models/exported_variable_collection.py b/src/oci/devops/models/exported_variable_collection.py index 68f4086c24..38b5ddc813 100644 --- a/src/oci/devops/models/exported_variable_collection.py +++ b/src/oci/devops/models/exported_variable_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ExportedVariableCollection(object): """ - Specifies list of Exported Variables. + Specifies list of exported variables. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this ExportedVariableCollection. - List of exported variables + List of exported variables. :return: The items of this ExportedVariableCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this ExportedVariableCollection. - List of exported variables + List of exported variables. :param items: The items of this ExportedVariableCollection. diff --git a/src/oci/devops/models/file_diff_response.py b/src/oci/devops/models/file_diff_response.py index ffc22cd4fd..a700ec1ff4 100644 --- a/src/oci/devops/models/file_diff_response.py +++ b/src/oci/devops/models/file_diff_response.py @@ -86,7 +86,7 @@ def __init__(self, **kwargs): def old_path(self): """ Gets the old_path of this FileDiffResponse. - The path on the baseVersion to the changed object. + The path on the base version to the changed object. :return: The old_path of this FileDiffResponse. @@ -98,7 +98,7 @@ def old_path(self): def old_path(self, old_path): """ Sets the old_path of this FileDiffResponse. - The path on the baseVersion to the changed object. + The path on the base version to the changed object. :param old_path: The old_path of this FileDiffResponse. @@ -110,7 +110,7 @@ def old_path(self, old_path): def new_path(self): """ Gets the new_path of this FileDiffResponse. - The path on the targetVersion to the changed object. + The path on the target version to the changed object. :return: The new_path of this FileDiffResponse. @@ -122,7 +122,7 @@ def new_path(self): def new_path(self, new_path): """ Sets the new_path of this FileDiffResponse. - The path on the targetVersion to the changed object. + The path on the target version to the changed object. :param new_path: The new_path of this FileDiffResponse. @@ -134,7 +134,7 @@ def new_path(self, new_path): def old_id(self): """ Gets the old_id of this FileDiffResponse. - The ID of the changed object on the baseVersion. + The ID of the changed object on the base version. :return: The old_id of this FileDiffResponse. @@ -146,7 +146,7 @@ def old_id(self): def old_id(self, old_id): """ Sets the old_id of this FileDiffResponse. - The ID of the changed object on the baseVersion. + The ID of the changed object on the base version. :param old_id: The old_id of this FileDiffResponse. @@ -158,7 +158,7 @@ def old_id(self, old_id): def new_id(self): """ Gets the new_id of this FileDiffResponse. - The ID of the changed object on the targetVersion. + The ID of the changed object on the target version. :return: The new_id of this FileDiffResponse. @@ -170,7 +170,7 @@ def new_id(self): def new_id(self, new_id): """ Sets the new_id of this FileDiffResponse. - The ID of the changed object on the targetVersion. + The ID of the changed object on the target version. :param new_id: The new_id of this FileDiffResponse. diff --git a/src/oci/devops/models/file_line_details.py b/src/oci/devops/models/file_line_details.py index 673505756c..34e64e5efe 100644 --- a/src/oci/devops/models/file_line_details.py +++ b/src/oci/devops/models/file_line_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class FileLineDetails(object): """ - Object containing the details of a line in a file + Object containing the details of a line in a file. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def line_number(self): """ **[Required]** Gets the line_number of this FileLineDetails. - The line number + The line number. :return: The line_number of this FileLineDetails. @@ -56,7 +56,7 @@ def line_number(self): def line_number(self, line_number): """ Sets the line_number of this FileLineDetails. - The line number + The line number. :param line_number: The line_number of this FileLineDetails. @@ -68,7 +68,7 @@ def line_number(self, line_number): def line_content(self): """ **[Required]** Gets the line_content of this FileLineDetails. - The content of the line + The content of the line. :return: The line_content of this FileLineDetails. @@ -80,7 +80,7 @@ def line_content(self): def line_content(self, line_content): """ Sets the line_content of this FileLineDetails. - The content of the line + The content of the line. :param line_content: The line_content of this FileLineDetails. diff --git a/src/oci/devops/models/filter.py b/src/oci/devops/models/filter.py index d234b7066c..42b0d97c03 100644 --- a/src/oci/devops/models/filter.py +++ b/src/oci/devops/models/filter.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Filter(object): """ - The filters for the trigger + The filters for the trigger. """ def __init__(self, **kwargs): @@ -62,7 +62,7 @@ def get_subtype(object_dictionary): def trigger_source(self): """ **[Required]** Gets the trigger_source of this Filter. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :return: The trigger_source of this Filter. @@ -74,7 +74,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this Filter. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :param trigger_source: The trigger_source of this Filter. diff --git a/src/oci/devops/models/generic_delivered_artifact.py b/src/oci/devops/models/generic_delivered_artifact.py index ea6d1db7dc..7b42aa1fa1 100644 --- a/src/oci/devops/models/generic_delivered_artifact.py +++ b/src/oci/devops/models/generic_delivered_artifact.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GenericDeliveredArtifact(DeliveredArtifact): """ - Details of UIM Artifact delivered via DeliverArtifactStage. + Details of the generic artifacts delivered through the Deliver Artifacts stage. """ def __init__(self, **kwargs): @@ -106,7 +106,7 @@ def artifact_repository_id(self, artifact_repository_id): def delivered_artifact_id(self): """ **[Required]** Gets the delivered_artifact_id of this GenericDeliveredArtifact. - The OCID of the artifact pushed by the DeliverArtifactStage + The OCID of the artifact pushed by the Deliver Artifacts stage. :return: The delivered_artifact_id of this GenericDeliveredArtifact. @@ -118,7 +118,7 @@ def delivered_artifact_id(self): def delivered_artifact_id(self, delivered_artifact_id): """ Sets the delivered_artifact_id of this GenericDeliveredArtifact. - The OCID of the artifact pushed by the DeliverArtifactStage + The OCID of the artifact pushed by the Deliver Artifacts stage. :param delivered_artifact_id: The delivered_artifact_id of this GenericDeliveredArtifact. diff --git a/src/oci/devops/models/github_access_token_connection.py b/src/oci/devops/models/github_access_token_connection.py index f7e57c9edb..e4fe0fdf35 100644 --- a/src/oci/devops/models/github_access_token_connection.py +++ b/src/oci/devops/models/github_access_token_connection.py @@ -126,7 +126,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this GithubAccessTokenConnection. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this GithubAccessTokenConnection. @@ -138,7 +138,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this GithubAccessTokenConnection. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this GithubAccessTokenConnection. diff --git a/src/oci/devops/models/github_access_token_connection_summary.py b/src/oci/devops/models/github_access_token_connection_summary.py index 1aa933d75f..b20b378319 100644 --- a/src/oci/devops/models/github_access_token_connection_summary.py +++ b/src/oci/devops/models/github_access_token_connection_summary.py @@ -124,7 +124,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this GithubAccessTokenConnectionSummary. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this GithubAccessTokenConnectionSummary. @@ -136,7 +136,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this GithubAccessTokenConnectionSummary. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this GithubAccessTokenConnectionSummary. diff --git a/src/oci/devops/models/github_build_run_source.py b/src/oci/devops/models/github_build_run_source.py index 10c68de41f..7cef6acdfa 100644 --- a/src/oci/devops/models/github_build_run_source.py +++ b/src/oci/devops/models/github_build_run_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubBuildRunSource(BuildRunSource): """ - Specifies details of build run through Github. + Specifies details of build run through GitHub. """ def __init__(self, **kwargs): @@ -54,7 +54,7 @@ def __init__(self, **kwargs): def trigger_id(self): """ **[Required]** Gets the trigger_id of this GithubBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :return: The trigger_id of this GithubBuildRunSource. @@ -66,7 +66,7 @@ def trigger_id(self): def trigger_id(self, trigger_id): """ Sets the trigger_id of this GithubBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :param trigger_id: The trigger_id of this GithubBuildRunSource. diff --git a/src/oci/devops/models/github_build_source.py b/src/oci/devops/models/github_build_source.py index 9afd1995cf..3fa6fdf969 100644 --- a/src/oci/devops/models/github_build_source.py +++ b/src/oci/devops/models/github_build_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubBuildSource(BuildSource): """ - Github Build Source for Build Stage + GitHub build source for Build stage. """ def __init__(self, **kwargs): @@ -68,7 +68,7 @@ def __init__(self, **kwargs): def connection_id(self): """ **[Required]** Gets the connection_id of this GithubBuildSource. - Connection identifier pertinent to GITHUB source provider + Connection identifier pertinent to GitHub source provider. :return: The connection_id of this GithubBuildSource. @@ -80,7 +80,7 @@ def connection_id(self): def connection_id(self, connection_id): """ Sets the connection_id of this GithubBuildSource. - Connection identifier pertinent to GITHUB source provider + Connection identifier pertinent to GitHub source provider. :param connection_id: The connection_id of this GithubBuildSource. diff --git a/src/oci/devops/models/github_filter.py b/src/oci/devops/models/github_filter.py index 44add92edb..5f8419d751 100644 --- a/src/oci/devops/models/github_filter.py +++ b/src/oci/devops/models/github_filter.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubFilter(Filter): """ - The filter for Github events + The filter for GitHub events. """ #: A constant which can be used with the events property of a GithubFilter. @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def events(self): """ Gets the events of this GithubFilter. - The events, example PUSH, PULL_REQUEST_MERGE etc. + The events, for example, PUSH, PULL_REQUEST_MERGE. Allowed values for items in this list are: "PUSH", "PULL_REQUEST_CREATED", "PULL_REQUEST_UPDATED", "PULL_REQUEST_REOPENED", "PULL_REQUEST_MERGED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -90,7 +90,7 @@ def events(self): def events(self, events): """ Sets the events of this GithubFilter. - The events, example PUSH, PULL_REQUEST_MERGE etc. + The events, for example, PUSH, PULL_REQUEST_MERGE. :param events: The events of this GithubFilter. diff --git a/src/oci/devops/models/github_filter_attributes.py b/src/oci/devops/models/github_filter_attributes.py index 3f0a81dfb9..345271c432 100644 --- a/src/oci/devops/models/github_filter_attributes.py +++ b/src/oci/devops/models/github_filter_attributes.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubFilterAttributes(object): """ - Attributes to filter Github events + Attributes to filter GitHub events. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def head_ref(self): """ Gets the head_ref of this GithubFilterAttributes. - Branch for push event; source branch for pull requests + Branch for push event; source branch for pull requests. :return: The head_ref of this GithubFilterAttributes. @@ -56,7 +56,7 @@ def head_ref(self): def head_ref(self, head_ref): """ Sets the head_ref of this GithubFilterAttributes. - Branch for push event; source branch for pull requests + Branch for push event; source branch for pull requests. :param head_ref: The head_ref of this GithubFilterAttributes. @@ -68,7 +68,7 @@ def head_ref(self, head_ref): def base_ref(self): """ Gets the base_ref of this GithubFilterAttributes. - The target branch for pull requests; not applicable for push + The target branch for pull requests; not applicable for push requests. :return: The base_ref of this GithubFilterAttributes. @@ -80,7 +80,7 @@ def base_ref(self): def base_ref(self, base_ref): """ Sets the base_ref of this GithubFilterAttributes. - The target branch for pull requests; not applicable for push + The target branch for pull requests; not applicable for push requests. :param base_ref: The base_ref of this GithubFilterAttributes. diff --git a/src/oci/devops/models/github_trigger.py b/src/oci/devops/models/github_trigger.py index 4aa2569512..ed45d9026f 100644 --- a/src/oci/devops/models/github_trigger.py +++ b/src/oci/devops/models/github_trigger.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubTrigger(Trigger): """ - Trigger specific to Github + Trigger specific to GitHub. """ def __init__(self, **kwargs): @@ -139,7 +139,7 @@ def __init__(self, **kwargs): def trigger_url(self): """ **[Required]** Gets the trigger_url of this GithubTrigger. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :return: The trigger_url of this GithubTrigger. @@ -151,7 +151,7 @@ def trigger_url(self): def trigger_url(self, trigger_url): """ Sets the trigger_url of this GithubTrigger. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :param trigger_url: The trigger_url of this GithubTrigger. diff --git a/src/oci/devops/models/github_trigger_create_result.py b/src/oci/devops/models/github_trigger_create_result.py index e974d770ba..471be751fb 100644 --- a/src/oci/devops/models/github_trigger_create_result.py +++ b/src/oci/devops/models/github_trigger_create_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubTriggerCreateResult(TriggerCreateResult): """ - Trigger Create response specific to Github + Trigger create response specific to GitHub. """ def __init__(self, **kwargs): @@ -144,7 +144,7 @@ def __init__(self, **kwargs): def secret(self): """ **[Required]** Gets the secret of this GithubTriggerCreateResult. - The secret used to validate the incoming Trigger call (this is visible only once after the resource is created) + The secret used to validate the incoming trigger call. This is visible only after the resource is created. :return: The secret of this GithubTriggerCreateResult. @@ -156,7 +156,7 @@ def secret(self): def secret(self, secret): """ Sets the secret of this GithubTriggerCreateResult. - The secret used to validate the incoming Trigger call (this is visible only once after the resource is created) + The secret used to validate the incoming trigger call. This is visible only after the resource is created. :param secret: The secret of this GithubTriggerCreateResult. @@ -168,7 +168,7 @@ def secret(self, secret): def trigger_url(self): """ **[Required]** Gets the trigger_url of this GithubTriggerCreateResult. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :return: The trigger_url of this GithubTriggerCreateResult. @@ -180,7 +180,7 @@ def trigger_url(self): def trigger_url(self, trigger_url): """ Sets the trigger_url of this GithubTriggerCreateResult. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :param trigger_url: The trigger_url of this GithubTriggerCreateResult. diff --git a/src/oci/devops/models/github_trigger_summary.py b/src/oci/devops/models/github_trigger_summary.py index 7e8f36a8c9..2f00067db6 100644 --- a/src/oci/devops/models/github_trigger_summary.py +++ b/src/oci/devops/models/github_trigger_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GithubTriggerSummary(TriggerSummary): """ - Summary of the Github Trigger. + Summary of the GitHub trigger. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/gitlab_access_token_connection.py b/src/oci/devops/models/gitlab_access_token_connection.py index 4deb459c44..fc154e313d 100644 --- a/src/oci/devops/models/gitlab_access_token_connection.py +++ b/src/oci/devops/models/gitlab_access_token_connection.py @@ -126,7 +126,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this GitlabAccessTokenConnection. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this GitlabAccessTokenConnection. @@ -138,7 +138,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this GitlabAccessTokenConnection. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this GitlabAccessTokenConnection. diff --git a/src/oci/devops/models/gitlab_access_token_connection_summary.py b/src/oci/devops/models/gitlab_access_token_connection_summary.py index 17ca8931b3..ca8748ffd5 100644 --- a/src/oci/devops/models/gitlab_access_token_connection_summary.py +++ b/src/oci/devops/models/gitlab_access_token_connection_summary.py @@ -124,7 +124,7 @@ def __init__(self, **kwargs): def access_token(self): """ **[Required]** Gets the access_token of this GitlabAccessTokenConnectionSummary. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this GitlabAccessTokenConnectionSummary. @@ -136,7 +136,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this GitlabAccessTokenConnectionSummary. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this GitlabAccessTokenConnectionSummary. diff --git a/src/oci/devops/models/gitlab_build_run_source.py b/src/oci/devops/models/gitlab_build_run_source.py index 29fb001b1e..a249b6b791 100644 --- a/src/oci/devops/models/gitlab_build_run_source.py +++ b/src/oci/devops/models/gitlab_build_run_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabBuildRunSource(BuildRunSource): """ - Specifies details of build run through Gitlab. + Specifies details of build run through GitLab. """ def __init__(self, **kwargs): @@ -54,7 +54,7 @@ def __init__(self, **kwargs): def trigger_id(self): """ **[Required]** Gets the trigger_id of this GitlabBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :return: The trigger_id of this GitlabBuildRunSource. @@ -66,7 +66,7 @@ def trigger_id(self): def trigger_id(self, trigger_id): """ Sets the trigger_id of this GitlabBuildRunSource. - The Trigger that invoked this build run + The trigger that invoked the build run. :param trigger_id: The trigger_id of this GitlabBuildRunSource. diff --git a/src/oci/devops/models/gitlab_build_source.py b/src/oci/devops/models/gitlab_build_source.py index ad48275102..5bef528ca2 100644 --- a/src/oci/devops/models/gitlab_build_source.py +++ b/src/oci/devops/models/gitlab_build_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabBuildSource(BuildSource): """ - Gitlab Build Source for Build Stage + GitLab build source for Build stage. """ def __init__(self, **kwargs): @@ -68,7 +68,7 @@ def __init__(self, **kwargs): def connection_id(self): """ **[Required]** Gets the connection_id of this GitlabBuildSource. - Connection identifier pertinent to GITLAB source provider + Connection identifier pertinent to GitLab source provider. :return: The connection_id of this GitlabBuildSource. @@ -80,7 +80,7 @@ def connection_id(self): def connection_id(self, connection_id): """ Sets the connection_id of this GitlabBuildSource. - Connection identifier pertinent to GITLAB source provider + Connection identifier pertinent to GitLab source provider. :param connection_id: The connection_id of this GitlabBuildSource. diff --git a/src/oci/devops/models/gitlab_filter.py b/src/oci/devops/models/gitlab_filter.py index dbb10ead89..633c6070a4 100644 --- a/src/oci/devops/models/gitlab_filter.py +++ b/src/oci/devops/models/gitlab_filter.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabFilter(Filter): """ - The filter for Gitlab events + The filter for GitLab events. """ #: A constant which can be used with the events property of a GitlabFilter. @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def events(self): """ Gets the events of this GitlabFilter. - The events, example PUSH, PULL_REQUEST_MERGE etc. + The events, for example, PUSH, PULL_REQUEST_MERGE. Allowed values for items in this list are: "PUSH", "PULL_REQUEST_CREATED", "PULL_REQUEST_UPDATED", "PULL_REQUEST_REOPENED", "PULL_REQUEST_MERGED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -90,7 +90,7 @@ def events(self): def events(self, events): """ Sets the events of this GitlabFilter. - The events, example PUSH, PULL_REQUEST_MERGE etc. + The events, for example, PUSH, PULL_REQUEST_MERGE. :param events: The events of this GitlabFilter. diff --git a/src/oci/devops/models/gitlab_filter_attributes.py b/src/oci/devops/models/gitlab_filter_attributes.py index 2d65defe26..ad52839bb8 100644 --- a/src/oci/devops/models/gitlab_filter_attributes.py +++ b/src/oci/devops/models/gitlab_filter_attributes.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabFilterAttributes(object): """ - Attributes to filter Gitlab events + Attributes to filter GitLab events. """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def head_ref(self): """ Gets the head_ref of this GitlabFilterAttributes. - Branch for push event; source branch for pull requests + Branch for push event; source branch for pull requests. :return: The head_ref of this GitlabFilterAttributes. @@ -56,7 +56,7 @@ def head_ref(self): def head_ref(self, head_ref): """ Sets the head_ref of this GitlabFilterAttributes. - Branch for push event; source branch for pull requests + Branch for push event; source branch for pull requests. :param head_ref: The head_ref of this GitlabFilterAttributes. @@ -68,7 +68,7 @@ def head_ref(self, head_ref): def base_ref(self): """ Gets the base_ref of this GitlabFilterAttributes. - The target branch for pull requests; not applicable for push + The target branch for pull requests; not applicable for push requests. :return: The base_ref of this GitlabFilterAttributes. @@ -80,7 +80,7 @@ def base_ref(self): def base_ref(self, base_ref): """ Sets the base_ref of this GitlabFilterAttributes. - The target branch for pull requests; not applicable for push + The target branch for pull requests; not applicable for push requests. :param base_ref: The base_ref of this GitlabFilterAttributes. diff --git a/src/oci/devops/models/gitlab_trigger.py b/src/oci/devops/models/gitlab_trigger.py index 9362023fb2..8c8fb74728 100644 --- a/src/oci/devops/models/gitlab_trigger.py +++ b/src/oci/devops/models/gitlab_trigger.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabTrigger(Trigger): """ - Trigger specific to Gitlab + Trigger specific to GitLab. """ def __init__(self, **kwargs): @@ -139,7 +139,7 @@ def __init__(self, **kwargs): def trigger_url(self): """ **[Required]** Gets the trigger_url of this GitlabTrigger. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :return: The trigger_url of this GitlabTrigger. @@ -151,7 +151,7 @@ def trigger_url(self): def trigger_url(self, trigger_url): """ Sets the trigger_url of this GitlabTrigger. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :param trigger_url: The trigger_url of this GitlabTrigger. diff --git a/src/oci/devops/models/gitlab_trigger_create_result.py b/src/oci/devops/models/gitlab_trigger_create_result.py index f129b2e031..6f4d08a2f4 100644 --- a/src/oci/devops/models/gitlab_trigger_create_result.py +++ b/src/oci/devops/models/gitlab_trigger_create_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabTriggerCreateResult(TriggerCreateResult): """ - Trigger Create response specific to Gitlab + Trigger create response specific to GitLab. """ def __init__(self, **kwargs): @@ -144,7 +144,7 @@ def __init__(self, **kwargs): def secret(self): """ **[Required]** Gets the secret of this GitlabTriggerCreateResult. - The secret used to validate the incoming Trigger call (this is visible only once after the resource is created) + The secret used to validate the incoming trigger call. This is visible only after the resource is created. :return: The secret of this GitlabTriggerCreateResult. @@ -156,7 +156,7 @@ def secret(self): def secret(self, secret): """ Sets the secret of this GitlabTriggerCreateResult. - The secret used to validate the incoming Trigger call (this is visible only once after the resource is created) + The secret used to validate the incoming trigger call. This is visible only after the resource is created. :param secret: The secret of this GitlabTriggerCreateResult. @@ -168,7 +168,7 @@ def secret(self, secret): def trigger_url(self): """ **[Required]** Gets the trigger_url of this GitlabTriggerCreateResult. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :return: The trigger_url of this GitlabTriggerCreateResult. @@ -180,7 +180,7 @@ def trigger_url(self): def trigger_url(self, trigger_url): """ Sets the trigger_url of this GitlabTriggerCreateResult. - The endpoint which listens to Trigger events + The endpoint that listens to trigger events. :param trigger_url: The trigger_url of this GitlabTriggerCreateResult. diff --git a/src/oci/devops/models/gitlab_trigger_summary.py b/src/oci/devops/models/gitlab_trigger_summary.py index 50dc8fde29..9d3a1849b2 100644 --- a/src/oci/devops/models/gitlab_trigger_summary.py +++ b/src/oci/devops/models/gitlab_trigger_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class GitlabTriggerSummary(TriggerSummary): """ - Summary of the Gitlab Trigger. + Summary of the GitLab trigger. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/manual_build_run_source.py b/src/oci/devops/models/manual_build_run_source.py index e5169225a4..c88933c44f 100644 --- a/src/oci/devops/models/manual_build_run_source.py +++ b/src/oci/devops/models/manual_build_run_source.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ManualBuildRunSource(BuildRunSource): """ - Specifies details of build runs triggered manually through API. + Specifies details of build runs triggered manually through the API. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/mirror_repository_config.py b/src/oci/devops/models/mirror_repository_config.py index e1e5022684..c9db90d9c4 100644 --- a/src/oci/devops/models/mirror_repository_config.py +++ b/src/oci/devops/models/mirror_repository_config.py @@ -75,7 +75,7 @@ def connector_id(self, connector_id): def repository_url(self): """ Gets the repository_url of this MirrorRepositoryConfig. - Url of external repository we'd like to mirror + URL of external repository you want to mirror. :return: The repository_url of this MirrorRepositoryConfig. @@ -87,7 +87,7 @@ def repository_url(self): def repository_url(self, repository_url): """ Sets the repository_url of this MirrorRepositoryConfig. - Url of external repository we'd like to mirror + URL of external repository you want to mirror. :param repository_url: The repository_url of this MirrorRepositoryConfig. diff --git a/src/oci/devops/models/put_repository_branch_details.py b/src/oci/devops/models/put_repository_branch_details.py index 3d0fd98515..1b5057e32e 100644 --- a/src/oci/devops/models/put_repository_branch_details.py +++ b/src/oci/devops/models/put_repository_branch_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PutRepositoryBranchDetails(PutRepositoryRefDetails): """ - The information needed to create a branch + The information needed to create a branch. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/put_repository_ref_details.py b/src/oci/devops/models/put_repository_ref_details.py index 8ca24fab99..7e082fc87b 100644 --- a/src/oci/devops/models/put_repository_ref_details.py +++ b/src/oci/devops/models/put_repository_ref_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PutRepositoryRefDetails(object): """ - The information needed to create a ref. If the ref already exists, it can be used to update it. + The information needed to create a reference. If the reference already exists, then it can be used to update the reference. """ #: A constant which can be used with the ref_type property of a PutRepositoryRefDetails. @@ -67,7 +67,7 @@ def get_subtype(object_dictionary): def ref_type(self): """ **[Required]** Gets the ref_type of this PutRepositoryRefDetails. - The type of Ref (Branch or Tag) + The type of reference (Branch or Tag). Allowed values for this property are: "BRANCH", "TAG" @@ -81,7 +81,7 @@ def ref_type(self): def ref_type(self, ref_type): """ Sets the ref_type of this PutRepositoryRefDetails. - The type of Ref (Branch or Tag) + The type of reference (Branch or Tag). :param ref_type: The ref_type of this PutRepositoryRefDetails. diff --git a/src/oci/devops/models/put_repository_tag_details.py b/src/oci/devops/models/put_repository_tag_details.py index bc22624fbf..b347776fd2 100644 --- a/src/oci/devops/models/put_repository_tag_details.py +++ b/src/oci/devops/models/put_repository_tag_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PutRepositoryTagDetails(PutRepositoryRefDetails): """ - The information needed to create a lightweight Tag + The information needed to create a lightweight tag. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository.py b/src/oci/devops/models/repository.py index 1c97f33b6e..4f6a49b548 100644 --- a/src/oci/devops/models/repository.py +++ b/src/oci/devops/models/repository.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Repository(object): """ - Description of Repository. + Repositories containing the source code to build and deploy. """ #: A constant which can be used with the repository_type property of a Repository. @@ -273,7 +273,7 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Repository. - The OCID of the repository's Compartment. + The OCID of the repository's compartment. :return: The compartment_id of this Repository. @@ -285,7 +285,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Repository. - The OCID of the repository's Compartment. + The OCID of the repository's compartment. :param compartment_id: The compartment_id of this Repository. @@ -297,7 +297,7 @@ def compartment_id(self, compartment_id): def namespace(self): """ Gets the namespace of this Repository. - Tenancy unique namespace + Tenancy unique namespace. :return: The namespace of this Repository. @@ -309,7 +309,7 @@ def namespace(self): def namespace(self, namespace): """ Sets the namespace of this Repository. - Tenancy unique namespace + Tenancy unique namespace. :param namespace: The namespace of this Repository. @@ -321,7 +321,7 @@ def namespace(self, namespace): def project_id(self): """ **[Required]** Gets the project_id of this Repository. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :return: The project_id of this Repository. @@ -333,7 +333,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this Repository. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :param project_id: The project_id of this Repository. @@ -345,7 +345,7 @@ def project_id(self, project_id): def project_name(self): """ Gets the project_name of this Repository. - Project unique Name under namespace + Unique project name in a namespace. :return: The project_name of this Repository. @@ -357,7 +357,7 @@ def project_name(self): def project_name(self, project_name): """ Sets the project_name of this Repository. - Project unique Name under namespace + Unique project name in a namespace. :param project_name: The project_name of this Repository. @@ -369,7 +369,7 @@ def project_name(self, project_name): def ssh_url(self): """ Gets the ssh_url of this Repository. - ssh url user utilized to git clone, pull and push + SSH URL that you use to git clone, pull and push. :return: The ssh_url of this Repository. @@ -381,7 +381,7 @@ def ssh_url(self): def ssh_url(self, ssh_url): """ Sets the ssh_url of this Repository. - ssh url user utilized to git clone, pull and push + SSH URL that you use to git clone, pull and push. :param ssh_url: The ssh_url of this Repository. @@ -393,7 +393,7 @@ def ssh_url(self, ssh_url): def http_url(self): """ Gets the http_url of this Repository. - http url user utilized to git clone, pull and push + HTTP URL that you use to git clone, pull and push. :return: The http_url of this Repository. @@ -405,7 +405,7 @@ def http_url(self): def http_url(self, http_url): """ Sets the http_url of this Repository. - http url user utilized to git clone, pull and push + HTTP URL that you use to git clone, pull and push. :param http_url: The http_url of this Repository. @@ -417,7 +417,7 @@ def http_url(self, http_url): def description(self): """ Gets the description of this Repository. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :return: The description of this Repository. @@ -429,7 +429,7 @@ def description(self): def description(self, description): """ Sets the description of this Repository. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :param description: The description of this Repository. @@ -441,7 +441,7 @@ def description(self, description): def default_branch(self): """ Gets the default_branch of this Repository. - The default branch of the repository + The default branch of the repository. :return: The default_branch of this Repository. @@ -453,7 +453,7 @@ def default_branch(self): def default_branch(self, default_branch): """ Sets the default_branch of this Repository. - The default branch of the repository + The default branch of the repository. :param default_branch: The default_branch of this Repository. @@ -465,9 +465,9 @@ def default_branch(self, default_branch): def repository_type(self): """ Gets the repository_type of this Repository. - Type of repository - MIRRORED - Repository was created by mirroring an existing repository. - HOSTED - Repository was created and hosted using OCI Devops Code Repository. + Type of repository: + Mirrored - Repository created by mirroring an existing repository. + Hosted - Repository created and hosted using OCI DevOps code repository. Allowed values for this property are: "MIRRORED", "HOSTED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -482,9 +482,9 @@ def repository_type(self): def repository_type(self, repository_type): """ Sets the repository_type of this Repository. - Type of repository - MIRRORED - Repository was created by mirroring an existing repository. - HOSTED - Repository was created and hosted using OCI Devops Code Repository. + Type of repository: + Mirrored - Repository created by mirroring an existing repository. + Hosted - Repository created and hosted using OCI DevOps code repository. :param repository_type: The repository_type of this Repository. @@ -519,7 +519,9 @@ def mirror_repository_config(self, mirror_repository_config): def time_created(self): """ Gets the time_created of this Repository. - The time the the Repository was created. An RFC3339 formatted datetime string + The time the repository was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this Repository. @@ -531,7 +533,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this Repository. - The time the the Repository was created. An RFC3339 formatted datetime string + The time the repository was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this Repository. @@ -543,7 +547,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this Repository. - The time the Repository was updated. An RFC3339 formatted datetime string + The time the repository was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this Repository. @@ -555,7 +561,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this Repository. - The time the Repository was updated. An RFC3339 formatted datetime string + The time the repository was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this Repository. @@ -567,7 +575,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this Repository. - The current state of the Repository. + The current state of the repository. Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -582,7 +590,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this Repository. - The current state of the Repository. + The current state of the repository. :param lifecycle_state: The lifecycle_state of this Repository. @@ -693,9 +701,9 @@ def size_in_bytes(self, size_in_bytes): def trigger_build_events(self): """ Gets the trigger_build_events of this Repository. - Trigger Build Events supported for this repository - PUSH - Build is triggered when a push event occurs - COMMIT_UPDATES - Build is triggered when new commits are mirrored into repository + Trigger build events supported for this repository: + Push - Build is triggered when a push event occurs. + Commit updates - Build is triggered when new commits are mirrored into a repository. Allowed values for items in this list are: "PUSH", "COMMIT_UPDATES", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -710,9 +718,9 @@ def trigger_build_events(self): def trigger_build_events(self, trigger_build_events): """ Sets the trigger_build_events of this Repository. - Trigger Build Events supported for this repository - PUSH - Build is triggered when a push event occurs - COMMIT_UPDATES - Build is triggered when new commits are mirrored into repository + Trigger build events supported for this repository: + Push - Build is triggered when a push event occurs. + Commit updates - Build is triggered when new commits are mirrored into a repository. :param trigger_build_events: The trigger_build_events of this Repository. diff --git a/src/oci/devops/models/repository_author_collection.py b/src/oci/devops/models/repository_author_collection.py index 14c595e20f..d9e255a827 100644 --- a/src/oci/devops/models/repository_author_collection.py +++ b/src/oci/devops/models/repository_author_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryAuthorCollection(object): """ - Result of List Authors. + Result of list authors. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_author_summary.py b/src/oci/devops/models/repository_author_summary.py index 98993d4a6c..a394a1aa2b 100644 --- a/src/oci/devops/models/repository_author_summary.py +++ b/src/oci/devops/models/repository_author_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryAuthorSummary(object): """ - Object containing summary of authors in a repository + Object containing summary of authors in a repository. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def author_name(self): """ **[Required]** Gets the author_name of this RepositoryAuthorSummary. - Author name + Author name. :return: The author_name of this RepositoryAuthorSummary. @@ -63,7 +63,7 @@ def author_name(self): def author_name(self, author_name): """ Sets the author_name of this RepositoryAuthorSummary. - Author name + Author name. :param author_name: The author_name of this RepositoryAuthorSummary. diff --git a/src/oci/devops/models/repository_branch.py b/src/oci/devops/models/repository_branch.py index 40e8a9d06e..0f742b8ee5 100644 --- a/src/oci/devops/models/repository_branch.py +++ b/src/oci/devops/models/repository_branch.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryBranch(RepositoryRef): """ - Branch related information + Branch related information. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_branch_summary.py b/src/oci/devops/models/repository_branch_summary.py index 0211eaabfd..92f102be6d 100644 --- a/src/oci/devops/models/repository_branch_summary.py +++ b/src/oci/devops/models/repository_branch_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryBranchSummary(RepositoryRefSummary): """ - Branch related information + Branch related information. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_collection.py b/src/oci/devops/models/repository_collection.py index e58976ecad..ac70de278a 100644 --- a/src/oci/devops/models/repository_collection.py +++ b/src/oci/devops/models/repository_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryCollection(object): """ - Results of a repository search. Contains RepositorySummary items and other information, such as metadata. + Results of a repository search. Contains repository summary items and other information, such as metadata. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_commit.py b/src/oci/devops/models/repository_commit.py index 59fe676f61..2a86de9c48 100644 --- a/src/oci/devops/models/repository_commit.py +++ b/src/oci/devops/models/repository_commit.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryCommit(object): """ - Commit object with commit information + Commit object with commit information. """ def __init__(self, **kwargs): @@ -93,7 +93,7 @@ def __init__(self, **kwargs): def commit_id(self): """ **[Required]** Gets the commit_id of this RepositoryCommit. - Commit hash pointed to by Ref name + Commit hash pointed to by reference name. :return: The commit_id of this RepositoryCommit. @@ -105,7 +105,7 @@ def commit_id(self): def commit_id(self, commit_id): """ Sets the commit_id of this RepositoryCommit. - Commit hash pointed to by Ref name + Commit hash pointed to by reference name. :param commit_id: The commit_id of this RepositoryCommit. @@ -141,7 +141,7 @@ def commit_message(self, commit_message): def author_name(self): """ Gets the author_name of this RepositoryCommit. - The name of the author of the repository. + Name of the author of the repository. :return: The author_name of this RepositoryCommit. @@ -153,7 +153,7 @@ def author_name(self): def author_name(self, author_name): """ Sets the author_name of this RepositoryCommit. - The name of the author of the repository. + Name of the author of the repository. :param author_name: The author_name of this RepositoryCommit. @@ -165,7 +165,7 @@ def author_name(self, author_name): def author_email(self): """ Gets the author_email of this RepositoryCommit. - The email of the author of the repository. + Email of the author of the repository. :return: The author_email of this RepositoryCommit. @@ -177,7 +177,7 @@ def author_email(self): def author_email(self, author_email): """ Sets the author_email of this RepositoryCommit. - The email of the author of the repository. + Email of the author of the repository. :param author_email: The author_email of this RepositoryCommit. @@ -189,7 +189,7 @@ def author_email(self, author_email): def committer_name(self): """ Gets the committer_name of this RepositoryCommit. - The name of who create the commit. + Name of who creates the commit. :return: The committer_name of this RepositoryCommit. @@ -201,7 +201,7 @@ def committer_name(self): def committer_name(self, committer_name): """ Sets the committer_name of this RepositoryCommit. - The name of who create the commit. + Name of who creates the commit. :param committer_name: The committer_name of this RepositoryCommit. @@ -213,7 +213,7 @@ def committer_name(self, committer_name): def committer_email(self): """ Gets the committer_email of this RepositoryCommit. - The email of who create the commit. + Email of who creates the commit. :return: The committer_email of this RepositoryCommit. @@ -225,7 +225,7 @@ def committer_email(self): def committer_email(self, committer_email): """ Sets the committer_email of this RepositoryCommit. - The email of who create the commit. + Email of who creates the commit. :param committer_email: The committer_email of this RepositoryCommit. @@ -237,7 +237,7 @@ def committer_email(self, committer_email): def parent_commit_ids(self): """ Gets the parent_commit_ids of this RepositoryCommit. - An array of parent commit ids of created commit. + An array of parent commit IDs of created commit. :return: The parent_commit_ids of this RepositoryCommit. @@ -249,7 +249,7 @@ def parent_commit_ids(self): def parent_commit_ids(self, parent_commit_ids): """ Sets the parent_commit_ids of this RepositoryCommit. - An array of parent commit ids of created commit. + An array of parent commit IDs of created commit. :param parent_commit_ids: The parent_commit_ids of this RepositoryCommit. @@ -285,7 +285,7 @@ def time_created(self, time_created): def tree_id(self): """ Gets the tree_id of this RepositoryCommit. - Tree information for the specified commit + Tree information for the specified commit. :return: The tree_id of this RepositoryCommit. @@ -297,7 +297,7 @@ def tree_id(self): def tree_id(self, tree_id): """ Sets the tree_id of this RepositoryCommit. - Tree information for the specified commit + Tree information for the specified commit. :param tree_id: The tree_id of this RepositoryCommit. diff --git a/src/oci/devops/models/repository_commit_collection.py b/src/oci/devops/models/repository_commit_collection.py index 792f5113e5..b4d4812dd9 100644 --- a/src/oci/devops/models/repository_commit_collection.py +++ b/src/oci/devops/models/repository_commit_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryCommitCollection(object): """ - Result of a Commit search. + Result of a commit search. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_commit_summary.py b/src/oci/devops/models/repository_commit_summary.py index 487b47cf38..08b7e93f20 100644 --- a/src/oci/devops/models/repository_commit_summary.py +++ b/src/oci/devops/models/repository_commit_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryCommitSummary(object): """ - Commit summary with commit information + Commit summary with commit information. """ def __init__(self, **kwargs): @@ -107,7 +107,7 @@ def __init__(self, **kwargs): def commit_id(self): """ **[Required]** Gets the commit_id of this RepositoryCommitSummary. - Commit hash pointed to by Ref name + Commit hash pointed to by reference name. :return: The commit_id of this RepositoryCommitSummary. @@ -119,7 +119,7 @@ def commit_id(self): def commit_id(self, commit_id): """ Sets the commit_id of this RepositoryCommitSummary. - Commit hash pointed to by Ref name + Commit hash pointed to by reference name. :param commit_id: The commit_id of this RepositoryCommitSummary. @@ -155,7 +155,7 @@ def commit_message(self, commit_message): def author_name(self): """ **[Required]** Gets the author_name of this RepositoryCommitSummary. - The name of the author of the repository. + Name of the author of the repository. :return: The author_name of this RepositoryCommitSummary. @@ -167,7 +167,7 @@ def author_name(self): def author_name(self, author_name): """ Sets the author_name of this RepositoryCommitSummary. - The name of the author of the repository. + Name of the author of the repository. :param author_name: The author_name of this RepositoryCommitSummary. @@ -179,7 +179,7 @@ def author_name(self, author_name): def author_email(self): """ **[Required]** Gets the author_email of this RepositoryCommitSummary. - The email of the author of the repository. + Email of the author of the repository. :return: The author_email of this RepositoryCommitSummary. @@ -191,7 +191,7 @@ def author_email(self): def author_email(self, author_email): """ Sets the author_email of this RepositoryCommitSummary. - The email of the author of the repository. + Email of the author of the repository. :param author_email: The author_email of this RepositoryCommitSummary. @@ -203,7 +203,7 @@ def author_email(self, author_email): def committer_name(self): """ **[Required]** Gets the committer_name of this RepositoryCommitSummary. - The name of who create the commit. + Name of who creates the commit. :return: The committer_name of this RepositoryCommitSummary. @@ -215,7 +215,7 @@ def committer_name(self): def committer_name(self, committer_name): """ Sets the committer_name of this RepositoryCommitSummary. - The name of who create the commit. + Name of who creates the commit. :param committer_name: The committer_name of this RepositoryCommitSummary. @@ -227,7 +227,7 @@ def committer_name(self, committer_name): def committer_email(self): """ **[Required]** Gets the committer_email of this RepositoryCommitSummary. - The email of who create the commit. + Email of who creates the commit. :return: The committer_email of this RepositoryCommitSummary. @@ -239,7 +239,7 @@ def committer_email(self): def committer_email(self, committer_email): """ Sets the committer_email of this RepositoryCommitSummary. - The email of who create the commit. + Email of who creates the commit. :param committer_email: The committer_email of this RepositoryCommitSummary. @@ -251,7 +251,7 @@ def committer_email(self, committer_email): def parent_commit_ids(self): """ **[Required]** Gets the parent_commit_ids of this RepositoryCommitSummary. - An array of parent commit ids of created commit. + An array of parent commit IDs of created commit. :return: The parent_commit_ids of this RepositoryCommitSummary. @@ -263,7 +263,7 @@ def parent_commit_ids(self): def parent_commit_ids(self, parent_commit_ids): """ Sets the parent_commit_ids of this RepositoryCommitSummary. - An array of parent commit ids of created commit. + An array of parent commit IDs of created commit. :param parent_commit_ids: The parent_commit_ids of this RepositoryCommitSummary. @@ -299,7 +299,7 @@ def time_created(self, time_created): def tree_id(self): """ **[Required]** Gets the tree_id of this RepositoryCommitSummary. - Tree information for the specified commit + Tree information for the specified commit. :return: The tree_id of this RepositoryCommitSummary. @@ -311,7 +311,7 @@ def tree_id(self): def tree_id(self, tree_id): """ Sets the tree_id of this RepositoryCommitSummary. - Tree information for the specified commit + Tree information for the specified commit. :param tree_id: The tree_id of this RepositoryCommitSummary. diff --git a/src/oci/devops/models/repository_file_lines.py b/src/oci/devops/models/repository_file_lines.py index fa06e2bbf0..6c5f45a834 100644 --- a/src/oci/devops/models/repository_file_lines.py +++ b/src/oci/devops/models/repository_file_lines.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryFileLines(object): """ - Object containing the lines of a file in a repository + Object containing the lines of a file in a repository. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def lines(self): """ **[Required]** Gets the lines of this RepositoryFileLines. - The list of lines in the file + The list of lines in the file. :return: The lines of this RepositoryFileLines. @@ -49,7 +49,7 @@ def lines(self): def lines(self, lines): """ Sets the lines of this RepositoryFileLines. - The list of lines in the file + The list of lines in the file. :param lines: The lines of this RepositoryFileLines. diff --git a/src/oci/devops/models/repository_mirror_record.py b/src/oci/devops/models/repository_mirror_record.py index 123be750c0..bd3f8a43c8 100644 --- a/src/oci/devops/models/repository_mirror_record.py +++ b/src/oci/devops/models/repository_mirror_record.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryMirrorRecord(object): """ - Object containing information about a mirror record + Object containing information about a mirror record. """ #: A constant which can be used with the mirror_status property of a RepositoryMirrorRecord. @@ -125,7 +125,7 @@ def mirror_status(self, mirror_status): def work_request_id(self): """ Gets the work_request_id of this RepositoryMirrorRecord. - Workrequest Id to track current mirror operation + Workrequest ID to track current mirror operation. :return: The work_request_id of this RepositoryMirrorRecord. @@ -137,7 +137,7 @@ def work_request_id(self): def work_request_id(self, work_request_id): """ Sets the work_request_id of this RepositoryMirrorRecord. - Workrequest Id to track current mirror operation + Workrequest ID to track current mirror operation. :param work_request_id: The work_request_id of this RepositoryMirrorRecord. @@ -197,7 +197,7 @@ def time_started(self, time_started): def time_ended(self): """ Gets the time_ended of this RepositoryMirrorRecord. - Time that the mirror operation ended or null if it hasn't yet ended. + The time taken to complete a mirror operation. Value is null if not completed. :return: The time_ended of this RepositoryMirrorRecord. @@ -209,7 +209,7 @@ def time_ended(self): def time_ended(self, time_ended): """ Sets the time_ended of this RepositoryMirrorRecord. - Time that the mirror operation ended or null if it hasn't yet ended. + The time taken to complete a mirror operation. Value is null if not completed. :param time_ended: The time_ended of this RepositoryMirrorRecord. diff --git a/src/oci/devops/models/repository_mirror_record_summary.py b/src/oci/devops/models/repository_mirror_record_summary.py index bd1b3ababd..686725d6b3 100644 --- a/src/oci/devops/models/repository_mirror_record_summary.py +++ b/src/oci/devops/models/repository_mirror_record_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryMirrorRecordSummary(object): """ - Object containing information about a mirror record + Object containing information about a mirror record. """ #: A constant which can be used with the mirror_status property of a RepositoryMirrorRecordSummary. @@ -139,7 +139,7 @@ def mirror_status(self, mirror_status): def work_request_id(self): """ Gets the work_request_id of this RepositoryMirrorRecordSummary. - Workrequest Id to track current mirror operation + Workrequest ID to track current mirror operation. :return: The work_request_id of this RepositoryMirrorRecordSummary. @@ -151,7 +151,7 @@ def work_request_id(self): def work_request_id(self, work_request_id): """ Sets the work_request_id of this RepositoryMirrorRecordSummary. - Workrequest Id to track current mirror operation + Workrequest ID to track current mirror operation. :param work_request_id: The work_request_id of this RepositoryMirrorRecordSummary. @@ -211,7 +211,7 @@ def time_started(self, time_started): def time_completed(self): """ Gets the time_completed of this RepositoryMirrorRecordSummary. - The time complete a mirror operation. + The time to complete a mirror operation. :return: The time_completed of this RepositoryMirrorRecordSummary. @@ -223,7 +223,7 @@ def time_completed(self): def time_completed(self, time_completed): """ Sets the time_completed of this RepositoryMirrorRecordSummary. - The time complete a mirror operation. + The time to complete a mirror operation. :param time_completed: The time_completed of this RepositoryMirrorRecordSummary. diff --git a/src/oci/devops/models/repository_object.py b/src/oci/devops/models/repository_object.py index 8fdf4e8ac7..98d49ef622 100644 --- a/src/oci/devops/models/repository_object.py +++ b/src/oci/devops/models/repository_object.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryObject(object): """ - Object containing information about files and directories in a repository + Object containing information about files and directories in a repository. """ #: A constant which can be used with the type property of a RepositoryObject. @@ -102,7 +102,7 @@ def type(self, type): def size_in_bytes(self): """ **[Required]** Gets the size_in_bytes of this RepositoryObject. - Size in Bytes + Size in bytes. :return: The size_in_bytes of this RepositoryObject. @@ -114,7 +114,7 @@ def size_in_bytes(self): def size_in_bytes(self, size_in_bytes): """ Sets the size_in_bytes of this RepositoryObject. - Size in Bytes + Size in bytes. :param size_in_bytes: The size_in_bytes of this RepositoryObject. @@ -126,7 +126,7 @@ def size_in_bytes(self, size_in_bytes): def sha(self): """ **[Required]** Gets the sha of this RepositoryObject. - SHA-1 hash of git object + SHA-1 hash of git object. :return: The sha of this RepositoryObject. @@ -138,7 +138,7 @@ def sha(self): def sha(self, sha): """ Sets the sha of this RepositoryObject. - SHA-1 hash of git object + SHA-1 hash of git object. :param sha: The sha of this RepositoryObject. @@ -150,7 +150,7 @@ def sha(self, sha): def is_binary(self): """ Gets the is_binary of this RepositoryObject. - flag to determine is the object contains binary file content or not. + Flag to determine if the object contains binary file content or not. :return: The is_binary of this RepositoryObject. @@ -162,7 +162,7 @@ def is_binary(self): def is_binary(self, is_binary): """ Sets the is_binary of this RepositoryObject. - flag to determine is the object contains binary file content or not. + Flag to determine if the object contains binary file content or not. :param is_binary: The is_binary of this RepositoryObject. diff --git a/src/oci/devops/models/repository_path_collection.py b/src/oci/devops/models/repository_path_collection.py index 5ce853912c..3ac44d3f1e 100644 --- a/src/oci/devops/models/repository_path_collection.py +++ b/src/oci/devops/models/repository_path_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryPathCollection(object): """ - Result of a List Paths in a repository + Result of list paths in a repository. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this RepositoryPathCollection. - List of objects describings files or directories in a repository. + List of objects describing files or directories in a repository. :return: The items of this RepositoryPathCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this RepositoryPathCollection. - List of objects describings files or directories in a repository. + List of objects describing files or directories in a repository. :param items: The items of this RepositoryPathCollection. diff --git a/src/oci/devops/models/repository_path_summary.py b/src/oci/devops/models/repository_path_summary.py index 1db2500e83..47fa97c774 100644 --- a/src/oci/devops/models/repository_path_summary.py +++ b/src/oci/devops/models/repository_path_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryPathSummary(object): """ - Object containing information about files and directories in a repository + Object containing information about files and directories in a repository. """ def __init__(self, **kwargs): @@ -86,7 +86,7 @@ def __init__(self, **kwargs): def type(self): """ Gets the type of this RepositoryPathSummary. - File or Directory + File or directory. :return: The type of this RepositoryPathSummary. @@ -98,7 +98,7 @@ def type(self): def type(self, type): """ Sets the type of this RepositoryPathSummary. - File or Directory + File or directory. :param type: The type of this RepositoryPathSummary. @@ -110,7 +110,7 @@ def type(self, type): def size_in_bytes(self): """ Gets the size_in_bytes of this RepositoryPathSummary. - Size of file or directory + Size of file or directory. :return: The size_in_bytes of this RepositoryPathSummary. @@ -122,7 +122,7 @@ def size_in_bytes(self): def size_in_bytes(self, size_in_bytes): """ Sets the size_in_bytes of this RepositoryPathSummary. - Size of file or directory + Size of file or directory. :param size_in_bytes: The size_in_bytes of this RepositoryPathSummary. @@ -134,7 +134,7 @@ def size_in_bytes(self, size_in_bytes): def name(self): """ Gets the name of this RepositoryPathSummary. - Name of file or directory + Name of file or directory. :return: The name of this RepositoryPathSummary. @@ -146,7 +146,7 @@ def name(self): def name(self, name): """ Sets the name of this RepositoryPathSummary. - Name of file or directory + Name of file or directory. :param name: The name of this RepositoryPathSummary. @@ -158,7 +158,7 @@ def name(self, name): def path(self): """ Gets the path of this RepositoryPathSummary. - Path to file or directory in a repository + Path to file or directory in a repository. :return: The path of this RepositoryPathSummary. @@ -170,7 +170,7 @@ def path(self): def path(self, path): """ Sets the path of this RepositoryPathSummary. - Path to file or directory in a repository + Path to file or directory in a repository. :param path: The path of this RepositoryPathSummary. @@ -182,7 +182,7 @@ def path(self, path): def sha(self): """ Gets the sha of this RepositoryPathSummary. - SHA-1 checksum of blob or tree + SHA-1 checksum of blob or tree. :return: The sha of this RepositoryPathSummary. @@ -194,7 +194,7 @@ def sha(self): def sha(self, sha): """ Sets the sha of this RepositoryPathSummary. - SHA-1 checksum of blob or tree + SHA-1 checksum of blob or tree. :param sha: The sha of this RepositoryPathSummary. @@ -206,7 +206,7 @@ def sha(self, sha): def submodule_git_url(self): """ Gets the submodule_git_url of this RepositoryPathSummary. - The giturl of the submodule + The git URL of the submodule. :return: The submodule_git_url of this RepositoryPathSummary. @@ -218,7 +218,7 @@ def submodule_git_url(self): def submodule_git_url(self, submodule_git_url): """ Sets the submodule_git_url of this RepositoryPathSummary. - The giturl of the submodule + The git URL of the submodule. :param submodule_git_url: The submodule_git_url of this RepositoryPathSummary. diff --git a/src/oci/devops/models/repository_ref.py b/src/oci/devops/models/repository_ref.py index 3d803f3ea8..afcff9b511 100644 --- a/src/oci/devops/models/repository_ref.py +++ b/src/oci/devops/models/repository_ref.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryRef(object): """ - Ref object with name and commitId + Reference object with name and commit ID. """ #: A constant which can be used with the ref_type property of a RepositoryRef. @@ -89,7 +89,7 @@ def get_subtype(object_dictionary): def ref_name(self): """ **[Required]** Gets the ref_name of this RepositoryRef. - Unique Ref name inside a repository + Unique reference name inside a repository. :return: The ref_name of this RepositoryRef. @@ -101,7 +101,7 @@ def ref_name(self): def ref_name(self, ref_name): """ Sets the ref_name of this RepositoryRef. - Unique Ref name inside a repository + Unique reference name inside a repository. :param ref_name: The ref_name of this RepositoryRef. @@ -113,7 +113,7 @@ def ref_name(self, ref_name): def ref_type(self): """ **[Required]** Gets the ref_type of this RepositoryRef. - The type of Ref (Branch or Tag) + The type of reference (Branch or Tag). Allowed values for this property are: "BRANCH", "TAG", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -128,7 +128,7 @@ def ref_type(self): def ref_type(self, ref_type): """ Sets the ref_type of this RepositoryRef. - The type of Ref (Branch or Tag) + The type of reference (Branch or Tag). :param ref_type: The ref_type of this RepositoryRef. @@ -143,7 +143,7 @@ def ref_type(self, ref_type): def full_ref_name(self): """ **[Required]** Gets the full_ref_name of this RepositoryRef. - Unique full ref name inside a repository + Unique full reference name inside a repository. :return: The full_ref_name of this RepositoryRef. @@ -155,7 +155,7 @@ def full_ref_name(self): def full_ref_name(self, full_ref_name): """ Sets the full_ref_name of this RepositoryRef. - Unique full ref name inside a repository + Unique full reference name inside a repository. :param full_ref_name: The full_ref_name of this RepositoryRef. @@ -167,7 +167,7 @@ def full_ref_name(self, full_ref_name): def repository_id(self): """ **[Required]** Gets the repository_id of this RepositoryRef. - The OCID of the repository containing the ref. + The OCID of the repository containing the reference. :return: The repository_id of this RepositoryRef. @@ -179,7 +179,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this RepositoryRef. - The OCID of the repository containing the ref. + The OCID of the repository containing the reference. :param repository_id: The repository_id of this RepositoryRef. diff --git a/src/oci/devops/models/repository_ref_collection.py b/src/oci/devops/models/repository_ref_collection.py index 6de21448b3..01650e954e 100644 --- a/src/oci/devops/models/repository_ref_collection.py +++ b/src/oci/devops/models/repository_ref_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryRefCollection(object): """ - Result of a Ref search. + Result of a reference search. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this RepositoryRefCollection. - List of Refs. + List of references. :return: The items of this RepositoryRefCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this RepositoryRefCollection. - List of Refs. + List of references. :param items: The items of this RepositoryRefCollection. diff --git a/src/oci/devops/models/repository_ref_summary.py b/src/oci/devops/models/repository_ref_summary.py index 0acef2fb8c..b6a6c08a96 100644 --- a/src/oci/devops/models/repository_ref_summary.py +++ b/src/oci/devops/models/repository_ref_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryRefSummary(object): """ - Summary of a Ref + Summary of a reference. """ def __init__(self, **kwargs): @@ -93,7 +93,7 @@ def get_subtype(object_dictionary): def ref_name(self): """ **[Required]** Gets the ref_name of this RepositoryRefSummary. - Ref name inside a repository + Reference name inside a repository. :return: The ref_name of this RepositoryRefSummary. @@ -105,7 +105,7 @@ def ref_name(self): def ref_name(self, ref_name): """ Sets the ref_name of this RepositoryRefSummary. - Ref name inside a repository + Reference name inside a repository. :param ref_name: The ref_name of this RepositoryRefSummary. @@ -117,7 +117,7 @@ def ref_name(self, ref_name): def ref_type(self): """ **[Required]** Gets the ref_type of this RepositoryRefSummary. - Type of Ref. Branch or Tag. + The type of reference (Branch or Tag). :return: The ref_type of this RepositoryRefSummary. @@ -129,7 +129,7 @@ def ref_type(self): def ref_type(self, ref_type): """ Sets the ref_type of this RepositoryRefSummary. - Type of Ref. Branch or Tag. + The type of reference (Branch or Tag). :param ref_type: The ref_type of this RepositoryRefSummary. @@ -141,7 +141,7 @@ def ref_type(self, ref_type): def full_ref_name(self): """ **[Required]** Gets the full_ref_name of this RepositoryRefSummary. - Unique full ref name inside a repository + Unique full reference name inside a repository. :return: The full_ref_name of this RepositoryRefSummary. @@ -153,7 +153,7 @@ def full_ref_name(self): def full_ref_name(self, full_ref_name): """ Sets the full_ref_name of this RepositoryRefSummary. - Unique full ref name inside a repository + Unique full reference name inside a repository. :param full_ref_name: The full_ref_name of this RepositoryRefSummary. @@ -165,7 +165,7 @@ def full_ref_name(self, full_ref_name): def repository_id(self): """ **[Required]** Gets the repository_id of this RepositoryRefSummary. - The OCID of the repository containing the ref. + The OCID of the repository containing the reference. :return: The repository_id of this RepositoryRefSummary. @@ -177,7 +177,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this RepositoryRefSummary. - The OCID of the repository containing the ref. + The OCID of the repository containing the reference. :param repository_id: The repository_id of this RepositoryRefSummary. diff --git a/src/oci/devops/models/repository_summary.py b/src/oci/devops/models/repository_summary.py index ce5559114a..e021b6e61f 100644 --- a/src/oci/devops/models/repository_summary.py +++ b/src/oci/devops/models/repository_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositorySummary(object): """ - Summary of the Repository. + Summary of the repository. """ def __init__(self, **kwargs): @@ -211,7 +211,7 @@ def name(self, name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this RepositorySummary. - The OCID of the repository's Compartment. + The OCID of the repository's compartment. :return: The compartment_id of this RepositorySummary. @@ -223,7 +223,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this RepositorySummary. - The OCID of the repository's Compartment. + The OCID of the repository's compartment. :param compartment_id: The compartment_id of this RepositorySummary. @@ -235,7 +235,7 @@ def compartment_id(self, compartment_id): def project_id(self): """ **[Required]** Gets the project_id of this RepositorySummary. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :return: The project_id of this RepositorySummary. @@ -247,7 +247,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this RepositorySummary. - The OCID of the Project containing the repository. + The OCID of the DevOps project containing the repository. :param project_id: The project_id of this RepositorySummary. @@ -259,7 +259,7 @@ def project_id(self, project_id): def namespace(self): """ Gets the namespace of this RepositorySummary. - Tenancy unique namespace. This value is fetched from Project Service + Tenancy unique namespace. :return: The namespace of this RepositorySummary. @@ -271,7 +271,7 @@ def namespace(self): def namespace(self, namespace): """ Sets the namespace of this RepositorySummary. - Tenancy unique namespace. This value is fetched from Project Service + Tenancy unique namespace. :param namespace: The namespace of this RepositorySummary. @@ -283,7 +283,7 @@ def namespace(self, namespace): def project_name(self): """ Gets the project_name of this RepositorySummary. - Unique name of a project in a namespace. This value is fetched from Project Service + Unique project name in a namespace. :return: The project_name of this RepositorySummary. @@ -295,7 +295,7 @@ def project_name(self): def project_name(self, project_name): """ Sets the project_name of this RepositorySummary. - Unique name of a project in a namespace. This value is fetched from Project Service + Unique project name in a namespace. :param project_name: The project_name of this RepositorySummary. @@ -307,7 +307,7 @@ def project_name(self, project_name): def description(self): """ Gets the description of this RepositorySummary. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :return: The description of this RepositorySummary. @@ -319,7 +319,7 @@ def description(self): def description(self, description): """ Sets the description of this RepositorySummary. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :param description: The description of this RepositorySummary. @@ -331,7 +331,7 @@ def description(self, description): def default_branch(self): """ Gets the default_branch of this RepositorySummary. - The default branch of the repository + The default branch of the repository. :return: The default_branch of this RepositorySummary. @@ -343,7 +343,7 @@ def default_branch(self): def default_branch(self, default_branch): """ Sets the default_branch of this RepositorySummary. - The default branch of the repository + The default branch of the repository. :param default_branch: The default_branch of this RepositorySummary. @@ -355,7 +355,7 @@ def default_branch(self, default_branch): def repository_type(self): """ Gets the repository_type of this RepositorySummary. - Type of repository + Type of repository. :return: The repository_type of this RepositorySummary. @@ -367,7 +367,7 @@ def repository_type(self): def repository_type(self, repository_type): """ Sets the repository_type of this RepositorySummary. - Type of repository + Type of repository. :param repository_type: The repository_type of this RepositorySummary. @@ -379,7 +379,7 @@ def repository_type(self, repository_type): def ssh_url(self): """ Gets the ssh_url of this RepositorySummary. - ssh url user utilized to git clone, pull and push + SSH URL that you use to git clone, pull and push. :return: The ssh_url of this RepositorySummary. @@ -391,7 +391,7 @@ def ssh_url(self): def ssh_url(self, ssh_url): """ Sets the ssh_url of this RepositorySummary. - ssh url user utilized to git clone, pull and push + SSH URL that you use to git clone, pull and push. :param ssh_url: The ssh_url of this RepositorySummary. @@ -403,7 +403,7 @@ def ssh_url(self, ssh_url): def http_url(self): """ Gets the http_url of this RepositorySummary. - http url user utilized to git clone, pull and push + HTTP URL that you use to git clone, pull and push. :return: The http_url of this RepositorySummary. @@ -415,7 +415,7 @@ def http_url(self): def http_url(self, http_url): """ Sets the http_url of this RepositorySummary. - http url user utilized to git clone, pull and push + HTTP URL that you use to git clone, pull and push. :param http_url: The http_url of this RepositorySummary. @@ -447,7 +447,9 @@ def mirror_repository_config(self, mirror_repository_config): def time_created(self): """ Gets the time_created of this RepositorySummary. - The time the the Repository was created. An RFC3339 formatted datetime string + The time the repository was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this RepositorySummary. @@ -459,7 +461,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this RepositorySummary. - The time the the Repository was created. An RFC3339 formatted datetime string + The time the repository was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this RepositorySummary. @@ -471,7 +475,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this RepositorySummary. - The time the Repository was updated. An RFC3339 formatted datetime string + The time the repository was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this RepositorySummary. @@ -483,7 +489,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this RepositorySummary. - The time the Repository was updated. An RFC3339 formatted datetime string + The time the repository was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this RepositorySummary. @@ -495,7 +503,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this RepositorySummary. - The current state of the Repository. + The current state of the repository. :return: The lifecycle_state of this RepositorySummary. @@ -507,7 +515,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this RepositorySummary. - The current state of the Repository. + The current state of the repository. :param lifecycle_state: The lifecycle_state of this RepositorySummary. diff --git a/src/oci/devops/models/repository_tag.py b/src/oci/devops/models/repository_tag.py index 9c6f025284..9371b511ef 100644 --- a/src/oci/devops/models/repository_tag.py +++ b/src/oci/devops/models/repository_tag.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryTag(RepositoryRef): """ - The information needed to create a lightweight Tag + The information needed to create a lightweight tag. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/repository_tag_summary.py b/src/oci/devops/models/repository_tag_summary.py index 1661b52ab3..dcc27f8804 100644 --- a/src/oci/devops/models/repository_tag_summary.py +++ b/src/oci/devops/models/repository_tag_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RepositoryTagSummary(RepositoryRefSummary): """ - The information needed to create a lightweight Tag + The information needed to create a lightweight tag. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/trigger.py b/src/oci/devops/models/trigger.py index c4f98d2315..728364c4e8 100644 --- a/src/oci/devops/models/trigger.py +++ b/src/oci/devops/models/trigger.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Trigger(object): """ - Description of Trigger. + Trigger the deployment pipeline to deploy the artifact. """ #: A constant which can be used with the trigger_source property of a Trigger. @@ -173,7 +173,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this Trigger. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this Trigger. @@ -185,7 +185,7 @@ def id(self): def id(self, id): """ Sets the id of this Trigger. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this Trigger. @@ -197,7 +197,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this Trigger. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :return: The display_name of this Trigger. @@ -209,7 +209,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Trigger. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :param display_name: The display_name of this Trigger. @@ -221,7 +221,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this Trigger. - Description about the Trigger + Description about the trigger. :return: The description of this Trigger. @@ -233,7 +233,7 @@ def description(self): def description(self, description): """ Sets the description of this Trigger. - Description about the Trigger + Description about the trigger. :param description: The description of this Trigger. @@ -245,7 +245,7 @@ def description(self, description): def project_id(self): """ **[Required]** Gets the project_id of this Trigger. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :return: The project_id of this Trigger. @@ -257,7 +257,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this Trigger. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :param project_id: The project_id of this Trigger. @@ -269,7 +269,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Trigger. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :return: The compartment_id of this Trigger. @@ -281,7 +281,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Trigger. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :param compartment_id: The compartment_id of this Trigger. @@ -293,7 +293,7 @@ def compartment_id(self, compartment_id): def trigger_source(self): """ **[Required]** Gets the trigger_source of this Trigger. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB, GITLAB and DEVOPS_CODE_REPOSITORY. Allowed values for this property are: "GITHUB", "GITLAB", "DEVOPS_CODE_REPOSITORY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -308,7 +308,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this Trigger. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB, GITLAB and DEVOPS_CODE_REPOSITORY. :param trigger_source: The trigger_source of this Trigger. @@ -323,7 +323,9 @@ def trigger_source(self, trigger_source): def time_created(self): """ Gets the time_created of this Trigger. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this Trigger. @@ -335,7 +337,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this Trigger. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this Trigger. @@ -347,7 +351,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this Trigger. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this Trigger. @@ -359,7 +365,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this Trigger. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this Trigger. @@ -371,7 +379,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this Trigger. - The current state of the Trigger. + The current state of the trigger. Allowed values for this property are: "ACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -386,7 +394,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this Trigger. - The current state of the Trigger. + The current state of the trigger. :param lifecycle_state: The lifecycle_state of this Trigger. @@ -425,7 +433,7 @@ def lifecycle_details(self, lifecycle_details): def actions(self): """ **[Required]** Gets the actions of this Trigger. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :return: The actions of this Trigger. @@ -437,7 +445,7 @@ def actions(self): def actions(self, actions): """ Sets the actions of this Trigger. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :param actions: The actions of this Trigger. diff --git a/src/oci/devops/models/trigger_action.py b/src/oci/devops/models/trigger_action.py index 9a6134a0b7..f02895c5be 100644 --- a/src/oci/devops/models/trigger_action.py +++ b/src/oci/devops/models/trigger_action.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerAction(object): """ - The action to be performed + The trigger action to be performed. """ #: A constant which can be used with the type property of a TriggerAction. @@ -67,7 +67,7 @@ def get_subtype(object_dictionary): def type(self): """ **[Required]** Gets the type of this TriggerAction. - The type of action that will be taken (allowed value - TRIGGER_BUILD_PIPELINE) + The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. Allowed values for this property are: "TRIGGER_BUILD_PIPELINE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -82,7 +82,7 @@ def type(self): def type(self, type): """ Sets the type of this TriggerAction. - The type of action that will be taken (allowed value - TRIGGER_BUILD_PIPELINE) + The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. :param type: The type of this TriggerAction. diff --git a/src/oci/devops/models/trigger_build_pipeline_action.py b/src/oci/devops/models/trigger_build_pipeline_action.py index b171f880c1..68d7286e7d 100644 --- a/src/oci/devops/models/trigger_build_pipeline_action.py +++ b/src/oci/devops/models/trigger_build_pipeline_action.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerBuildPipelineAction(TriggerAction): """ - The action to trigger a build pipeline + The action to trigger a build pipeline. """ def __init__(self, **kwargs): @@ -54,7 +54,7 @@ def __init__(self, **kwargs): def build_pipeline_id(self): """ **[Required]** Gets the build_pipeline_id of this TriggerBuildPipelineAction. - The id of the build pipeline to be triggered + The OCID of the build pipeline to be triggered. :return: The build_pipeline_id of this TriggerBuildPipelineAction. @@ -66,7 +66,7 @@ def build_pipeline_id(self): def build_pipeline_id(self, build_pipeline_id): """ Sets the build_pipeline_id of this TriggerBuildPipelineAction. - The id of the build pipeline to be triggered + The OCID of the build pipeline to be triggered. :param build_pipeline_id: The build_pipeline_id of this TriggerBuildPipelineAction. diff --git a/src/oci/devops/models/trigger_collection.py b/src/oci/devops/models/trigger_collection.py index 04c3636c59..e023984560 100644 --- a/src/oci/devops/models/trigger_collection.py +++ b/src/oci/devops/models/trigger_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerCollection(object): """ - Results of a trigger search. Contains boh TriggerSummary items and other information, such as metadata. + Results of a trigger search. Contains boh trigger summary items and other information such as metadata. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/trigger_create_result.py b/src/oci/devops/models/trigger_create_result.py index 449d5989cd..78276e9454 100644 --- a/src/oci/devops/models/trigger_create_result.py +++ b/src/oci/devops/models/trigger_create_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerCreateResult(object): """ - Description of Trigger Create response. + Details of the trigger create response. """ def __init__(self, **kwargs): @@ -153,7 +153,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this TriggerCreateResult. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this TriggerCreateResult. @@ -165,7 +165,7 @@ def id(self): def id(self, id): """ Sets the id of this TriggerCreateResult. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this TriggerCreateResult. @@ -177,7 +177,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this TriggerCreateResult. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :return: The display_name of this TriggerCreateResult. @@ -189,7 +189,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TriggerCreateResult. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :param display_name: The display_name of this TriggerCreateResult. @@ -201,7 +201,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this TriggerCreateResult. - Description about the Trigger + Description about the trigger. :return: The description of this TriggerCreateResult. @@ -213,7 +213,7 @@ def description(self): def description(self, description): """ Sets the description of this TriggerCreateResult. - Description about the Trigger + Description about the trigger. :param description: The description of this TriggerCreateResult. @@ -225,7 +225,7 @@ def description(self, description): def project_id(self): """ **[Required]** Gets the project_id of this TriggerCreateResult. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :return: The project_id of this TriggerCreateResult. @@ -237,7 +237,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this TriggerCreateResult. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :param project_id: The project_id of this TriggerCreateResult. @@ -249,7 +249,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this TriggerCreateResult. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :return: The compartment_id of this TriggerCreateResult. @@ -261,7 +261,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this TriggerCreateResult. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :param compartment_id: The compartment_id of this TriggerCreateResult. @@ -273,7 +273,7 @@ def compartment_id(self, compartment_id): def trigger_source(self): """ **[Required]** Gets the trigger_source of this TriggerCreateResult. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :return: The trigger_source of this TriggerCreateResult. @@ -285,7 +285,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this TriggerCreateResult. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :param trigger_source: The trigger_source of this TriggerCreateResult. @@ -297,7 +297,9 @@ def trigger_source(self, trigger_source): def time_created(self): """ Gets the time_created of this TriggerCreateResult. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this TriggerCreateResult. @@ -309,7 +311,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this TriggerCreateResult. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this TriggerCreateResult. @@ -321,7 +325,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this TriggerCreateResult. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this TriggerCreateResult. @@ -333,7 +339,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this TriggerCreateResult. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this TriggerCreateResult. @@ -345,7 +353,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this TriggerCreateResult. - The current state of the Trigger. + The current state of the trigger. :return: The lifecycle_state of this TriggerCreateResult. @@ -357,7 +365,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this TriggerCreateResult. - The current state of the Trigger. + The current state of the trigger. :param lifecycle_state: The lifecycle_state of this TriggerCreateResult. @@ -393,7 +401,7 @@ def lifecycle_details(self, lifecycle_details): def actions(self): """ **[Required]** Gets the actions of this TriggerCreateResult. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :return: The actions of this TriggerCreateResult. @@ -405,7 +413,7 @@ def actions(self): def actions(self, actions): """ Sets the actions of this TriggerCreateResult. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :param actions: The actions of this TriggerCreateResult. diff --git a/src/oci/devops/models/trigger_deployment_pipeline_stage_run_progress.py b/src/oci/devops/models/trigger_deployment_pipeline_stage_run_progress.py index 5ad233da0c..348877256f 100644 --- a/src/oci/devops/models/trigger_deployment_pipeline_stage_run_progress.py +++ b/src/oci/devops/models/trigger_deployment_pipeline_stage_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerDeploymentPipelineStageRunProgress(BuildPipelineStageRunProgress): """ - Specifies Trigger Deployment Pipleline stage specific exeution details. + Specifies Trigger Deployment Pipleline stage specific run details. """ def __init__(self, **kwargs): @@ -143,7 +143,7 @@ def artifact_override_parameters(self, artifact_override_parameters): def deployment_id(self): """ Gets the deployment_id of this TriggerDeploymentPipelineStageRunProgress. - Identifier of the Deployment Trigerred. + Identifier of the deployment triggered. :return: The deployment_id of this TriggerDeploymentPipelineStageRunProgress. @@ -155,7 +155,7 @@ def deployment_id(self): def deployment_id(self, deployment_id): """ Sets the deployment_id of this TriggerDeploymentPipelineStageRunProgress. - Identifier of the Deployment Trigerred. + Identifier of the deployment triggered. :param deployment_id: The deployment_id of this TriggerDeploymentPipelineStageRunProgress. diff --git a/src/oci/devops/models/trigger_deployment_stage.py b/src/oci/devops/models/trigger_deployment_stage.py index dc970ce351..4ccc2bb364 100644 --- a/src/oci/devops/models/trigger_deployment_stage.py +++ b/src/oci/devops/models/trigger_deployment_stage.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerDeploymentStage(BuildPipelineStage): """ - Specifies Trigger Deployment Pipleline stage which runs another pipeline of the application. + Specifies the Trigger Deployment stage, which runs another pipeline of the application. """ def __init__(self, **kwargs): @@ -153,7 +153,7 @@ def __init__(self, **kwargs): def deploy_pipeline_id(self): """ **[Required]** Gets the deploy_pipeline_id of this TriggerDeploymentStage. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :return: The deploy_pipeline_id of this TriggerDeploymentStage. @@ -165,7 +165,7 @@ def deploy_pipeline_id(self): def deploy_pipeline_id(self, deploy_pipeline_id): """ Sets the deploy_pipeline_id of this TriggerDeploymentStage. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :param deploy_pipeline_id: The deploy_pipeline_id of this TriggerDeploymentStage. @@ -177,7 +177,7 @@ def deploy_pipeline_id(self, deploy_pipeline_id): def is_pass_all_parameters_enabled(self): """ **[Required]** Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStage. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :return: The is_pass_all_parameters_enabled of this TriggerDeploymentStage. @@ -189,7 +189,7 @@ def is_pass_all_parameters_enabled(self): def is_pass_all_parameters_enabled(self, is_pass_all_parameters_enabled): """ Sets the is_pass_all_parameters_enabled of this TriggerDeploymentStage. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :param is_pass_all_parameters_enabled: The is_pass_all_parameters_enabled of this TriggerDeploymentStage. diff --git a/src/oci/devops/models/trigger_deployment_stage_summary.py b/src/oci/devops/models/trigger_deployment_stage_summary.py index 1ad84d0319..0dcd495bf7 100644 --- a/src/oci/devops/models/trigger_deployment_stage_summary.py +++ b/src/oci/devops/models/trigger_deployment_stage_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerDeploymentStageSummary(BuildPipelineStageSummary): """ - Specifies Trigger Deployment Pipleline stage which runs another pipeline of the application. + Specifies the Trigger Deployment stage, which runs another pipeline of the application. """ def __init__(self, **kwargs): @@ -151,7 +151,7 @@ def __init__(self, **kwargs): def deploy_pipeline_id(self): """ **[Required]** Gets the deploy_pipeline_id of this TriggerDeploymentStageSummary. - A target deploy Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :return: The deploy_pipeline_id of this TriggerDeploymentStageSummary. @@ -163,7 +163,7 @@ def deploy_pipeline_id(self): def deploy_pipeline_id(self, deploy_pipeline_id): """ Sets the deploy_pipeline_id of this TriggerDeploymentStageSummary. - A target deploy Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :param deploy_pipeline_id: The deploy_pipeline_id of this TriggerDeploymentStageSummary. @@ -175,7 +175,7 @@ def deploy_pipeline_id(self, deploy_pipeline_id): def is_pass_all_parameters_enabled(self): """ **[Required]** Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :return: The is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. @@ -187,7 +187,7 @@ def is_pass_all_parameters_enabled(self): def is_pass_all_parameters_enabled(self, is_pass_all_parameters_enabled): """ Sets the is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :param is_pass_all_parameters_enabled: The is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. diff --git a/src/oci/devops/models/trigger_schedule.py b/src/oci/devops/models/trigger_schedule.py index a8776ba3d2..ac537dc817 100644 --- a/src/oci/devops/models/trigger_schedule.py +++ b/src/oci/devops/models/trigger_schedule.py @@ -58,10 +58,10 @@ def __init__(self, **kwargs): def schedule_type(self): """ **[Required]** Gets the schedule_type of this TriggerSchedule. - Different types to trigger schedule - - NONE - No automated sync schedule. - - DEFAULT - Trigger Schedule will be every 30 minutes. - - CUSTOM - Custom triggering schedule. + Different types of trigger schedule: + None - No automated synchronization schedule. + Default - Trigger schedule is every 30 minutes. + Custom - Custom triggering schedule. Allowed values for this property are: "NONE", "DEFAULT", "CUSTOM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -76,10 +76,10 @@ def schedule_type(self): def schedule_type(self, schedule_type): """ Sets the schedule_type of this TriggerSchedule. - Different types to trigger schedule - - NONE - No automated sync schedule. - - DEFAULT - Trigger Schedule will be every 30 minutes. - - CUSTOM - Custom triggering schedule. + Different types of trigger schedule: + None - No automated synchronization schedule. + Default - Trigger schedule is every 30 minutes. + Custom - Custom triggering schedule. :param schedule_type: The schedule_type of this TriggerSchedule. @@ -95,8 +95,8 @@ def custom_schedule(self): """ Gets the custom_schedule of this TriggerSchedule. Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. - Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window, we can - control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. + Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. + You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. :return: The custom_schedule of this TriggerSchedule. @@ -109,8 +109,8 @@ def custom_schedule(self, custom_schedule): """ Sets the custom_schedule of this TriggerSchedule. Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. - Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window, we can - control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. + Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. + You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. :param custom_schedule: The custom_schedule of this TriggerSchedule. diff --git a/src/oci/devops/models/trigger_summary.py b/src/oci/devops/models/trigger_summary.py index 9c4ac113c8..ca1091b41c 100644 --- a/src/oci/devops/models/trigger_summary.py +++ b/src/oci/devops/models/trigger_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TriggerSummary(object): """ - Summary of the Trigger. + Summary of the trigger. """ def __init__(self, **kwargs): @@ -146,7 +146,7 @@ def get_subtype(object_dictionary): def id(self): """ **[Required]** Gets the id of this TriggerSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this TriggerSummary. @@ -158,7 +158,7 @@ def id(self): def id(self, id): """ Sets the id of this TriggerSummary. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this TriggerSummary. @@ -170,7 +170,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this TriggerSummary. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :return: The display_name of this TriggerSummary. @@ -182,7 +182,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TriggerSummary. - Name for Trigger. + Trigger display name. Avoid entering confidential information. :param display_name: The display_name of this TriggerSummary. @@ -194,7 +194,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this TriggerSummary. - Description about the Trigger + Description about the trigger. :return: The description of this TriggerSummary. @@ -206,7 +206,7 @@ def description(self): def description(self, description): """ Sets the description of this TriggerSummary. - Description about the Trigger + Description about the trigger. :param description: The description of this TriggerSummary. @@ -218,7 +218,7 @@ def description(self, description): def project_id(self): """ **[Required]** Gets the project_id of this TriggerSummary. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :return: The project_id of this TriggerSummary. @@ -230,7 +230,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this TriggerSummary. - Project to which the Trigger belongs + The OCID of the DevOps project to which the trigger belongs to. :param project_id: The project_id of this TriggerSummary. @@ -242,7 +242,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this TriggerSummary. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :return: The compartment_id of this TriggerSummary. @@ -254,7 +254,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this TriggerSummary. - Compartment to which the Trigger belongs + The OCID of the compartment that contains the trigger. :param compartment_id: The compartment_id of this TriggerSummary. @@ -266,7 +266,7 @@ def compartment_id(self, compartment_id): def trigger_source(self): """ **[Required]** Gets the trigger_source of this TriggerSummary. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :return: The trigger_source of this TriggerSummary. @@ -278,7 +278,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this TriggerSummary. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :param trigger_source: The trigger_source of this TriggerSummary. @@ -290,7 +290,9 @@ def trigger_source(self, trigger_source): def time_created(self): """ Gets the time_created of this TriggerSummary. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_created of this TriggerSummary. @@ -302,7 +304,9 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this TriggerSummary. - The time the the Trigger was created. An RFC3339 formatted datetime string + The time the trigger was created. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_created: The time_created of this TriggerSummary. @@ -314,7 +318,9 @@ def time_created(self, time_created): def time_updated(self): """ Gets the time_updated of this TriggerSummary. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :return: The time_updated of this TriggerSummary. @@ -326,7 +332,9 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this TriggerSummary. - The time the Trigger was updated. An RFC3339 formatted datetime string + The time the trigger was updated. Format defined by `RFC3339`__. + + __ https://datatracker.ietf.org/doc/html/rfc3339 :param time_updated: The time_updated of this TriggerSummary. @@ -338,7 +346,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ Gets the lifecycle_state of this TriggerSummary. - The current state of the Trigger. + The current state of the trigger. :return: The lifecycle_state of this TriggerSummary. @@ -350,7 +358,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this TriggerSummary. - The current state of the Trigger. + The current state of the trigger. :param lifecycle_state: The lifecycle_state of this TriggerSummary. diff --git a/src/oci/devops/models/update_absolute_wait_criteria_details.py b/src/oci/devops/models/update_absolute_wait_criteria_details.py index db12c03abc..aba60f2398 100644 --- a/src/oci/devops/models/update_absolute_wait_criteria_details.py +++ b/src/oci/devops/models/update_absolute_wait_criteria_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateAbsoluteWaitCriteriaDetails(UpdateWaitCriteriaDetails): """ - Specifies the absolute wait criteria, user can specify fixed length of wait duration. + Specifies the absolute wait criteria. You can specify fixed length of wait duration. """ def __init__(self, **kwargs): @@ -48,8 +48,8 @@ def wait_duration(self): """ Gets the wait_duration of this UpdateAbsoluteWaitCriteriaDetails. The absolute wait duration. - Minimum waitDuration should be 5 seconds. - Maximum waitDuration can be up to 2 days. + Minimum wait duration must be 5 seconds. + Maximum wait duration can be up to 2 days. :return: The wait_duration of this UpdateAbsoluteWaitCriteriaDetails. @@ -62,8 +62,8 @@ def wait_duration(self, wait_duration): """ Sets the wait_duration of this UpdateAbsoluteWaitCriteriaDetails. The absolute wait duration. - Minimum waitDuration should be 5 seconds. - Maximum waitDuration can be up to 2 days. + Minimum wait duration must be 5 seconds. + Maximum wait duration can be up to 2 days. :param wait_duration: The wait_duration of this UpdateAbsoluteWaitCriteriaDetails. diff --git a/src/oci/devops/models/update_build_pipeline_details.py b/src/oci/devops/models/update_build_pipeline_details.py index 1440b644b4..dab67aa7ae 100644 --- a/src/oci/devops/models/update_build_pipeline_details.py +++ b/src/oci/devops/models/update_build_pipeline_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateBuildPipelineDetails(object): """ - The information to be updated for the given BuildPipeline. + The information to be updated for the given build pipeline. """ def __init__(self, **kwargs): @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def description(self): """ Gets the description of this UpdateBuildPipelineDetails. - Optional description about the BuildPipeline + Optional description about the build pipeline. :return: The description of this UpdateBuildPipelineDetails. @@ -77,7 +77,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateBuildPipelineDetails. - Optional description about the BuildPipeline + Optional description about the build pipeline. :param description: The description of this UpdateBuildPipelineDetails. @@ -89,7 +89,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateBuildPipelineDetails. - BuildPipeline display name + Build pipeline display name. Avoid entering confidential information. :return: The display_name of this UpdateBuildPipelineDetails. @@ -101,7 +101,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateBuildPipelineDetails. - BuildPipeline display name + Build pipeline display name. Avoid entering confidential information. :param display_name: The display_name of this UpdateBuildPipelineDetails. diff --git a/src/oci/devops/models/update_build_pipeline_stage_details.py b/src/oci/devops/models/update_build_pipeline_stage_details.py index d8c1e458a0..9e0836491e 100644 --- a/src/oci/devops/models/update_build_pipeline_stage_details.py +++ b/src/oci/devops/models/update_build_pipeline_stage_details.py @@ -101,7 +101,7 @@ def get_subtype(object_dictionary): def display_name(self): """ Gets the display_name of this UpdateBuildPipelineStageDetails. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :return: The display_name of this UpdateBuildPipelineStageDetails. @@ -113,7 +113,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateBuildPipelineStageDetails. - Stage identifier which can be renamed and is not necessarily unique + Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. :param display_name: The display_name of this UpdateBuildPipelineStageDetails. @@ -125,7 +125,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateBuildPipelineStageDetails. - Optional description about the BuildStage + Optional description about the build stage. :return: The description of this UpdateBuildPipelineStageDetails. @@ -137,7 +137,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateBuildPipelineStageDetails. - Optional description about the BuildStage + Optional description about the build stage. :param description: The description of this UpdateBuildPipelineStageDetails. @@ -149,7 +149,7 @@ def description(self, description): def build_pipeline_stage_type(self): """ **[Required]** Gets the build_pipeline_stage_type of this UpdateBuildPipelineStageDetails. - Stage sub types. + Stage types. :return: The build_pipeline_stage_type of this UpdateBuildPipelineStageDetails. @@ -161,7 +161,7 @@ def build_pipeline_stage_type(self): def build_pipeline_stage_type(self, build_pipeline_stage_type): """ Sets the build_pipeline_stage_type of this UpdateBuildPipelineStageDetails. - Stage sub types. + Stage types. :param build_pipeline_stage_type: The build_pipeline_stage_type of this UpdateBuildPipelineStageDetails. diff --git a/src/oci/devops/models/update_build_run_details.py b/src/oci/devops/models/update_build_run_details.py index bd3525c676..76f5549a85 100644 --- a/src/oci/devops/models/update_build_run_details.py +++ b/src/oci/devops/models/update_build_run_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateBuildRunDetails(object): """ - The build Run information to be updated. + The build run information to be updated. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateBuildRunDetails. - BuildRun display name + Build run display name. Avoid entering confidential information. :return: The display_name of this UpdateBuildRunDetails. @@ -63,7 +63,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateBuildRunDetails. - BuildRun display name + Build run display name. Avoid entering confidential information. :param display_name: The display_name of this UpdateBuildRunDetails. diff --git a/src/oci/devops/models/update_build_stage_details.py b/src/oci/devops/models/update_build_stage_details.py index 2d14ceca5f..a615d377d0 100644 --- a/src/oci/devops/models/update_build_stage_details.py +++ b/src/oci/devops/models/update_build_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateBuildStageDetails(UpdateBuildPipelineStageDetails): """ - Specifies the Build Stage. + Specifies the build stage. """ def __init__(self, **kwargs): @@ -109,7 +109,7 @@ def __init__(self, **kwargs): def image(self): """ Gets the image of this UpdateBuildStageDetails. - Image name for the Build Environment + Image name for the build environment. :return: The image of this UpdateBuildStageDetails. @@ -121,7 +121,7 @@ def image(self): def image(self, image): """ Sets the image of this UpdateBuildStageDetails. - Image name for the Build Environment + Image name for the build environment. :param image: The image of this UpdateBuildStageDetails. @@ -133,7 +133,7 @@ def image(self, image): def build_spec_file(self): """ Gets the build_spec_file of this UpdateBuildStageDetails. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :return: The build_spec_file of this UpdateBuildStageDetails. @@ -145,7 +145,7 @@ def build_spec_file(self): def build_spec_file(self, build_spec_file): """ Sets the build_spec_file of this UpdateBuildStageDetails. - The path to the build specification file for this Environment. The default location if not specified is build_spec.yaml + The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. :param build_spec_file: The build_spec_file of this UpdateBuildStageDetails. @@ -157,7 +157,7 @@ def build_spec_file(self, build_spec_file): def stage_execution_timeout_in_seconds(self): """ Gets the stage_execution_timeout_in_seconds of this UpdateBuildStageDetails. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :return: The stage_execution_timeout_in_seconds of this UpdateBuildStageDetails. @@ -169,7 +169,7 @@ def stage_execution_timeout_in_seconds(self): def stage_execution_timeout_in_seconds(self, stage_execution_timeout_in_seconds): """ Sets the stage_execution_timeout_in_seconds of this UpdateBuildStageDetails. - Timeout for the Build Stage Execution. Value in seconds. + Timeout for the build stage execution. Specify value in seconds. :param stage_execution_timeout_in_seconds: The stage_execution_timeout_in_seconds of this UpdateBuildStageDetails. @@ -201,7 +201,7 @@ def build_source_collection(self, build_source_collection): def primary_build_source(self): """ Gets the primary_build_source of this UpdateBuildStageDetails. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :return: The primary_build_source of this UpdateBuildStageDetails. @@ -213,7 +213,7 @@ def primary_build_source(self): def primary_build_source(self, primary_build_source): """ Sets the primary_build_source of this UpdateBuildStageDetails. - Name of the BuildSource in which the build_spec.yml file need to be located. If not specified, the 1st entry in the BuildSource collection will be chosen as Primary. + Name of the build source where the build_spec.yml file is located. If not specified, the first entry in the build source collection is chosen as primary build source. :param primary_build_source: The primary_build_source of this UpdateBuildStageDetails. diff --git a/src/oci/devops/models/update_connection_details.py b/src/oci/devops/models/update_connection_details.py index 894a25bfc1..ba6a2e35c7 100644 --- a/src/oci/devops/models/update_connection_details.py +++ b/src/oci/devops/models/update_connection_details.py @@ -86,7 +86,7 @@ def get_subtype(object_dictionary): def description(self): """ Gets the description of this UpdateConnectionDetails. - Optional description about the Connection + Optional description about the connection. :return: The description of this UpdateConnectionDetails. @@ -98,7 +98,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateConnectionDetails. - Optional description about the Connection + Optional description about the connection. :param description: The description of this UpdateConnectionDetails. @@ -110,7 +110,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateConnectionDetails. - Optional Connection display name + Optional connection display name. Avoid entering confidential information. :return: The display_name of this UpdateConnectionDetails. @@ -122,7 +122,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateConnectionDetails. - Optional Connection display name + Optional connection display name. Avoid entering confidential information. :param display_name: The display_name of this UpdateConnectionDetails. diff --git a/src/oci/devops/models/update_deliver_artifact_stage_details.py b/src/oci/devops/models/update_deliver_artifact_stage_details.py index 64a869b968..48d27d3143 100644 --- a/src/oci/devops/models/update_deliver_artifact_stage_details.py +++ b/src/oci/devops/models/update_deliver_artifact_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateDeliverArtifactStageDetails(UpdateBuildPipelineStageDetails): """ - Specifies the DeliverArtifact Stage. + Specifies the Deliver Artifacts stage. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/update_devops_code_repository_trigger_details.py b/src/oci/devops/models/update_devops_code_repository_trigger_details.py index cebd89d21e..30dff589b7 100644 --- a/src/oci/devops/models/update_devops_code_repository_trigger_details.py +++ b/src/oci/devops/models/update_devops_code_repository_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateDevopsCodeRepositoryTriggerDetails(UpdateTriggerDetails): """ - Update Trigger specific to OCI Devops Repository + Update trigger specific to OCI DevOps code repository. """ def __init__(self, **kwargs): @@ -81,7 +81,7 @@ def __init__(self, **kwargs): def repository_id(self): """ Gets the repository_id of this UpdateDevopsCodeRepositoryTriggerDetails. - The Devops Code Repository Id + The OCID of the DevOps code repository. :return: The repository_id of this UpdateDevopsCodeRepositoryTriggerDetails. @@ -93,7 +93,7 @@ def repository_id(self): def repository_id(self, repository_id): """ Sets the repository_id of this UpdateDevopsCodeRepositoryTriggerDetails. - The Devops Code Repository Id + The OCID of the DevOps code repository. :param repository_id: The repository_id of this UpdateDevopsCodeRepositoryTriggerDetails. diff --git a/src/oci/devops/models/update_github_access_token_connection_details.py b/src/oci/devops/models/update_github_access_token_connection_details.py index ab8a94eba9..a2ca454266 100644 --- a/src/oci/devops/models/update_github_access_token_connection_details.py +++ b/src/oci/devops/models/update_github_access_token_connection_details.py @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def access_token(self): """ Gets the access_token of this UpdateGithubAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this UpdateGithubAccessTokenConnectionDetails. @@ -87,7 +87,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this UpdateGithubAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this UpdateGithubAccessTokenConnectionDetails. diff --git a/src/oci/devops/models/update_github_trigger_details.py b/src/oci/devops/models/update_github_trigger_details.py index 251d085769..df3c51d21f 100644 --- a/src/oci/devops/models/update_github_trigger_details.py +++ b/src/oci/devops/models/update_github_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateGithubTriggerDetails(UpdateTriggerDetails): """ - Update Trigger specific to Github + Update trigger specific to GitHub. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/update_gitlab_access_token_connection_details.py b/src/oci/devops/models/update_gitlab_access_token_connection_details.py index 0c7b0da9c3..77d346905f 100644 --- a/src/oci/devops/models/update_gitlab_access_token_connection_details.py +++ b/src/oci/devops/models/update_gitlab_access_token_connection_details.py @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def access_token(self): """ Gets the access_token of this UpdateGitlabAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :return: The access_token of this UpdateGitlabAccessTokenConnectionDetails. @@ -87,7 +87,7 @@ def access_token(self): def access_token(self, access_token): """ Sets the access_token of this UpdateGitlabAccessTokenConnectionDetails. - OCID of personal access token saved in secret store + The OCID of personal access token saved in secret store. :param access_token: The access_token of this UpdateGitlabAccessTokenConnectionDetails. diff --git a/src/oci/devops/models/update_gitlab_trigger_details.py b/src/oci/devops/models/update_gitlab_trigger_details.py index c874a6cf44..70441a0091 100644 --- a/src/oci/devops/models/update_gitlab_trigger_details.py +++ b/src/oci/devops/models/update_gitlab_trigger_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateGitlabTriggerDetails(UpdateTriggerDetails): """ - Update Trigger specific to Github + Update trigger specific to GitLab. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/update_repository_details.py b/src/oci/devops/models/update_repository_details.py index 18d446f08d..2fb1716bec 100644 --- a/src/oci/devops/models/update_repository_details.py +++ b/src/oci/devops/models/update_repository_details.py @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def name(self): """ Gets the name of this UpdateRepositoryDetails. - Repository Identifier + Unique name of a repository. :return: The name of this UpdateRepositoryDetails. @@ -91,7 +91,7 @@ def name(self): def name(self, name): """ Sets the name of this UpdateRepositoryDetails. - Repository Identifier + Unique name of a repository. :param name: The name of this UpdateRepositoryDetails. @@ -103,7 +103,7 @@ def name(self, name): def description(self): """ Gets the description of this UpdateRepositoryDetails. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :return: The description of this UpdateRepositoryDetails. @@ -115,7 +115,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateRepositoryDetails. - The description of this repository. Avoid entering confidential information + Details of the repository. Avoid entering confidential information. :param description: The description of this UpdateRepositoryDetails. @@ -127,7 +127,7 @@ def description(self, description): def default_branch(self): """ Gets the default_branch of this UpdateRepositoryDetails. - The default branch of the repository + The default branch of the repository. :return: The default_branch of this UpdateRepositoryDetails. @@ -139,7 +139,7 @@ def default_branch(self): def default_branch(self, default_branch): """ Sets the default_branch of this UpdateRepositoryDetails. - The default branch of the repository + The default branch of the repository. :param default_branch: The default_branch of this UpdateRepositoryDetails. @@ -151,7 +151,7 @@ def default_branch(self, default_branch): def repository_type(self): """ Gets the repository_type of this UpdateRepositoryDetails. - Type of repository + Type of repository. :return: The repository_type of this UpdateRepositoryDetails. @@ -163,7 +163,7 @@ def repository_type(self): def repository_type(self, repository_type): """ Sets the repository_type of this UpdateRepositoryDetails. - Type of repository + Type of repository. :param repository_type: The repository_type of this UpdateRepositoryDetails. diff --git a/src/oci/devops/models/update_trigger_deployment_stage_details.py b/src/oci/devops/models/update_trigger_deployment_stage_details.py index 221e6ea678..335bdeeba1 100644 --- a/src/oci/devops/models/update_trigger_deployment_stage_details.py +++ b/src/oci/devops/models/update_trigger_deployment_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateTriggerDeploymentStageDetails(UpdateBuildPipelineStageDetails): """ - Specifies trigger Deployment Pipleline stage which runs another pipeline of the application. + Specifies the Trigger Deployment stage, which runs another pipeline of the application. """ def __init__(self, **kwargs): @@ -88,7 +88,7 @@ def __init__(self, **kwargs): def deploy_pipeline_id(self): """ Gets the deploy_pipeline_id of this UpdateTriggerDeploymentStageDetails. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :return: The deploy_pipeline_id of this UpdateTriggerDeploymentStageDetails. @@ -100,7 +100,7 @@ def deploy_pipeline_id(self): def deploy_pipeline_id(self, deploy_pipeline_id): """ Sets the deploy_pipeline_id of this UpdateTriggerDeploymentStageDetails. - A target Pipeline ocid that will be run in this stage. + A target deployment pipeline OCID that will run in this stage. :param deploy_pipeline_id: The deploy_pipeline_id of this UpdateTriggerDeploymentStageDetails. @@ -112,7 +112,7 @@ def deploy_pipeline_id(self, deploy_pipeline_id): def is_pass_all_parameters_enabled(self): """ Gets the is_pass_all_parameters_enabled of this UpdateTriggerDeploymentStageDetails. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :return: The is_pass_all_parameters_enabled of this UpdateTriggerDeploymentStageDetails. @@ -124,7 +124,7 @@ def is_pass_all_parameters_enabled(self): def is_pass_all_parameters_enabled(self, is_pass_all_parameters_enabled): """ Sets the is_pass_all_parameters_enabled of this UpdateTriggerDeploymentStageDetails. - A boolean flag specifies whether the parameters should be passed during the deployment trigger. + A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. :param is_pass_all_parameters_enabled: The is_pass_all_parameters_enabled of this UpdateTriggerDeploymentStageDetails. diff --git a/src/oci/devops/models/update_trigger_details.py b/src/oci/devops/models/update_trigger_details.py index 92b699a85d..81ab41d7f4 100644 --- a/src/oci/devops/models/update_trigger_details.py +++ b/src/oci/devops/models/update_trigger_details.py @@ -97,7 +97,7 @@ def get_subtype(object_dictionary): def display_name(self): """ Gets the display_name of this UpdateTriggerDetails. - Trigger Identifier + Trigger display name. Avoid entering confidential information. :return: The display_name of this UpdateTriggerDetails. @@ -109,7 +109,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateTriggerDetails. - Trigger Identifier + Trigger display name. Avoid entering confidential information. :param display_name: The display_name of this UpdateTriggerDetails. @@ -121,7 +121,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateTriggerDetails. - Optional description about the Trigger + Optional description about the trigger. :return: The description of this UpdateTriggerDetails. @@ -133,7 +133,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateTriggerDetails. - Optional description about the Trigger + Optional description about the trigger. :param description: The description of this UpdateTriggerDetails. @@ -145,7 +145,7 @@ def description(self, description): def trigger_source(self): """ **[Required]** Gets the trigger_source of this UpdateTriggerDetails. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :return: The trigger_source of this UpdateTriggerDetails. @@ -157,7 +157,7 @@ def trigger_source(self): def trigger_source(self, trigger_source): """ Sets the trigger_source of this UpdateTriggerDetails. - Source of the Trigger (allowed values are - GITHUB, GITLAB) + Source of the trigger. Allowed values are, GITHUB and GITLAB. :param trigger_source: The trigger_source of this UpdateTriggerDetails. @@ -169,7 +169,7 @@ def trigger_source(self, trigger_source): def actions(self): """ Gets the actions of this UpdateTriggerDetails. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :return: The actions of this UpdateTriggerDetails. @@ -181,7 +181,7 @@ def actions(self): def actions(self, actions): """ Sets the actions of this UpdateTriggerDetails. - The list of actions that are to be performed for this Trigger + The list of actions that are to be performed for this trigger. :param actions: The actions of this UpdateTriggerDetails. diff --git a/src/oci/devops/models/update_wait_criteria_details.py b/src/oci/devops/models/update_wait_criteria_details.py index 0117519701..f5873f2f56 100644 --- a/src/oci/devops/models/update_wait_criteria_details.py +++ b/src/oci/devops/models/update_wait_criteria_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateWaitCriteriaDetails(object): """ - Specifies wait criteria for wait stage. + Specifies wait criteria for the Wait stage. """ #: A constant which can be used with the wait_type property of a UpdateWaitCriteriaDetails. @@ -59,7 +59,7 @@ def get_subtype(object_dictionary): def wait_type(self): """ **[Required]** Gets the wait_type of this UpdateWaitCriteriaDetails. - wait criteria sub type + Wait criteria type. Allowed values for this property are: "ABSOLUTE_WAIT" @@ -73,7 +73,7 @@ def wait_type(self): def wait_type(self, wait_type): """ Sets the wait_type of this UpdateWaitCriteriaDetails. - wait criteria sub type + Wait criteria type. :param wait_type: The wait_type of this UpdateWaitCriteriaDetails. diff --git a/src/oci/devops/models/update_wait_stage_details.py b/src/oci/devops/models/update_wait_stage_details.py index f9c2de3fe7..63500f4c99 100644 --- a/src/oci/devops/models/update_wait_stage_details.py +++ b/src/oci/devops/models/update_wait_stage_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateWaitStageDetails(UpdateBuildPipelineStageDetails): """ - Specifies the Wait Stage. User can specify variable wait times or an absolute duration. + Specifies the Wait stage. You can specify variable wait times or an absolute duration. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/wait_stage.py b/src/oci/devops/models/wait_stage.py index 102e035099..2c7da4d3f3 100644 --- a/src/oci/devops/models/wait_stage.py +++ b/src/oci/devops/models/wait_stage.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WaitStage(BuildPipelineStage): """ - Specifies the Wait Stage. User can specify variable wait times or an absolute duration. + Specifies the Wait stage. You can specify variable wait times or an absolute duration. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/wait_stage_run_progress.py b/src/oci/devops/models/wait_stage_run_progress.py index 2a01645c07..e109c019fe 100644 --- a/src/oci/devops/models/wait_stage_run_progress.py +++ b/src/oci/devops/models/wait_stage_run_progress.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WaitStageRunProgress(BuildPipelineStageRunProgress): """ - Specifies wait stage specific run details. + Specifies Wait stage specific run details. """ def __init__(self, **kwargs): diff --git a/src/oci/devops/models/wait_stage_summary.py b/src/oci/devops/models/wait_stage_summary.py index 98b8705be3..bed1f24014 100644 --- a/src/oci/devops/models/wait_stage_summary.py +++ b/src/oci/devops/models/wait_stage_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WaitStageSummary(BuildPipelineStageSummary): """ - Specifies the Wait Stage. User can specify variable wait times or an absolute duration. + Specifies the Wait stage. You can specify variable wait times or an absolute duration. """ def __init__(self, **kwargs): diff --git a/src/oci/golden_gate/models/create_deployment_details.py b/src/oci/golden_gate/models/create_deployment_details.py index 676669b25b..c9bf71a436 100644 --- a/src/oci/golden_gate/models/create_deployment_details.py +++ b/src/oci/golden_gate/models/create_deployment_details.py @@ -489,7 +489,8 @@ def is_auto_scaling_enabled(self, is_auto_scaling_enabled): def deployment_type(self): """ **[Required]** Gets the deployment_type of this CreateDeploymentDetails. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. Allowed values for this property are: "OGG" @@ -503,7 +504,8 @@ def deployment_type(self): def deployment_type(self, deployment_type): """ Sets the deployment_type of this CreateDeploymentDetails. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. :param deployment_type: The deployment_type of this CreateDeploymentDetails. diff --git a/src/oci/golden_gate/models/deployment.py b/src/oci/golden_gate/models/deployment.py index cd62bf43a3..acf424549a 100644 --- a/src/oci/golden_gate/models/deployment.py +++ b/src/oci/golden_gate/models/deployment.py @@ -1006,7 +1006,8 @@ def time_upgrade_required(self, time_upgrade_required): def deployment_type(self): """ **[Required]** Gets the deployment_type of this Deployment. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. Allowed values for this property are: "OGG", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -1021,7 +1022,8 @@ def deployment_type(self): def deployment_type(self, deployment_type): """ Sets the deployment_type of this Deployment. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. :param deployment_type: The deployment_type of this Deployment. diff --git a/src/oci/golden_gate/models/deployment_backup.py b/src/oci/golden_gate/models/deployment_backup.py index c46c0919a3..c35e9488c8 100644 --- a/src/oci/golden_gate/models/deployment_backup.py +++ b/src/oci/golden_gate/models/deployment_backup.py @@ -108,6 +108,14 @@ def __init__(self, **kwargs): The value to assign to the time_of_backup property of this DeploymentBackup. :type time_of_backup: datetime + :param time_backup_finished: + The value to assign to the time_backup_finished property of this DeploymentBackup. + :type time_backup_finished: datetime + + :param size_in_bytes: + The value to assign to the size_in_bytes property of this DeploymentBackup. + :type size_in_bytes: float + :param backup_type: The value to assign to the backup_type property of this DeploymentBackup. Allowed values for this property are: "INCREMENTAL", "FULL", 'UNKNOWN_ENUM_VALUE'. @@ -160,6 +168,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'time_of_backup': 'datetime', + 'time_backup_finished': 'datetime', + 'size_in_bytes': 'float', 'backup_type': 'str', 'ogg_version': 'str', 'namespace_name': 'str', @@ -181,6 +191,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'time_of_backup': 'timeOfBackup', + 'time_backup_finished': 'timeBackupFinished', + 'size_in_bytes': 'sizeInBytes', 'backup_type': 'backupType', 'ogg_version': 'oggVersion', 'namespace_name': 'namespaceName', @@ -201,6 +213,8 @@ def __init__(self, **kwargs): self._lifecycle_state = None self._lifecycle_details = None self._time_of_backup = None + self._time_backup_finished = None + self._size_in_bytes = None self._backup_type = None self._ogg_version = None self._namespace_name = None @@ -426,6 +440,58 @@ def time_of_backup(self, time_of_backup): """ self._time_of_backup = time_of_backup + @property + def time_backup_finished(self): + """ + Gets the time_backup_finished of this DeploymentBackup. + The time of the resource backup finish. The format is defined by `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_backup_finished of this DeploymentBackup. + :rtype: datetime + """ + return self._time_backup_finished + + @time_backup_finished.setter + def time_backup_finished(self, time_backup_finished): + """ + Sets the time_backup_finished of this DeploymentBackup. + The time of the resource backup finish. The format is defined by `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_backup_finished: The time_backup_finished of this DeploymentBackup. + :type: datetime + """ + self._time_backup_finished = time_backup_finished + + @property + def size_in_bytes(self): + """ + Gets the size_in_bytes of this DeploymentBackup. + The size of the backup stored in object storage (in bytes) + + + :return: The size_in_bytes of this DeploymentBackup. + :rtype: float + """ + return self._size_in_bytes + + @size_in_bytes.setter + def size_in_bytes(self, size_in_bytes): + """ + Sets the size_in_bytes of this DeploymentBackup. + The size of the backup stored in object storage (in bytes) + + + :param size_in_bytes: The size_in_bytes of this DeploymentBackup. + :type: float + """ + self._size_in_bytes = size_in_bytes + @property def backup_type(self): """ diff --git a/src/oci/golden_gate/models/deployment_backup_summary.py b/src/oci/golden_gate/models/deployment_backup_summary.py index 11dd032b65..34aad0e1e5 100644 --- a/src/oci/golden_gate/models/deployment_backup_summary.py +++ b/src/oci/golden_gate/models/deployment_backup_summary.py @@ -108,6 +108,14 @@ def __init__(self, **kwargs): The value to assign to the time_of_backup property of this DeploymentBackupSummary. :type time_of_backup: datetime + :param time_backup_finished: + The value to assign to the time_backup_finished property of this DeploymentBackupSummary. + :type time_backup_finished: datetime + + :param size_in_bytes: + The value to assign to the size_in_bytes property of this DeploymentBackupSummary. + :type size_in_bytes: float + :param backup_type: The value to assign to the backup_type property of this DeploymentBackupSummary. Allowed values for this property are: "INCREMENTAL", "FULL", 'UNKNOWN_ENUM_VALUE'. @@ -160,6 +168,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'time_of_backup': 'datetime', + 'time_backup_finished': 'datetime', + 'size_in_bytes': 'float', 'backup_type': 'str', 'ogg_version': 'str', 'namespace_name': 'str', @@ -181,6 +191,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'time_of_backup': 'timeOfBackup', + 'time_backup_finished': 'timeBackupFinished', + 'size_in_bytes': 'sizeInBytes', 'backup_type': 'backupType', 'ogg_version': 'oggVersion', 'namespace_name': 'namespaceName', @@ -201,6 +213,8 @@ def __init__(self, **kwargs): self._lifecycle_state = None self._lifecycle_details = None self._time_of_backup = None + self._time_backup_finished = None + self._size_in_bytes = None self._backup_type = None self._ogg_version = None self._namespace_name = None @@ -426,6 +440,58 @@ def time_of_backup(self, time_of_backup): """ self._time_of_backup = time_of_backup + @property + def time_backup_finished(self): + """ + Gets the time_backup_finished of this DeploymentBackupSummary. + The time of the resource backup finish. The format is defined by `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_backup_finished of this DeploymentBackupSummary. + :rtype: datetime + """ + return self._time_backup_finished + + @time_backup_finished.setter + def time_backup_finished(self, time_backup_finished): + """ + Sets the time_backup_finished of this DeploymentBackupSummary. + The time of the resource backup finish. The format is defined by `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_backup_finished: The time_backup_finished of this DeploymentBackupSummary. + :type: datetime + """ + self._time_backup_finished = time_backup_finished + + @property + def size_in_bytes(self): + """ + Gets the size_in_bytes of this DeploymentBackupSummary. + The size of the backup stored in object storage (in bytes) + + + :return: The size_in_bytes of this DeploymentBackupSummary. + :rtype: float + """ + return self._size_in_bytes + + @size_in_bytes.setter + def size_in_bytes(self, size_in_bytes): + """ + Sets the size_in_bytes of this DeploymentBackupSummary. + The size of the backup stored in object storage (in bytes) + + + :param size_in_bytes: The size_in_bytes of this DeploymentBackupSummary. + :type: float + """ + self._size_in_bytes = size_in_bytes + @property def backup_type(self): """ diff --git a/src/oci/golden_gate/models/deployment_summary.py b/src/oci/golden_gate/models/deployment_summary.py index 940ab5196c..04c271791d 100644 --- a/src/oci/golden_gate/models/deployment_summary.py +++ b/src/oci/golden_gate/models/deployment_summary.py @@ -898,7 +898,8 @@ def time_upgrade_required(self, time_upgrade_required): def deployment_type(self): """ Gets the deployment_type of this DeploymentSummary. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. Allowed values for this property are: "OGG", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -913,7 +914,8 @@ def deployment_type(self): def deployment_type(self, deployment_type): """ Sets the deployment_type of this DeploymentSummary. - The deployment type. + The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value OGG is maintained for backward compatibility purposes. Its use is discouraged + in favor of the equivalent DATABASE_ORACLE value. :param deployment_type: The deployment_type of this DeploymentSummary. diff --git a/src/oci/golden_gate/models/upgrade_deployment_details.py b/src/oci/golden_gate/models/upgrade_deployment_details.py index 158aaf6482..94a1bb6f20 100644 --- a/src/oci/golden_gate/models/upgrade_deployment_details.py +++ b/src/oci/golden_gate/models/upgrade_deployment_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpgradeDeploymentDetails(object): """ - The information about the Patch for a Deployment. + The information about the Upgrade for a Deployment. """ #: A constant which can be used with the type property of a UpgradeDeploymentDetails. diff --git a/src/oci/golden_gate/models/work_request.py b/src/oci/golden_gate/models/work_request.py index c1bbed24cf..cfe75118dd 100644 --- a/src/oci/golden_gate/models/work_request.py +++ b/src/oci/golden_gate/models/work_request.py @@ -61,6 +61,10 @@ class WorkRequest(object): #: This constant has a value of "GOLDENGATE_DEPLOYMENT_PATCH" OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_PATCH = "GOLDENGATE_DEPLOYMENT_PATCH" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_DEPLOYMENT_UPGRADE" + OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_UPGRADE = "GOLDENGATE_DEPLOYMENT_UPGRADE" + #: A constant which can be used with the operation_type property of a WorkRequest. #: This constant has a value of "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE" OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_CREATE = "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE" @@ -69,6 +73,10 @@ class WorkRequest(object): #: This constant has a value of "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE" OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_DELETE = "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL" + OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL = "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -96,7 +104,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: "GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -175,7 +183,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The work request's operation type. - Allowed values for this property are: "GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -194,7 +202,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE"] + allowed_values = ["GOLDENGATE_DATABASE_REGISTRATION_CREATE", "GOLDENGATE_DATABASE_REGISTRATION_UPDATE", "GOLDENGATE_DATABASE_REGISTRATION_DELETE", "GOLDENGATE_DATABASE_REGISTRATION_MOVE", "GOLDENGATE_DEPLOYMENT_CREATE", "GOLDENGATE_DEPLOYMENT_UPDATE", "GOLDENGATE_DEPLOYMENT_DELETE", "GOLDENGATE_DEPLOYMENT_MOVE", "GOLDENGATE_DEPLOYMENT_RESTORE", "GOLDENGATE_DEPLOYMENT_START", "GOLDENGATE_DEPLOYMENT_STOP", "GOLDENGATE_DEPLOYMENT_PATCH", "GOLDENGATE_DEPLOYMENT_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL"] 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/identity/identity_client.py b/src/oci/identity/identity_client.py index 6c5ca92d4c..ecc85df5cb 100644 --- a/src/oci/identity/identity_client.py +++ b/src/oci/identity/identity_client.py @@ -5949,6 +5949,86 @@ def get_policy(self, policy_id, **kwargs): header_params=header_params, response_type="Policy") + def get_standard_tag_template(self, compartment_id, standard_tag_namespace_name, **kwargs): + """ + Retrieve the standard tag namespace template given the standard tag namespace name. + + + :param str compartment_id: (required) + The OCID of the compartment (remember that the tenancy is simply the root compartment). + + :param str standard_tag_namespace_name: (required) + The name of the standard tag namespace tempate that is requested + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.identity.models.StandardTagNamespaceTemplate` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_standard_tag_template API. + """ + resource_path = "/tags/standardTagNamespaceTemplates/{standardTagNamespaceName}" + method = "GET" + + expected_kwargs = ["retry_strategy"] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_standard_tag_template got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "standardTagNamespaceName": standard_tag_namespace_name + } + + 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 = { + "compartmentId": compartment_id + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json" + } + + 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="StandardTagNamespaceTemplate") + 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="StandardTagNamespaceTemplate") + def get_tag(self, tag_namespace_id, tag_name, **kwargs): """ Gets the specified tag's information. @@ -6586,6 +6666,86 @@ def get_work_request(self, work_request_id, **kwargs): header_params=header_params, response_type="WorkRequest") + def import_standard_tags(self, **kwargs): + """ + OCI will release Tag Namespaces that our customers can import. + These Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting. + + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (e.g., if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + + :param oci.identity.models.ImportStandardTagsDetails import_standard_tags_details: (optional) + The request object for creating or updating standard tag namespace. + + :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`. + + :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 import_standard_tags API. + """ + resource_path = "/tags/actions/importStandardTags" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "import_standard_tags_details" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "import_standard_tags 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: + 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=kwargs.get('import_standard_tags_details')) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=kwargs.get('import_standard_tags_details')) + def list_allowed_domain_license_types(self, **kwargs): """ List the allowed domain license types supported by OCI @@ -9278,6 +9438,84 @@ def list_smtp_credentials(self, user_id, **kwargs): header_params=header_params, response_type="list[SmtpCredentialSummary]") + def list_standard_tag_namespaces(self, compartment_id, **kwargs): + """ + Lists available standard tag namespaces that users can create. + + + :param str compartment_id: (required) + The OCID of the compartment (remember that the tenancy is simply the root compartment). + + :param str page: (optional) + The value of the `opc-next-page` response header from the previous \"List\" call. + + :param int limit: (optional) + The maximum number of items to return in a paginated \"List\" call. + + :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`. + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.identity.models.StandardTagNamespaceTemplateSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_standard_tag_namespaces API. + """ + resource_path = "/tags/standardTagNamespaceTemplates" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "retry_strategy", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_standard_tag_namespaces got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "compartmentId": compartment_id, + "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" + } + + 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="list[StandardTagNamespaceTemplateSummary]") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[StandardTagNamespaceTemplateSummary]") + def list_swift_passwords(self, user_id, **kwargs): """ **Deprecated. Use :func:`list_auth_tokens` instead.** diff --git a/src/oci/identity/identity_client_composite_operations.py b/src/oci/identity/identity_client_composite_operations.py index b875bccd96..0b4b27690e 100644 --- a/src/oci/identity/identity_client_composite_operations.py +++ b/src/oci/identity/identity_client_composite_operations.py @@ -1426,6 +1426,41 @@ def generate_totp_seed_and_wait_for_state(self, user_id, mfa_totp_device_id, wai except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def import_standard_tags_and_wait_for_state(self, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.identity.IdentityClient.import_standard_tags` and waits for the :py:class:`~oci.identity.models.WorkRequest` + to enter the given state(s). + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.identity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.identity.IdentityClient.import_standard_tags` + + :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.import_standard_tags(**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 move_compartment_and_wait_for_state(self, compartment_id, move_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.identity.IdentityClient.move_compartment` and waits for the :py:class:`~oci.identity.models.WorkRequest` diff --git a/src/oci/identity/models/__init__.py b/src/oci/identity/models/__init__.py index 37992fd985..830887740b 100644 --- a/src/oci/identity/models/__init__.py +++ b/src/oci/identity/models/__init__.py @@ -68,6 +68,7 @@ from .identity_provider import IdentityProvider from .identity_provider_group_summary import IdentityProviderGroupSummary from .idp_group_mapping import IdpGroupMapping +from .import_standard_tags_details import ImportStandardTagsDetails from .mfa_totp_device import MfaTotpDevice from .mfa_totp_device_summary import MfaTotpDeviceSummary from .mfa_totp_token import MfaTotpToken @@ -87,6 +88,9 @@ from .scim_client_credentials import ScimClientCredentials from .smtp_credential import SmtpCredential from .smtp_credential_summary import SmtpCredentialSummary +from .standard_tag_definition_template import StandardTagDefinitionTemplate +from .standard_tag_namespace_template import StandardTagNamespaceTemplate +from .standard_tag_namespace_template_summary import StandardTagNamespaceTemplateSummary from .swift_password import SwiftPassword from .tag import Tag from .tag_default import TagDefault @@ -197,6 +201,7 @@ "IdentityProvider": IdentityProvider, "IdentityProviderGroupSummary": IdentityProviderGroupSummary, "IdpGroupMapping": IdpGroupMapping, + "ImportStandardTagsDetails": ImportStandardTagsDetails, "MfaTotpDevice": MfaTotpDevice, "MfaTotpDeviceSummary": MfaTotpDeviceSummary, "MfaTotpToken": MfaTotpToken, @@ -216,6 +221,9 @@ "ScimClientCredentials": ScimClientCredentials, "SmtpCredential": SmtpCredential, "SmtpCredentialSummary": SmtpCredentialSummary, + "StandardTagDefinitionTemplate": StandardTagDefinitionTemplate, + "StandardTagNamespaceTemplate": StandardTagNamespaceTemplate, + "StandardTagNamespaceTemplateSummary": StandardTagNamespaceTemplateSummary, "SwiftPassword": SwiftPassword, "Tag": Tag, "TagDefault": TagDefault, diff --git a/src/oci/identity/models/bulk_edit_resource.py b/src/oci/identity/models/bulk_edit_resource.py index ac80ba3735..a4364ef99d 100644 --- a/src/oci/identity/models/bulk_edit_resource.py +++ b/src/oci/identity/models/bulk_edit_resource.py @@ -75,7 +75,7 @@ def id(self, id): def resource_type(self): """ **[Required]** Gets the resource_type of this BulkEditResource. - The type of resource. See :func:`bulk_edit_resource_types`. + The type of resource. See :func:`list_bulk_edit_tags_resource_types`. :return: The resource_type of this BulkEditResource. @@ -87,7 +87,7 @@ def resource_type(self): def resource_type(self, resource_type): """ Sets the resource_type of this BulkEditResource. - The type of resource. See :func:`bulk_edit_resource_types`. + The type of resource. See :func:`list_bulk_edit_tags_resource_types`. :param resource_type: The resource_type of this BulkEditResource. diff --git a/src/oci/identity/models/create_domain_details.py b/src/oci/identity/models/create_domain_details.py index 57c67dbd14..83a69e943a 100644 --- a/src/oci/identity/models/create_domain_details.py +++ b/src/oci/identity/models/create_domain_details.py @@ -200,7 +200,7 @@ def description(self, description): def home_region(self): """ **[Required]** Gets the home_region of this CreateDomainDetails. - The region's name. See `Regions and Availability Domains`__ + The region's name identifier. See `Regions and Availability Domains`__ for the full list of supported region names. Example: `us-phoenix-1` @@ -217,7 +217,7 @@ def home_region(self): def home_region(self, home_region): """ Sets the home_region of this CreateDomainDetails. - The region's name. See `Regions and Availability Domains`__ + The region's name identifier. See `Regions and Availability Domains`__ for the full list of supported region names. Example: `us-phoenix-1` diff --git a/src/oci/identity/models/import_standard_tags_details.py b/src/oci/identity/models/import_standard_tags_details.py new file mode 100644 index 0000000000..623829372a --- /dev/null +++ b/src/oci/identity/models/import_standard_tags_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 ImportStandardTagsDetails(object): + """ + ImportStandardTagsDetails model. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ImportStandardTagsDetails 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 ImportStandardTagsDetails. + :type compartment_id: str + + :param standard_tag_namespace_name: + The value to assign to the standard_tag_namespace_name property of this ImportStandardTagsDetails. + :type standard_tag_namespace_name: str + + """ + self.swagger_types = { + 'compartment_id': 'str', + 'standard_tag_namespace_name': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId', + 'standard_tag_namespace_name': 'standardTagNamespaceName' + } + + self._compartment_id = None + self._standard_tag_namespace_name = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ImportStandardTagsDetails. + The OCID of the compartment where the bulk create request is submitted and where the tag namespaces will be created. + + + :return: The compartment_id of this ImportStandardTagsDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ImportStandardTagsDetails. + The OCID of the compartment where the bulk create request is submitted and where the tag namespaces will be created. + + + :param compartment_id: The compartment_id of this ImportStandardTagsDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def standard_tag_namespace_name(self): + """ + **[Required]** Gets the standard_tag_namespace_name of this ImportStandardTagsDetails. + The name of standard tag namespace that will be imported in bulk + + + :return: The standard_tag_namespace_name of this ImportStandardTagsDetails. + :rtype: str + """ + return self._standard_tag_namespace_name + + @standard_tag_namespace_name.setter + def standard_tag_namespace_name(self, standard_tag_namespace_name): + """ + Sets the standard_tag_namespace_name of this ImportStandardTagsDetails. + The name of standard tag namespace that will be imported in bulk + + + :param standard_tag_namespace_name: The standard_tag_namespace_name of this ImportStandardTagsDetails. + :type: str + """ + self._standard_tag_namespace_name = standard_tag_namespace_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/identity/models/standard_tag_definition_template.py b/src/oci/identity/models/standard_tag_definition_template.py new file mode 100644 index 0000000000..5eefa9e252 --- /dev/null +++ b/src/oci/identity/models/standard_tag_definition_template.py @@ -0,0 +1,261 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 StandardTagDefinitionTemplate(object): + """ + The template of the tag definition. This object includes necessary details to create the provided standard tag definition. + """ + + #: A constant which can be used with the type property of a StandardTagDefinitionTemplate. + #: This constant has a value of "ENUM" + TYPE_ENUM = "ENUM" + + #: A constant which can be used with the type property of a StandardTagDefinitionTemplate. + #: This constant has a value of "STRING" + TYPE_STRING = "STRING" + + #: A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. + #: This constant has a value of "IMMUTABLE" + ENUM_MUTABILITY_IMMUTABLE = "IMMUTABLE" + + #: A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. + #: This constant has a value of "MUTABLE" + ENUM_MUTABILITY_MUTABLE = "MUTABLE" + + #: A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. + #: This constant has a value of "APPENDABLE" + ENUM_MUTABILITY_APPENDABLE = "APPENDABLE" + + def __init__(self, **kwargs): + """ + Initializes a new StandardTagDefinitionTemplate object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param description: + The value to assign to the description property of this StandardTagDefinitionTemplate. + :type description: str + + :param tag_definition_name: + The value to assign to the tag_definition_name property of this StandardTagDefinitionTemplate. + :type tag_definition_name: str + + :param type: + The value to assign to the type property of this StandardTagDefinitionTemplate. + Allowed values for this property are: "ENUM", "STRING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param possible_values: + The value to assign to the possible_values property of this StandardTagDefinitionTemplate. + :type possible_values: list[str] + + :param is_cost_tracking: + The value to assign to the is_cost_tracking property of this StandardTagDefinitionTemplate. + :type is_cost_tracking: bool + + :param enum_mutability: + The value to assign to the enum_mutability property of this StandardTagDefinitionTemplate. + Allowed values for this property are: "IMMUTABLE", "MUTABLE", "APPENDABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type enum_mutability: str + + """ + self.swagger_types = { + 'description': 'str', + 'tag_definition_name': 'str', + 'type': 'str', + 'possible_values': 'list[str]', + 'is_cost_tracking': 'bool', + 'enum_mutability': 'str' + } + + self.attribute_map = { + 'description': 'description', + 'tag_definition_name': 'tagDefinitionName', + 'type': 'type', + 'possible_values': 'possibleValues', + 'is_cost_tracking': 'isCostTracking', + 'enum_mutability': 'enumMutability' + } + + self._description = None + self._tag_definition_name = None + self._type = None + self._possible_values = None + self._is_cost_tracking = None + self._enum_mutability = None + + @property + def description(self): + """ + **[Required]** Gets the description of this StandardTagDefinitionTemplate. + The default description of the tag namespace that users can use to create the tag definition + + + :return: The description of this StandardTagDefinitionTemplate. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this StandardTagDefinitionTemplate. + The default description of the tag namespace that users can use to create the tag definition + + + :param description: The description of this StandardTagDefinitionTemplate. + :type: str + """ + self._description = description + + @property + def tag_definition_name(self): + """ + **[Required]** Gets the tag_definition_name of this StandardTagDefinitionTemplate. + The name of this standard tag definition + + + :return: The tag_definition_name of this StandardTagDefinitionTemplate. + :rtype: str + """ + return self._tag_definition_name + + @tag_definition_name.setter + def tag_definition_name(self, tag_definition_name): + """ + Sets the tag_definition_name of this StandardTagDefinitionTemplate. + The name of this standard tag definition + + + :param tag_definition_name: The tag_definition_name of this StandardTagDefinitionTemplate. + :type: str + """ + self._tag_definition_name = tag_definition_name + + @property + def type(self): + """ + **[Required]** Gets the type of this StandardTagDefinitionTemplate. + The type of tag definition. Enum or string. + + Allowed values for this property are: "ENUM", "STRING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this StandardTagDefinitionTemplate. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this StandardTagDefinitionTemplate. + The type of tag definition. Enum or string. + + + :param type: The type of this StandardTagDefinitionTemplate. + :type: str + """ + allowed_values = ["ENUM", "STRING"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def possible_values(self): + """ + Gets the possible_values of this StandardTagDefinitionTemplate. + List of possible values. An optional parameter that will be present if the type of definition is enum. + + + :return: The possible_values of this StandardTagDefinitionTemplate. + :rtype: list[str] + """ + return self._possible_values + + @possible_values.setter + def possible_values(self, possible_values): + """ + Sets the possible_values of this StandardTagDefinitionTemplate. + List of possible values. An optional parameter that will be present if the type of definition is enum. + + + :param possible_values: The possible_values of this StandardTagDefinitionTemplate. + :type: list[str] + """ + self._possible_values = possible_values + + @property + def is_cost_tracking(self): + """ + **[Required]** Gets the is_cost_tracking of this StandardTagDefinitionTemplate. + Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated + + + :return: The is_cost_tracking of this StandardTagDefinitionTemplate. + :rtype: bool + """ + return self._is_cost_tracking + + @is_cost_tracking.setter + def is_cost_tracking(self, is_cost_tracking): + """ + Sets the is_cost_tracking of this StandardTagDefinitionTemplate. + Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated + + + :param is_cost_tracking: The is_cost_tracking of this StandardTagDefinitionTemplate. + :type: bool + """ + self._is_cost_tracking = is_cost_tracking + + @property + def enum_mutability(self): + """ + Gets the enum_mutability of this StandardTagDefinitionTemplate. + The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags + + Allowed values for this property are: "IMMUTABLE", "MUTABLE", "APPENDABLE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The enum_mutability of this StandardTagDefinitionTemplate. + :rtype: str + """ + return self._enum_mutability + + @enum_mutability.setter + def enum_mutability(self, enum_mutability): + """ + Sets the enum_mutability of this StandardTagDefinitionTemplate. + The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags + + + :param enum_mutability: The enum_mutability of this StandardTagDefinitionTemplate. + :type: str + """ + allowed_values = ["IMMUTABLE", "MUTABLE", "APPENDABLE"] + if not value_allowed_none_or_none_sentinel(enum_mutability, allowed_values): + enum_mutability = 'UNKNOWN_ENUM_VALUE' + self._enum_mutability = enum_mutability + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/identity/models/standard_tag_namespace_template.py b/src/oci/identity/models/standard_tag_namespace_template.py new file mode 100644 index 0000000000..de2ca4fabc --- /dev/null +++ b/src/oci/identity/models/standard_tag_namespace_template.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 StandardTagNamespaceTemplate(object): + """ + The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StandardTagNamespaceTemplate object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param description: + The value to assign to the description property of this StandardTagNamespaceTemplate. + :type description: str + + :param standard_tag_namespace_name: + The value to assign to the standard_tag_namespace_name property of this StandardTagNamespaceTemplate. + :type standard_tag_namespace_name: str + + :param tag_definition_templates: + The value to assign to the tag_definition_templates property of this StandardTagNamespaceTemplate. + :type tag_definition_templates: list[oci.identity.models.StandardTagDefinitionTemplate] + + :param status: + The value to assign to the status property of this StandardTagNamespaceTemplate. + :type status: str + + """ + self.swagger_types = { + 'description': 'str', + 'standard_tag_namespace_name': 'str', + 'tag_definition_templates': 'list[StandardTagDefinitionTemplate]', + 'status': 'str' + } + + self.attribute_map = { + 'description': 'description', + 'standard_tag_namespace_name': 'standardTagNamespaceName', + 'tag_definition_templates': 'tagDefinitionTemplates', + 'status': 'status' + } + + self._description = None + self._standard_tag_namespace_name = None + self._tag_definition_templates = None + self._status = None + + @property + def description(self): + """ + **[Required]** Gets the description of this StandardTagNamespaceTemplate. + The default description of the tag namespace that users can use to create the tag namespace + + + :return: The description of this StandardTagNamespaceTemplate. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this StandardTagNamespaceTemplate. + The default description of the tag namespace that users can use to create the tag namespace + + + :param description: The description of this StandardTagNamespaceTemplate. + :type: str + """ + self._description = description + + @property + def standard_tag_namespace_name(self): + """ + **[Required]** Gets the standard_tag_namespace_name of this StandardTagNamespaceTemplate. + The reserved name of this standard tag namespace + + + :return: The standard_tag_namespace_name of this StandardTagNamespaceTemplate. + :rtype: str + """ + return self._standard_tag_namespace_name + + @standard_tag_namespace_name.setter + def standard_tag_namespace_name(self, standard_tag_namespace_name): + """ + Sets the standard_tag_namespace_name of this StandardTagNamespaceTemplate. + The reserved name of this standard tag namespace + + + :param standard_tag_namespace_name: The standard_tag_namespace_name of this StandardTagNamespaceTemplate. + :type: str + """ + self._standard_tag_namespace_name = standard_tag_namespace_name + + @property + def tag_definition_templates(self): + """ + **[Required]** Gets the tag_definition_templates of this StandardTagNamespaceTemplate. + The template of the tag definition. This object includes necessary details to create the provided standard tag definition. + + + :return: The tag_definition_templates of this StandardTagNamespaceTemplate. + :rtype: list[oci.identity.models.StandardTagDefinitionTemplate] + """ + return self._tag_definition_templates + + @tag_definition_templates.setter + def tag_definition_templates(self, tag_definition_templates): + """ + Sets the tag_definition_templates of this StandardTagNamespaceTemplate. + The template of the tag definition. This object includes necessary details to create the provided standard tag definition. + + + :param tag_definition_templates: The tag_definition_templates of this StandardTagNamespaceTemplate. + :type: list[oci.identity.models.StandardTagDefinitionTemplate] + """ + self._tag_definition_templates = tag_definition_templates + + @property + def status(self): + """ + **[Required]** Gets the status of this StandardTagNamespaceTemplate. + The status of the standard tag namespace + + + :return: The status of this StandardTagNamespaceTemplate. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this StandardTagNamespaceTemplate. + The status of the standard tag namespace + + + :param status: The status of this StandardTagNamespaceTemplate. + :type: str + """ + 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/identity/models/standard_tag_namespace_template_summary.py b/src/oci/identity/models/standard_tag_namespace_template_summary.py new file mode 100644 index 0000000000..94b139ab2a --- /dev/null +++ b/src/oci/identity/models/standard_tag_namespace_template_summary.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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 StandardTagNamespaceTemplateSummary(object): + """ + The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StandardTagNamespaceTemplateSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param description: + The value to assign to the description property of this StandardTagNamespaceTemplateSummary. + :type description: str + + :param standard_tag_namespace_name: + The value to assign to the standard_tag_namespace_name property of this StandardTagNamespaceTemplateSummary. + :type standard_tag_namespace_name: str + + :param status: + The value to assign to the status property of this StandardTagNamespaceTemplateSummary. + :type status: str + + """ + self.swagger_types = { + 'description': 'str', + 'standard_tag_namespace_name': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'description': 'description', + 'standard_tag_namespace_name': 'standardTagNamespaceName', + 'status': 'status' + } + + self._description = None + self._standard_tag_namespace_name = None + self._status = None + + @property + def description(self): + """ + **[Required]** Gets the description of this StandardTagNamespaceTemplateSummary. + The default description of the tag namespace that users can use to create the tag namespace + + + :return: The description of this StandardTagNamespaceTemplateSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this StandardTagNamespaceTemplateSummary. + The default description of the tag namespace that users can use to create the tag namespace + + + :param description: The description of this StandardTagNamespaceTemplateSummary. + :type: str + """ + self._description = description + + @property + def standard_tag_namespace_name(self): + """ + **[Required]** Gets the standard_tag_namespace_name of this StandardTagNamespaceTemplateSummary. + The reserved name of this standard tag namespace + + + :return: The standard_tag_namespace_name of this StandardTagNamespaceTemplateSummary. + :rtype: str + """ + return self._standard_tag_namespace_name + + @standard_tag_namespace_name.setter + def standard_tag_namespace_name(self, standard_tag_namespace_name): + """ + Sets the standard_tag_namespace_name of this StandardTagNamespaceTemplateSummary. + The reserved name of this standard tag namespace + + + :param standard_tag_namespace_name: The standard_tag_namespace_name of this StandardTagNamespaceTemplateSummary. + :type: str + """ + self._standard_tag_namespace_name = standard_tag_namespace_name + + @property + def status(self): + """ + **[Required]** Gets the status of this StandardTagNamespaceTemplateSummary. + The status of the standard tag namespace + + + :return: The status of this StandardTagNamespaceTemplateSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this StandardTagNamespaceTemplateSummary. + The status of the standard tag namespace + + + :param status: The status of this StandardTagNamespaceTemplateSummary. + :type: str + """ + 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/identity/models/tagging_work_request.py b/src/oci/identity/models/tagging_work_request.py index 545f67938d..5299ae58f1 100644 --- a/src/oci/identity/models/tagging_work_request.py +++ b/src/oci/identity/models/tagging_work_request.py @@ -30,6 +30,10 @@ class TaggingWorkRequest(object): #: This constant has a value of "BULK_EDIT_OF_TAGS" OPERATION_TYPE_BULK_EDIT_OF_TAGS = "BULK_EDIT_OF_TAGS" + #: A constant which can be used with the operation_type property of a TaggingWorkRequest. + #: This constant has a value of "IMPORT_STANDARD_TAGS" + OPERATION_TYPE_IMPORT_STANDARD_TAGS = "IMPORT_STANDARD_TAGS" + #: A constant which can be used with the status property of a TaggingWorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -69,7 +73,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this TaggingWorkRequest. - Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -168,7 +172,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this TaggingWorkRequest. An enum-like description of the type of work the work request is doing. - Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -187,7 +191,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this TaggingWorkRequest. :type: str """ - allowed_values = ["DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS"] + allowed_values = ["DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS"] 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/identity/models/tagging_work_request_summary.py b/src/oci/identity/models/tagging_work_request_summary.py index 3dccfe3719..e5a5173454 100644 --- a/src/oci/identity/models/tagging_work_request_summary.py +++ b/src/oci/identity/models/tagging_work_request_summary.py @@ -29,6 +29,10 @@ class TaggingWorkRequestSummary(object): #: This constant has a value of "BULK_EDIT_OF_TAGS" OPERATION_TYPE_BULK_EDIT_OF_TAGS = "BULK_EDIT_OF_TAGS" + #: A constant which can be used with the operation_type property of a TaggingWorkRequestSummary. + #: This constant has a value of "IMPORT_STANDARD_TAGS" + OPERATION_TYPE_IMPORT_STANDARD_TAGS = "IMPORT_STANDARD_TAGS" + #: A constant which can be used with the status property of a TaggingWorkRequestSummary. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -68,7 +72,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this TaggingWorkRequestSummary. - Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -167,7 +171,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this TaggingWorkRequestSummary. An enum-like description of the type of work the work request is doing. - Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -186,7 +190,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this TaggingWorkRequestSummary. :type: str """ - allowed_values = ["DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS"] + allowed_values = ["DELETE_TAG_DEFINITION", "DELETE_NON_EMPTY_TAG_NAMESPACE", "BULK_DELETE_TAG_DEFINITION", "BULK_EDIT_OF_TAGS", "IMPORT_STANDARD_TAGS"] 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/management_agent/management_agent_client.py b/src/oci/management_agent/management_agent_client.py index 924f050db3..34e52aaceb 100644 --- a/src/oci/management_agent/management_agent_client.py +++ b/src/oci/management_agent/management_agent_client.py @@ -1384,7 +1384,7 @@ def list_management_agent_plugins(self, compartment_id, **kwargs): :param list[str] platform_type: (optional) Filter to return only results having the particular platform type. - Allowed values are: "LINUX", "WINDOWS" + Allowed values are: "LINUX", "WINDOWS", "SOLARIS" :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. @@ -1442,7 +1442,7 @@ def list_management_agent_plugins(self, compartment_id, **kwargs): ) if 'platform_type' in kwargs: - platform_type_allowed_values = ["LINUX", "WINDOWS"] + platform_type_allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] for platform_type_item in kwargs['platform_type']: if platform_type_item not in platform_type_allowed_values: raise ValueError( @@ -1525,7 +1525,7 @@ def list_management_agents(self, compartment_id, **kwargs): :param list[str] platform_type: (optional) Filter to return only results having the particular platform type. - Allowed values are: "LINUX", "WINDOWS" + Allowed values are: "LINUX", "WINDOWS", "SOLARIS" :param bool is_customer_deployed: (optional) true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. @@ -1609,7 +1609,7 @@ def list_management_agents(self, compartment_id, **kwargs): ) if 'platform_type' in kwargs: - platform_type_allowed_values = ["LINUX", "WINDOWS"] + platform_type_allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] for platform_type_item in kwargs['platform_type']: if platform_type_item not in platform_type_allowed_values: raise ValueError( diff --git a/src/oci/management_agent/models/management_agent.py b/src/oci/management_agent/models/management_agent.py index 7b41a0e426..29a8c88383 100644 --- a/src/oci/management_agent/models/management_agent.py +++ b/src/oci/management_agent/models/management_agent.py @@ -21,6 +21,10 @@ class ManagementAgent(object): #: This constant has a value of "WINDOWS" PLATFORM_TYPE_WINDOWS = "WINDOWS" + #: A constant which can be used with the platform_type property of a ManagementAgent. + #: This constant has a value of "SOLARIS" + PLATFORM_TYPE_SOLARIS = "SOLARIS" + #: A constant which can be used with the availability_status property of a ManagementAgent. #: This constant has a value of "ACTIVE" AVAILABILITY_STATUS_ACTIVE = "ACTIVE" @@ -92,7 +96,7 @@ def __init__(self, **kwargs): :param platform_type: The value to assign to the platform_type property of this ManagementAgent. - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str @@ -340,7 +344,7 @@ def platform_type(self): Gets the platform_type of this ManagementAgent. Platform Type - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -359,7 +363,7 @@ def platform_type(self, platform_type): :param platform_type: The platform_type of this ManagementAgent. :type: str """ - allowed_values = ["LINUX", "WINDOWS"] + allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] if not value_allowed_none_or_none_sentinel(platform_type, allowed_values): platform_type = 'UNKNOWN_ENUM_VALUE' self._platform_type = platform_type diff --git a/src/oci/management_agent/models/management_agent_aggregation_dimensions.py b/src/oci/management_agent/models/management_agent_aggregation_dimensions.py index 4a4fd2b579..24b49f8f2d 100644 --- a/src/oci/management_agent/models/management_agent_aggregation_dimensions.py +++ b/src/oci/management_agent/models/management_agent_aggregation_dimensions.py @@ -33,6 +33,10 @@ class ManagementAgentAggregationDimensions(object): #: This constant has a value of "WINDOWS" PLATFORM_TYPE_WINDOWS = "WINDOWS" + #: A constant which can be used with the platform_type property of a ManagementAgentAggregationDimensions. + #: This constant has a value of "SOLARIS" + PLATFORM_TYPE_SOLARIS = "SOLARIS" + #: A constant which can be used with the install_type property of a ManagementAgentAggregationDimensions. #: This constant has a value of "AGENT" INSTALL_TYPE_AGENT = "AGENT" @@ -54,7 +58,7 @@ def __init__(self, **kwargs): :param platform_type: The value to assign to the platform_type property of this ManagementAgentAggregationDimensions. - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str @@ -131,7 +135,7 @@ def platform_type(self): Gets the platform_type of this ManagementAgentAggregationDimensions. Platform Type - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -150,7 +154,7 @@ def platform_type(self, platform_type): :param platform_type: The platform_type of this ManagementAgentAggregationDimensions. :type: str """ - allowed_values = ["LINUX", "WINDOWS"] + allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] if not value_allowed_none_or_none_sentinel(platform_type, allowed_values): platform_type = 'UNKNOWN_ENUM_VALUE' self._platform_type = platform_type diff --git a/src/oci/management_agent/models/management_agent_image.py b/src/oci/management_agent/models/management_agent_image.py index 216da7f4c0..e22d03c3ea 100644 --- a/src/oci/management_agent/models/management_agent_image.py +++ b/src/oci/management_agent/models/management_agent_image.py @@ -21,6 +21,10 @@ class ManagementAgentImage(object): #: This constant has a value of "WINDOWS" PLATFORM_TYPE_WINDOWS = "WINDOWS" + #: A constant which can be used with the platform_type property of a ManagementAgentImage. + #: This constant has a value of "SOLARIS" + PLATFORM_TYPE_SOLARIS = "SOLARIS" + #: A constant which can be used with the lifecycle_state property of a ManagementAgentImage. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -64,7 +68,7 @@ def __init__(self, **kwargs): :param platform_type: The value to assign to the platform_type property of this ManagementAgentImage. - Allowed values for this property are: "LINUX", "WINDOWS" + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS" :type platform_type: str :param platform_name: @@ -154,7 +158,7 @@ def platform_type(self): **[Required]** Gets the platform_type of this ManagementAgentImage. Agent image platform type - Allowed values for this property are: "LINUX", "WINDOWS" + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS" :return: The platform_type of this ManagementAgentImage. @@ -172,7 +176,7 @@ def platform_type(self, platform_type): :param platform_type: The platform_type of this ManagementAgentImage. :type: str """ - allowed_values = ["LINUX", "WINDOWS"] + allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] if not value_allowed_none_or_none_sentinel(platform_type, allowed_values): raise ValueError( "Invalid value for `platform_type`, must be None or one of {0}" diff --git a/src/oci/management_agent/models/management_agent_image_summary.py b/src/oci/management_agent/models/management_agent_image_summary.py index e81bb76317..931e8fcdc2 100644 --- a/src/oci/management_agent/models/management_agent_image_summary.py +++ b/src/oci/management_agent/models/management_agent_image_summary.py @@ -21,6 +21,10 @@ class ManagementAgentImageSummary(object): #: This constant has a value of "WINDOWS" PLATFORM_TYPE_WINDOWS = "WINDOWS" + #: A constant which can be used with the platform_type property of a ManagementAgentImageSummary. + #: This constant has a value of "SOLARIS" + PLATFORM_TYPE_SOLARIS = "SOLARIS" + #: A constant which can be used with the lifecycle_state property of a ManagementAgentImageSummary. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -64,7 +68,7 @@ def __init__(self, **kwargs): :param platform_type: The value to assign to the platform_type property of this ManagementAgentImageSummary. - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str @@ -156,7 +160,7 @@ def platform_type(self): **[Required]** Gets the platform_type of this ManagementAgentImageSummary. Agent image platform type - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -175,7 +179,7 @@ def platform_type(self, platform_type): :param platform_type: The platform_type of this ManagementAgentImageSummary. :type: str """ - allowed_values = ["LINUX", "WINDOWS"] + allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] if not value_allowed_none_or_none_sentinel(platform_type, allowed_values): platform_type = 'UNKNOWN_ENUM_VALUE' self._platform_type = platform_type diff --git a/src/oci/management_agent/models/management_agent_summary.py b/src/oci/management_agent/models/management_agent_summary.py index 866c73db94..1888885533 100644 --- a/src/oci/management_agent/models/management_agent_summary.py +++ b/src/oci/management_agent/models/management_agent_summary.py @@ -21,6 +21,10 @@ class ManagementAgentSummary(object): #: This constant has a value of "WINDOWS" PLATFORM_TYPE_WINDOWS = "WINDOWS" + #: A constant which can be used with the platform_type property of a ManagementAgentSummary. + #: This constant has a value of "SOLARIS" + PLATFORM_TYPE_SOLARIS = "SOLARIS" + #: A constant which can be used with the availability_status property of a ManagementAgentSummary. #: This constant has a value of "ACTIVE" AVAILABILITY_STATUS_ACTIVE = "ACTIVE" @@ -92,7 +96,7 @@ def __init__(self, **kwargs): :param platform_type: The value to assign to the platform_type property of this ManagementAgentSummary. - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type platform_type: str @@ -333,7 +337,7 @@ def platform_type(self): Gets the platform_type of this ManagementAgentSummary. Platform Type - Allowed values for this property are: "LINUX", "WINDOWS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LINUX", "WINDOWS", "SOLARIS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -352,7 +356,7 @@ def platform_type(self, platform_type): :param platform_type: The platform_type of this ManagementAgentSummary. :type: str """ - allowed_values = ["LINUX", "WINDOWS"] + allowed_values = ["LINUX", "WINDOWS", "SOLARIS"] if not value_allowed_none_or_none_sentinel(platform_type, allowed_values): platform_type = 'UNKNOWN_ENUM_VALUE' self._platform_type = platform_type diff --git a/src/oci/opsi/models/database_details.py b/src/oci/opsi/models/database_details.py index 69806fe630..09b93a6c2a 100644 --- a/src/oci/opsi/models/database_details.py +++ b/src/oci/opsi/models/database_details.py @@ -26,6 +26,10 @@ def __init__(self, **kwargs): The value to assign to the database_id property of this DatabaseDetails. :type database_id: str + :param compartment_id: + The value to assign to the compartment_id property of this DatabaseDetails. + :type compartment_id: str + :param database_name: The value to assign to the database_name property of this DatabaseDetails. :type database_name: str @@ -54,6 +58,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'id': 'str', 'database_id': 'str', + 'compartment_id': 'str', 'database_name': 'str', 'database_display_name': 'str', 'database_type': 'str', @@ -65,6 +70,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'id': 'id', 'database_id': 'databaseId', + 'compartment_id': 'compartmentId', 'database_name': 'databaseName', 'database_display_name': 'databaseDisplayName', 'database_type': 'databaseType', @@ -75,6 +81,7 @@ def __init__(self, **kwargs): self._id = None self._database_id = None + self._compartment_id = None self._database_name = None self._database_display_name = None self._database_type = None @@ -138,6 +145,34 @@ def database_id(self, database_id): """ self._database_id = database_id + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this DatabaseDetails. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this DatabaseDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DatabaseDetails. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this DatabaseDetails. + :type: str + """ + self._compartment_id = compartment_id + @property def database_name(self): """ diff --git a/src/oci/opsi/models/host_details.py b/src/oci/opsi/models/host_details.py index 64e5432715..ae87cce75b 100644 --- a/src/oci/opsi/models/host_details.py +++ b/src/oci/opsi/models/host_details.py @@ -26,6 +26,10 @@ def __init__(self, **kwargs): The value to assign to the id property of this HostDetails. :type id: str + :param compartment_id: + The value to assign to the compartment_id property of this HostDetails. + :type compartment_id: str + :param host_name: The value to assign to the host_name property of this HostDetails. :type host_name: str @@ -47,6 +51,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { 'id': 'str', + 'compartment_id': 'str', 'host_name': 'str', 'host_display_name': 'str', 'platform_type': 'str', @@ -55,6 +60,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'id': 'id', + 'compartment_id': 'compartmentId', 'host_name': 'hostName', 'host_display_name': 'hostDisplayName', 'platform_type': 'platformType', @@ -62,6 +68,7 @@ def __init__(self, **kwargs): } self._id = None + self._compartment_id = None self._host_name = None self._host_display_name = None self._platform_type = None @@ -95,6 +102,34 @@ def id(self, id): """ self._id = id + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this HostDetails. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this HostDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this HostDetails. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this HostDetails. + :type: str + """ + self._compartment_id = compartment_id + @property def host_name(self): """ diff --git a/src/oci/opsi/models/sql_text_summary.py b/src/oci/opsi/models/sql_text_summary.py index f62f25c547..258530d1cf 100644 --- a/src/oci/opsi/models/sql_text_summary.py +++ b/src/oci/opsi/models/sql_text_summary.py @@ -30,6 +30,10 @@ def __init__(self, **kwargs): The value to assign to the database_id property of this SqlTextSummary. :type database_id: str + :param compartment_id: + The value to assign to the compartment_id property of this SqlTextSummary. + :type compartment_id: str + :param sql_text: The value to assign to the sql_text property of this SqlTextSummary. :type sql_text: str @@ -39,6 +43,7 @@ def __init__(self, **kwargs): 'sql_identifier': 'str', 'id': 'str', 'database_id': 'str', + 'compartment_id': 'str', 'sql_text': 'str' } @@ -46,12 +51,14 @@ def __init__(self, **kwargs): 'sql_identifier': 'sqlIdentifier', 'id': 'id', 'database_id': 'databaseId', + 'compartment_id': 'compartmentId', 'sql_text': 'sqlText' } self._sql_identifier = None self._id = None self._database_id = None + self._compartment_id = None self._sql_text = None @property @@ -134,6 +141,34 @@ def database_id(self, database_id): """ self._database_id = database_id + @property + def compartment_id(self): + """ + Gets the compartment_id of this SqlTextSummary. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this SqlTextSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this SqlTextSummary. + The `OCID`__ of the compartment. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this SqlTextSummary. + :type: str + """ + self._compartment_id = compartment_id + @property def sql_text(self): """ diff --git a/src/oci/opsi/operations_insights_client.py b/src/oci/opsi/operations_insights_client.py index f02f7fdf84..b82e4af4b6 100644 --- a/src/oci/opsi/operations_insights_client.py +++ b/src/oci/opsi/operations_insights_client.py @@ -2909,6 +2909,7 @@ def ingest_sql_text(self, ingest_sql_text_details, **kwargs): def list_database_configurations(self, **kwargs): """ Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified. + When both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned. :param str compartment_id: (optional) @@ -3001,6 +3002,9 @@ def list_database_configurations(self, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -3037,7 +3041,8 @@ def list_database_configurations(self, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -3082,7 +3087,8 @@ def list_database_configurations(self, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3120,6 +3126,7 @@ def list_database_configurations(self, **kwargs): def list_database_insights(self, **kwargs): """ Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. + When both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned. :param str compartment_id: (optional) @@ -3192,6 +3199,9 @@ def list_database_insights(self, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. @@ -3229,6 +3239,7 @@ def list_database_insights(self, **kwargs): "sort_order", "sort_by", "exadata_insight_id", + "compartment_id_in_subtree", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -3295,7 +3306,8 @@ def list_database_insights(self, **kwargs): "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), "sortBy": kwargs.get("sort_by", missing), - "exadataInsightId": kwargs.get("exadata_insight_id", missing) + "exadataInsightId": kwargs.get("exadata_insight_id", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3333,6 +3345,7 @@ def list_database_insights(self, **kwargs): def list_enterprise_manager_bridges(self, **kwargs): """ Gets a list of Operations Insights Enterprise Manager bridges. Either compartmentId or id must be specified. + When both compartmentId and compartmentIdInSubtree are specified, a list of bridges in that compartment and in all sub-compartments will be returned. :param str compartment_id: (optional) @@ -3377,6 +3390,9 @@ def list_enterprise_manager_bridges(self, **kwargs): Allowed values are: "timeCreated", "displayName" + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. @@ -3409,6 +3425,7 @@ def list_enterprise_manager_bridges(self, **kwargs): "page", "sort_order", "sort_by", + "compartment_id_in_subtree", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -3446,7 +3463,8 @@ def list_enterprise_manager_bridges(self, **kwargs): "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "sortBy": kwargs.get("sort_by", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3656,6 +3674,7 @@ def list_exadata_configurations(self, **kwargs): def list_exadata_insights(self, **kwargs): """ Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. + When both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned. :param str compartment_id: (optional) @@ -3711,6 +3730,9 @@ def list_exadata_insights(self, **kwargs): Allowed values are: "timeCreated", "exadataName" + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. @@ -3745,6 +3767,7 @@ def list_exadata_insights(self, **kwargs): "page", "sort_order", "sort_by", + "compartment_id_in_subtree", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -3792,7 +3815,8 @@ def list_exadata_insights(self, **kwargs): "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "sortBy": kwargs.get("sort_by", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -3912,6 +3936,9 @@ def list_host_configurations(self, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -3945,7 +3972,8 @@ def list_host_configurations(self, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -3987,7 +4015,8 @@ def list_host_configurations(self, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4025,6 +4054,7 @@ def list_host_configurations(self, **kwargs): def list_host_insights(self, **kwargs): """ Gets a list of host insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. + When both compartmentId and compartmentIdInSubtree are specified, a list of host insights in that compartment and in all sub-compartments will be returned. :param str compartment_id: (optional) @@ -4091,6 +4121,9 @@ def list_host_insights(self, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. @@ -4127,6 +4160,7 @@ def list_host_insights(self, **kwargs): "sort_by", "enterprise_manager_bridge_id", "exadata_insight_id", + "compartment_id_in_subtree", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -4184,7 +4218,8 @@ def list_host_insights(self, **kwargs): "sortOrder": kwargs.get("sort_order", missing), "sortBy": kwargs.get("sort_by", missing), "enterpriseManagerBridgeId": kwargs.get("enterprise_manager_bridge_id", missing), - "exadataInsightId": kwargs.get("exadata_insight_id", missing) + "exadataInsightId": kwargs.get("exadata_insight_id", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4761,7 +4796,8 @@ def list_sql_plans(self, compartment_id, sql_identifier, plan_hash, **kwargs): def list_sql_searches(self, compartment_id, sql_identifier, **kwargs): """ - Search SQL by SQL Identifier across databases and get the SQL Text and the details of the databases executing the SQL for a given time period. + Search SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified. + And get the SQL Text and the details of the databases executing the SQL for a given time period. :param str compartment_id: (required) @@ -4828,6 +4864,9 @@ def list_sql_searches(self, compartment_id, sql_identifier, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -4856,7 +4895,8 @@ def list_sql_searches(self, compartment_id, sql_identifier, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -4873,7 +4913,8 @@ def list_sql_searches(self, compartment_id, sql_identifier, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4910,7 +4951,7 @@ def list_sql_searches(self, compartment_id, sql_identifier, **kwargs): def list_sql_texts(self, compartment_id, sql_identifier, **kwargs): """ - Query SQL Warehouse to get the full SQL Text for a SQL. + Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -4968,6 +5009,9 @@ def list_sql_texts(self, compartment_id, sql_identifier, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -4995,7 +5039,8 @@ def list_sql_texts(self, compartment_id, sql_identifier, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -5011,7 +5056,8 @@ def list_sql_texts(self, compartment_id, sql_identifier, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5473,6 +5519,7 @@ def summarize_database_insight_resource_capacity_trend(self, compartment_id, res """ Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -5593,6 +5640,9 @@ def summarize_database_insight_resource_capacity_trend(self, compartment_id, res Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -5632,7 +5682,8 @@ def summarize_database_insight_resource_capacity_trend(self, compartment_id, res "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -5689,7 +5740,8 @@ def summarize_database_insight_resource_capacity_trend(self, compartment_id, res "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5727,6 +5779,7 @@ def summarize_database_insight_resource_capacity_trend(self, compartment_id, res def summarize_database_insight_resource_forecast_trend(self, compartment_id, resource_metric, **kwargs): """ Get Forecast predictions for CPU and Storage resources since a time in the past. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -5861,6 +5914,9 @@ def summarize_database_insight_resource_forecast_trend(self, compartment_id, res Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -5902,7 +5958,8 @@ def summarize_database_insight_resource_forecast_trend(self, compartment_id, res "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -5961,7 +6018,8 @@ def summarize_database_insight_resource_forecast_trend(self, compartment_id, res "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5999,7 +6057,7 @@ def summarize_database_insight_resource_forecast_trend(self, compartment_id, res def summarize_database_insight_resource_statistics(self, compartment_id, resource_metric, **kwargs): """ Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled) - for each database filtered by utilization level. + for each database filtered by utilization level in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -6128,6 +6186,9 @@ def summarize_database_insight_resource_statistics(self, compartment_id, resourc Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -6169,7 +6230,8 @@ def summarize_database_insight_resource_statistics(self, compartment_id, resourc "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -6221,7 +6283,8 @@ def summarize_database_insight_resource_statistics(self, compartment_id, resourc "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6261,6 +6324,7 @@ def summarize_database_insight_resource_usage(self, compartment_id, resource_met A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -6359,6 +6423,9 @@ def summarize_database_insight_resource_usage(self, compartment_id, resource_met Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -6394,7 +6461,8 @@ def summarize_database_insight_resource_usage(self, compartment_id, resource_met "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -6426,7 +6494,8 @@ def summarize_database_insight_resource_usage(self, compartment_id, resource_met "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6465,6 +6534,7 @@ def summarize_database_insight_resource_usage_trend(self, compartment_id, resour """ Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -6570,6 +6640,9 @@ def summarize_database_insight_resource_usage_trend(self, compartment_id, resour Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -6606,7 +6679,8 @@ def summarize_database_insight_resource_usage_trend(self, compartment_id, resour "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -6653,7 +6727,8 @@ def summarize_database_insight_resource_usage_trend(self, compartment_id, resour "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6691,6 +6766,7 @@ def summarize_database_insight_resource_usage_trend(self, compartment_id, resour def summarize_database_insight_resource_utilization_insight(self, compartment_id, resource_metric, **kwargs): """ Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -6789,6 +6865,9 @@ def summarize_database_insight_resource_utilization_insight(self, compartment_id Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -6824,7 +6903,8 @@ def summarize_database_insight_resource_utilization_insight(self, compartment_id "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -6856,7 +6936,8 @@ def summarize_database_insight_resource_utilization_insight(self, compartment_id "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -8864,6 +8945,7 @@ def summarize_host_insight_resource_capacity_trend(self, compartment_id, resourc """ Returns response with time series data (endTimestamp, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -8965,6 +9047,9 @@ def summarize_host_insight_resource_capacity_trend(self, compartment_id, resourc Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -8999,7 +9084,8 @@ def summarize_host_insight_resource_capacity_trend(self, compartment_id, resourc "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -9051,7 +9137,8 @@ def summarize_host_insight_resource_capacity_trend(self, compartment_id, resourc "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -9089,6 +9176,7 @@ def summarize_host_insight_resource_capacity_trend(self, compartment_id, resourc def summarize_host_insight_resource_forecast_trend(self, compartment_id, resource_metric, **kwargs): """ Get Forecast predictions for CPU or memory resources since a time in the past. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -9204,6 +9292,9 @@ def summarize_host_insight_resource_forecast_trend(self, compartment_id, resourc Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -9240,7 +9331,8 @@ def summarize_host_insight_resource_forecast_trend(self, compartment_id, resourc "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -9294,7 +9386,8 @@ def summarize_host_insight_resource_forecast_trend(self, compartment_id, resourc "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -9332,7 +9425,7 @@ def summarize_host_insight_resource_forecast_trend(self, compartment_id, resourc def summarize_host_insight_resource_statistics(self, compartment_id, resource_metric, **kwargs): """ Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered - by utilization level. + by utilization level in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -9445,6 +9538,9 @@ def summarize_host_insight_resource_statistics(self, compartment_id, resource_me Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -9482,7 +9578,8 @@ def summarize_host_insight_resource_statistics(self, compartment_id, resource_me "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -9530,7 +9627,8 @@ def summarize_host_insight_resource_statistics(self, compartment_id, resource_me "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -9570,6 +9668,7 @@ def summarize_host_insight_resource_usage(self, compartment_id, resource_metric, A cumulative distribution function is used to rank the usage data points per host within the specified time period. For each host, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -9655,6 +9754,9 @@ def summarize_host_insight_resource_usage(self, compartment_id, resource_metric, Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -9687,7 +9789,8 @@ def summarize_host_insight_resource_usage(self, compartment_id, resource_metric, "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -9716,7 +9819,8 @@ def summarize_host_insight_resource_usage(self, compartment_id, resource_metric, "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -9755,6 +9859,7 @@ def summarize_host_insight_resource_usage_trend(self, compartment_id, resource_m """ Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -9847,6 +9952,9 @@ def summarize_host_insight_resource_usage_trend(self, compartment_id, resource_m Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -9880,7 +9988,8 @@ def summarize_host_insight_resource_usage_trend(self, compartment_id, resource_m "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -9924,7 +10033,8 @@ def summarize_host_insight_resource_usage_trend(self, compartment_id, resource_m "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -9962,6 +10072,7 @@ def summarize_host_insight_resource_usage_trend(self, compartment_id, resource_m def summarize_host_insight_resource_utilization_insight(self, compartment_id, resource_metric, **kwargs): """ Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. + If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. :param str compartment_id: (required) @@ -10047,6 +10158,9 @@ def summarize_host_insight_resource_utilization_insight(self, compartment_id, re Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -10079,7 +10193,8 @@ def summarize_host_insight_resource_utilization_insight(self, compartment_id, re "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -10108,7 +10223,8 @@ def summarize_host_insight_resource_utilization_insight(self, compartment_id, re "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -10146,7 +10262,7 @@ def summarize_host_insight_resource_utilization_insight(self, compartment_id, re def summarize_sql_insights(self, compartment_id, **kwargs): """ Query SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given - time period across the given databases or database types. + time period across the given databases or database types in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -10239,6 +10355,9 @@ def summarize_sql_insights(self, compartment_id, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -10274,7 +10393,8 @@ def summarize_sql_insights(self, compartment_id, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -10305,7 +10425,8 @@ def summarize_sql_insights(self, compartment_id, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -10605,7 +10726,7 @@ def summarize_sql_response_time_distributions(self, compartment_id, sql_identifi def summarize_sql_statistics(self, compartment_id, **kwargs): """ Query SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given - time period across the given databases or database types. + time period across the given databases or database types in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -10727,6 +10848,9 @@ def summarize_sql_statistics(self, compartment_id, **kwargs): Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -10767,7 +10891,8 @@ def summarize_sql_statistics(self, compartment_id, **kwargs): "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -10825,7 +10950,8 @@ def summarize_sql_statistics(self, compartment_id, **kwargs): "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -10862,7 +10988,8 @@ def summarize_sql_statistics(self, compartment_id, **kwargs): def summarize_sql_statistics_time_series(self, compartment_id, sql_identifier, **kwargs): """ - Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period. + Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a + given time period in a compartment and in all sub-compartments if specified. :param str compartment_id: (required) @@ -10950,6 +11077,9 @@ def summarize_sql_statistics_time_series(self, compartment_id, sql_identifier, * Currently, only existence (\"true\" at the end) is supported. Absence (\"false\" at the end) is not supported. Multiple values for different tag names are interpreted as \"AND\". + :param bool compartment_id_in_subtree: (optional) + A flag to search all resources within a given compartment and all sub-compartments. + :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. @@ -10983,7 +11113,8 @@ def summarize_sql_statistics_time_series(self, compartment_id, sql_identifier, * "defined_tag_equals", "freeform_tag_equals", "defined_tag_exists", - "freeform_tag_exists" + "freeform_tag_exists", + "compartment_id_in_subtree" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -11005,7 +11136,8 @@ def summarize_sql_statistics_time_series(self, compartment_id, sql_identifier, * "definedTagEquals": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_equals", missing), 'multi'), "freeformTagEquals": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_equals", missing), 'multi'), "definedTagExists": self.base_client.generate_collection_format_param(kwargs.get("defined_tag_exists", missing), 'multi'), - "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi') + "freeformTagExists": self.base_client.generate_collection_format_param(kwargs.get("freeform_tag_exists", missing), 'multi'), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} diff --git a/src/oci/regions_definitions.py b/src/oci/regions_definitions.py index e7c1be88e3..4b644ed3dc 100644 --- a/src/oci/regions_definitions.py +++ b/src/oci/regions_definitions.py @@ -29,6 +29,8 @@ 'mtz': 'il-jerusalem-1', 'mrs': 'eu-marseille-1', 'sin': 'ap-singapore-1', + 'auh': 'me-abudhabi-1', + 'lin': 'eu-milan-1', 'lfi': 'us-langley-1', 'luf': 'us-luke-1', 'ric': 'us-gov-ashburn-1', @@ -66,6 +68,8 @@ 'il-jerusalem-1': 'oc1', 'eu-marseille-1': 'oc1', 'ap-singapore-1': 'oc1', + 'me-abudhabi-1': 'oc1', + 'eu-milan-1': 'oc1', 'us-langley-1': 'oc2', 'us-luke-1': 'oc2', @@ -114,6 +118,8 @@ 'il-jerusalem-1', 'eu-marseille-1', 'ap-singapore-1', + 'me-abudhabi-1', + 'eu-milan-1', 'us-langley-1', 'us-luke-1', 'us-gov-ashburn-1', diff --git a/src/oci/version.py b/src/oci/version.py index 6ecab410ca..0f710ac30c 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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.51.0" +__version__ = "2.52.0"