diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2f1470b087..8faaf0e042 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,34 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.141.0 - 2024-12-17 +==================== + +Added +----- +* Support for backup retention locks on autonomous database create and update operations in the Database service +* Support for multi-modality flags in data source in the Generative AI service +* Support for knowledge base statistics in the Generative AI service +* Support for document id, title and page numbers in citations in the Generative AI service +* Support for creating and updating Amazon Web Services (AWS) asset-sources, EC2 and Elastic Block Store (EBS) assets in the Cloud Bridge service +* Support for listing Amazon Web Services (AWS) regions available for discovery and migrations in the Cloud Bridge service +* Support for stored video analysis in the AI Vision service +* Support for HTTP or REST endpoint-based metric extensions in the OCI Monitoring service +* Support for metric extension filter in the list metric extensions operation in the OCI Monitoring service +* Support for creating and updating private endpoints for model deployments in the Data Science service +* Support for OCI Identity user integration in the Big Data service +* Support for user principal session tokens in the Big Data service +* Support for historical cluster versions in the Big Data service +* Support for new SKUs for digital assets editions in the Blockchain Platform service +* Support for Zero ETL pipelines in the GoldenGate service + +Breaking +-------- +* Removed fallback to the deprecated Instance Metadata service (IMDS) V1 endpoint +* `INSTANCE_METADATA_URL_CERTIFICATE_RETRIEVER_RETRY_STRATEGY` was modified to do 8 retry attempts and exponential backoff with Jitter between attempts, instead of 3 fixed interval retries +* Parameter `compartment_id` in operation `list_metric_extensions` was removed from the `StackMonitoringClient` in the OCI Monitoring service + ==================== 2.140.0 - 2024-12-10 ==================== diff --git a/docs/api/ai_vision.rst b/docs/api/ai_vision.rst index 6bac6e50e9..7a91e621c4 100644 --- a/docs/api/ai_vision.rst +++ b/docs/api/ai_vision.rst @@ -22,6 +22,7 @@ Ai Vision oci.ai_vision.models.AnalyzeDocumentResult oci.ai_vision.models.AnalyzeImageDetails oci.ai_vision.models.AnalyzeImageResult + oci.ai_vision.models.AnalyzeVideoResult oci.ai_vision.models.BoundingPolygon oci.ai_vision.models.Cell oci.ai_vision.models.ChangeModelCompartmentDetails @@ -30,6 +31,7 @@ Ai Vision oci.ai_vision.models.CreateImageJobDetails oci.ai_vision.models.CreateModelDetails oci.ai_vision.models.CreateProjectDetails + oci.ai_vision.models.CreateVideoJobDetails oci.ai_vision.models.DataScienceLabelingDataset oci.ai_vision.models.Dataset oci.ai_vision.models.DetectedDocumentType @@ -70,6 +72,7 @@ Ai Vision oci.ai_vision.models.NormalizedVertex oci.ai_vision.models.ObjectListInlineInputLocation oci.ai_vision.models.ObjectLocation + oci.ai_vision.models.ObjectProperty oci.ai_vision.models.ObjectStorageDataset oci.ai_vision.models.ObjectStorageDocumentDetails oci.ai_vision.models.ObjectStorageImageDetails @@ -91,6 +94,30 @@ Ai Vision oci.ai_vision.models.ValuePhoneNumber oci.ai_vision.models.ValueString oci.ai_vision.models.ValueTime + oci.ai_vision.models.VideoFace + oci.ai_vision.models.VideoFaceDetectionFeature + oci.ai_vision.models.VideoFaceFrame + oci.ai_vision.models.VideoFaceSegment + oci.ai_vision.models.VideoFeature + oci.ai_vision.models.VideoJob + oci.ai_vision.models.VideoLabel + oci.ai_vision.models.VideoLabelDetectionFeature + oci.ai_vision.models.VideoLabelSegment + oci.ai_vision.models.VideoMetadata + oci.ai_vision.models.VideoObject + oci.ai_vision.models.VideoObjectDetectionFeature + oci.ai_vision.models.VideoObjectFrame + oci.ai_vision.models.VideoObjectSegment + oci.ai_vision.models.VideoObjectTrackingFeature + oci.ai_vision.models.VideoSegment + oci.ai_vision.models.VideoText + oci.ai_vision.models.VideoTextDetectionFeature + oci.ai_vision.models.VideoTextFrame + oci.ai_vision.models.VideoTextSegment + oci.ai_vision.models.VideoTrackedObject + oci.ai_vision.models.VideoTrackedObjectProperties + oci.ai_vision.models.VideoTrackedObjectSegment + oci.ai_vision.models.VideoTrackingFrame oci.ai_vision.models.Word oci.ai_vision.models.WorkRequest oci.ai_vision.models.WorkRequestError diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.AnalyzeVideoResult.rst b/docs/api/ai_vision/models/oci.ai_vision.models.AnalyzeVideoResult.rst new file mode 100644 index 0000000000..5eaae243d1 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.AnalyzeVideoResult.rst @@ -0,0 +1,11 @@ +AnalyzeVideoResult +================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: AnalyzeVideoResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.CreateVideoJobDetails.rst b/docs/api/ai_vision/models/oci.ai_vision.models.CreateVideoJobDetails.rst new file mode 100644 index 0000000000..44bb92b307 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.CreateVideoJobDetails.rst @@ -0,0 +1,11 @@ +CreateVideoJobDetails +===================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: CreateVideoJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.ObjectProperty.rst b/docs/api/ai_vision/models/oci.ai_vision.models.ObjectProperty.rst new file mode 100644 index 0000000000..9fe9767ac1 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.ObjectProperty.rst @@ -0,0 +1,11 @@ +ObjectProperty +============== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: ObjectProperty + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoFace.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFace.rst new file mode 100644 index 0000000000..c179461b17 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFace.rst @@ -0,0 +1,11 @@ +VideoFace +========= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoFace + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceDetectionFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceDetectionFeature.rst new file mode 100644 index 0000000000..996a77af2f --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceDetectionFeature.rst @@ -0,0 +1,11 @@ +VideoFaceDetectionFeature +========================= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoFaceDetectionFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceFrame.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceFrame.rst new file mode 100644 index 0000000000..6d1df24c7e --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceFrame.rst @@ -0,0 +1,11 @@ +VideoFaceFrame +============== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoFaceFrame + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceSegment.rst new file mode 100644 index 0000000000..bf558730ce --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFaceSegment.rst @@ -0,0 +1,11 @@ +VideoFaceSegment +================ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoFaceSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFeature.rst new file mode 100644 index 0000000000..5bf8fd8bb1 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoFeature.rst @@ -0,0 +1,11 @@ +VideoFeature +============ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoJob.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoJob.rst new file mode 100644 index 0000000000..3973781f57 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoJob.rst @@ -0,0 +1,11 @@ +VideoJob +======== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoJob + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabel.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabel.rst new file mode 100644 index 0000000000..75235b8069 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabel.rst @@ -0,0 +1,11 @@ +VideoLabel +========== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoLabel + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelDetectionFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelDetectionFeature.rst new file mode 100644 index 0000000000..3cef909f72 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelDetectionFeature.rst @@ -0,0 +1,11 @@ +VideoLabelDetectionFeature +========================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoLabelDetectionFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelSegment.rst new file mode 100644 index 0000000000..cf139c47ca --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoLabelSegment.rst @@ -0,0 +1,11 @@ +VideoLabelSegment +================= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoLabelSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoMetadata.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoMetadata.rst new file mode 100644 index 0000000000..4861e65e0d --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoMetadata.rst @@ -0,0 +1,11 @@ +VideoMetadata +============= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoMetadata + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoObject.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObject.rst new file mode 100644 index 0000000000..eba28a2cb5 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObject.rst @@ -0,0 +1,11 @@ +VideoObject +=========== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoObject + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectDetectionFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectDetectionFeature.rst new file mode 100644 index 0000000000..9e105da051 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectDetectionFeature.rst @@ -0,0 +1,11 @@ +VideoObjectDetectionFeature +=========================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoObjectDetectionFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectFrame.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectFrame.rst new file mode 100644 index 0000000000..ae865879be --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectFrame.rst @@ -0,0 +1,11 @@ +VideoObjectFrame +================ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoObjectFrame + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectSegment.rst new file mode 100644 index 0000000000..827deb4f84 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectSegment.rst @@ -0,0 +1,11 @@ +VideoObjectSegment +================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoObjectSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectTrackingFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectTrackingFeature.rst new file mode 100644 index 0000000000..39a9aaf5a4 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoObjectTrackingFeature.rst @@ -0,0 +1,11 @@ +VideoObjectTrackingFeature +========================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoObjectTrackingFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoSegment.rst new file mode 100644 index 0000000000..ec08038134 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoSegment.rst @@ -0,0 +1,11 @@ +VideoSegment +============ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoText.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoText.rst new file mode 100644 index 0000000000..e5f15aa097 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoText.rst @@ -0,0 +1,11 @@ +VideoText +========= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoText + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextDetectionFeature.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextDetectionFeature.rst new file mode 100644 index 0000000000..c52ab3a0c0 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextDetectionFeature.rst @@ -0,0 +1,11 @@ +VideoTextDetectionFeature +========================= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTextDetectionFeature + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextFrame.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextFrame.rst new file mode 100644 index 0000000000..aa4ca7320b --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextFrame.rst @@ -0,0 +1,11 @@ +VideoTextFrame +============== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTextFrame + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextSegment.rst new file mode 100644 index 0000000000..05225aedce --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTextSegment.rst @@ -0,0 +1,11 @@ +VideoTextSegment +================ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTextSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObject.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObject.rst new file mode 100644 index 0000000000..a67b4ddefc --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObject.rst @@ -0,0 +1,11 @@ +VideoTrackedObject +================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTrackedObject + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectProperties.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectProperties.rst new file mode 100644 index 0000000000..f25a758321 --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectProperties.rst @@ -0,0 +1,11 @@ +VideoTrackedObjectProperties +============================ + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTrackedObjectProperties + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectSegment.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectSegment.rst new file mode 100644 index 0000000000..fe54ec75fa --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackedObjectSegment.rst @@ -0,0 +1,11 @@ +VideoTrackedObjectSegment +========================= + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTrackedObjectSegment + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackingFrame.rst b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackingFrame.rst new file mode 100644 index 0000000000..e7e1ec33cf --- /dev/null +++ b/docs/api/ai_vision/models/oci.ai_vision.models.VideoTrackingFrame.rst @@ -0,0 +1,11 @@ +VideoTrackingFrame +================== + +.. currentmodule:: oci.ai_vision.models + +.. autoclass:: VideoTrackingFrame + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds.rst b/docs/api/bds.rst index f3415884fc..2b12ecd04a 100644 --- a/docs/api/bds.rst +++ b/docs/api/bds.rst @@ -19,6 +19,8 @@ Bds :template: autosummary/model_class.rst oci.bds.models.ActivateBdsMetastoreConfigurationDetails + oci.bds.models.ActivateIamUserSyncConfigurationDetails + oci.bds.models.ActivateUpstConfigurationDetails oci.bds.models.AddAutoScalePolicyDetails oci.bds.models.AddAutoScalingConfigurationDetails oci.bds.models.AddBlockStorageDetails @@ -42,6 +44,7 @@ Bds oci.bds.models.BatchingBasedPatchingConfigs oci.bds.models.BdsApiKey oci.bds.models.BdsApiKeySummary + oci.bds.models.BdsClusterVersionSummary oci.bds.models.BdsInstance oci.bds.models.BdsInstanceSummary oci.bds.models.BdsMetastoreConfiguration @@ -56,12 +59,15 @@ Bds oci.bds.models.CreateBdsApiKeyDetails oci.bds.models.CreateBdsInstanceDetails oci.bds.models.CreateBdsMetastoreConfigurationDetails + oci.bds.models.CreateIdentityConfigurationDetails oci.bds.models.CreateNodeBackupConfigurationDetails oci.bds.models.CreateNodeDetails oci.bds.models.CreateNodeReplaceConfigurationDetails oci.bds.models.CreateResourcePrincipalConfigurationDetails oci.bds.models.DayBasedHorizontalScalingScheduleDetails oci.bds.models.DayBasedVerticalScalingScheduleDetails + oci.bds.models.DeactivateIamUserSyncConfigurationDetails + oci.bds.models.DeactivateUpstConfigurationDetails oci.bds.models.DefaultError oci.bds.models.DisableCertificateDetails oci.bds.models.DomainBasedOdhPatchingConfig @@ -74,6 +80,10 @@ Bds oci.bds.models.HorizontalScalingScheduleDetails oci.bds.models.HostCertDetails oci.bds.models.HostSpecificCertificateDetails + oci.bds.models.IamUserSyncConfiguration + oci.bds.models.IamUserSyncConfigurationDetails + oci.bds.models.IdentityConfiguration + oci.bds.models.IdentityConfigurationSummary oci.bds.models.InstallOsPatchDetails oci.bds.models.InstallPatchDetails oci.bds.models.KerberosDetails @@ -95,6 +105,7 @@ Bds oci.bds.models.NodeReplaceConfiguration oci.bds.models.NodeReplaceConfigurationSummary oci.bds.models.NodeTypeLevelDetails + oci.bds.models.NodeTypeShapeConfig oci.bds.models.OdhPatchingConfig oci.bds.models.OsPatchDetails oci.bds.models.OsPatchPackageSummary @@ -102,6 +113,8 @@ Bds oci.bds.models.PatchHistorySummary oci.bds.models.PatchSummary oci.bds.models.PatchingConfigs + oci.bds.models.RefreshConfidentialApplicationDetails + oci.bds.models.RefreshUpstTokenExchangeKeytabDetails oci.bds.models.RemoveAutoScalingConfigurationDetails oci.bds.models.RemoveCloudSqlDetails oci.bds.models.RemoveKafkaDetails @@ -117,6 +130,7 @@ Bds oci.bds.models.ScheduleBasedVerticalScalingPolicyDetails oci.bds.models.ShapeConfigDetails oci.bds.models.StartBdsInstanceDetails + oci.bds.models.StartClusterShapeConfigs oci.bds.models.StopBdsInstanceDetails oci.bds.models.TestBdsMetastoreConfigurationDetails oci.bds.models.TestBdsObjectStorageConnectionDetails @@ -126,6 +140,7 @@ Bds oci.bds.models.UpdateAutoScalingConfigurationDetails oci.bds.models.UpdateBdsInstanceDetails oci.bds.models.UpdateBdsMetastoreConfigurationDetails + oci.bds.models.UpdateIdentityConfigurationDetails oci.bds.models.UpdateMetricBasedHorizontalScalingPolicyDetails oci.bds.models.UpdateMetricBasedVerticalScalingPolicyDetails oci.bds.models.UpdateNodeBackupConfigurationDetails @@ -133,6 +148,8 @@ Bds oci.bds.models.UpdateResourcePrincipalConfigurationDetails oci.bds.models.UpdateScheduleBasedHorizontalScalingPolicyDetails oci.bds.models.UpdateScheduleBasedVerticalScalingPolicyDetails + oci.bds.models.UpstConfiguration + oci.bds.models.UpstConfigurationDetails oci.bds.models.VerticalScalingScheduleDetails oci.bds.models.VolumeAttachmentDetail oci.bds.models.WorkRequest diff --git a/docs/api/bds/models/oci.bds.models.ActivateIamUserSyncConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.ActivateIamUserSyncConfigurationDetails.rst new file mode 100644 index 0000000000..c82bd94856 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.ActivateIamUserSyncConfigurationDetails.rst @@ -0,0 +1,11 @@ +ActivateIamUserSyncConfigurationDetails +======================================= + +.. currentmodule:: oci.bds.models + +.. autoclass:: ActivateIamUserSyncConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.ActivateUpstConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.ActivateUpstConfigurationDetails.rst new file mode 100644 index 0000000000..6461a599fc --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.ActivateUpstConfigurationDetails.rst @@ -0,0 +1,11 @@ +ActivateUpstConfigurationDetails +================================ + +.. currentmodule:: oci.bds.models + +.. autoclass:: ActivateUpstConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.BdsClusterVersionSummary.rst b/docs/api/bds/models/oci.bds.models.BdsClusterVersionSummary.rst new file mode 100644 index 0000000000..282ad0d057 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.BdsClusterVersionSummary.rst @@ -0,0 +1,11 @@ +BdsClusterVersionSummary +======================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: BdsClusterVersionSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.CreateIdentityConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.CreateIdentityConfigurationDetails.rst new file mode 100644 index 0000000000..72e6cba850 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.CreateIdentityConfigurationDetails.rst @@ -0,0 +1,11 @@ +CreateIdentityConfigurationDetails +================================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: CreateIdentityConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.DeactivateIamUserSyncConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.DeactivateIamUserSyncConfigurationDetails.rst new file mode 100644 index 0000000000..191355811e --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.DeactivateIamUserSyncConfigurationDetails.rst @@ -0,0 +1,11 @@ +DeactivateIamUserSyncConfigurationDetails +========================================= + +.. currentmodule:: oci.bds.models + +.. autoclass:: DeactivateIamUserSyncConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.DeactivateUpstConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.DeactivateUpstConfigurationDetails.rst new file mode 100644 index 0000000000..afe2e3c253 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.DeactivateUpstConfigurationDetails.rst @@ -0,0 +1,11 @@ +DeactivateUpstConfigurationDetails +================================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: DeactivateUpstConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.IamUserSyncConfiguration.rst b/docs/api/bds/models/oci.bds.models.IamUserSyncConfiguration.rst new file mode 100644 index 0000000000..ed2b88b097 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.IamUserSyncConfiguration.rst @@ -0,0 +1,11 @@ +IamUserSyncConfiguration +======================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: IamUserSyncConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.IamUserSyncConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.IamUserSyncConfigurationDetails.rst new file mode 100644 index 0000000000..11c0f03b87 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.IamUserSyncConfigurationDetails.rst @@ -0,0 +1,11 @@ +IamUserSyncConfigurationDetails +=============================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: IamUserSyncConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.IdentityConfiguration.rst b/docs/api/bds/models/oci.bds.models.IdentityConfiguration.rst new file mode 100644 index 0000000000..0151237d04 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.IdentityConfiguration.rst @@ -0,0 +1,11 @@ +IdentityConfiguration +===================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: IdentityConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.IdentityConfigurationSummary.rst b/docs/api/bds/models/oci.bds.models.IdentityConfigurationSummary.rst new file mode 100644 index 0000000000..4e5653b29a --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.IdentityConfigurationSummary.rst @@ -0,0 +1,11 @@ +IdentityConfigurationSummary +============================ + +.. currentmodule:: oci.bds.models + +.. autoclass:: IdentityConfigurationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.NodeTypeShapeConfig.rst b/docs/api/bds/models/oci.bds.models.NodeTypeShapeConfig.rst new file mode 100644 index 0000000000..70435f1b4f --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.NodeTypeShapeConfig.rst @@ -0,0 +1,11 @@ +NodeTypeShapeConfig +=================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: NodeTypeShapeConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.RefreshConfidentialApplicationDetails.rst b/docs/api/bds/models/oci.bds.models.RefreshConfidentialApplicationDetails.rst new file mode 100644 index 0000000000..a2c53e49ae --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.RefreshConfidentialApplicationDetails.rst @@ -0,0 +1,11 @@ +RefreshConfidentialApplicationDetails +===================================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: RefreshConfidentialApplicationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.RefreshUpstTokenExchangeKeytabDetails.rst b/docs/api/bds/models/oci.bds.models.RefreshUpstTokenExchangeKeytabDetails.rst new file mode 100644 index 0000000000..2bbd3c454c --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.RefreshUpstTokenExchangeKeytabDetails.rst @@ -0,0 +1,11 @@ +RefreshUpstTokenExchangeKeytabDetails +===================================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: RefreshUpstTokenExchangeKeytabDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.StartClusterShapeConfigs.rst b/docs/api/bds/models/oci.bds.models.StartClusterShapeConfigs.rst new file mode 100644 index 0000000000..427e1d1c7a --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.StartClusterShapeConfigs.rst @@ -0,0 +1,11 @@ +StartClusterShapeConfigs +======================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: StartClusterShapeConfigs + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.UpdateIdentityConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.UpdateIdentityConfigurationDetails.rst new file mode 100644 index 0000000000..2228543c22 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.UpdateIdentityConfigurationDetails.rst @@ -0,0 +1,11 @@ +UpdateIdentityConfigurationDetails +================================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: UpdateIdentityConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.UpstConfiguration.rst b/docs/api/bds/models/oci.bds.models.UpstConfiguration.rst new file mode 100644 index 0000000000..35e8b4c54b --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.UpstConfiguration.rst @@ -0,0 +1,11 @@ +UpstConfiguration +================= + +.. currentmodule:: oci.bds.models + +.. autoclass:: UpstConfiguration + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/bds/models/oci.bds.models.UpstConfigurationDetails.rst b/docs/api/bds/models/oci.bds.models.UpstConfigurationDetails.rst new file mode 100644 index 0000000000..b67a652b91 --- /dev/null +++ b/docs/api/bds/models/oci.bds.models.UpstConfigurationDetails.rst @@ -0,0 +1,11 @@ +UpstConfigurationDetails +======================== + +.. currentmodule:: oci.bds.models + +.. autoclass:: UpstConfigurationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_bridge.rst b/docs/api/cloud_bridge.rst index 761a43cc12..895179fec8 100644 --- a/docs/api/cloud_bridge.rst +++ b/docs/api/cloud_bridge.rst @@ -47,8 +47,10 @@ Cloud Bridge oci.cloud_bridge.models.AwsAssetSource oci.cloud_bridge.models.AwsAssetSourceSummary oci.cloud_bridge.models.AwsEbsAsset + oci.cloud_bridge.models.AwsEbsAssetDetails oci.cloud_bridge.models.AwsEbsProperties oci.cloud_bridge.models.AwsEc2Asset + oci.cloud_bridge.models.AwsEc2AssetDetails oci.cloud_bridge.models.AwsEc2Properties oci.cloud_bridge.models.ChangeAgentCompartmentDetails oci.cloud_bridge.models.ChangeAgentDependencyCompartmentDetails @@ -116,6 +118,7 @@ Cloud Bridge oci.cloud_bridge.models.UpdateDiscoveryScheduleDetails oci.cloud_bridge.models.UpdateEnvironmentDetails oci.cloud_bridge.models.UpdateInventoryDetails + oci.cloud_bridge.models.UpdatePluginDetails oci.cloud_bridge.models.UpdateVmAssetDetails oci.cloud_bridge.models.UpdateVmWareAssetSourceDetails oci.cloud_bridge.models.UpdateVmwareVmAssetDetails diff --git a/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEbsAssetDetails.rst b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEbsAssetDetails.rst new file mode 100644 index 0000000000..e4a5503a65 --- /dev/null +++ b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEbsAssetDetails.rst @@ -0,0 +1,11 @@ +AwsEbsAssetDetails +================== + +.. currentmodule:: oci.cloud_bridge.models + +.. autoclass:: AwsEbsAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEc2AssetDetails.rst b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEc2AssetDetails.rst new file mode 100644 index 0000000000..4aa0e18676 --- /dev/null +++ b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.AwsEc2AssetDetails.rst @@ -0,0 +1,11 @@ +AwsEc2AssetDetails +================== + +.. currentmodule:: oci.cloud_bridge.models + +.. autoclass:: AwsEc2AssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_bridge/models/oci.cloud_bridge.models.UpdatePluginDetails.rst b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.UpdatePluginDetails.rst new file mode 100644 index 0000000000..2147f5957a --- /dev/null +++ b/docs/api/cloud_bridge/models/oci.cloud_bridge.models.UpdatePluginDetails.rst @@ -0,0 +1,11 @@ +UpdatePluginDetails +=================== + +.. currentmodule:: oci.cloud_bridge.models + +.. autoclass:: UpdatePluginDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/generative_ai_agent.rst b/docs/api/generative_ai_agent.rst index a8abf475bc..f4f038f759 100644 --- a/docs/api/generative_ai_agent.rst +++ b/docs/api/generative_ai_agent.rst @@ -52,6 +52,7 @@ Generative Ai Agent oci.generative_ai_agent.models.IndexSchema oci.generative_ai_agent.models.KnowledgeBase oci.generative_ai_agent.models.KnowledgeBaseCollection + oci.generative_ai_agent.models.KnowledgeBaseStatistics oci.generative_ai_agent.models.KnowledgeBaseSummary oci.generative_ai_agent.models.ObjectStoragePrefix oci.generative_ai_agent.models.OciDatabaseConfig diff --git a/docs/api/generative_ai_agent/models/oci.generative_ai_agent.models.KnowledgeBaseStatistics.rst b/docs/api/generative_ai_agent/models/oci.generative_ai_agent.models.KnowledgeBaseStatistics.rst new file mode 100644 index 0000000000..68a764e019 --- /dev/null +++ b/docs/api/generative_ai_agent/models/oci.generative_ai_agent.models.KnowledgeBaseStatistics.rst @@ -0,0 +1,11 @@ +KnowledgeBaseStatistics +======================= + +.. currentmodule:: oci.generative_ai_agent.models + +.. autoclass:: KnowledgeBaseStatistics + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate.rst b/docs/api/golden_gate.rst index bd8299983d..7f46aa88fd 100644 --- a/docs/api/golden_gate.rst +++ b/docs/api/golden_gate.rst @@ -39,6 +39,7 @@ Golden Gate oci.golden_gate.models.ChangeDatabaseRegistrationCompartmentDetails oci.golden_gate.models.ChangeDeploymentBackupCompartmentDetails oci.golden_gate.models.ChangeDeploymentCompartmentDetails + oci.golden_gate.models.ChangePipelineCompartmentDetails oci.golden_gate.models.CollectDeploymentDiagnosticDetails oci.golden_gate.models.Connection oci.golden_gate.models.ConnectionAssignment @@ -77,9 +78,11 @@ Golden Gate oci.golden_gate.models.CreateOggDeploymentDetails oci.golden_gate.models.CreateOracleConnectionDetails oci.golden_gate.models.CreateOracleNosqlConnectionDetails + oci.golden_gate.models.CreatePipelineDetails oci.golden_gate.models.CreatePostgresqlConnectionDetails oci.golden_gate.models.CreateRedisConnectionDetails oci.golden_gate.models.CreateSnowflakeConnectionDetails + oci.golden_gate.models.CreateZeroEtlPipelineDetails oci.golden_gate.models.DatabaseRegistration oci.golden_gate.models.DatabaseRegistrationCollection oci.golden_gate.models.DatabaseRegistrationSummary @@ -94,8 +97,11 @@ Golden Gate oci.golden_gate.models.DefaultRollbackDeploymentUpgradeDetails oci.golden_gate.models.DefaultSnoozeDeploymentUpgradeDetails oci.golden_gate.models.DefaultStartDeploymentDetails + oci.golden_gate.models.DefaultStartPipelineDetails oci.golden_gate.models.DefaultStopDeploymentDetails + oci.golden_gate.models.DefaultStopPipelineDetails oci.golden_gate.models.DefaultTestConnectionAssignmentDetails + oci.golden_gate.models.DefaultTestPipelineConnectionDetails oci.golden_gate.models.DefaultUpgradeDeploymentUpgradeDetails oci.golden_gate.models.Deployment oci.golden_gate.models.DeploymentBackup @@ -136,6 +142,7 @@ Golden Gate oci.golden_gate.models.HdfsConnectionSummary oci.golden_gate.models.ImportDeploymentWalletDetails oci.golden_gate.models.IngressIpDetails + oci.golden_gate.models.InitialDataLoad oci.golden_gate.models.JavaMessageServiceConnection oci.golden_gate.models.JavaMessageServiceConnectionSummary oci.golden_gate.models.KafkaBootstrapServer @@ -146,6 +153,7 @@ Golden Gate oci.golden_gate.models.LibraryUrl oci.golden_gate.models.MaintenanceConfiguration oci.golden_gate.models.MaintenanceWindow + oci.golden_gate.models.MappingRule oci.golden_gate.models.MessageSummary oci.golden_gate.models.MicrosoftSqlserverConnection oci.golden_gate.models.MicrosoftSqlserverConnectionSummary @@ -161,12 +169,27 @@ Golden Gate oci.golden_gate.models.OracleConnectionSummary oci.golden_gate.models.OracleNosqlConnection oci.golden_gate.models.OracleNosqlConnectionSummary + oci.golden_gate.models.Pipeline + oci.golden_gate.models.PipelineCollection + oci.golden_gate.models.PipelineInitializationStep + oci.golden_gate.models.PipelineInitializationSteps + oci.golden_gate.models.PipelineRunningProcessCollection + oci.golden_gate.models.PipelineRunningProcessSummary + oci.golden_gate.models.PipelineSchemaCollection + oci.golden_gate.models.PipelineSchemaSummary + oci.golden_gate.models.PipelineSchemaTableCollection + oci.golden_gate.models.PipelineSchemaTableSummary + oci.golden_gate.models.PipelineSummary oci.golden_gate.models.PostgresqlConnection oci.golden_gate.models.PostgresqlConnectionSummary + oci.golden_gate.models.ProcessOptions + oci.golden_gate.models.RecipeSummary + oci.golden_gate.models.RecipeSummaryCollection oci.golden_gate.models.RedisConnection oci.golden_gate.models.RedisConnectionSummary oci.golden_gate.models.RefreshConnectionDetails oci.golden_gate.models.RemoveResourceLockDetails + oci.golden_gate.models.ReplicateSchemaChange oci.golden_gate.models.RescheduleDeploymentUpgradeDetails oci.golden_gate.models.RescheduleDeploymentUpgradeToDateDetails oci.golden_gate.models.ResourceLock @@ -175,11 +198,19 @@ Golden Gate oci.golden_gate.models.SnoozeDeploymentUpgradeDetails oci.golden_gate.models.SnowflakeConnection oci.golden_gate.models.SnowflakeConnectionSummary + oci.golden_gate.models.SourcePipelineConnectionDetails oci.golden_gate.models.StartDeploymentDetails + oci.golden_gate.models.StartPipelineDetails + oci.golden_gate.models.StepMessage oci.golden_gate.models.StopDeploymentDetails + oci.golden_gate.models.StopPipelineDetails + oci.golden_gate.models.TargetPipelineConnectionDetails oci.golden_gate.models.TestConnectionAssignmentDetails oci.golden_gate.models.TestConnectionAssignmentError oci.golden_gate.models.TestConnectionAssignmentResult + oci.golden_gate.models.TestPipelineConnectionDetails + oci.golden_gate.models.TestPipelineConnectionError + oci.golden_gate.models.TestPipelineConnectionResult oci.golden_gate.models.TrailFileCollection oci.golden_gate.models.TrailFileSummary oci.golden_gate.models.TrailSequenceCollection @@ -213,9 +244,11 @@ Golden Gate oci.golden_gate.models.UpdateOggDeploymentDetails oci.golden_gate.models.UpdateOracleConnectionDetails oci.golden_gate.models.UpdateOracleNosqlConnectionDetails + oci.golden_gate.models.UpdatePipelineDetails oci.golden_gate.models.UpdatePostgresqlConnectionDetails oci.golden_gate.models.UpdateRedisConnectionDetails oci.golden_gate.models.UpdateSnowflakeConnectionDetails + oci.golden_gate.models.UpdateZeroEtlPipelineDetails oci.golden_gate.models.UpgradeDeploymentCurrentReleaseDetails oci.golden_gate.models.UpgradeDeploymentDetails oci.golden_gate.models.UpgradeDeploymentSpecificReleaseDetails @@ -224,3 +257,5 @@ Golden Gate oci.golden_gate.models.WorkRequestError oci.golden_gate.models.WorkRequestLogEntry oci.golden_gate.models.WorkRequestResource + oci.golden_gate.models.ZeroEtlPipeline + oci.golden_gate.models.ZeroEtlPipelineSummary diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.ChangePipelineCompartmentDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.ChangePipelineCompartmentDetails.rst new file mode 100644 index 0000000000..8b5a41ddb2 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.ChangePipelineCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangePipelineCompartmentDetails +================================ + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: ChangePipelineCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.CreatePipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.CreatePipelineDetails.rst new file mode 100644 index 0000000000..115539b1ee --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.CreatePipelineDetails.rst @@ -0,0 +1,11 @@ +CreatePipelineDetails +===================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: CreatePipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.CreateZeroEtlPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.CreateZeroEtlPipelineDetails.rst new file mode 100644 index 0000000000..f54358db02 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.CreateZeroEtlPipelineDetails.rst @@ -0,0 +1,11 @@ +CreateZeroEtlPipelineDetails +============================ + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: CreateZeroEtlPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStartPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStartPipelineDetails.rst new file mode 100644 index 0000000000..140ab7b9d5 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStartPipelineDetails.rst @@ -0,0 +1,11 @@ +DefaultStartPipelineDetails +=========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: DefaultStartPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStopPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStopPipelineDetails.rst new file mode 100644 index 0000000000..2843552e17 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultStopPipelineDetails.rst @@ -0,0 +1,11 @@ +DefaultStopPipelineDetails +========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: DefaultStopPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.DefaultTestPipelineConnectionDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultTestPipelineConnectionDetails.rst new file mode 100644 index 0000000000..754e59c650 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.DefaultTestPipelineConnectionDetails.rst @@ -0,0 +1,11 @@ +DefaultTestPipelineConnectionDetails +==================================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: DefaultTestPipelineConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.InitialDataLoad.rst b/docs/api/golden_gate/models/oci.golden_gate.models.InitialDataLoad.rst new file mode 100644 index 0000000000..be599db54b --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.InitialDataLoad.rst @@ -0,0 +1,11 @@ +InitialDataLoad +=============== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: InitialDataLoad + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.MappingRule.rst b/docs/api/golden_gate/models/oci.golden_gate.models.MappingRule.rst new file mode 100644 index 0000000000..a6d5069ec8 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.MappingRule.rst @@ -0,0 +1,11 @@ +MappingRule +=========== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: MappingRule + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.Pipeline.rst b/docs/api/golden_gate/models/oci.golden_gate.models.Pipeline.rst new file mode 100644 index 0000000000..31255ca99c --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.Pipeline.rst @@ -0,0 +1,11 @@ +Pipeline +======== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: Pipeline + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineCollection.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineCollection.rst new file mode 100644 index 0000000000..73ed970654 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineCollection.rst @@ -0,0 +1,11 @@ +PipelineCollection +================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationStep.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationStep.rst new file mode 100644 index 0000000000..8c4e2b376b --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationStep.rst @@ -0,0 +1,11 @@ +PipelineInitializationStep +========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineInitializationStep + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationSteps.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationSteps.rst new file mode 100644 index 0000000000..e424961995 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineInitializationSteps.rst @@ -0,0 +1,11 @@ +PipelineInitializationSteps +=========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineInitializationSteps + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessCollection.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessCollection.rst new file mode 100644 index 0000000000..a372b56084 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessCollection.rst @@ -0,0 +1,11 @@ +PipelineRunningProcessCollection +================================ + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineRunningProcessCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessSummary.rst new file mode 100644 index 0000000000..88e1d9bf27 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineRunningProcessSummary.rst @@ -0,0 +1,11 @@ +PipelineRunningProcessSummary +============================= + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineRunningProcessSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaCollection.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaCollection.rst new file mode 100644 index 0000000000..69d0ba7cb9 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaCollection.rst @@ -0,0 +1,11 @@ +PipelineSchemaCollection +======================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineSchemaCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaSummary.rst new file mode 100644 index 0000000000..1ccb693933 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaSummary.rst @@ -0,0 +1,11 @@ +PipelineSchemaSummary +===================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineSchemaSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableCollection.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableCollection.rst new file mode 100644 index 0000000000..f18db4d694 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableCollection.rst @@ -0,0 +1,11 @@ +PipelineSchemaTableCollection +============================= + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineSchemaTableCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableSummary.rst new file mode 100644 index 0000000000..7f53ebb4de --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSchemaTableSummary.rst @@ -0,0 +1,11 @@ +PipelineSchemaTableSummary +========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineSchemaTableSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSummary.rst new file mode 100644 index 0000000000..6735700a8b --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.PipelineSummary.rst @@ -0,0 +1,11 @@ +PipelineSummary +=============== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: PipelineSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.ProcessOptions.rst b/docs/api/golden_gate/models/oci.golden_gate.models.ProcessOptions.rst new file mode 100644 index 0000000000..3fe5cb0e19 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.ProcessOptions.rst @@ -0,0 +1,11 @@ +ProcessOptions +============== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: ProcessOptions + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummary.rst new file mode 100644 index 0000000000..9fd4e91853 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummary.rst @@ -0,0 +1,11 @@ +RecipeSummary +============= + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: RecipeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummaryCollection.rst b/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummaryCollection.rst new file mode 100644 index 0000000000..e7c5b35cce --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.RecipeSummaryCollection.rst @@ -0,0 +1,11 @@ +RecipeSummaryCollection +======================= + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: RecipeSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.ReplicateSchemaChange.rst b/docs/api/golden_gate/models/oci.golden_gate.models.ReplicateSchemaChange.rst new file mode 100644 index 0000000000..a6b09c876d --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.ReplicateSchemaChange.rst @@ -0,0 +1,11 @@ +ReplicateSchemaChange +===================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: ReplicateSchemaChange + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.SourcePipelineConnectionDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.SourcePipelineConnectionDetails.rst new file mode 100644 index 0000000000..301b46545b --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.SourcePipelineConnectionDetails.rst @@ -0,0 +1,11 @@ +SourcePipelineConnectionDetails +=============================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: SourcePipelineConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.StartPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.StartPipelineDetails.rst new file mode 100644 index 0000000000..6e6d34d621 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.StartPipelineDetails.rst @@ -0,0 +1,11 @@ +StartPipelineDetails +==================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: StartPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.StepMessage.rst b/docs/api/golden_gate/models/oci.golden_gate.models.StepMessage.rst new file mode 100644 index 0000000000..598ddca2b2 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.StepMessage.rst @@ -0,0 +1,11 @@ +StepMessage +=========== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: StepMessage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.StopPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.StopPipelineDetails.rst new file mode 100644 index 0000000000..c6d5567914 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.StopPipelineDetails.rst @@ -0,0 +1,11 @@ +StopPipelineDetails +=================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: StopPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.TargetPipelineConnectionDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.TargetPipelineConnectionDetails.rst new file mode 100644 index 0000000000..61a9a95620 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.TargetPipelineConnectionDetails.rst @@ -0,0 +1,11 @@ +TargetPipelineConnectionDetails +=============================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: TargetPipelineConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionDetails.rst new file mode 100644 index 0000000000..a74c498be6 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionDetails.rst @@ -0,0 +1,11 @@ +TestPipelineConnectionDetails +============================= + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: TestPipelineConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionError.rst b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionError.rst new file mode 100644 index 0000000000..e294f0ef54 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionError.rst @@ -0,0 +1,11 @@ +TestPipelineConnectionError +=========================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: TestPipelineConnectionError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionResult.rst b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionResult.rst new file mode 100644 index 0000000000..eee96f22b5 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.TestPipelineConnectionResult.rst @@ -0,0 +1,11 @@ +TestPipelineConnectionResult +============================ + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: TestPipelineConnectionResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.UpdatePipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.UpdatePipelineDetails.rst new file mode 100644 index 0000000000..685389bf4b --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.UpdatePipelineDetails.rst @@ -0,0 +1,11 @@ +UpdatePipelineDetails +===================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: UpdatePipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.UpdateZeroEtlPipelineDetails.rst b/docs/api/golden_gate/models/oci.golden_gate.models.UpdateZeroEtlPipelineDetails.rst new file mode 100644 index 0000000000..401d5d1f77 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.UpdateZeroEtlPipelineDetails.rst @@ -0,0 +1,11 @@ +UpdateZeroEtlPipelineDetails +============================ + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: UpdateZeroEtlPipelineDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipeline.rst b/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipeline.rst new file mode 100644 index 0000000000..645be77807 --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipeline.rst @@ -0,0 +1,11 @@ +ZeroEtlPipeline +=============== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: ZeroEtlPipeline + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipelineSummary.rst b/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipelineSummary.rst new file mode 100644 index 0000000000..c632c101ad --- /dev/null +++ b/docs/api/golden_gate/models/oci.golden_gate.models.ZeroEtlPipelineSummary.rst @@ -0,0 +1,11 @@ +ZeroEtlPipelineSummary +====================== + +.. currentmodule:: oci.golden_gate.models + +.. autoclass:: ZeroEtlPipelineSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring.rst b/docs/api/stack_monitoring.rst index 5af4724332..32bca9c534 100644 --- a/docs/api/stack_monitoring.rst +++ b/docs/api/stack_monitoring.rst @@ -70,6 +70,9 @@ Stack Monitoring oci.stack_monitoring.models.EncryptedCredentials oci.stack_monitoring.models.EvaluateBaselineableMetricDetails oci.stack_monitoring.models.EvaluateBaselineableMetricResult + oci.stack_monitoring.models.HttpQueryProperties + oci.stack_monitoring.models.HttpScriptFileDetails + oci.stack_monitoring.models.HttpUpdateQueryProperties oci.stack_monitoring.models.ImportOciTelemetryResourcesTaskDetails oci.stack_monitoring.models.JmxQueryProperties oci.stack_monitoring.models.JmxUpdateQueryProperties @@ -142,6 +145,7 @@ Stack Monitoring oci.stack_monitoring.models.UpdateAutoPromoteConfigDetails oci.stack_monitoring.models.UpdateBaselineableMetricDetails oci.stack_monitoring.models.UpdateConfigDetails + oci.stack_monitoring.models.UpdateHttpScriptFileDetails oci.stack_monitoring.models.UpdateLicenseAutoAssignConfigDetails oci.stack_monitoring.models.UpdateLicenseEnterpriseExtensibilityConfigDetails oci.stack_monitoring.models.UpdateMaintenanceWindowDetails diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpQueryProperties.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpQueryProperties.rst new file mode 100644 index 0000000000..1822d84623 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpQueryProperties.rst @@ -0,0 +1,11 @@ +HttpQueryProperties +=================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: HttpQueryProperties + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpScriptFileDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpScriptFileDetails.rst new file mode 100644 index 0000000000..81b8961eb2 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpScriptFileDetails.rst @@ -0,0 +1,11 @@ +HttpScriptFileDetails +===================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: HttpScriptFileDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpUpdateQueryProperties.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpUpdateQueryProperties.rst new file mode 100644 index 0000000000..4714164677 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.HttpUpdateQueryProperties.rst @@ -0,0 +1,11 @@ +HttpUpdateQueryProperties +========================= + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: HttpUpdateQueryProperties + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateHttpScriptFileDetails.rst b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateHttpScriptFileDetails.rst new file mode 100644 index 0000000000..35a857d138 --- /dev/null +++ b/docs/api/stack_monitoring/models/oci.stack_monitoring.models.UpdateHttpScriptFileDetails.rst @@ -0,0 +1,11 @@ +UpdateHttpScriptFileDetails +=========================== + +.. currentmodule:: oci.stack_monitoring.models + +.. autoclass:: UpdateHttpScriptFileDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/sdk_behaviors/retries.rst b/docs/sdk_behaviors/retries.rst index 1302e6a7c8..685145b8dd 100644 --- a/docs/sdk_behaviors/retries.rst +++ b/docs/sdk_behaviors/retries.rst @@ -6,6 +6,7 @@ By default, operations exposed in the SDK do not retry, but retries can be set i ``retry_strategy`` keyword argument which can be used to set the retry strategy for that operation. This retry strategy could be: * The default strategy vended by the SDK as :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` +* The default federation client retry strategy vended by the SDK for the federation client as :py:data:`~oci.retry.DEFAULT_FEDERATION_CLIENT_RETRY_STRATEGY` * The :py:class:`~oci.retry.NoneRetryStrategy`. This will result in no retries being performed for the operation * A custom strategy produced via the :py:class:`~oci.retry.RetryStrategyBuilder` @@ -51,7 +52,7 @@ In this strategy we keep some amount of De-correlated Jitter (default 1 second) sleep_time = min(exponential_backoff_sleep_base + random.uniform(0, decorrelated_jitter), max_wait_between_calls_seconds) Default Retry Strategy ------------------------ +---------------------- The default retry strategy vended by the SDK has the following attributes: * 8 total attempts @@ -69,6 +70,23 @@ The default retry strategy vended by the SDK has the following attributes: * HTTP 429s (throttles) * HTTP 5xx (server errors), except 501 +Default Federation Client Retry Strategy +---------------------------------------- +The default federation client retry strategy for federation client vended by the SDK has the following attributes: + +* 3 total attempts +* Total allowed elapsed time for all requests of 100 seconds +* Exponential backoff with de-correlated jitter of 1000 ms, using: + + * The base time to use in retry calculations will be 1 second + * An exponent of 2. When calculating the next retry time we will raise this to the power of the number of attempts + * A maximum wait time between calls of 30 seconds + +* Retries on the following exception types: + + * Timeouts and connection errors + * HTTP 5xx (server errors), except 501 + Customizing Retry Strategy -------------------------- As mentioned above, users can create there own custom retry strategy using :py:class:`~oci.retry.RetryStrategyBuilder` class. diff --git a/src/oci/ai_vision/ai_service_vision_client.py b/src/oci/ai_vision/ai_service_vision_client.py index b7051b6379..71646018b2 100644 --- a/src/oci/ai_vision/ai_service_vision_client.py +++ b/src/oci/ai_vision/ai_service_vision_client.py @@ -498,6 +498,109 @@ def cancel_image_job(self, image_job_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def cancel_video_job(self, video_job_id, **kwargs): + """ + Cancel a video analysis job. + + + :param str video_job_id: (required) + Video job id. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use cancel_video_job API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['videoJobId'] + resource_path = "/videoJobs/{videoJobId}/actions/cancel" + method = "POST" + operation_name = "cancel_video_job" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/vision/20220125/VideoJob/CancelVideoJob" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"cancel_video_job got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "videoJobId": video_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def cancel_work_request(self, work_request_id, **kwargs): """ Cancel the work request with the given ID. @@ -1201,6 +1304,102 @@ def create_project(self, create_project_details, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def create_video_job(self, create_video_job_details, **kwargs): + """ + Create a video analysis job with given inputs and features. + + + :param oci.ai_vision.models.CreateVideoJobDetails create_video_job_details: (required) + Details about the video analysis. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without the risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_vision.models.VideoJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_video_job API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/videoJobs" + method = "POST" + operation_name = "create_video_job" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/vision/20220125/VideoJob/CreateVideoJob" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"create_video_job got unknown kwargs: {extra_kwargs!r}") + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_video_job_details, + response_type="VideoJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_video_job_details, + response_type="VideoJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def delete_model(self, model_id, **kwargs): """ Delete a model by identifier. @@ -1791,6 +1990,102 @@ def get_project(self, project_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def get_video_job(self, video_job_id, **kwargs): + """ + Get details of a video analysis job. + + + :param str video_job_id: (required) + Video job id. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_vision.models.VideoJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_video_job API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['videoJobId'] + resource_path = "/videoJobs/{videoJobId}" + method = "GET" + operation_name = "get_video_job" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/vision/20220125/VideoJob/GetVideoJob" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"get_video_job got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "videoJobId": video_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="VideoJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="VideoJob", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def get_work_request(self, work_request_id, **kwargs): """ Gets the status of the work request with the given ID. diff --git a/src/oci/ai_vision/ai_service_vision_client_composite_operations.py b/src/oci/ai_vision/ai_service_vision_client_composite_operations.py index d440593d4c..4233980af4 100644 --- a/src/oci/ai_vision/ai_service_vision_client_composite_operations.py +++ b/src/oci/ai_vision/ai_service_vision_client_composite_operations.py @@ -187,6 +187,48 @@ def create_project_and_wait_for_state(self, create_project_details, wait_for_sta except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_video_job_and_wait_for_state(self, create_video_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.ai_vision.AIServiceVisionClient.create_video_job` and waits for the :py:class:`~oci.ai_vision.models.VideoJob` acted upon + to enter the given state(s). + + :param oci.ai_vision.models.CreateVideoJobDetails create_video_job_details: (required) + Details about the video analysis. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.ai_vision.models.VideoJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.ai_vision.AIServiceVisionClient.create_video_job` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_video_job(create_video_job_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + video_job_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_video_job(video_job_id), # noqa: F821 + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except (NameError, TypeError) as e: + if not e.args: + e.args = ('',) + e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', ) + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_model_and_wait_for_state(self, model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.ai_vision.AIServiceVisionClient.delete_model` and waits for the :py:class:`~oci.ai_vision.models.WorkRequest` diff --git a/src/oci/ai_vision/models/__init__.py b/src/oci/ai_vision/models/__init__.py index ef6b9cb1a2..1a429813d0 100644 --- a/src/oci/ai_vision/models/__init__.py +++ b/src/oci/ai_vision/models/__init__.py @@ -10,6 +10,7 @@ from .analyze_document_result import AnalyzeDocumentResult from .analyze_image_details import AnalyzeImageDetails from .analyze_image_result import AnalyzeImageResult +from .analyze_video_result import AnalyzeVideoResult from .bounding_polygon import BoundingPolygon from .cell import Cell from .change_model_compartment_details import ChangeModelCompartmentDetails @@ -18,6 +19,7 @@ from .create_image_job_details import CreateImageJobDetails from .create_model_details import CreateModelDetails from .create_project_details import CreateProjectDetails +from .create_video_job_details import CreateVideoJobDetails from .data_science_labeling_dataset import DataScienceLabelingDataset from .dataset import Dataset from .detected_document_type import DetectedDocumentType @@ -58,6 +60,7 @@ from .normalized_vertex import NormalizedVertex from .object_list_inline_input_location import ObjectListInlineInputLocation from .object_location import ObjectLocation +from .object_property import ObjectProperty from .object_storage_dataset import ObjectStorageDataset from .object_storage_document_details import ObjectStorageDocumentDetails from .object_storage_image_details import ObjectStorageImageDetails @@ -79,6 +82,30 @@ from .value_phone_number import ValuePhoneNumber from .value_string import ValueString from .value_time import ValueTime +from .video_face import VideoFace +from .video_face_detection_feature import VideoFaceDetectionFeature +from .video_face_frame import VideoFaceFrame +from .video_face_segment import VideoFaceSegment +from .video_feature import VideoFeature +from .video_job import VideoJob +from .video_label import VideoLabel +from .video_label_detection_feature import VideoLabelDetectionFeature +from .video_label_segment import VideoLabelSegment +from .video_metadata import VideoMetadata +from .video_object import VideoObject +from .video_object_detection_feature import VideoObjectDetectionFeature +from .video_object_frame import VideoObjectFrame +from .video_object_segment import VideoObjectSegment +from .video_object_tracking_feature import VideoObjectTrackingFeature +from .video_segment import VideoSegment +from .video_text import VideoText +from .video_text_detection_feature import VideoTextDetectionFeature +from .video_text_frame import VideoTextFrame +from .video_text_segment import VideoTextSegment +from .video_tracked_object import VideoTrackedObject +from .video_tracked_object_properties import VideoTrackedObjectProperties +from .video_tracked_object_segment import VideoTrackedObjectSegment +from .video_tracking_frame import VideoTrackingFrame from .word import Word from .work_request import WorkRequest from .work_request_error import WorkRequestError @@ -95,6 +122,7 @@ "AnalyzeDocumentResult": AnalyzeDocumentResult, "AnalyzeImageDetails": AnalyzeImageDetails, "AnalyzeImageResult": AnalyzeImageResult, + "AnalyzeVideoResult": AnalyzeVideoResult, "BoundingPolygon": BoundingPolygon, "Cell": Cell, "ChangeModelCompartmentDetails": ChangeModelCompartmentDetails, @@ -103,6 +131,7 @@ "CreateImageJobDetails": CreateImageJobDetails, "CreateModelDetails": CreateModelDetails, "CreateProjectDetails": CreateProjectDetails, + "CreateVideoJobDetails": CreateVideoJobDetails, "DataScienceLabelingDataset": DataScienceLabelingDataset, "Dataset": Dataset, "DetectedDocumentType": DetectedDocumentType, @@ -143,6 +172,7 @@ "NormalizedVertex": NormalizedVertex, "ObjectListInlineInputLocation": ObjectListInlineInputLocation, "ObjectLocation": ObjectLocation, + "ObjectProperty": ObjectProperty, "ObjectStorageDataset": ObjectStorageDataset, "ObjectStorageDocumentDetails": ObjectStorageDocumentDetails, "ObjectStorageImageDetails": ObjectStorageImageDetails, @@ -164,6 +194,30 @@ "ValuePhoneNumber": ValuePhoneNumber, "ValueString": ValueString, "ValueTime": ValueTime, + "VideoFace": VideoFace, + "VideoFaceDetectionFeature": VideoFaceDetectionFeature, + "VideoFaceFrame": VideoFaceFrame, + "VideoFaceSegment": VideoFaceSegment, + "VideoFeature": VideoFeature, + "VideoJob": VideoJob, + "VideoLabel": VideoLabel, + "VideoLabelDetectionFeature": VideoLabelDetectionFeature, + "VideoLabelSegment": VideoLabelSegment, + "VideoMetadata": VideoMetadata, + "VideoObject": VideoObject, + "VideoObjectDetectionFeature": VideoObjectDetectionFeature, + "VideoObjectFrame": VideoObjectFrame, + "VideoObjectSegment": VideoObjectSegment, + "VideoObjectTrackingFeature": VideoObjectTrackingFeature, + "VideoSegment": VideoSegment, + "VideoText": VideoText, + "VideoTextDetectionFeature": VideoTextDetectionFeature, + "VideoTextFrame": VideoTextFrame, + "VideoTextSegment": VideoTextSegment, + "VideoTrackedObject": VideoTrackedObject, + "VideoTrackedObjectProperties": VideoTrackedObjectProperties, + "VideoTrackedObjectSegment": VideoTrackedObjectSegment, + "VideoTrackingFrame": VideoTrackingFrame, "Word": Word, "WorkRequest": WorkRequest, "WorkRequestError": WorkRequestError, diff --git a/src/oci/ai_vision/models/analyze_video_result.py b/src/oci/ai_vision/models/analyze_video_result.py new file mode 100644 index 0000000000..d3c168fb4b --- /dev/null +++ b/src/oci/ai_vision/models/analyze_video_result.py @@ -0,0 +1,440 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AnalyzeVideoResult(object): + """ + Video analysis results. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AnalyzeVideoResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_metadata: + The value to assign to the video_metadata property of this AnalyzeVideoResult. + :type video_metadata: oci.ai_vision.models.VideoMetadata + + :param video_labels: + The value to assign to the video_labels property of this AnalyzeVideoResult. + :type video_labels: list[oci.ai_vision.models.VideoLabel] + + :param video_objects: + The value to assign to the video_objects property of this AnalyzeVideoResult. + :type video_objects: list[oci.ai_vision.models.VideoObject] + + :param video_tracked_objects: + The value to assign to the video_tracked_objects property of this AnalyzeVideoResult. + :type video_tracked_objects: list[oci.ai_vision.models.VideoTrackedObject] + + :param video_text: + The value to assign to the video_text property of this AnalyzeVideoResult. + :type video_text: list[oci.ai_vision.models.VideoText] + + :param video_faces: + The value to assign to the video_faces property of this AnalyzeVideoResult. + :type video_faces: list[oci.ai_vision.models.VideoFace] + + :param ontology_classes: + The value to assign to the ontology_classes property of this AnalyzeVideoResult. + :type ontology_classes: list[oci.ai_vision.models.OntologyClass] + + :param label_detection_model_version: + The value to assign to the label_detection_model_version property of this AnalyzeVideoResult. + :type label_detection_model_version: str + + :param object_detection_model_version: + The value to assign to the object_detection_model_version property of this AnalyzeVideoResult. + :type object_detection_model_version: str + + :param object_tracking_model_version: + The value to assign to the object_tracking_model_version property of this AnalyzeVideoResult. + :type object_tracking_model_version: str + + :param text_detection_model_version: + The value to assign to the text_detection_model_version property of this AnalyzeVideoResult. + :type text_detection_model_version: str + + :param face_detection_model_version: + The value to assign to the face_detection_model_version property of this AnalyzeVideoResult. + :type face_detection_model_version: str + + :param errors: + The value to assign to the errors property of this AnalyzeVideoResult. + :type errors: list[oci.ai_vision.models.ProcessingError] + + """ + self.swagger_types = { + 'video_metadata': 'VideoMetadata', + 'video_labels': 'list[VideoLabel]', + 'video_objects': 'list[VideoObject]', + 'video_tracked_objects': 'list[VideoTrackedObject]', + 'video_text': 'list[VideoText]', + 'video_faces': 'list[VideoFace]', + 'ontology_classes': 'list[OntologyClass]', + 'label_detection_model_version': 'str', + 'object_detection_model_version': 'str', + 'object_tracking_model_version': 'str', + 'text_detection_model_version': 'str', + 'face_detection_model_version': 'str', + 'errors': 'list[ProcessingError]' + } + + self.attribute_map = { + 'video_metadata': 'videoMetadata', + 'video_labels': 'videoLabels', + 'video_objects': 'videoObjects', + 'video_tracked_objects': 'videoTrackedObjects', + 'video_text': 'videoText', + 'video_faces': 'videoFaces', + 'ontology_classes': 'ontologyClasses', + 'label_detection_model_version': 'labelDetectionModelVersion', + 'object_detection_model_version': 'objectDetectionModelVersion', + 'object_tracking_model_version': 'objectTrackingModelVersion', + 'text_detection_model_version': 'textDetectionModelVersion', + 'face_detection_model_version': 'faceDetectionModelVersion', + 'errors': 'errors' + } + + self._video_metadata = None + self._video_labels = None + self._video_objects = None + self._video_tracked_objects = None + self._video_text = None + self._video_faces = None + self._ontology_classes = None + self._label_detection_model_version = None + self._object_detection_model_version = None + self._object_tracking_model_version = None + self._text_detection_model_version = None + self._face_detection_model_version = None + self._errors = None + + @property + def video_metadata(self): + """ + **[Required]** Gets the video_metadata of this AnalyzeVideoResult. + + :return: The video_metadata of this AnalyzeVideoResult. + :rtype: oci.ai_vision.models.VideoMetadata + """ + return self._video_metadata + + @video_metadata.setter + def video_metadata(self, video_metadata): + """ + Sets the video_metadata of this AnalyzeVideoResult. + + :param video_metadata: The video_metadata of this AnalyzeVideoResult. + :type: oci.ai_vision.models.VideoMetadata + """ + self._video_metadata = video_metadata + + @property + def video_labels(self): + """ + Gets the video_labels of this AnalyzeVideoResult. + Detected labels in a video. + + + :return: The video_labels of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.VideoLabel] + """ + return self._video_labels + + @video_labels.setter + def video_labels(self, video_labels): + """ + Sets the video_labels of this AnalyzeVideoResult. + Detected labels in a video. + + + :param video_labels: The video_labels of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.VideoLabel] + """ + self._video_labels = video_labels + + @property + def video_objects(self): + """ + Gets the video_objects of this AnalyzeVideoResult. + Detected objects in a video. + + + :return: The video_objects of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.VideoObject] + """ + return self._video_objects + + @video_objects.setter + def video_objects(self, video_objects): + """ + Sets the video_objects of this AnalyzeVideoResult. + Detected objects in a video. + + + :param video_objects: The video_objects of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.VideoObject] + """ + self._video_objects = video_objects + + @property + def video_tracked_objects(self): + """ + Gets the video_tracked_objects of this AnalyzeVideoResult. + Tracked objects in a video. + + + :return: The video_tracked_objects of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.VideoTrackedObject] + """ + return self._video_tracked_objects + + @video_tracked_objects.setter + def video_tracked_objects(self, video_tracked_objects): + """ + Sets the video_tracked_objects of this AnalyzeVideoResult. + Tracked objects in a video. + + + :param video_tracked_objects: The video_tracked_objects of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.VideoTrackedObject] + """ + self._video_tracked_objects = video_tracked_objects + + @property + def video_text(self): + """ + Gets the video_text of this AnalyzeVideoResult. + Detected text in a video. + + + :return: The video_text of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.VideoText] + """ + return self._video_text + + @video_text.setter + def video_text(self, video_text): + """ + Sets the video_text of this AnalyzeVideoResult. + Detected text in a video. + + + :param video_text: The video_text of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.VideoText] + """ + self._video_text = video_text + + @property + def video_faces(self): + """ + Gets the video_faces of this AnalyzeVideoResult. + Detected faces in a video. + + + :return: The video_faces of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.VideoFace] + """ + return self._video_faces + + @video_faces.setter + def video_faces(self, video_faces): + """ + Sets the video_faces of this AnalyzeVideoResult. + Detected faces in a video. + + + :param video_faces: The video_faces of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.VideoFace] + """ + self._video_faces = video_faces + + @property + def ontology_classes(self): + """ + Gets the ontology_classes of this AnalyzeVideoResult. + The ontologyClasses of video labels. + + + :return: The ontology_classes of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.OntologyClass] + """ + return self._ontology_classes + + @ontology_classes.setter + def ontology_classes(self, ontology_classes): + """ + Sets the ontology_classes of this AnalyzeVideoResult. + The ontologyClasses of video labels. + + + :param ontology_classes: The ontology_classes of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.OntologyClass] + """ + self._ontology_classes = ontology_classes + + @property + def label_detection_model_version(self): + """ + Gets the label_detection_model_version of this AnalyzeVideoResult. + Label Detection model version. + + + :return: The label_detection_model_version of this AnalyzeVideoResult. + :rtype: str + """ + return self._label_detection_model_version + + @label_detection_model_version.setter + def label_detection_model_version(self, label_detection_model_version): + """ + Sets the label_detection_model_version of this AnalyzeVideoResult. + Label Detection model version. + + + :param label_detection_model_version: The label_detection_model_version of this AnalyzeVideoResult. + :type: str + """ + self._label_detection_model_version = label_detection_model_version + + @property + def object_detection_model_version(self): + """ + Gets the object_detection_model_version of this AnalyzeVideoResult. + Object Detection model version. + + + :return: The object_detection_model_version of this AnalyzeVideoResult. + :rtype: str + """ + return self._object_detection_model_version + + @object_detection_model_version.setter + def object_detection_model_version(self, object_detection_model_version): + """ + Sets the object_detection_model_version of this AnalyzeVideoResult. + Object Detection model version. + + + :param object_detection_model_version: The object_detection_model_version of this AnalyzeVideoResult. + :type: str + """ + self._object_detection_model_version = object_detection_model_version + + @property + def object_tracking_model_version(self): + """ + Gets the object_tracking_model_version of this AnalyzeVideoResult. + Object Tracking model version. + + + :return: The object_tracking_model_version of this AnalyzeVideoResult. + :rtype: str + """ + return self._object_tracking_model_version + + @object_tracking_model_version.setter + def object_tracking_model_version(self, object_tracking_model_version): + """ + Sets the object_tracking_model_version of this AnalyzeVideoResult. + Object Tracking model version. + + + :param object_tracking_model_version: The object_tracking_model_version of this AnalyzeVideoResult. + :type: str + """ + self._object_tracking_model_version = object_tracking_model_version + + @property + def text_detection_model_version(self): + """ + Gets the text_detection_model_version of this AnalyzeVideoResult. + Text Detection model version. + + + :return: The text_detection_model_version of this AnalyzeVideoResult. + :rtype: str + """ + return self._text_detection_model_version + + @text_detection_model_version.setter + def text_detection_model_version(self, text_detection_model_version): + """ + Sets the text_detection_model_version of this AnalyzeVideoResult. + Text Detection model version. + + + :param text_detection_model_version: The text_detection_model_version of this AnalyzeVideoResult. + :type: str + """ + self._text_detection_model_version = text_detection_model_version + + @property + def face_detection_model_version(self): + """ + Gets the face_detection_model_version of this AnalyzeVideoResult. + Face Detection model version. + + + :return: The face_detection_model_version of this AnalyzeVideoResult. + :rtype: str + """ + return self._face_detection_model_version + + @face_detection_model_version.setter + def face_detection_model_version(self, face_detection_model_version): + """ + Sets the face_detection_model_version of this AnalyzeVideoResult. + Face Detection model version. + + + :param face_detection_model_version: The face_detection_model_version of this AnalyzeVideoResult. + :type: str + """ + self._face_detection_model_version = face_detection_model_version + + @property + def errors(self): + """ + Gets the errors of this AnalyzeVideoResult. + Array of possible errors. + + + :return: The errors of this AnalyzeVideoResult. + :rtype: list[oci.ai_vision.models.ProcessingError] + """ + return self._errors + + @errors.setter + def errors(self, errors): + """ + Sets the errors of this AnalyzeVideoResult. + Array of possible errors. + + + :param errors: The errors of this AnalyzeVideoResult. + :type: list[oci.ai_vision.models.ProcessingError] + """ + self._errors = errors + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/create_video_job_details.py b/src/oci/ai_vision/models/create_video_job_details.py new file mode 100644 index 0000000000..3f1c3dd00c --- /dev/null +++ b/src/oci/ai_vision/models/create_video_job_details.py @@ -0,0 +1,254 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateVideoJobDetails(object): + """ + Details about the video analysis. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateVideoJobDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param input_location: + The value to assign to the input_location property of this CreateVideoJobDetails. + :type input_location: oci.ai_vision.models.InputLocation + + :param features: + The value to assign to the features property of this CreateVideoJobDetails. + :type features: list[oci.ai_vision.models.VideoFeature] + + :param output_location: + The value to assign to the output_location property of this CreateVideoJobDetails. + :type output_location: oci.ai_vision.models.OutputLocation + + :param compartment_id: + The value to assign to the compartment_id property of this CreateVideoJobDetails. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this CreateVideoJobDetails. + :type display_name: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateVideoJobDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateVideoJobDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'input_location': 'InputLocation', + 'features': 'list[VideoFeature]', + 'output_location': 'OutputLocation', + 'compartment_id': 'str', + 'display_name': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'input_location': 'inputLocation', + 'features': 'features', + 'output_location': 'outputLocation', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._input_location = None + self._features = None + self._output_location = None + self._compartment_id = None + self._display_name = None + self._freeform_tags = None + self._defined_tags = None + + @property + def input_location(self): + """ + **[Required]** Gets the input_location of this CreateVideoJobDetails. + + :return: The input_location of this CreateVideoJobDetails. + :rtype: oci.ai_vision.models.InputLocation + """ + return self._input_location + + @input_location.setter + def input_location(self, input_location): + """ + Sets the input_location of this CreateVideoJobDetails. + + :param input_location: The input_location of this CreateVideoJobDetails. + :type: oci.ai_vision.models.InputLocation + """ + self._input_location = input_location + + @property + def features(self): + """ + **[Required]** Gets the features of this CreateVideoJobDetails. + a list of video analysis features. + + + :return: The features of this CreateVideoJobDetails. + :rtype: list[oci.ai_vision.models.VideoFeature] + """ + return self._features + + @features.setter + def features(self, features): + """ + Sets the features of this CreateVideoJobDetails. + a list of video analysis features. + + + :param features: The features of this CreateVideoJobDetails. + :type: list[oci.ai_vision.models.VideoFeature] + """ + self._features = features + + @property + def output_location(self): + """ + **[Required]** Gets the output_location of this CreateVideoJobDetails. + + :return: The output_location of this CreateVideoJobDetails. + :rtype: oci.ai_vision.models.OutputLocation + """ + return self._output_location + + @output_location.setter + def output_location(self, output_location): + """ + Sets the output_location of this CreateVideoJobDetails. + + :param output_location: The output_location of this CreateVideoJobDetails. + :type: oci.ai_vision.models.OutputLocation + """ + self._output_location = output_location + + @property + def compartment_id(self): + """ + Gets the compartment_id of this CreateVideoJobDetails. + Compartment identifier from the requester. + + + :return: The compartment_id of this CreateVideoJobDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateVideoJobDetails. + Compartment identifier from the requester. + + + :param compartment_id: The compartment_id of this CreateVideoJobDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this CreateVideoJobDetails. + Video job display name. + + + :return: The display_name of this CreateVideoJobDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateVideoJobDetails. + Video job display name. + + + :param display_name: The display_name of this CreateVideoJobDetails. + :type: str + """ + self._display_name = display_name + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateVideoJobDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. + For example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreateVideoJobDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateVideoJobDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. + For example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreateVideoJobDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateVideoJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateVideoJobDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this CreateVideoJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateVideoJobDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/object_property.py b/src/oci/ai_vision/models/object_property.py new file mode 100644 index 0000000000..1e3bf907b3 --- /dev/null +++ b/src/oci/ai_vision/models/object_property.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectProperty(object): + """ + A property of a tracked object in a frame. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectProperty 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 ObjectProperty. + :type name: str + + :param confidence: + The value to assign to the confidence property of this ObjectProperty. + :type confidence: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this ObjectProperty. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + """ + self.swagger_types = { + 'name': 'str', + 'confidence': 'float', + 'bounding_polygon': 'BoundingPolygon' + } + + self.attribute_map = { + 'name': 'name', + 'confidence': 'confidence', + 'bounding_polygon': 'boundingPolygon' + } + + self._name = None + self._confidence = None + self._bounding_polygon = None + + @property + def name(self): + """ + **[Required]** Gets the name of this ObjectProperty. + Property name + + + :return: The name of this ObjectProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ObjectProperty. + Property name + + + :param name: The name of this ObjectProperty. + :type: str + """ + self._name = name + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this ObjectProperty. + The confidence score, between 0 and 1. + + + :return: The confidence of this ObjectProperty. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this ObjectProperty. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this ObjectProperty. + :type: float + """ + self._confidence = confidence + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this ObjectProperty. + + :return: The bounding_polygon of this ObjectProperty. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this ObjectProperty. + + :param bounding_polygon: The bounding_polygon of this ObjectProperty. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_face.py b/src/oci/ai_vision/models/video_face.py new file mode 100644 index 0000000000..d04658d1b9 --- /dev/null +++ b/src/oci/ai_vision/models/video_face.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoFace(object): + """ + Detected face in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoFace object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param segments: + The value to assign to the segments property of this VideoFace. + :type segments: list[oci.ai_vision.models.VideoFaceSegment] + + """ + self.swagger_types = { + 'segments': 'list[VideoFaceSegment]' + } + + self.attribute_map = { + 'segments': 'segments' + } + + self._segments = None + + @property + def segments(self): + """ + **[Required]** Gets the segments of this VideoFace. + Face segments in a video. + + + :return: The segments of this VideoFace. + :rtype: list[oci.ai_vision.models.VideoFaceSegment] + """ + return self._segments + + @segments.setter + def segments(self, segments): + """ + Sets the segments of this VideoFace. + Face segments in a video. + + + :param segments: The segments of this VideoFace. + :type: list[oci.ai_vision.models.VideoFaceSegment] + """ + self._segments = segments + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_face_detection_feature.py b/src/oci/ai_vision/models/video_face_detection_feature.py new file mode 100644 index 0000000000..0cd02472c6 --- /dev/null +++ b/src/oci/ai_vision/models/video_face_detection_feature.py @@ -0,0 +1,146 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .video_feature import VideoFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoFaceDetectionFeature(VideoFeature): + """ + Video face detection feature + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoFaceDetectionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.VideoFaceDetectionFeature.feature_type` attribute + of this class is ``FACE_DETECTION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoFaceDetectionFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING" + :type feature_type: str + + :param max_results: + The value to assign to the max_results property of this VideoFaceDetectionFeature. + :type max_results: int + + :param is_landmark_required: + The value to assign to the is_landmark_required property of this VideoFaceDetectionFeature. + :type is_landmark_required: bool + + :param min_confidence: + The value to assign to the min_confidence property of this VideoFaceDetectionFeature. + :type min_confidence: float + + """ + self.swagger_types = { + 'feature_type': 'str', + 'max_results': 'int', + 'is_landmark_required': 'bool', + 'min_confidence': 'float' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'max_results': 'maxResults', + 'is_landmark_required': 'isLandmarkRequired', + 'min_confidence': 'minConfidence' + } + + self._feature_type = None + self._max_results = None + self._is_landmark_required = None + self._min_confidence = None + self._feature_type = 'FACE_DETECTION' + + @property + def max_results(self): + """ + Gets the max_results of this VideoFaceDetectionFeature. + The maximum number of results per frame to return. + + + :return: The max_results of this VideoFaceDetectionFeature. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this VideoFaceDetectionFeature. + The maximum number of results per frame to return. + + + :param max_results: The max_results of this VideoFaceDetectionFeature. + :type: int + """ + self._max_results = max_results + + @property + def is_landmark_required(self): + """ + Gets the is_landmark_required of this VideoFaceDetectionFeature. + Whether or not return face landmarks. + + + :return: The is_landmark_required of this VideoFaceDetectionFeature. + :rtype: bool + """ + return self._is_landmark_required + + @is_landmark_required.setter + def is_landmark_required(self, is_landmark_required): + """ + Sets the is_landmark_required of this VideoFaceDetectionFeature. + Whether or not return face landmarks. + + + :param is_landmark_required: The is_landmark_required of this VideoFaceDetectionFeature. + :type: bool + """ + self._is_landmark_required = is_landmark_required + + @property + def min_confidence(self): + """ + Gets the min_confidence of this VideoFaceDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :return: The min_confidence of this VideoFaceDetectionFeature. + :rtype: float + """ + return self._min_confidence + + @min_confidence.setter + def min_confidence(self, min_confidence): + """ + Sets the min_confidence of this VideoFaceDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :param min_confidence: The min_confidence of this VideoFaceDetectionFeature. + :type: float + """ + self._min_confidence = min_confidence + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_face_frame.py b/src/oci/ai_vision/models/video_face_frame.py new file mode 100644 index 0000000000..7e68b35527 --- /dev/null +++ b/src/oci/ai_vision/models/video_face_frame.py @@ -0,0 +1,192 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoFaceFrame(object): + """ + A face frame. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoFaceFrame object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_offset_ms: + The value to assign to the time_offset_ms property of this VideoFaceFrame. + :type time_offset_ms: int + + :param confidence: + The value to assign to the confidence property of this VideoFaceFrame. + :type confidence: float + + :param quality_score: + The value to assign to the quality_score property of this VideoFaceFrame. + :type quality_score: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this VideoFaceFrame. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + :param landmarks: + The value to assign to the landmarks property of this VideoFaceFrame. + :type landmarks: list[oci.ai_vision.models.Landmark] + + """ + self.swagger_types = { + 'time_offset_ms': 'int', + 'confidence': 'float', + 'quality_score': 'float', + 'bounding_polygon': 'BoundingPolygon', + 'landmarks': 'list[Landmark]' + } + + self.attribute_map = { + 'time_offset_ms': 'timeOffsetMs', + 'confidence': 'confidence', + 'quality_score': 'qualityScore', + 'bounding_polygon': 'boundingPolygon', + 'landmarks': 'landmarks' + } + + self._time_offset_ms = None + self._confidence = None + self._quality_score = None + self._bounding_polygon = None + self._landmarks = None + + @property + def time_offset_ms(self): + """ + **[Required]** Gets the time_offset_ms of this VideoFaceFrame. + Time offset(Milliseconds) in the video. + + + :return: The time_offset_ms of this VideoFaceFrame. + :rtype: int + """ + return self._time_offset_ms + + @time_offset_ms.setter + def time_offset_ms(self, time_offset_ms): + """ + Sets the time_offset_ms of this VideoFaceFrame. + Time offset(Milliseconds) in the video. + + + :param time_offset_ms: The time_offset_ms of this VideoFaceFrame. + :type: int + """ + self._time_offset_ms = time_offset_ms + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoFaceFrame. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoFaceFrame. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoFaceFrame. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoFaceFrame. + :type: float + """ + self._confidence = confidence + + @property + def quality_score(self): + """ + **[Required]** Gets the quality_score of this VideoFaceFrame. + The quality score of the face detected, between 0 and 1. + + + :return: The quality_score of this VideoFaceFrame. + :rtype: float + """ + return self._quality_score + + @quality_score.setter + def quality_score(self, quality_score): + """ + Sets the quality_score of this VideoFaceFrame. + The quality score of the face detected, between 0 and 1. + + + :param quality_score: The quality_score of this VideoFaceFrame. + :type: float + """ + self._quality_score = quality_score + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this VideoFaceFrame. + + :return: The bounding_polygon of this VideoFaceFrame. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this VideoFaceFrame. + + :param bounding_polygon: The bounding_polygon of this VideoFaceFrame. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + @property + def landmarks(self): + """ + Gets the landmarks of this VideoFaceFrame. + Face landmarks. + + + :return: The landmarks of this VideoFaceFrame. + :rtype: list[oci.ai_vision.models.Landmark] + """ + return self._landmarks + + @landmarks.setter + def landmarks(self, landmarks): + """ + Sets the landmarks of this VideoFaceFrame. + Face landmarks. + + + :param landmarks: The landmarks of this VideoFaceFrame. + :type: list[oci.ai_vision.models.Landmark] + """ + self._landmarks = landmarks + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_face_segment.py b/src/oci/ai_vision/models/video_face_segment.py new file mode 100644 index 0000000000..f7ff98d477 --- /dev/null +++ b/src/oci/ai_vision/models/video_face_segment.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoFaceSegment(object): + """ + A face segment in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoFaceSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_segment: + The value to assign to the video_segment property of this VideoFaceSegment. + :type video_segment: oci.ai_vision.models.VideoSegment + + :param confidence: + The value to assign to the confidence property of this VideoFaceSegment. + :type confidence: float + + :param frames: + The value to assign to the frames property of this VideoFaceSegment. + :type frames: list[oci.ai_vision.models.VideoFaceFrame] + + """ + self.swagger_types = { + 'video_segment': 'VideoSegment', + 'confidence': 'float', + 'frames': 'list[VideoFaceFrame]' + } + + self.attribute_map = { + 'video_segment': 'videoSegment', + 'confidence': 'confidence', + 'frames': 'frames' + } + + self._video_segment = None + self._confidence = None + self._frames = None + + @property + def video_segment(self): + """ + **[Required]** Gets the video_segment of this VideoFaceSegment. + + :return: The video_segment of this VideoFaceSegment. + :rtype: oci.ai_vision.models.VideoSegment + """ + return self._video_segment + + @video_segment.setter + def video_segment(self, video_segment): + """ + Sets the video_segment of this VideoFaceSegment. + + :param video_segment: The video_segment of this VideoFaceSegment. + :type: oci.ai_vision.models.VideoSegment + """ + self._video_segment = video_segment + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoFaceSegment. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoFaceSegment. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoFaceSegment. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoFaceSegment. + :type: float + """ + self._confidence = confidence + + @property + def frames(self): + """ + **[Required]** Gets the frames of this VideoFaceSegment. + Face frames in a segment. + + + :return: The frames of this VideoFaceSegment. + :rtype: list[oci.ai_vision.models.VideoFaceFrame] + """ + return self._frames + + @frames.setter + def frames(self, frames): + """ + Sets the frames of this VideoFaceSegment. + Face frames in a segment. + + + :param frames: The frames of this VideoFaceSegment. + :type: list[oci.ai_vision.models.VideoFaceFrame] + """ + self._frames = frames + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_feature.py b/src/oci/ai_vision/models/video_feature.py new file mode 100644 index 0000000000..457fd43171 --- /dev/null +++ b/src/oci/ai_vision/models/video_feature.py @@ -0,0 +1,145 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoFeature(object): + """ + Details about a video feature request. + """ + + #: A constant which can be used with the feature_type property of a VideoFeature. + #: This constant has a value of "LABEL_DETECTION" + FEATURE_TYPE_LABEL_DETECTION = "LABEL_DETECTION" + + #: A constant which can be used with the feature_type property of a VideoFeature. + #: This constant has a value of "OBJECT_DETECTION" + FEATURE_TYPE_OBJECT_DETECTION = "OBJECT_DETECTION" + + #: A constant which can be used with the feature_type property of a VideoFeature. + #: This constant has a value of "TEXT_DETECTION" + FEATURE_TYPE_TEXT_DETECTION = "TEXT_DETECTION" + + #: A constant which can be used with the feature_type property of a VideoFeature. + #: This constant has a value of "FACE_DETECTION" + FEATURE_TYPE_FACE_DETECTION = "FACE_DETECTION" + + #: A constant which can be used with the feature_type property of a VideoFeature. + #: This constant has a value of "OBJECT_TRACKING" + FEATURE_TYPE_OBJECT_TRACKING = "OBJECT_TRACKING" + + def __init__(self, **kwargs): + """ + Initializes a new VideoFeature object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.ai_vision.models.VideoObjectDetectionFeature` + * :class:`~oci.ai_vision.models.VideoFaceDetectionFeature` + * :class:`~oci.ai_vision.models.VideoTextDetectionFeature` + * :class:`~oci.ai_vision.models.VideoObjectTrackingFeature` + * :class:`~oci.ai_vision.models.VideoLabelDetectionFeature` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type feature_type: str + + """ + self.swagger_types = { + 'feature_type': 'str' + } + + self.attribute_map = { + 'feature_type': 'featureType' + } + + self._feature_type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['featureType'] + + if type == 'OBJECT_DETECTION': + return 'VideoObjectDetectionFeature' + + if type == 'FACE_DETECTION': + return 'VideoFaceDetectionFeature' + + if type == 'TEXT_DETECTION': + return 'VideoTextDetectionFeature' + + if type == 'OBJECT_TRACKING': + return 'VideoObjectTrackingFeature' + + if type == 'LABEL_DETECTION': + return 'VideoLabelDetectionFeature' + else: + return 'VideoFeature' + + @property + def feature_type(self): + """ + **[Required]** Gets the feature_type of this VideoFeature. + The feature of video analysis. + Allowed values are: + - LABEL_DETECTION: Label detection feature(IC). + - OBJECT_DETECTION: Object detection feature(OD). + - TEXT_DETECTION: Text detection feature(OCR). + - FACE_DETECTION: Face detection feature(fd). + - OBJECT_TRACKING: Object tracking feature(OT). + + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The feature_type of this VideoFeature. + :rtype: str + """ + return self._feature_type + + @feature_type.setter + def feature_type(self, feature_type): + """ + Sets the feature_type of this VideoFeature. + The feature of video analysis. + Allowed values are: + - LABEL_DETECTION: Label detection feature(IC). + - OBJECT_DETECTION: Object detection feature(OD). + - TEXT_DETECTION: Text detection feature(OCR). + - FACE_DETECTION: Face detection feature(fd). + - OBJECT_TRACKING: Object tracking feature(OT). + + + :param feature_type: The feature_type of this VideoFeature. + :type: str + """ + allowed_values = ["LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING"] + if not value_allowed_none_or_none_sentinel(feature_type, allowed_values): + feature_type = 'UNKNOWN_ENUM_VALUE' + self._feature_type = feature_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_job.py b/src/oci/ai_vision/models/video_job.py new file mode 100644 index 0000000000..37590404e2 --- /dev/null +++ b/src/oci/ai_vision/models/video_job.py @@ -0,0 +1,552 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoJob(object): + """ + Job details for a video analysis. + """ + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "IN_PROGRESS" + LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the lifecycle_state property of a VideoJob. + #: This constant has a value of "CANCELING" + LIFECYCLE_STATE_CANCELING = "CANCELING" + + #: A constant which can be used with the lifecycle_details property of a VideoJob. + #: This constant has a value of "PARTIALLY_SUCCEEDED" + LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED = "PARTIALLY_SUCCEEDED" + + #: A constant which can be used with the lifecycle_details property of a VideoJob. + #: This constant has a value of "COMPLETELY_FAILED" + LIFECYCLE_DETAILS_COMPLETELY_FAILED = "COMPLETELY_FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new VideoJob 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 VideoJob. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this VideoJob. + :type compartment_id: str + + :param display_name: + The value to assign to the display_name property of this VideoJob. + :type display_name: str + + :param features: + The value to assign to the features property of this VideoJob. + :type features: list[oci.ai_vision.models.VideoFeature] + + :param input_location: + The value to assign to the input_location property of this VideoJob. + :type input_location: oci.ai_vision.models.InputLocation + + :param time_accepted: + The value to assign to the time_accepted property of this VideoJob. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this VideoJob. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this VideoJob. + :type time_finished: datetime + + :param percent_complete: + The value to assign to the percent_complete property of this VideoJob. + :type percent_complete: float + + :param output_location: + The value to assign to the output_location property of this VideoJob. + :type output_location: oci.ai_vision.models.OutputLocation + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this VideoJob. + Allowed values for this property are: "SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this VideoJob. + Allowed values for this property are: "PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this VideoJob. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this VideoJob. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this VideoJob. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'display_name': 'str', + 'features': 'list[VideoFeature]', + 'input_location': 'InputLocation', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'percent_complete': 'float', + 'output_location': 'OutputLocation', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'display_name': 'displayName', + 'features': 'features', + 'input_location': 'inputLocation', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'percent_complete': 'percentComplete', + 'output_location': 'outputLocation', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._compartment_id = None + self._display_name = None + self._features = None + self._input_location = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + self._percent_complete = None + self._output_location = None + self._lifecycle_state = None + self._lifecycle_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + + @property + def id(self): + """ + **[Required]** Gets the id of this VideoJob. + Id of the job. + + + :return: The id of this VideoJob. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this VideoJob. + Id of the job. + + + :param id: The id of this VideoJob. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this VideoJob. + The ocid of the compartment that starts the job. + + + :return: The compartment_id of this VideoJob. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this VideoJob. + The ocid of the compartment that starts the job. + + + :param compartment_id: The compartment_id of this VideoJob. + :type: str + """ + self._compartment_id = compartment_id + + @property + def display_name(self): + """ + Gets the display_name of this VideoJob. + Video job display name. + + + :return: The display_name of this VideoJob. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this VideoJob. + Video job display name. + + + :param display_name: The display_name of this VideoJob. + :type: str + """ + self._display_name = display_name + + @property + def features(self): + """ + **[Required]** Gets the features of this VideoJob. + a list of document analysis features. + + + :return: The features of this VideoJob. + :rtype: list[oci.ai_vision.models.VideoFeature] + """ + return self._features + + @features.setter + def features(self, features): + """ + Sets the features of this VideoJob. + a list of document analysis features. + + + :param features: The features of this VideoJob. + :type: list[oci.ai_vision.models.VideoFeature] + """ + self._features = features + + @property + def input_location(self): + """ + Gets the input_location of this VideoJob. + + :return: The input_location of this VideoJob. + :rtype: oci.ai_vision.models.InputLocation + """ + return self._input_location + + @input_location.setter + def input_location(self, input_location): + """ + Sets the input_location of this VideoJob. + + :param input_location: The input_location of this VideoJob. + :type: oci.ai_vision.models.InputLocation + """ + self._input_location = input_location + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this VideoJob. + Job accepted time. + + + :return: The time_accepted of this VideoJob. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this VideoJob. + Job accepted time. + + + :param time_accepted: The time_accepted of this VideoJob. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this VideoJob. + Job started time. + + + :return: The time_started of this VideoJob. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this VideoJob. + Job started time. + + + :param time_started: The time_started of this VideoJob. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this VideoJob. + Job finished time. + + + :return: The time_finished of this VideoJob. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this VideoJob. + Job finished time. + + + :param time_finished: The time_finished of this VideoJob. + :type: datetime + """ + self._time_finished = time_finished + + @property + def percent_complete(self): + """ + Gets the percent_complete of this VideoJob. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :return: The percent_complete of this VideoJob. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this VideoJob. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :param percent_complete: The percent_complete of this VideoJob. + :type: float + """ + self._percent_complete = percent_complete + + @property + def output_location(self): + """ + **[Required]** Gets the output_location of this VideoJob. + + :return: The output_location of this VideoJob. + :rtype: oci.ai_vision.models.OutputLocation + """ + return self._output_location + + @output_location.setter + def output_location(self, output_location): + """ + Sets the output_location of this VideoJob. + + :param output_location: The output_location of this VideoJob. + :type: oci.ai_vision.models.OutputLocation + """ + self._output_location = output_location + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this VideoJob. + The current state of the batch document job. + + Allowed values for this property are: "SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this VideoJob. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this VideoJob. + The current state of the batch document job. + + + :param lifecycle_state: The lifecycle_state of this VideoJob. + :type: str + """ + allowed_values = ["SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this VideoJob. + Detailed status of FAILED state. + + Allowed values for this property are: "PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_details of this VideoJob. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this VideoJob. + Detailed status of FAILED state. + + + :param lifecycle_details: The lifecycle_details of this VideoJob. + :type: str + """ + allowed_values = ["PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values): + lifecycle_details = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this VideoJob. + A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. + For example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this VideoJob. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this VideoJob. + A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. + For example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this VideoJob. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this VideoJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this VideoJob. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this VideoJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this VideoJob. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this VideoJob. + Usage of system tag keys. These predefined keys are scoped to namespaces. + For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this VideoJob. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this VideoJob. + Usage of system tag keys. These predefined keys are scoped to namespaces. + For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this VideoJob. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_label.py b/src/oci/ai_vision/models/video_label.py new file mode 100644 index 0000000000..6d76745c75 --- /dev/null +++ b/src/oci/ai_vision/models/video_label.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoLabel(object): + """ + Detected label in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoLabel 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 VideoLabel. + :type name: str + + :param segments: + The value to assign to the segments property of this VideoLabel. + :type segments: list[oci.ai_vision.models.VideoLabelSegment] + + """ + self.swagger_types = { + 'name': 'str', + 'segments': 'list[VideoLabelSegment]' + } + + self.attribute_map = { + 'name': 'name', + 'segments': 'segments' + } + + self._name = None + self._segments = None + + @property + def name(self): + """ + **[Required]** Gets the name of this VideoLabel. + Detected label name. + + + :return: The name of this VideoLabel. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VideoLabel. + Detected label name. + + + :param name: The name of this VideoLabel. + :type: str + """ + self._name = name + + @property + def segments(self): + """ + **[Required]** Gets the segments of this VideoLabel. + Label segments in a video. + + + :return: The segments of this VideoLabel. + :rtype: list[oci.ai_vision.models.VideoLabelSegment] + """ + return self._segments + + @segments.setter + def segments(self, segments): + """ + Sets the segments of this VideoLabel. + Label segments in a video. + + + :param segments: The segments of this VideoLabel. + :type: list[oci.ai_vision.models.VideoLabelSegment] + """ + self._segments = segments + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_label_detection_feature.py b/src/oci/ai_vision/models/video_label_detection_feature.py new file mode 100644 index 0000000000..5fe924e3f7 --- /dev/null +++ b/src/oci/ai_vision/models/video_label_detection_feature.py @@ -0,0 +1,146 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .video_feature import VideoFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoLabelDetectionFeature(VideoFeature): + """ + Video label detection feature + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoLabelDetectionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.VideoLabelDetectionFeature.feature_type` attribute + of this class is ``LABEL_DETECTION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoLabelDetectionFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING" + :type feature_type: str + + :param min_confidence: + The value to assign to the min_confidence property of this VideoLabelDetectionFeature. + :type min_confidence: float + + :param max_results: + The value to assign to the max_results property of this VideoLabelDetectionFeature. + :type max_results: int + + :param model_id: + The value to assign to the model_id property of this VideoLabelDetectionFeature. + :type model_id: str + + """ + self.swagger_types = { + 'feature_type': 'str', + 'min_confidence': 'float', + 'max_results': 'int', + 'model_id': 'str' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'min_confidence': 'minConfidence', + 'max_results': 'maxResults', + 'model_id': 'modelId' + } + + self._feature_type = None + self._min_confidence = None + self._max_results = None + self._model_id = None + self._feature_type = 'LABEL_DETECTION' + + @property + def min_confidence(self): + """ + Gets the min_confidence of this VideoLabelDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :return: The min_confidence of this VideoLabelDetectionFeature. + :rtype: float + """ + return self._min_confidence + + @min_confidence.setter + def min_confidence(self, min_confidence): + """ + Sets the min_confidence of this VideoLabelDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :param min_confidence: The min_confidence of this VideoLabelDetectionFeature. + :type: float + """ + self._min_confidence = min_confidence + + @property + def max_results(self): + """ + Gets the max_results of this VideoLabelDetectionFeature. + The maximum number of results per video frame to return. + + + :return: The max_results of this VideoLabelDetectionFeature. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this VideoLabelDetectionFeature. + The maximum number of results per video frame to return. + + + :param max_results: The max_results of this VideoLabelDetectionFeature. + :type: int + """ + self._max_results = max_results + + @property + def model_id(self): + """ + Gets the model_id of this VideoLabelDetectionFeature. + The custom model ID. + + + :return: The model_id of this VideoLabelDetectionFeature. + :rtype: str + """ + return self._model_id + + @model_id.setter + def model_id(self, model_id): + """ + Sets the model_id of this VideoLabelDetectionFeature. + The custom model ID. + + + :param model_id: The model_id of this VideoLabelDetectionFeature. + :type: str + """ + self._model_id = model_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/ai_vision/models/video_label_segment.py b/src/oci/ai_vision/models/video_label_segment.py new file mode 100644 index 0000000000..376d4ededa --- /dev/null +++ b/src/oci/ai_vision/models/video_label_segment.py @@ -0,0 +1,99 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoLabelSegment(object): + """ + A label segment in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoLabelSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_segment: + The value to assign to the video_segment property of this VideoLabelSegment. + :type video_segment: oci.ai_vision.models.VideoSegment + + :param confidence: + The value to assign to the confidence property of this VideoLabelSegment. + :type confidence: float + + """ + self.swagger_types = { + 'video_segment': 'VideoSegment', + 'confidence': 'float' + } + + self.attribute_map = { + 'video_segment': 'videoSegment', + 'confidence': 'confidence' + } + + self._video_segment = None + self._confidence = None + + @property + def video_segment(self): + """ + **[Required]** Gets the video_segment of this VideoLabelSegment. + + :return: The video_segment of this VideoLabelSegment. + :rtype: oci.ai_vision.models.VideoSegment + """ + return self._video_segment + + @video_segment.setter + def video_segment(self, video_segment): + """ + Sets the video_segment of this VideoLabelSegment. + + :param video_segment: The video_segment of this VideoLabelSegment. + :type: oci.ai_vision.models.VideoSegment + """ + self._video_segment = video_segment + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoLabelSegment. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoLabelSegment. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoLabelSegment. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoLabelSegment. + :type: float + """ + self._confidence = confidence + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_metadata.py b/src/oci/ai_vision/models/video_metadata.py new file mode 100644 index 0000000000..218fb7aab2 --- /dev/null +++ b/src/oci/ai_vision/models/video_metadata.py @@ -0,0 +1,165 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoMetadata(object): + """ + Video information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoMetadata object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param frame_count: + The value to assign to the frame_count property of this VideoMetadata. + :type frame_count: int + + :param frame_rate: + The value to assign to the frame_rate property of this VideoMetadata. + :type frame_rate: float + + :param frame_width: + The value to assign to the frame_width property of this VideoMetadata. + :type frame_width: int + + :param frame_height: + The value to assign to the frame_height property of this VideoMetadata. + :type frame_height: int + + """ + self.swagger_types = { + 'frame_count': 'int', + 'frame_rate': 'float', + 'frame_width': 'int', + 'frame_height': 'int' + } + + self.attribute_map = { + 'frame_count': 'frameCount', + 'frame_rate': 'frameRate', + 'frame_width': 'frameWidth', + 'frame_height': 'frameHeight' + } + + self._frame_count = None + self._frame_rate = None + self._frame_width = None + self._frame_height = None + + @property + def frame_count(self): + """ + **[Required]** Gets the frame_count of this VideoMetadata. + Total number of frames. + + + :return: The frame_count of this VideoMetadata. + :rtype: int + """ + return self._frame_count + + @frame_count.setter + def frame_count(self, frame_count): + """ + Sets the frame_count of this VideoMetadata. + Total number of frames. + + + :param frame_count: The frame_count of this VideoMetadata. + :type: int + """ + self._frame_count = frame_count + + @property + def frame_rate(self): + """ + **[Required]** Gets the frame_rate of this VideoMetadata. + Video framerate. + + + :return: The frame_rate of this VideoMetadata. + :rtype: float + """ + return self._frame_rate + + @frame_rate.setter + def frame_rate(self, frame_rate): + """ + Sets the frame_rate of this VideoMetadata. + Video framerate. + + + :param frame_rate: The frame_rate of this VideoMetadata. + :type: float + """ + self._frame_rate = frame_rate + + @property + def frame_width(self): + """ + **[Required]** Gets the frame_width of this VideoMetadata. + Width of each frame. + + + :return: The frame_width of this VideoMetadata. + :rtype: int + """ + return self._frame_width + + @frame_width.setter + def frame_width(self, frame_width): + """ + Sets the frame_width of this VideoMetadata. + Width of each frame. + + + :param frame_width: The frame_width of this VideoMetadata. + :type: int + """ + self._frame_width = frame_width + + @property + def frame_height(self): + """ + **[Required]** Gets the frame_height of this VideoMetadata. + Height of each frame. + + + :return: The frame_height of this VideoMetadata. + :rtype: int + """ + return self._frame_height + + @frame_height.setter + def frame_height(self, frame_height): + """ + Sets the frame_height of this VideoMetadata. + Height of each frame. + + + :param frame_height: The frame_height of this VideoMetadata. + :type: int + """ + self._frame_height = frame_height + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_object.py b/src/oci/ai_vision/models/video_object.py new file mode 100644 index 0000000000..d83cb8eb61 --- /dev/null +++ b/src/oci/ai_vision/models/video_object.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoObject(object): + """ + Detected object in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoObject 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 VideoObject. + :type name: str + + :param segments: + The value to assign to the segments property of this VideoObject. + :type segments: list[oci.ai_vision.models.VideoObjectSegment] + + """ + self.swagger_types = { + 'name': 'str', + 'segments': 'list[VideoObjectSegment]' + } + + self.attribute_map = { + 'name': 'name', + 'segments': 'segments' + } + + self._name = None + self._segments = None + + @property + def name(self): + """ + **[Required]** Gets the name of this VideoObject. + Detected object name. + + + :return: The name of this VideoObject. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VideoObject. + Detected object name. + + + :param name: The name of this VideoObject. + :type: str + """ + self._name = name + + @property + def segments(self): + """ + **[Required]** Gets the segments of this VideoObject. + Object segments in a video. + + + :return: The segments of this VideoObject. + :rtype: list[oci.ai_vision.models.VideoObjectSegment] + """ + return self._segments + + @segments.setter + def segments(self, segments): + """ + Sets the segments of this VideoObject. + Object segments in a video. + + + :param segments: The segments of this VideoObject. + :type: list[oci.ai_vision.models.VideoObjectSegment] + """ + self._segments = segments + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_object_detection_feature.py b/src/oci/ai_vision/models/video_object_detection_feature.py new file mode 100644 index 0000000000..527841801a --- /dev/null +++ b/src/oci/ai_vision/models/video_object_detection_feature.py @@ -0,0 +1,146 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .video_feature import VideoFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoObjectDetectionFeature(VideoFeature): + """ + Video object detection feature + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoObjectDetectionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.VideoObjectDetectionFeature.feature_type` attribute + of this class is ``OBJECT_DETECTION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoObjectDetectionFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING" + :type feature_type: str + + :param min_confidence: + The value to assign to the min_confidence property of this VideoObjectDetectionFeature. + :type min_confidence: float + + :param max_results: + The value to assign to the max_results property of this VideoObjectDetectionFeature. + :type max_results: int + + :param model_id: + The value to assign to the model_id property of this VideoObjectDetectionFeature. + :type model_id: str + + """ + self.swagger_types = { + 'feature_type': 'str', + 'min_confidence': 'float', + 'max_results': 'int', + 'model_id': 'str' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'min_confidence': 'minConfidence', + 'max_results': 'maxResults', + 'model_id': 'modelId' + } + + self._feature_type = None + self._min_confidence = None + self._max_results = None + self._model_id = None + self._feature_type = 'OBJECT_DETECTION' + + @property + def min_confidence(self): + """ + Gets the min_confidence of this VideoObjectDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :return: The min_confidence of this VideoObjectDetectionFeature. + :rtype: float + """ + return self._min_confidence + + @min_confidence.setter + def min_confidence(self, min_confidence): + """ + Sets the min_confidence of this VideoObjectDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :param min_confidence: The min_confidence of this VideoObjectDetectionFeature. + :type: float + """ + self._min_confidence = min_confidence + + @property + def max_results(self): + """ + Gets the max_results of this VideoObjectDetectionFeature. + The maximum number of results per frame to return. + + + :return: The max_results of this VideoObjectDetectionFeature. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this VideoObjectDetectionFeature. + The maximum number of results per frame to return. + + + :param max_results: The max_results of this VideoObjectDetectionFeature. + :type: int + """ + self._max_results = max_results + + @property + def model_id(self): + """ + Gets the model_id of this VideoObjectDetectionFeature. + The custom model ID. + + + :return: The model_id of this VideoObjectDetectionFeature. + :rtype: str + """ + return self._model_id + + @model_id.setter + def model_id(self, model_id): + """ + Sets the model_id of this VideoObjectDetectionFeature. + The custom model ID. + + + :param model_id: The model_id of this VideoObjectDetectionFeature. + :type: str + """ + self._model_id = model_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/ai_vision/models/video_object_frame.py b/src/oci/ai_vision/models/video_object_frame.py new file mode 100644 index 0000000000..8424bc5a8d --- /dev/null +++ b/src/oci/ai_vision/models/video_object_frame.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoObjectFrame(object): + """ + An object frame. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoObjectFrame object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_offset_ms: + The value to assign to the time_offset_ms property of this VideoObjectFrame. + :type time_offset_ms: int + + :param confidence: + The value to assign to the confidence property of this VideoObjectFrame. + :type confidence: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this VideoObjectFrame. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + """ + self.swagger_types = { + 'time_offset_ms': 'int', + 'confidence': 'float', + 'bounding_polygon': 'BoundingPolygon' + } + + self.attribute_map = { + 'time_offset_ms': 'timeOffsetMs', + 'confidence': 'confidence', + 'bounding_polygon': 'boundingPolygon' + } + + self._time_offset_ms = None + self._confidence = None + self._bounding_polygon = None + + @property + def time_offset_ms(self): + """ + **[Required]** Gets the time_offset_ms of this VideoObjectFrame. + Time offset(Milliseconds) in the video. + + + :return: The time_offset_ms of this VideoObjectFrame. + :rtype: int + """ + return self._time_offset_ms + + @time_offset_ms.setter + def time_offset_ms(self, time_offset_ms): + """ + Sets the time_offset_ms of this VideoObjectFrame. + Time offset(Milliseconds) in the video. + + + :param time_offset_ms: The time_offset_ms of this VideoObjectFrame. + :type: int + """ + self._time_offset_ms = time_offset_ms + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoObjectFrame. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoObjectFrame. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoObjectFrame. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoObjectFrame. + :type: float + """ + self._confidence = confidence + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this VideoObjectFrame. + + :return: The bounding_polygon of this VideoObjectFrame. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this VideoObjectFrame. + + :param bounding_polygon: The bounding_polygon of this VideoObjectFrame. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_object_segment.py b/src/oci/ai_vision/models/video_object_segment.py new file mode 100644 index 0000000000..25050ab158 --- /dev/null +++ b/src/oci/ai_vision/models/video_object_segment.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoObjectSegment(object): + """ + An object segment in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoObjectSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_segment: + The value to assign to the video_segment property of this VideoObjectSegment. + :type video_segment: oci.ai_vision.models.VideoSegment + + :param confidence: + The value to assign to the confidence property of this VideoObjectSegment. + :type confidence: float + + :param frames: + The value to assign to the frames property of this VideoObjectSegment. + :type frames: list[oci.ai_vision.models.VideoObjectFrame] + + """ + self.swagger_types = { + 'video_segment': 'VideoSegment', + 'confidence': 'float', + 'frames': 'list[VideoObjectFrame]' + } + + self.attribute_map = { + 'video_segment': 'videoSegment', + 'confidence': 'confidence', + 'frames': 'frames' + } + + self._video_segment = None + self._confidence = None + self._frames = None + + @property + def video_segment(self): + """ + **[Required]** Gets the video_segment of this VideoObjectSegment. + + :return: The video_segment of this VideoObjectSegment. + :rtype: oci.ai_vision.models.VideoSegment + """ + return self._video_segment + + @video_segment.setter + def video_segment(self, video_segment): + """ + Sets the video_segment of this VideoObjectSegment. + + :param video_segment: The video_segment of this VideoObjectSegment. + :type: oci.ai_vision.models.VideoSegment + """ + self._video_segment = video_segment + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoObjectSegment. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoObjectSegment. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoObjectSegment. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoObjectSegment. + :type: float + """ + self._confidence = confidence + + @property + def frames(self): + """ + **[Required]** Gets the frames of this VideoObjectSegment. + Object frame in a segment. + + + :return: The frames of this VideoObjectSegment. + :rtype: list[oci.ai_vision.models.VideoObjectFrame] + """ + return self._frames + + @frames.setter + def frames(self, frames): + """ + Sets the frames of this VideoObjectSegment. + Object frame in a segment. + + + :param frames: The frames of this VideoObjectSegment. + :type: list[oci.ai_vision.models.VideoObjectFrame] + """ + self._frames = frames + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_object_tracking_feature.py b/src/oci/ai_vision/models/video_object_tracking_feature.py new file mode 100644 index 0000000000..1d4c88c9d1 --- /dev/null +++ b/src/oci/ai_vision/models/video_object_tracking_feature.py @@ -0,0 +1,146 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .video_feature import VideoFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoObjectTrackingFeature(VideoFeature): + """ + Video object tracking feature + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoObjectTrackingFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.VideoObjectTrackingFeature.feature_type` attribute + of this class is ``OBJECT_TRACKING`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoObjectTrackingFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING" + :type feature_type: str + + :param min_confidence: + The value to assign to the min_confidence property of this VideoObjectTrackingFeature. + :type min_confidence: float + + :param max_results: + The value to assign to the max_results property of this VideoObjectTrackingFeature. + :type max_results: int + + :param model_id: + The value to assign to the model_id property of this VideoObjectTrackingFeature. + :type model_id: str + + """ + self.swagger_types = { + 'feature_type': 'str', + 'min_confidence': 'float', + 'max_results': 'int', + 'model_id': 'str' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'min_confidence': 'minConfidence', + 'max_results': 'maxResults', + 'model_id': 'modelId' + } + + self._feature_type = None + self._min_confidence = None + self._max_results = None + self._model_id = None + self._feature_type = 'OBJECT_TRACKING' + + @property + def min_confidence(self): + """ + Gets the min_confidence of this VideoObjectTrackingFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :return: The min_confidence of this VideoObjectTrackingFeature. + :rtype: float + """ + return self._min_confidence + + @min_confidence.setter + def min_confidence(self, min_confidence): + """ + Sets the min_confidence of this VideoObjectTrackingFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :param min_confidence: The min_confidence of this VideoObjectTrackingFeature. + :type: float + """ + self._min_confidence = min_confidence + + @property + def max_results(self): + """ + Gets the max_results of this VideoObjectTrackingFeature. + The maximum number of results per frame to return. + + + :return: The max_results of this VideoObjectTrackingFeature. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this VideoObjectTrackingFeature. + The maximum number of results per frame to return. + + + :param max_results: The max_results of this VideoObjectTrackingFeature. + :type: int + """ + self._max_results = max_results + + @property + def model_id(self): + """ + Gets the model_id of this VideoObjectTrackingFeature. + The custom model ID. + + + :return: The model_id of this VideoObjectTrackingFeature. + :rtype: str + """ + return self._model_id + + @model_id.setter + def model_id(self, model_id): + """ + Sets the model_id of this VideoObjectTrackingFeature. + The custom model ID. + + + :param model_id: The model_id of this VideoObjectTrackingFeature. + :type: str + """ + self._model_id = model_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/ai_vision/models/video_segment.py b/src/oci/ai_vision/models/video_segment.py new file mode 100644 index 0000000000..6f0bdf1415 --- /dev/null +++ b/src/oci/ai_vision/models/video_segment.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoSegment(object): + """ + A sequence of frames that was (or appears to be) continuously captured for a label/object/text?. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param start_time_offset_ms: + The value to assign to the start_time_offset_ms property of this VideoSegment. + :type start_time_offset_ms: int + + :param end_time_offset_ms: + The value to assign to the end_time_offset_ms property of this VideoSegment. + :type end_time_offset_ms: int + + """ + self.swagger_types = { + 'start_time_offset_ms': 'int', + 'end_time_offset_ms': 'int' + } + + self.attribute_map = { + 'start_time_offset_ms': 'startTimeOffsetMs', + 'end_time_offset_ms': 'endTimeOffsetMs' + } + + self._start_time_offset_ms = None + self._end_time_offset_ms = None + + @property + def start_time_offset_ms(self): + """ + **[Required]** Gets the start_time_offset_ms of this VideoSegment. + Video start time offset(Milliseconds). + + + :return: The start_time_offset_ms of this VideoSegment. + :rtype: int + """ + return self._start_time_offset_ms + + @start_time_offset_ms.setter + def start_time_offset_ms(self, start_time_offset_ms): + """ + Sets the start_time_offset_ms of this VideoSegment. + Video start time offset(Milliseconds). + + + :param start_time_offset_ms: The start_time_offset_ms of this VideoSegment. + :type: int + """ + self._start_time_offset_ms = start_time_offset_ms + + @property + def end_time_offset_ms(self): + """ + **[Required]** Gets the end_time_offset_ms of this VideoSegment. + Video end time offset(Milliseconds). + + + :return: The end_time_offset_ms of this VideoSegment. + :rtype: int + """ + return self._end_time_offset_ms + + @end_time_offset_ms.setter + def end_time_offset_ms(self, end_time_offset_ms): + """ + Sets the end_time_offset_ms of this VideoSegment. + Video end time offset(Milliseconds). + + + :param end_time_offset_ms: The end_time_offset_ms of this VideoSegment. + :type: int + """ + self._end_time_offset_ms = end_time_offset_ms + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_text.py b/src/oci/ai_vision/models/video_text.py new file mode 100644 index 0000000000..ee17ffa802 --- /dev/null +++ b/src/oci/ai_vision/models/video_text.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoText(object): + """ + Detected text in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoText object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param text: + The value to assign to the text property of this VideoText. + :type text: str + + :param segments: + The value to assign to the segments property of this VideoText. + :type segments: list[oci.ai_vision.models.VideoTextSegment] + + """ + self.swagger_types = { + 'text': 'str', + 'segments': 'list[VideoTextSegment]' + } + + self.attribute_map = { + 'text': 'text', + 'segments': 'segments' + } + + self._text = None + self._segments = None + + @property + def text(self): + """ + **[Required]** Gets the text of this VideoText. + Detected text. + + + :return: The text of this VideoText. + :rtype: str + """ + return self._text + + @text.setter + def text(self, text): + """ + Sets the text of this VideoText. + Detected text. + + + :param text: The text of this VideoText. + :type: str + """ + self._text = text + + @property + def segments(self): + """ + **[Required]** Gets the segments of this VideoText. + Text segments in a video. + + + :return: The segments of this VideoText. + :rtype: list[oci.ai_vision.models.VideoTextSegment] + """ + return self._segments + + @segments.setter + def segments(self, segments): + """ + Sets the segments of this VideoText. + Text segments in a video. + + + :param segments: The segments of this VideoText. + :type: list[oci.ai_vision.models.VideoTextSegment] + """ + self._segments = segments + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_text_detection_feature.py b/src/oci/ai_vision/models/video_text_detection_feature.py new file mode 100644 index 0000000000..7595bc74ab --- /dev/null +++ b/src/oci/ai_vision/models/video_text_detection_feature.py @@ -0,0 +1,84 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + +from .video_feature import VideoFeature +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTextDetectionFeature(VideoFeature): + """ + Video text detection feature + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTextDetectionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_vision.models.VideoTextDetectionFeature.feature_type` attribute + of this class is ``TEXT_DETECTION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param feature_type: + The value to assign to the feature_type property of this VideoTextDetectionFeature. + Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING" + :type feature_type: str + + :param min_confidence: + The value to assign to the min_confidence property of this VideoTextDetectionFeature. + :type min_confidence: float + + """ + self.swagger_types = { + 'feature_type': 'str', + 'min_confidence': 'float' + } + + self.attribute_map = { + 'feature_type': 'featureType', + 'min_confidence': 'minConfidence' + } + + self._feature_type = None + self._min_confidence = None + self._feature_type = 'TEXT_DETECTION' + + @property + def min_confidence(self): + """ + Gets the min_confidence of this VideoTextDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :return: The min_confidence of this VideoTextDetectionFeature. + :rtype: float + """ + return self._min_confidence + + @min_confidence.setter + def min_confidence(self, min_confidence): + """ + Sets the min_confidence of this VideoTextDetectionFeature. + The minimum confidence score, between 0 and 1, + when the value is set, results with lower confidence will not be returned. + + + :param min_confidence: The min_confidence of this VideoTextDetectionFeature. + :type: float + """ + self._min_confidence = min_confidence + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_text_frame.py b/src/oci/ai_vision/models/video_text_frame.py new file mode 100644 index 0000000000..487c7e85a1 --- /dev/null +++ b/src/oci/ai_vision/models/video_text_frame.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTextFrame(object): + """ + A text frame. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTextFrame object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_offset_ms: + The value to assign to the time_offset_ms property of this VideoTextFrame. + :type time_offset_ms: int + + :param confidence: + The value to assign to the confidence property of this VideoTextFrame. + :type confidence: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this VideoTextFrame. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + """ + self.swagger_types = { + 'time_offset_ms': 'int', + 'confidence': 'float', + 'bounding_polygon': 'BoundingPolygon' + } + + self.attribute_map = { + 'time_offset_ms': 'timeOffsetMs', + 'confidence': 'confidence', + 'bounding_polygon': 'boundingPolygon' + } + + self._time_offset_ms = None + self._confidence = None + self._bounding_polygon = None + + @property + def time_offset_ms(self): + """ + **[Required]** Gets the time_offset_ms of this VideoTextFrame. + Time offset(Milliseconds) in the video. + + + :return: The time_offset_ms of this VideoTextFrame. + :rtype: int + """ + return self._time_offset_ms + + @time_offset_ms.setter + def time_offset_ms(self, time_offset_ms): + """ + Sets the time_offset_ms of this VideoTextFrame. + Time offset(Milliseconds) in the video. + + + :param time_offset_ms: The time_offset_ms of this VideoTextFrame. + :type: int + """ + self._time_offset_ms = time_offset_ms + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoTextFrame. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoTextFrame. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoTextFrame. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoTextFrame. + :type: float + """ + self._confidence = confidence + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this VideoTextFrame. + + :return: The bounding_polygon of this VideoTextFrame. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this VideoTextFrame. + + :param bounding_polygon: The bounding_polygon of this VideoTextFrame. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_text_segment.py b/src/oci/ai_vision/models/video_text_segment.py new file mode 100644 index 0000000000..8050d1d5ea --- /dev/null +++ b/src/oci/ai_vision/models/video_text_segment.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTextSegment(object): + """ + A text segment in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTextSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_segment: + The value to assign to the video_segment property of this VideoTextSegment. + :type video_segment: oci.ai_vision.models.VideoSegment + + :param confidence: + The value to assign to the confidence property of this VideoTextSegment. + :type confidence: float + + :param frames: + The value to assign to the frames property of this VideoTextSegment. + :type frames: list[oci.ai_vision.models.VideoTextFrame] + + """ + self.swagger_types = { + 'video_segment': 'VideoSegment', + 'confidence': 'float', + 'frames': 'list[VideoTextFrame]' + } + + self.attribute_map = { + 'video_segment': 'videoSegment', + 'confidence': 'confidence', + 'frames': 'frames' + } + + self._video_segment = None + self._confidence = None + self._frames = None + + @property + def video_segment(self): + """ + **[Required]** Gets the video_segment of this VideoTextSegment. + + :return: The video_segment of this VideoTextSegment. + :rtype: oci.ai_vision.models.VideoSegment + """ + return self._video_segment + + @video_segment.setter + def video_segment(self, video_segment): + """ + Sets the video_segment of this VideoTextSegment. + + :param video_segment: The video_segment of this VideoTextSegment. + :type: oci.ai_vision.models.VideoSegment + """ + self._video_segment = video_segment + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoTextSegment. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoTextSegment. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoTextSegment. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoTextSegment. + :type: float + """ + self._confidence = confidence + + @property + def frames(self): + """ + **[Required]** Gets the frames of this VideoTextSegment. + Text frame in a segment. + + + :return: The frames of this VideoTextSegment. + :rtype: list[oci.ai_vision.models.VideoTextFrame] + """ + return self._frames + + @frames.setter + def frames(self, frames): + """ + Sets the frames of this VideoTextSegment. + Text frame in a segment. + + + :param frames: The frames of this VideoTextSegment. + :type: list[oci.ai_vision.models.VideoTextFrame] + """ + self._frames = frames + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_tracked_object.py b/src/oci/ai_vision/models/video_tracked_object.py new file mode 100644 index 0000000000..fd73dfc6f8 --- /dev/null +++ b/src/oci/ai_vision/models/video_tracked_object.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTrackedObject(object): + """ + Tracked object in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTrackedObject 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 VideoTrackedObject. + :type name: str + + :param object_id: + The value to assign to the object_id property of this VideoTrackedObject. + :type object_id: int + + :param properties: + The value to assign to the properties property of this VideoTrackedObject. + :type properties: oci.ai_vision.models.VideoTrackedObjectProperties + + :param segments: + The value to assign to the segments property of this VideoTrackedObject. + :type segments: list[oci.ai_vision.models.VideoTrackedObjectSegment] + + """ + self.swagger_types = { + 'name': 'str', + 'object_id': 'int', + 'properties': 'VideoTrackedObjectProperties', + 'segments': 'list[VideoTrackedObjectSegment]' + } + + self.attribute_map = { + 'name': 'name', + 'object_id': 'objectId', + 'properties': 'properties', + 'segments': 'segments' + } + + self._name = None + self._object_id = None + self._properties = None + self._segments = None + + @property + def name(self): + """ + **[Required]** Gets the name of this VideoTrackedObject. + Name of the object category label. + + + :return: The name of this VideoTrackedObject. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VideoTrackedObject. + Name of the object category label. + + + :param name: The name of this VideoTrackedObject. + :type: str + """ + self._name = name + + @property + def object_id(self): + """ + **[Required]** Gets the object_id of this VideoTrackedObject. + Unique identifier for the object. + + + :return: The object_id of this VideoTrackedObject. + :rtype: int + """ + return self._object_id + + @object_id.setter + def object_id(self, object_id): + """ + Sets the object_id of this VideoTrackedObject. + Unique identifier for the object. + + + :param object_id: The object_id of this VideoTrackedObject. + :type: int + """ + self._object_id = object_id + + @property + def properties(self): + """ + Gets the properties of this VideoTrackedObject. + + :return: The properties of this VideoTrackedObject. + :rtype: oci.ai_vision.models.VideoTrackedObjectProperties + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VideoTrackedObject. + + :param properties: The properties of this VideoTrackedObject. + :type: oci.ai_vision.models.VideoTrackedObjectProperties + """ + self._properties = properties + + @property + def segments(self): + """ + **[Required]** Gets the segments of this VideoTrackedObject. + Segments for the tracked object. + + + :return: The segments of this VideoTrackedObject. + :rtype: list[oci.ai_vision.models.VideoTrackedObjectSegment] + """ + return self._segments + + @segments.setter + def segments(self, segments): + """ + Sets the segments of this VideoTrackedObject. + Segments for the tracked object. + + + :param segments: The segments of this VideoTrackedObject. + :type: list[oci.ai_vision.models.VideoTrackedObjectSegment] + """ + self._segments = segments + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_tracked_object_properties.py b/src/oci/ai_vision/models/video_tracked_object_properties.py new file mode 100644 index 0000000000..5a947f21f0 --- /dev/null +++ b/src/oci/ai_vision/models/video_tracked_object_properties.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTrackedObjectProperties(object): + """ + Properties of a tracked object in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTrackedObjectProperties object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param axle_count: + The value to assign to the axle_count property of this VideoTrackedObjectProperties. + :type axle_count: int + + """ + self.swagger_types = { + 'axle_count': 'int' + } + + self.attribute_map = { + 'axle_count': 'axleCount' + } + + self._axle_count = None + + @property + def axle_count(self): + """ + Gets the axle_count of this VideoTrackedObjectProperties. + The axle count value of a tracked vehicle. + + + :return: The axle_count of this VideoTrackedObjectProperties. + :rtype: int + """ + return self._axle_count + + @axle_count.setter + def axle_count(self, axle_count): + """ + Sets the axle_count of this VideoTrackedObjectProperties. + The axle count value of a tracked vehicle. + + + :param axle_count: The axle_count of this VideoTrackedObjectProperties. + :type: int + """ + self._axle_count = axle_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/ai_vision/models/video_tracked_object_segment.py b/src/oci/ai_vision/models/video_tracked_object_segment.py new file mode 100644 index 0000000000..47b6f404e3 --- /dev/null +++ b/src/oci/ai_vision/models/video_tracked_object_segment.py @@ -0,0 +1,130 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTrackedObjectSegment(object): + """ + A segment of a tracked object in a video. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTrackedObjectSegment object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param video_segment: + The value to assign to the video_segment property of this VideoTrackedObjectSegment. + :type video_segment: oci.ai_vision.models.VideoSegment + + :param confidence: + The value to assign to the confidence property of this VideoTrackedObjectSegment. + :type confidence: float + + :param frames: + The value to assign to the frames property of this VideoTrackedObjectSegment. + :type frames: list[oci.ai_vision.models.VideoTrackingFrame] + + """ + self.swagger_types = { + 'video_segment': 'VideoSegment', + 'confidence': 'float', + 'frames': 'list[VideoTrackingFrame]' + } + + self.attribute_map = { + 'video_segment': 'videoSegment', + 'confidence': 'confidence', + 'frames': 'frames' + } + + self._video_segment = None + self._confidence = None + self._frames = None + + @property + def video_segment(self): + """ + **[Required]** Gets the video_segment of this VideoTrackedObjectSegment. + + :return: The video_segment of this VideoTrackedObjectSegment. + :rtype: oci.ai_vision.models.VideoSegment + """ + return self._video_segment + + @video_segment.setter + def video_segment(self, video_segment): + """ + Sets the video_segment of this VideoTrackedObjectSegment. + + :param video_segment: The video_segment of this VideoTrackedObjectSegment. + :type: oci.ai_vision.models.VideoSegment + """ + self._video_segment = video_segment + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoTrackedObjectSegment. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoTrackedObjectSegment. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoTrackedObjectSegment. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoTrackedObjectSegment. + :type: float + """ + self._confidence = confidence + + @property + def frames(self): + """ + **[Required]** Gets the frames of this VideoTrackedObjectSegment. + Frames within the segment. + + + :return: The frames of this VideoTrackedObjectSegment. + :rtype: list[oci.ai_vision.models.VideoTrackingFrame] + """ + return self._frames + + @frames.setter + def frames(self, frames): + """ + Sets the frames of this VideoTrackedObjectSegment. + Frames within the segment. + + + :param frames: The frames of this VideoTrackedObjectSegment. + :type: list[oci.ai_vision.models.VideoTrackingFrame] + """ + self._frames = frames + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_vision/models/video_tracking_frame.py b/src/oci/ai_vision/models/video_tracking_frame.py new file mode 100644 index 0000000000..7e3f379ef1 --- /dev/null +++ b/src/oci/ai_vision/models/video_tracking_frame.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class VideoTrackingFrame(object): + """ + A frame capturing a tracked object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new VideoTrackingFrame object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param time_offset_ms: + The value to assign to the time_offset_ms property of this VideoTrackingFrame. + :type time_offset_ms: int + + :param confidence: + The value to assign to the confidence property of this VideoTrackingFrame. + :type confidence: float + + :param bounding_polygon: + The value to assign to the bounding_polygon property of this VideoTrackingFrame. + :type bounding_polygon: oci.ai_vision.models.BoundingPolygon + + :param properties: + The value to assign to the properties property of this VideoTrackingFrame. + :type properties: list[oci.ai_vision.models.ObjectProperty] + + """ + self.swagger_types = { + 'time_offset_ms': 'int', + 'confidence': 'float', + 'bounding_polygon': 'BoundingPolygon', + 'properties': 'list[ObjectProperty]' + } + + self.attribute_map = { + 'time_offset_ms': 'timeOffsetMs', + 'confidence': 'confidence', + 'bounding_polygon': 'boundingPolygon', + 'properties': 'properties' + } + + self._time_offset_ms = None + self._confidence = None + self._bounding_polygon = None + self._properties = None + + @property + def time_offset_ms(self): + """ + **[Required]** Gets the time_offset_ms of this VideoTrackingFrame. + Time offset(Milliseconds) of the frame. + + + :return: The time_offset_ms of this VideoTrackingFrame. + :rtype: int + """ + return self._time_offset_ms + + @time_offset_ms.setter + def time_offset_ms(self, time_offset_ms): + """ + Sets the time_offset_ms of this VideoTrackingFrame. + Time offset(Milliseconds) of the frame. + + + :param time_offset_ms: The time_offset_ms of this VideoTrackingFrame. + :type: int + """ + self._time_offset_ms = time_offset_ms + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this VideoTrackingFrame. + The confidence score, between 0 and 1. + + + :return: The confidence of this VideoTrackingFrame. + :rtype: float + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this VideoTrackingFrame. + The confidence score, between 0 and 1. + + + :param confidence: The confidence of this VideoTrackingFrame. + :type: float + """ + self._confidence = confidence + + @property + def bounding_polygon(self): + """ + **[Required]** Gets the bounding_polygon of this VideoTrackingFrame. + + :return: The bounding_polygon of this VideoTrackingFrame. + :rtype: oci.ai_vision.models.BoundingPolygon + """ + return self._bounding_polygon + + @bounding_polygon.setter + def bounding_polygon(self, bounding_polygon): + """ + Sets the bounding_polygon of this VideoTrackingFrame. + + :param bounding_polygon: The bounding_polygon of this VideoTrackingFrame. + :type: oci.ai_vision.models.BoundingPolygon + """ + self._bounding_polygon = bounding_polygon + + @property + def properties(self): + """ + Gets the properties of this VideoTrackingFrame. + Properties associated with the tracked object in the frame. + + + :return: The properties of this VideoTrackingFrame. + :rtype: list[oci.ai_vision.models.ObjectProperty] + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VideoTrackingFrame. + Properties associated with the tracked object in the frame. + + + :param properties: The properties of this VideoTrackingFrame. + :type: list[oci.ai_vision.models.ObjectProperty] + """ + self._properties = properties + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/auth/certificate_retriever.py b/src/oci/auth/certificate_retriever.py index f353607ecd..5c2f2b0162 100644 --- a/src/oci/auth/certificate_retriever.py +++ b/src/oci/auth/certificate_retriever.py @@ -17,17 +17,14 @@ # A retry strategy for use when calling the metadata endpoint on an instance to retrieve certificates. # This retry strategy will retry on 404, 429 and 5xx exceptions (the metadata endpoint does not throw errors like an -# OCI service) up to 3 times with ~30-31 seconds wait, for a max of 3 minutes +# OCI service) up to 8 times with exponential backoff and jitter, for a max of 3 minutes INSTANCE_METADATA_URL_CERTIFICATE_RETRIEVER_RETRY_STRATEGY = ( oci.retry.RetryStrategyBuilder(service_error_check=True, service_error_retry_config={-1: [], 429: [], 404: []}, service_error_retry_on_any_5xx=True, - retry_max_wait_between_calls_seconds=31, - retry_base_sleep_time_seconds=30, - retry_exponential_growth_factor=1, total_elapsed_time_seconds=180 ) - .add_max_attempts(3).add_total_elapsed_time().get_retry_strategy()) + .add_max_attempts(8).add_total_elapsed_time().get_retry_strategy()) # An abstract class which defines the interface via which certificates (and their corresponding private key) can be retrieved. diff --git a/src/oci/auth/signers/instance_principals_security_token_signer.py b/src/oci/auth/signers/instance_principals_security_token_signer.py index 32ba3bba1c..337a932c44 100644 --- a/src/oci/auth/signers/instance_principals_security_token_signer.py +++ b/src/oci/auth/signers/instance_principals_security_token_signer.py @@ -12,6 +12,7 @@ from oci._vendor.requests.exceptions import ConnectTimeout import oci.regions +import os import logging @@ -24,6 +25,7 @@ class InstancePrincipalsSecurityTokenSigner(X509FederationClientBasedSecurityTok the token: * Using the metadata endpoint for the instance (http://169.254.169.254/opc/v2) we can discover the region the instance is in, its leaf certificate and any intermediate certificates (for requesting the token) and the tenancy (as) that is in the leaf certificate. + * You can override the metadata endpoint by overriding the environment variable OCI_METADATA_BASE_URL with an endpoint of your choice * The signer leverages X509FederationClient so it can refresh the security token and also get the private key needed to sign requests (via the client's session_key_supplier) This signer can be used as follows: @@ -47,7 +49,7 @@ class InstancePrincipalsSecurityTokenSigner(X509FederationClientBasedSecurityTok :param obj federation_client_retry_strategy: (optional): A retry strategy to apply to calls made by the X509FederationClient used by this class. 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 and + the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_FEDERATION_CLIENT_RETRY_STRATEGY` is also available and will be used by the X509FederationClient if no explicit retry strategy is specified. The specifics of the default retry strategy are described `here `__. @@ -59,15 +61,16 @@ class InstancePrincipalsSecurityTokenSigner(X509FederationClientBasedSecurityTok the certificate & corresponding private key (if there is one defined for this retriever) from UrlBasedCertificateRetriever, region, federation endpoint, and the response for receiving the token from the federation endpoint """ - - METADATA_URL_BASE = 'http://169.254.169.254/opc/v2' - GET_REGION_URL = '{}/instance/region'.format(METADATA_URL_BASE) - LEAF_CERTIFICATE_URL = '{}/identity/cert.pem'.format(METADATA_URL_BASE) - LEAF_CERTIFICATE_PRIVATE_KEY_URL = '{}/identity/key.pem'.format(METADATA_URL_BASE) - INTERMEDIATE_CERTIFICATE_URL = '{}/identity/intermediate.pem'.format(METADATA_URL_BASE) - METADATA_AUTH_HEADERS = {'Authorization': 'Bearer Oracle'} - def __init__(self, **kwargs): + self.METADATA_URL_BASE_ENV_VAR = 'OCI_METADATA_BASE_URL' + self.DEFAULT_METADATA_URL_BASE = 'http://169.254.169.254/opc/v2' + self.METADATA_URL_BASE = os.environ.get(self.METADATA_URL_BASE_ENV_VAR, self.DEFAULT_METADATA_URL_BASE) + self.GET_REGION_URL = '{}/instance/region'.format(self.METADATA_URL_BASE) + self.LEAF_CERTIFICATE_URL = '{}/identity/cert.pem'.format(self.METADATA_URL_BASE) + self.LEAF_CERTIFICATE_PRIVATE_KEY_URL = '{}/identity/key.pem'.format(self.METADATA_URL_BASE) + self.INTERMEDIATE_CERTIFICATE_URL = '{}/identity/intermediate.pem'.format(self.METADATA_URL_BASE) + self.METADATA_AUTH_HEADERS = {'Authorization': 'Bearer Oracle'} + self.logger = logging.getLogger("{}.{}".format(__name__, id(self))) self.logger.addHandler(logging.NullHandler()) if kwargs.get('log_requests'): @@ -90,22 +93,10 @@ def __init__(self, **kwargs): headers=self.METADATA_AUTH_HEADERS, log_requests=kwargs.get('log_requests')) except (HTTPError, ConnectTimeout, oci.exceptions.ServiceError) as e: - if e.response and e.response.status_code == 404: - InstancePrincipalsSecurityTokenSigner.METADATA_URL_BASE = 'http://169.254.169.254/opc/v1' - InstancePrincipalsSecurityTokenSigner.GET_REGION_URL = '{}/instance/region'.format(InstancePrincipalsSecurityTokenSigner.METADATA_URL_BASE) - InstancePrincipalsSecurityTokenSigner.LEAF_CERTIFICATE_URL = '{}/identity/cert.pem'.format(InstancePrincipalsSecurityTokenSigner.METADATA_URL_BASE) - InstancePrincipalsSecurityTokenSigner.LEAF_CERTIFICATE_PRIVATE_KEY_URL = '{}/identity/key.pem'.format(InstancePrincipalsSecurityTokenSigner.METADATA_URL_BASE) - InstancePrincipalsSecurityTokenSigner.INTERMEDIATE_CERTIFICATE_URL = '{}/identity/intermediate.pem'.format(InstancePrincipalsSecurityTokenSigner.METADATA_URL_BASE) - self.leaf_certificate_retriever = UrlBasedCertificateRetriever( - certificate_url=self.LEAF_CERTIFICATE_URL, - private_key_url=self.LEAF_CERTIFICATE_PRIVATE_KEY_URL, - retry_strategy=self.retry_strategy, - headers=self.METADATA_AUTH_HEADERS) - else: - if not e.args: - e.args = ('',) - e.args = e.args + ("Instance principals authentication can only be used on OCI compute instances. Please confirm this code is running on an OCI compute instance. See https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm for more info.",) - raise e + if not e.args: + e.args = ('',) + e.args = e.args + ("Instance principals authentication can only be used on OCI compute instances. Please confirm this code is running on an OCI compute instance. See https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm for more info.",) + raise e self.intermediate_certificate_retriever = UrlBasedCertificateRetriever( certificate_url=self.INTERMEDIATE_CERTIFICATE_URL, @@ -143,8 +134,23 @@ def initialize_and_return_region(self): if hasattr(self, 'region'): return self.region - self.logger.debug("Requesting region information from : %s " % (self.GET_REGION_URL)) + if self.retry_strategy: + self.retry_strategy.make_retrying_call(self._set_region_from_imds) + else: + self._set_region_from_imds() + + self.logger.debug(f"Region is set to: {self.region}") + return self.region + + def _set_region_from_imds(self): + self.logger.debug(f"Requesting region information from IMDS: {self.GET_REGION_URL}") response = requests.get(self.GET_REGION_URL, timeout=(10, 60), headers=self.METADATA_AUTH_HEADERS) + + try: + response.raise_for_status() + except HTTPError as e: + raise oci.exceptions.ServiceError(e.response.status_code, e.errno, e.response.headers, str(e)) + region_raw = response.text.strip().lower() # The region can be something like "phx" but internally we expect "us-phoenix-1", "us-ashburn-1" etc. @@ -152,6 +158,3 @@ def initialize_and_return_region(self): self.region = oci.regions.REGIONS_SHORT_NAMES[region_raw] else: self.region = region_raw - - self.logger.debug("Region is set to : %s " % (self.region)) - return self.region diff --git a/src/oci/bds/bds_client.py b/src/oci/bds/bds_client.py index a0b417b517..bbb9b81e4c 100644 --- a/src/oci/bds/bds_client.py +++ b/src/oci/bds/bds_client.py @@ -238,6 +238,250 @@ def activate_bds_metastore_configuration(self, bds_instance_id, metastore_config api_reference_link=api_reference_link, required_arguments=required_arguments) + def activate_iam_user_sync_configuration(self, bds_instance_id, identity_configuration_id, activate_iam_user_sync_configuration_details, **kwargs): + """ + Activate IAM user sync configuration for the given identity configuration + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.ActivateIamUserSyncConfigurationDetails activate_iam_user_sync_configuration_details: (required) + Details for activating a new IAM user sync config. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use activate_iam_user_sync_configuration API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateIamUserSyncConfiguration" + method = "POST" + operation_name = "activate_iam_user_sync_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/ActivateIamUserSyncConfiguration" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"activate_iam_user_sync_configuration got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=activate_iam_user_sync_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=activate_iam_user_sync_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def activate_upst_configuration(self, bds_instance_id, identity_configuration_id, activate_upst_configuration_details, **kwargs): + """ + Activate UPST configuration for the given identity configuration + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.ActivateUpstConfigurationDetails activate_upst_configuration_details: (required) + Details for activating UPST config + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use activate_upst_configuration API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateUpstConfiguration" + method = "POST" + operation_name = "activate_upst_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/ActivateUpstConfiguration" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"activate_upst_configuration got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=activate_upst_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=activate_upst_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def add_auto_scaling_configuration(self, bds_instance_id, add_auto_scaling_configuration_details, **kwargs): """ Add an autoscale configuration to the cluster. @@ -1850,19 +2094,16 @@ def create_bds_metastore_configuration(self, bds_instance_id, create_bds_metasto api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_node_backup_configuration(self, bds_instance_id, create_node_backup_configuration_details, **kwargs): + def create_identity_configuration(self, bds_instance_id, create_identity_configuration_details, **kwargs): """ - Add a node volume backup configuration to the cluster for an indicated node type or node. + Create an identity configuration for the cluster :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.CreateNodeBackupConfigurationDetails create_node_backup_configuration_details: (required) - Details for adding nodeBackupConfiguration to the BDS cluster. - - :param str opc_request_id: (optional) - The client request ID for tracing. + :param oci.bds.models.CreateIdentityConfigurationDetails create_identity_configuration_details: (required) + Details for creating an identity configuration :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or @@ -1871,6 +2112,9 @@ def create_node_backup_configuration(self, bds_instance_id, create_node_backup_c has been deleted and purged from the system, then a retry of the original creation request might be rejected. + :param str opc_request_id: (optional) + The client request ID for tracing. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1887,26 +2131,26 @@ def create_node_backup_configuration(self, bds_instance_id, create_node_backup_c :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_node_backup_configuration API. + Click `here `__ to see an example of how to use create_identity_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations" + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations" method = "POST" - operation_name = "create_node_backup_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateNodeBackupConfiguration" + operation_name = "create_identity_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/CreateIdentityConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "opc_retry_token" + "opc_retry_token", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") + f"create_identity_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -1921,8 +2165,8 @@ def create_node_backup_configuration(self, bds_instance_id, create_node_backup_c 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) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1942,7 +2186,7 @@ def create_node_backup_configuration(self, bds_instance_id, create_node_backup_c method=method, path_params=path_params, header_params=header_params, - body=create_node_backup_configuration_details, + body=create_identity_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -1953,22 +2197,22 @@ def create_node_backup_configuration(self, bds_instance_id, create_node_backup_c method=method, path_params=path_params, header_params=header_params, - body=create_node_backup_configuration_details, + body=create_identity_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_node_replace_configuration(self, bds_instance_id, create_node_replace_configuration_details, **kwargs): + def create_node_backup_configuration(self, bds_instance_id, create_node_backup_configuration_details, **kwargs): """ - Add a nodeReplaceConfigurations to the cluster. + Add a node volume backup configuration to the cluster for an indicated node type or node. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.CreateNodeReplaceConfigurationDetails create_node_replace_configuration_details: (required) - Details for adding nodeReplaceConfiguration to the BDS cluster. + :param oci.bds.models.CreateNodeBackupConfigurationDetails create_node_backup_configuration_details: (required) + Details for adding nodeBackupConfiguration to the BDS cluster. :param str opc_request_id: (optional) The client request ID for tracing. @@ -1996,14 +2240,14 @@ def create_node_replace_configuration(self, bds_instance_id, create_node_replace :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_node_replace_configuration API. + Click `here `__ to see an example of how to use create_node_backup_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations" + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations" method = "POST" - operation_name = "create_node_replace_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateNodeReplaceConfiguration" + operation_name = "create_node_backup_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateNodeBackupConfiguration" # Don't accept unknown kwargs expected_kwargs = [ @@ -2015,7 +2259,7 @@ def create_node_replace_configuration(self, bds_instance_id, create_node_replace extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_node_replace_configuration got unknown kwargs: {extra_kwargs!r}") + f"create_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -2051,7 +2295,7 @@ def create_node_replace_configuration(self, bds_instance_id, create_node_replace method=method, path_params=path_params, header_params=header_params, - body=create_node_replace_configuration_details, + body=create_node_backup_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2062,22 +2306,22 @@ def create_node_replace_configuration(self, bds_instance_id, create_node_replace method=method, path_params=path_params, header_params=header_params, - body=create_node_replace_configuration_details, + body=create_node_backup_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def create_resource_principal_configuration(self, bds_instance_id, create_resource_principal_configuration_details, **kwargs): + def create_node_replace_configuration(self, bds_instance_id, create_node_replace_configuration_details, **kwargs): """ - Create a resource principal session token configuration. + Add a nodeReplaceConfigurations to the cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.CreateResourcePrincipalConfigurationDetails create_resource_principal_configuration_details: (required) - Details of creating resource principal session token for the bds cluster. + :param oci.bds.models.CreateNodeReplaceConfigurationDetails create_node_replace_configuration_details: (required) + Details for adding nodeReplaceConfiguration to the BDS cluster. :param str opc_request_id: (optional) The client request ID for tracing. @@ -2105,14 +2349,14 @@ def create_resource_principal_configuration(self, bds_instance_id, create_resour :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use create_resource_principal_configuration API. + Click `here `__ to see an example of how to use create_node_replace_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations" + resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations" method = "POST" - operation_name = "create_resource_principal_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateResourcePrincipalConfiguration" + operation_name = "create_node_replace_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateNodeReplaceConfiguration" # Don't accept unknown kwargs expected_kwargs = [ @@ -2124,7 +2368,7 @@ def create_resource_principal_configuration(self, bds_instance_id, create_resour extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"create_resource_principal_configuration got unknown kwargs: {extra_kwargs!r}") + f"create_node_replace_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -2160,7 +2404,7 @@ def create_resource_principal_configuration(self, bds_instance_id, create_resour method=method, path_params=path_params, header_params=header_params, - body=create_resource_principal_configuration_details, + body=create_node_replace_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2171,32 +2415,32 @@ def create_resource_principal_configuration(self, bds_instance_id, create_resour method=method, path_params=path_params, header_params=header_params, - body=create_resource_principal_configuration_details, + body=create_node_replace_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): + def create_resource_principal_configuration(self, bds_instance_id, create_resource_principal_configuration_details, **kwargs): """ - Deletes the user's API key represented by the provided ID. + Create a resource principal session token configuration. :param str bds_instance_id: (required) The OCID of the cluster. - :param str api_key_id: (required) - The API key identifier. + :param oci.bds.models.CreateResourcePrincipalConfigurationDetails create_resource_principal_configuration_details: (required) + Details of creating resource principal session token for the bds cluster. :param str opc_request_id: (optional) The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. + :param 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. @@ -2214,30 +2458,29 @@ def delete_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_bds_api_key API. + Click `here `__ to see an example of how to use create_resource_principal_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'apiKeyId'] - resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}" - method = "DELETE" - operation_name = "delete_bds_api_key" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/DeleteBdsApiKey" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations" + method = "POST" + operation_name = "create_resource_principal_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/CreateResourcePrincipalConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", - "if_match" + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_bds_api_key got unknown kwargs: {extra_kwargs!r}") + f"create_resource_principal_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id, - "apiKeyId": api_key_id + "bdsInstanceId": bds_instance_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2250,7 +2493,7 @@ def delete_bds_api_key(self, bds_instance_id, api_key_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) + "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} @@ -2261,6 +2504,7 @@ def delete_bds_api_key(self, bds_instance_id, api_key_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( @@ -2269,6 +2513,7 @@ def delete_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): method=method, path_params=path_params, header_params=header_params, + body=create_resource_principal_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2279,19 +2524,26 @@ def delete_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): method=method, path_params=path_params, header_params=header_params, + body=create_resource_principal_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_bds_instance(self, bds_instance_id, **kwargs): + def deactivate_iam_user_sync_configuration(self, bds_instance_id, identity_configuration_id, deactivate_iam_user_sync_configuration_details, **kwargs): """ - Deletes the cluster identified by the given ID. + Deactivate the IAM user sync configuration. :param str bds_instance_id: (required) The OCID of the cluster. + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.DeactivateIamUserSyncConfigurationDetails deactivate_iam_user_sync_configuration_details: (required) + Details for deactivating the IAM user sync config + :param str opc_request_id: (optional) The client request ID for tracing. @@ -2302,6 +2554,13 @@ def delete_bds_instance(self, bds_instance_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. @@ -2318,29 +2577,31 @@ def delete_bds_instance(self, bds_instance_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_bds_instance API. + Click `here `__ to see an example of how to use deactivate_iam_user_sync_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}" - method = "DELETE" - operation_name = "delete_bds_instance" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/DeleteBdsInstance" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateIamUserSyncConfiguration" + method = "POST" + operation_name = "deactivate_iam_user_sync_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/DeactivateIamUserSyncConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "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: raise ValueError( - f"delete_bds_instance got unknown kwargs: {extra_kwargs!r}") + f"deactivate_iam_user_sync_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2353,7 +2614,8 @@ def delete_bds_instance(self, bds_instance_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} @@ -2364,6 +2626,7 @@ def delete_bds_instance(self, bds_instance_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( @@ -2372,6 +2635,7 @@ def delete_bds_instance(self, bds_instance_id, **kwargs): method=method, path_params=path_params, header_params=header_params, + body=deactivate_iam_user_sync_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2382,25 +2646,36 @@ def delete_bds_instance(self, bds_instance_id, **kwargs): method=method, path_params=path_params, header_params=header_params, + body=deactivate_iam_user_sync_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, **kwargs): + def deactivate_upst_configuration(self, bds_instance_id, identity_configuration_id, deactivate_upst_configuration_details, **kwargs): """ - Delete the BDS metastore configuration represented by the provided ID. + Deactivate the UPST configuration represented by the provided ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str metastore_config_id: (required) - The metastore configuration ID + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.DeactivateUpstConfigurationDetails deactivate_upst_configuration_details: (required) + Details for deactivating the UPST config :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 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 @@ -2424,30 +2699,31 @@ def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_i :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_bds_metastore_configuration API. + Click `here `__ to see an example of how to use deactivate_upst_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'metastoreConfigId'] - resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}" - method = "DELETE" - operation_name = "delete_bds_metastore_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/DeleteBdsMetastoreConfiguration" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateUpstConfiguration" + method = "POST" + operation_name = "deactivate_upst_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/DeactivateUpstConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", + "opc_retry_token", "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_bds_metastore_configuration got unknown kwargs: {extra_kwargs!r}") + f"deactivate_upst_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "metastoreConfigId": metastore_config_id + "identityConfigurationId": identity_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2460,6 +2736,7 @@ def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_i "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2471,6 +2748,7 @@ def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_i 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( @@ -2479,6 +2757,7 @@ def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_i method=method, path_params=path_params, header_params=header_params, + body=deactivate_upst_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2489,21 +2768,22 @@ def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_i method=method, path_params=path_params, header_params=header_params, + body=deactivate_upst_configuration_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_node_backup(self, bds_instance_id, node_backup_id, **kwargs): + def delete_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): """ - Delete the NodeBackup represented by the provided ID. + Deletes the user's API key represented by the provided ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str node_backup_id: (required) - Unique assigned identifier of the nodeBackupId. + :param str api_key_id: (required) + The API key identifier. :param str opc_request_id: (optional) The client request ID for tracing. @@ -2531,14 +2811,14 @@ def delete_node_backup(self, bds_instance_id, node_backup_id, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_node_backup API. + Click `here `__ to see an example of how to use delete_bds_api_key API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'nodeBackupId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}" + required_arguments = ['bdsInstanceId', 'apiKeyId'] + resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}" method = "DELETE" - operation_name = "delete_node_backup" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/NodeBackup/DeleteNodeBackup" + operation_name = "delete_bds_api_key" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/DeleteBdsApiKey" # Don't accept unknown kwargs expected_kwargs = [ @@ -2550,11 +2830,11 @@ def delete_node_backup(self, bds_instance_id, node_backup_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_node_backup got unknown kwargs: {extra_kwargs!r}") + f"delete_bds_api_key got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "nodeBackupId": node_backup_id + "apiKeyId": api_key_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2601,17 +2881,14 @@ def delete_node_backup(self, bds_instance_id, node_backup_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def delete_node_backup_configuration(self, bds_instance_id, node_backup_configuration_id, **kwargs): + def delete_bds_instance(self, bds_instance_id, **kwargs): """ - Delete the NodeBackupConfiguration represented by the provided ID. + Deletes the cluster identified by the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str node_backup_configuration_id: (required) - Unique Oracle-assigned identifier of the NodeBackupConfiguration. - :param str opc_request_id: (optional) The client request ID for tracing. @@ -2638,14 +2915,14 @@ def delete_node_backup_configuration(self, bds_instance_id, node_backup_configur :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use delete_node_backup_configuration API. + Click `here `__ to see an example of how to use delete_bds_instance API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'nodeBackupConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}" method = "DELETE" - operation_name = "delete_node_backup_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/NodeBackupConfiguration/DeleteNodeBackupConfiguration" + operation_name = "delete_bds_instance" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/DeleteBdsInstance" # Don't accept unknown kwargs expected_kwargs = [ @@ -2657,11 +2934,10 @@ def delete_node_backup_configuration(self, bds_instance_id, node_backup_configur extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"delete_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") + f"delete_bds_instance got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id, - "nodeBackupConfigurationId": node_backup_configuration_id + "bdsInstanceId": bds_instance_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2708,16 +2984,16 @@ def delete_node_backup_configuration(self, bds_instance_id, node_backup_configur api_reference_link=api_reference_link, required_arguments=required_arguments) - def disable_certificate(self, bds_instance_id, disable_certificate_details, **kwargs): + def delete_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, **kwargs): """ - Disabling TLS/SSL for various ODH services running on the BDS cluster. + Delete the BDS metastore configuration represented by the provided ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.DisableCertificateDetails disable_certificate_details: (required) - Details for disabling certificate. + :param str metastore_config_id: (required) + The metastore configuration ID :param str opc_request_id: (optional) The client request ID for tracing. @@ -2729,13 +3005,6 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw 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. @@ -2752,30 +3021,30 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use disable_certificate API. + Click `here `__ to see an example of how to use delete_bds_metastore_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/disableOdhServiceCertificate" - method = "POST" - operation_name = "disable_certificate" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/DisableCertificate" + required_arguments = ['bdsInstanceId', 'metastoreConfigId'] + resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}" + method = "DELETE" + operation_name = "delete_bds_metastore_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/DeleteBdsMetastoreConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", - "if_match", - "opc_retry_token" + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"disable_certificate got unknown kwargs: {extra_kwargs!r}") + f"delete_bds_metastore_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "metastoreConfigId": metastore_config_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2788,8 +3057,7 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2800,7 +3068,6 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw 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( @@ -2809,7 +3076,6 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw method=method, path_params=path_params, header_params=header_params, - body=disable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2820,22 +3086,21 @@ def disable_certificate(self, bds_instance_id, disable_certificate_details, **kw method=method, path_params=path_params, header_params=header_params, - body=disable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwargs): + def delete_identity_configuration(self, bds_instance_id, identity_configuration_id, **kwargs): """ - Configuring TLS/SSL for various ODH services running on the BDS cluster. + Delete the identity configuration represented by the provided ID. Deletion is only allowed if this identity configuration is not associated with any active IAM user sync configuration or UPST configuration. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.EnableCertificateDetails enable_certificate_details: (required) - Details for configuring certificate. + :param str identity_configuration_id: (required) + The OCID of the identity configuration :param str opc_request_id: (optional) The client request ID for tracing. @@ -2847,13 +3112,6 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar 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. @@ -2870,30 +3128,30 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use enable_certificate API. + Click `here `__ to see an example of how to use delete_identity_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/enableOdhServiceCertificate" - method = "POST" - operation_name = "enable_certificate" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/EnableCertificate" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}" + method = "DELETE" + operation_name = "delete_identity_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/DeleteIdentityConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", - "if_match", - "opc_retry_token" + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"enable_certificate got unknown kwargs: {extra_kwargs!r}") + f"delete_identity_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2906,8 +3164,7 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2918,7 +3175,6 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar 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( @@ -2927,7 +3183,6 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar method=method, path_params=path_params, header_params=header_params, - body=enable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2938,22 +3193,21 @@ def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwar method=method, path_params=path_params, header_params=header_params, - body=enable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_details, **kwargs): + def delete_node_backup(self, bds_instance_id, node_backup_id, **kwargs): """ - Execute bootstrap script. + Delete the NodeBackup represented by the provided ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.ExecuteBootstrapScriptDetails execute_bootstrap_script_details: (required) - Details of the bootstrap script to execute on this cluster. + :param str node_backup_id: (required) + Unique assigned identifier of the nodeBackupId. :param str opc_request_id: (optional) The client request ID for tracing. @@ -2965,13 +3219,6 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det 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. @@ -2988,30 +3235,30 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use execute_bootstrap_script API. + Click `here `__ to see an example of how to use delete_node_backup API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/executeBootstrapScript" - method = "POST" - operation_name = "execute_bootstrap_script" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ExecuteBootstrapScript" + required_arguments = ['bdsInstanceId', 'nodeBackupId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}" + method = "DELETE" + operation_name = "delete_node_backup" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/NodeBackup/DeleteNodeBackup" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", - "if_match", - "opc_retry_token" + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"execute_bootstrap_script got unknown kwargs: {extra_kwargs!r}") + f"delete_node_backup got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "nodeBackupId": node_backup_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3024,8 +3271,7 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -3036,7 +3282,6 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): - self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -3045,7 +3290,6 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det method=method, path_params=path_params, header_params=header_params, - body=execute_bootstrap_script_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3056,25 +3300,21 @@ def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_det method=method, path_params=path_params, header_params=header_params, - body=execute_bootstrap_script_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def force_refresh_resource_principal(self, bds_instance_id, resource_principal_configuration_id, force_refresh_resource_principal_details, **kwargs): + def delete_node_backup_configuration(self, bds_instance_id, node_backup_configuration_id, **kwargs): """ - Force Refresh Resource Principal for the cluster. + Delete the NodeBackupConfiguration represented by the provided ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str resource_principal_configuration_id: (required) - Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration. - - :param oci.bds.models.ForceRefreshResourcePrincipalDetails force_refresh_resource_principal_details: (required) - Details of refreshing resource principal session token + :param str node_backup_configuration_id: (required) + Unique Oracle-assigned identifier of the NodeBackupConfiguration. :param str opc_request_id: (optional) The client request ID for tracing. @@ -3086,13 +3326,6 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c 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. @@ -3109,31 +3342,30 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use force_refresh_resource_principal API. + Click `here `__ to see an example of how to use delete_node_backup_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'resourcePrincipalConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/forceRefreshResourcePrincipal" - method = "POST" - operation_name = "force_refresh_resource_principal" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ForceRefreshResourcePrincipal" + required_arguments = ['bdsInstanceId', 'nodeBackupConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}" + method = "DELETE" + operation_name = "delete_node_backup_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/NodeBackupConfiguration/DeleteNodeBackupConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", "opc_request_id", - "if_match", - "opc_retry_token" + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"force_refresh_resource_principal got unknown kwargs: {extra_kwargs!r}") + f"delete_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "resourcePrincipalConfigurationId": resource_principal_configuration_id + "nodeBackupConfigurationId": node_backup_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3146,8 +3378,7 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -3158,7 +3389,6 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c 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( @@ -3167,7 +3397,6 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c method=method, path_params=path_params, header_params=header_params, - body=force_refresh_resource_principal_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3178,26 +3407,39 @@ def force_refresh_resource_principal(self, bds_instance_id, resource_principal_c method=method, path_params=path_params, header_params=header_params, - body=force_refresh_resource_principal_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configuration_id, **kwargs): + def disable_certificate(self, bds_instance_id, disable_certificate_details, **kwargs): """ - Returns details of the autoscale configuration identified by the given ID. + Disabling TLS/SSL for various ODH services running on the BDS cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param str auto_scaling_configuration_id: (required) - Unique Oracle-assigned identifier of the autoscale configuration. + :param oci.bds.models.DisableCertificateDetails disable_certificate_details: (required) + Details for disabling certificate. :param str opc_request_id: (optional) The client request ID for tracing. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param 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. @@ -3210,33 +3452,34 @@ def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configura allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.AutoScalingConfiguration` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_auto_scaling_configuration API. + Click `here `__ to see an example of how to use disable_certificate API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'autoScalingConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}" - method = "GET" - operation_name = "get_auto_scaling_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetAutoScalingConfiguration" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/actions/disableOdhServiceCertificate" + method = "POST" + operation_name = "disable_certificate" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/DisableCertificate" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_auto_scaling_configuration got unknown kwargs: {extra_kwargs!r}") + f"disable_certificate got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id, - "autoScalingConfigurationId": auto_scaling_configuration_id + "bdsInstanceId": bds_instance_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3248,7 +3491,9 @@ def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configura header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -3259,6 +3504,7 @@ def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configura 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( @@ -3267,7 +3513,7 @@ def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configura method=method, path_params=path_params, header_params=header_params, - response_type="AutoScalingConfiguration", + body=disable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3278,26 +3524,40 @@ def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configura method=method, path_params=path_params, header_params=header_params, - response_type="AutoScalingConfiguration", + body=disable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): + def enable_certificate(self, bds_instance_id, enable_certificate_details, **kwargs): """ - Returns the user's API key information for the given ID. + Configuring TLS/SSL for various ODH services running on the BDS cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param str api_key_id: (required) - The API key identifier. + :param oci.bds.models.EnableCertificateDetails enable_certificate_details: (required) + Details for configuring certificate. :param str opc_request_id: (optional) The client request ID for tracing. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param 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. @@ -3310,33 +3570,34 @@ def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsApiKey` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_bds_api_key API. + Click `here `__ to see an example of how to use enable_certificate API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'apiKeyId'] - resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}" - method = "GET" - operation_name = "get_bds_api_key" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/GetBdsApiKey" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/actions/enableOdhServiceCertificate" + method = "POST" + operation_name = "enable_certificate" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/EnableCertificate" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_bds_api_key got unknown kwargs: {extra_kwargs!r}") + f"enable_certificate got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id, - "apiKeyId": api_key_id + "bdsInstanceId": bds_instance_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3348,7 +3609,9 @@ def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -3359,6 +3622,7 @@ def get_bds_api_key(self, bds_instance_id, api_key_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( @@ -3367,7 +3631,7 @@ def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="BdsApiKey", + body=enable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3378,23 +3642,40 @@ def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="BdsApiKey", + body=enable_certificate_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_bds_instance(self, bds_instance_id, **kwargs): + def execute_bootstrap_script(self, bds_instance_id, execute_bootstrap_script_details, **kwargs): """ - Returns information about the Big Data Service cluster identified by the given ID. + Execute bootstrap script. :param str bds_instance_id: (required) The OCID of the cluster. + :param oci.bds.models.ExecuteBootstrapScriptDetails execute_bootstrap_script_details: (required) + Details of the bootstrap script to execute on this cluster. + :param str opc_request_id: (optional) The client request ID for tracing. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param 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. @@ -3407,29 +3688,31 @@ def get_bds_instance(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsInstance` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_bds_instance API. + Click `here `__ to see an example of how to use execute_bootstrap_script API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}" - method = "GET" - operation_name = "get_bds_instance" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetBdsInstance" + resource_path = "/bdsInstances/{bdsInstanceId}/actions/executeBootstrapScript" + method = "POST" + operation_name = "execute_bootstrap_script" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ExecuteBootstrapScript" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_bds_instance got unknown kwargs: {extra_kwargs!r}") + f"execute_bootstrap_script got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -3444,7 +3727,9 @@ def get_bds_instance(self, bds_instance_id, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -3455,6 +3740,7 @@ def get_bds_instance(self, bds_instance_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( @@ -3463,7 +3749,7 @@ def get_bds_instance(self, bds_instance_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="BdsInstance", + body=execute_bootstrap_script_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3474,26 +3760,43 @@ def get_bds_instance(self, bds_instance_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="BdsInstance", + body=execute_bootstrap_script_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, **kwargs): + def force_refresh_resource_principal(self, bds_instance_id, resource_principal_configuration_id, force_refresh_resource_principal_details, **kwargs): """ - Returns the BDS Metastore configuration information for the given ID. + Force Refresh Resource Principal for the cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param str metastore_config_id: (required) - The metastore configuration ID + :param str resource_principal_configuration_id: (required) + Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration. + + :param oci.bds.models.ForceRefreshResourcePrincipalDetails force_refresh_resource_principal_details: (required) + Details of refreshing resource principal session token :param str opc_request_id: (optional) The client request ID for tracing. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param 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. @@ -3506,33 +3809,35 @@ def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsMetastoreConfiguration` + :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_bds_metastore_configuration API. + Click `here `__ to see an example of how to use force_refresh_resource_principal API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'metastoreConfigId'] - resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}" - method = "GET" - operation_name = "get_bds_metastore_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/GetBdsMetastoreConfiguration" + required_arguments = ['bdsInstanceId', 'resourcePrincipalConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/forceRefreshResourcePrincipal" + method = "POST" + operation_name = "force_refresh_resource_principal" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ForceRefreshResourcePrincipal" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_bds_metastore_configuration got unknown kwargs: {extra_kwargs!r}") + f"force_refresh_resource_principal got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "metastoreConfigId": metastore_config_id + "resourcePrincipalConfigurationId": resource_principal_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3544,7 +3849,9 @@ def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -3555,6 +3862,7 @@ def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -3563,7 +3871,7 @@ def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, method=method, path_params=path_params, header_params=header_params, - response_type="BdsMetastoreConfiguration", + body=force_refresh_resource_principal_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3574,22 +3882,22 @@ def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, method=method, path_params=path_params, header_params=header_params, - response_type="BdsMetastoreConfiguration", + body=force_refresh_resource_principal_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): + def get_auto_scaling_configuration(self, bds_instance_id, auto_scaling_configuration_id, **kwargs): """ - Returns details of NodeBackup identified by the given ID. + Returns details of the autoscale configuration identified by the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str node_backup_id: (required) - Unique assigned identifier of the nodeBackupId. + :param str auto_scaling_configuration_id: (required) + Unique Oracle-assigned identifier of the autoscale configuration. :param str opc_request_id: (optional) The client request ID for tracing. @@ -3606,18 +3914,18 @@ def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeBackup` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.AutoScalingConfiguration` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_node_backup API. + Click `here `__ to see an example of how to use get_auto_scaling_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'nodeBackupId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}" + required_arguments = ['bdsInstanceId', 'autoScalingConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}" method = "GET" - operation_name = "get_node_backup" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeBackup" + operation_name = "get_auto_scaling_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetAutoScalingConfiguration" # Don't accept unknown kwargs expected_kwargs = [ @@ -3628,11 +3936,11 @@ def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_node_backup got unknown kwargs: {extra_kwargs!r}") + f"get_auto_scaling_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "nodeBackupId": node_backup_id + "autoScalingConfigurationId": auto_scaling_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3663,7 +3971,7 @@ def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="NodeBackup", + response_type="AutoScalingConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3674,22 +3982,22 @@ def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="NodeBackup", + response_type="AutoScalingConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_node_backup_configuration(self, bds_instance_id, node_backup_configuration_id, **kwargs): + def get_bds_api_key(self, bds_instance_id, api_key_id, **kwargs): """ - Returns details of the NodeBackupConfiguration identified by the given ID. + Returns the user's API key information for the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str node_backup_configuration_id: (required) - Unique Oracle-assigned identifier of the NodeBackupConfiguration. + :param str api_key_id: (required) + The API key identifier. :param str opc_request_id: (optional) The client request ID for tracing. @@ -3706,18 +4014,18 @@ def get_node_backup_configuration(self, bds_instance_id, node_backup_configurati allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeBackupConfiguration` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsApiKey` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_node_backup_configuration API. + Click `here `__ to see an example of how to use get_bds_api_key API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'nodeBackupConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}" + required_arguments = ['bdsInstanceId', 'apiKeyId'] + resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}" method = "GET" - operation_name = "get_node_backup_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeBackupConfiguration" + operation_name = "get_bds_api_key" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/GetBdsApiKey" # Don't accept unknown kwargs expected_kwargs = [ @@ -3728,11 +4036,11 @@ def get_node_backup_configuration(self, bds_instance_id, node_backup_configurati extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") + f"get_bds_api_key got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "nodeBackupConfigurationId": node_backup_configuration_id + "apiKeyId": api_key_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3763,7 +4071,7 @@ def get_node_backup_configuration(self, bds_instance_id, node_backup_configurati method=method, path_params=path_params, header_params=header_params, - response_type="NodeBackupConfiguration", + response_type="BdsApiKey", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3774,23 +4082,20 @@ def get_node_backup_configuration(self, bds_instance_id, node_backup_configurati method=method, path_params=path_params, header_params=header_params, - response_type="NodeBackupConfiguration", + response_type="BdsApiKey", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_node_replace_configuration(self, bds_instance_id, node_replace_configuration_id, **kwargs): + def get_bds_instance(self, bds_instance_id, **kwargs): """ - Returns details of the nodeReplaceConfiguration identified by the given ID. + Returns information about the Big Data Service cluster identified by the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str node_replace_configuration_id: (required) - Unique Oracle-assigned identifier of the NodeReplaceConfiguration. - :param str opc_request_id: (optional) The client request ID for tracing. @@ -3806,18 +4111,18 @@ def get_node_replace_configuration(self, bds_instance_id, node_replace_configura allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeReplaceConfiguration` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsInstance` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_node_replace_configuration API. + Click `here `__ to see an example of how to use get_bds_instance API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'nodeReplaceConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}" method = "GET" - operation_name = "get_node_replace_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeReplaceConfiguration" + operation_name = "get_bds_instance" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetBdsInstance" # Don't accept unknown kwargs expected_kwargs = [ @@ -3828,11 +4133,10 @@ def get_node_replace_configuration(self, bds_instance_id, node_replace_configura extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_node_replace_configuration got unknown kwargs: {extra_kwargs!r}") + f"get_bds_instance got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id, - "nodeReplaceConfigurationId": node_replace_configuration_id + "bdsInstanceId": bds_instance_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3863,7 +4167,7 @@ def get_node_replace_configuration(self, bds_instance_id, node_replace_configura method=method, path_params=path_params, header_params=header_params, - response_type="NodeReplaceConfiguration", + response_type="BdsInstance", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3874,40 +4178,26 @@ def get_node_replace_configuration(self, bds_instance_id, node_replace_configura method=method, path_params=path_params, header_params=header_params, - response_type="NodeReplaceConfiguration", + response_type="BdsInstance", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): + def get_bds_metastore_configuration(self, bds_instance_id, metastore_config_id, **kwargs): """ - Get the details of an os patch + Returns the BDS Metastore configuration information for the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param str os_patch_version: (required) - The version of the OS patch. + :param str metastore_config_id: (required) + The metastore configuration ID :param str opc_request_id: (optional) The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. - - :param 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. @@ -3920,34 +4210,33 @@ def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.OsPatchDetails` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.BdsMetastoreConfiguration` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_os_patch_details API. + Click `here `__ to see an example of how to use get_bds_metastore_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'osPatchVersion'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/getOsPatch" - method = "POST" - operation_name = "get_os_patch_details" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetOsPatchDetails" + required_arguments = ['bdsInstanceId', 'metastoreConfigId'] + resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}" + method = "GET" + operation_name = "get_bds_metastore_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/GetBdsMetastoreConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "if_match", - "opc_retry_token" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_os_patch_details got unknown kwargs: {extra_kwargs!r}") + f"get_bds_metastore_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "metastoreConfigId": metastore_config_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3956,17 +4245,10 @@ def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - query_params = { - "osPatchVersion": os_patch_version - } - 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), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -3977,7 +4259,6 @@ def get_os_patch_details(self, bds_instance_id, os_patch_version, **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( @@ -3985,9 +4266,8 @@ def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="OsPatchDetails", + response_type="BdsMetastoreConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -3997,24 +4277,39 @@ def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="OsPatchDetails", + response_type="BdsMetastoreConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_resource_principal_configuration(self, bds_instance_id, resource_principal_configuration_id, **kwargs): + def get_identity_configuration(self, bds_instance_id, identity_configuration_id, **kwargs): """ - Returns details of the resourcePrincipalConfiguration identified by the given ID. + Get details of one identity config on the cluster :param str bds_instance_id: (required) The OCID of the cluster. - :param str resource_principal_configuration_id: (required) - Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration. + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" :param str opc_request_id: (optional) The client request ID for tracing. @@ -4031,33 +4326,37 @@ def get_resource_principal_configuration(self, bds_instance_id, resource_princip allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.ResourcePrincipalConfiguration` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.IdentityConfiguration` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_resource_principal_configuration API. + Click `here `__ to see an example of how to use get_identity_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'resourcePrincipalConfigurationId'] - resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}" method = "GET" - operation_name = "get_resource_principal_configuration" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetResourcePrincipalConfiguration" + operation_name = "get_identity_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/GetIdentityConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "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( - f"get_resource_principal_configuration got unknown kwargs: {extra_kwargs!r}") + f"get_identity_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id, - "resourcePrincipalConfigurationId": resource_principal_configuration_id + "identityConfigurationId": identity_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4066,6 +4365,28 @@ def get_resource_principal_configuration(self, bds_instance_id, resource_princip if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + header_params = { "accept": "application/json", "content-type": "application/json", @@ -4087,8 +4408,9 @@ def get_resource_principal_configuration(self, bds_instance_id, resource_princip resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - response_type="ResourcePrincipalConfiguration", + response_type="IdentityConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4098,20 +4420,24 @@ def get_resource_principal_configuration(self, bds_instance_id, resource_princip resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - response_type="ResourcePrincipalConfiguration", + response_type="IdentityConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_work_request(self, work_request_id, **kwargs): + def get_node_backup(self, bds_instance_id, node_backup_id, **kwargs): """ - Returns the status of the work request identified by the given ID. + Returns details of NodeBackup identified by the given ID. - :param str work_request_id: (required) - The ID of the asynchronous request. + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str node_backup_id: (required) + Unique assigned identifier of the nodeBackupId. :param str opc_request_id: (optional) The client request ID for tracing. @@ -4128,18 +4454,18 @@ def get_work_request(self, work_request_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.WorkRequest` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeBackup` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_work_request API. + Click `here `__ to see an example of how to use get_node_backup API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['workRequestId'] - resource_path = "/workRequests/{workRequestId}" + required_arguments = ['bdsInstanceId', 'nodeBackupId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}" method = "GET" - operation_name = "get_work_request" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequest/GetWorkRequest" + operation_name = "get_node_backup" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeBackup" # Don't accept unknown kwargs expected_kwargs = [ @@ -4150,10 +4476,11 @@ def get_work_request(self, work_request_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"get_work_request got unknown kwargs: {extra_kwargs!r}") + f"get_node_backup got unknown kwargs: {extra_kwargs!r}") path_params = { - "workRequestId": work_request_id + "bdsInstanceId": bds_instance_id, + "nodeBackupId": node_backup_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4184,7 +4511,7 @@ def get_work_request(self, work_request_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="WorkRequest", + response_type="NodeBackup", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4195,39 +4522,125 @@ def get_work_request(self, work_request_id, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="WorkRequest", + response_type="NodeBackup", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): + def get_node_backup_configuration(self, bds_instance_id, node_backup_configuration_id, **kwargs): """ - Install an os patch on a cluster + Returns details of the NodeBackupConfiguration identified by the given ID. :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.InstallOsPatchDetails install_os_patch_details: (required) - Details of the target os patch that will be installed + :param str node_backup_configuration_id: (required) + Unique Oracle-assigned identifier of the NodeBackupConfiguration. :param str opc_request_id: (optional) The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - :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. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeBackupConfiguration` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_node_backup_configuration API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId', 'nodeBackupConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}" + method = "GET" + operation_name = "get_node_backup_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeBackupConfiguration" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"get_node_backup_configuration got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id, + "nodeBackupConfigurationId": node_backup_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="NodeBackupConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="NodeBackupConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_node_replace_configuration(self, bds_instance_id, node_replace_configuration_id, **kwargs): + """ + Returns details of the nodeReplaceConfiguration identified by the given ID. + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str node_replace_configuration_id: (required) + Unique Oracle-assigned identifier of the NodeReplaceConfiguration. + + :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. @@ -4241,34 +4654,33 @@ def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.NodeReplaceConfiguration` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use install_os_patch API. + Click `here `__ to see an example of how to use get_node_replace_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/installOsPatch" - method = "POST" - operation_name = "install_os_patch" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/InstallOsPatch" + required_arguments = ['bdsInstanceId', 'nodeReplaceConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}" + method = "GET" + operation_name = "get_node_replace_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetNodeReplaceConfiguration" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "if_match", - "opc_retry_token" + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"install_os_patch got unknown kwargs: {extra_kwargs!r}") + f"get_node_replace_configuration got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "bdsInstanceId": bds_instance_id, + "nodeReplaceConfigurationId": node_replace_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -4280,9 +4692,7 @@ def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -4293,7 +4703,6 @@ def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): - self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -4302,7 +4711,7 @@ def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=install_os_patch_details, + response_type="NodeReplaceConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4313,22 +4722,22 @@ def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): method=method, path_params=path_params, header_params=header_params, - body=install_os_patch_details, + response_type="NodeReplaceConfiguration", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def install_patch(self, bds_instance_id, install_patch_details, **kwargs): + def get_os_patch_details(self, bds_instance_id, os_patch_version, **kwargs): """ - Install the specified patch to this cluster. + Get the details of an os patch :param str bds_instance_id: (required) The OCID of the cluster. - :param oci.bds.models.InstallPatchDetails install_patch_details: (required) - Details of the patch to be installed. + :param str os_patch_version: (required) + The version of the OS patch. :param str opc_request_id: (optional) The client request ID for tracing. @@ -4359,18 +4768,18 @@ def install_patch(self, bds_instance_id, install_patch_details, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.OsPatchDetails` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use install_patch API. + Click `here `__ to see an example of how to use get_os_patch_details API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/installPatch" + required_arguments = ['bdsInstanceId', 'osPatchVersion'] + resource_path = "/bdsInstances/{bdsInstanceId}/actions/getOsPatch" method = "POST" - operation_name = "install_patch" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/InstallPatch" + operation_name = "get_os_patch_details" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetOsPatchDetails" # Don't accept unknown kwargs expected_kwargs = [ @@ -4383,7 +4792,7 @@ def install_patch(self, bds_instance_id, install_patch_details, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"install_patch got unknown kwargs: {extra_kwargs!r}") + f"get_os_patch_details got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -4395,6 +4804,11 @@ def install_patch(self, bds_instance_id, install_patch_details, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + query_params = { + "osPatchVersion": os_patch_version + } + 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", @@ -4419,8 +4833,9 @@ def install_patch(self, bds_instance_id, install_patch_details, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=install_patch_details, + response_type="OsPatchDetails", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4430,47 +4845,24 @@ def install_patch(self, bds_instance_id, install_patch_details, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=install_patch_details, + response_type="OsPatchDetails", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kwargs): + def get_resource_principal_configuration(self, bds_instance_id, resource_principal_configuration_id, **kwargs): """ - Returns information about the autoscaling configurations for a cluster. - + Returns details of the resourcePrincipalConfiguration identified by the given ID. - :param str compartment_id: (required) - The OCID of the compartment. :param str bds_instance_id: (required) The OCID of the cluster. - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - - :param int limit: (optional) - The maximum number of items to return. - - :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. - - Allowed values are: "timeCreated", "displayName" - - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. - - Allowed values are: "ASC", "DESC" - - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. - - :param str lifecycle_state: (optional) - The state of the autoscale configuration. - - Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + :param str resource_principal_configuration_id: (required) + Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration. :param str opc_request_id: (optional) The client request ID for tracing. @@ -4487,35 +4879,1102 @@ def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kw allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.AutoScalingConfigurationSummary` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.ResourcePrincipalConfiguration` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_auto_scaling_configurations API. + Click `here `__ to see an example of how to use get_resource_principal_configuration API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId', 'compartmentId'] - resource_path = "/bdsInstances/{bdsInstanceId}/autoScalingConfiguration" + required_arguments = ['bdsInstanceId', 'resourcePrincipalConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}" method = "GET" - operation_name = "list_auto_scaling_configurations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListAutoScalingConfigurations" + operation_name = "get_resource_principal_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/GetResourcePrincipalConfiguration" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"get_resource_principal_configuration got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id, + "resourcePrincipalConfigurationId": resource_principal_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ResourcePrincipalConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ResourcePrincipalConfiguration", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_work_request(self, work_request_id, **kwargs): + """ + Returns the status of the work request identified by the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.bds.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['workRequestId'] + resource_path = "/workRequests/{workRequestId}" + method = "GET" + operation_name = "get_work_request" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequest/GetWorkRequest" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"get_work_request got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def install_os_patch(self, bds_instance_id, install_os_patch_details, **kwargs): + """ + Install an os patch on a cluster + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param oci.bds.models.InstallOsPatchDetails install_os_patch_details: (required) + Details of the target os patch that will be installed + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use install_os_patch API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/actions/installOsPatch" + method = "POST" + operation_name = "install_os_patch" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/InstallOsPatch" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"install_os_patch got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=install_os_patch_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=install_os_patch_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def install_patch(self, bds_instance_id, install_patch_details, **kwargs): + """ + Install the specified patch to this cluster. + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param oci.bds.models.InstallPatchDetails install_patch_details: (required) + Details of the patch to be installed. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use install_patch API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/actions/installPatch" + method = "POST" + operation_name = "install_patch" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/InstallPatch" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"install_patch got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=install_patch_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=install_patch_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kwargs): + """ + Returns information about the autoscaling configurations for a cluster. + + + :param str compartment_id: (required) + The OCID of the compartment. + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + The state of the autoscale configuration. + + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.AutoScalingConfigurationSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_auto_scaling_configurations API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId', 'compartmentId'] + resource_path = "/bdsInstances/{bdsInstanceId}/autoScalingConfiguration" + method = "GET" + operation_name = "list_auto_scaling_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListAutoScalingConfigurations" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "page", + "limit", + "sort_by", + "sort_order", + "display_name", + "lifecycle_state", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_auto_scaling_configurations got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + + query_params = { + "compartmentId": compartment_id, + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", 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="list[AutoScalingConfigurationSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[AutoScalingConfigurationSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_bds_api_keys(self, bds_instance_id, **kwargs): + """ + Returns a list of all API keys associated with this Big Data Service cluster. + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str lifecycle_state: (optional) + The state of the API key. + + Allowed values are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" + + :param str user_id: (optional) + The OCID of the user for whom the API key belongs. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsApiKeySummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_bds_api_keys API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys" + method = "GET" + operation_name = "list_bds_api_keys" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/ListBdsApiKeys" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "lifecycle_state", + "user_id", + "page", + "limit", + "sort_by", + "sort_order", + "display_name", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_bds_api_keys got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "lifecycleState": kwargs.get("lifecycle_state", missing), + "userId": kwargs.get("user_id", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "displayName": kwargs.get("display_name", 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="list[BdsApiKeySummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[BdsApiKeySummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_bds_cluster_versions(self, **kwargs): + """ + Returns a list of cluster versions with associated odh and bds versions. + + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. If no value is specified bdsVersion is default. + + Allowed values are: "bdsVersion" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsClusterVersionSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_bds_cluster_versions API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/bdsClusterVersions" + method = "GET" + operation_name = "list_bds_cluster_versions" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsClusterVersionSummary/ListBdsClusterVersions" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "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( + f"list_bds_cluster_versions got unknown kwargs: {extra_kwargs!r}") + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["bdsVersion"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[BdsClusterVersionSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[BdsClusterVersionSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_bds_instances(self, compartment_id, **kwargs): + """ + Returns a list of all Big Data Service clusters in a compartment. + + + :param str compartment_id: (required) + The OCID of the compartment. + + :param str lifecycle_state: (optional) + The state of the cluster. + + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "SUSPENDING", "SUSPENDED", "RESUMING", "DELETING", "DELETED", "FAILED", "INACTIVE" + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsInstanceSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_bds_instances API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['compartmentId'] + resource_path = "/bdsInstances" + method = "GET" + operation_name = "list_bds_instances" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstanceSummary/ListBdsInstances" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "lifecycle_state", + "page", + "limit", + "sort_by", + "sort_order", + "display_name", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_bds_instances got unknown kwargs: {extra_kwargs!r}") + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "SUSPENDING", "SUSPENDED", "RESUMING", "DELETING", "DELETED", "FAILED", "INACTIVE"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "compartmentId": compartment_id, + "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), + "displayName": kwargs.get("display_name", 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="list[BdsInstanceSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[BdsInstanceSummary]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): + """ + Returns a list of metastore configurations ssociated with this Big Data Service cluster. + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str metastore_type: (optional) + The type of the metastore in the metastore configuration + + Allowed values are: "LOCAL", "EXTERNAL" + + :param str metastore_id: (optional) + The OCID of the Data Catalog metastore in the metastore configuration + + :param str lifecycle_state: (optional) + The lifecycle state of the metastore in the metastore configuration + + Allowed values are: "CREATING", "ACTIVATING", "ACTIVE", "INACTIVE", "UPDATING", "FAILED", "DELETING", "DELETED" + + :param str bds_api_key_id: (optional) + The ID of the API key that is associated with the external metastore in the metastore configuration + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsMetastoreConfigurationSummary` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_bds_metastore_configurations API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs" + method = "GET" + operation_name = "list_bds_metastore_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/ListBdsMetastoreConfigurations" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "metastore_type", + "metastore_id", + "lifecycle_state", + "bds_api_key_id", "page", "limit", "sort_by", "sort_order", "display_name", - "lifecycle_state", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_auto_scaling_configurations got unknown kwargs: {extra_kwargs!r}") + f"list_bds_metastore_configurations got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -4527,6 +5986,20 @@ def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kw if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'metastore_type' in kwargs: + metastore_type_allowed_values = ["LOCAL", "EXTERNAL"] + if kwargs['metastore_type'] not in metastore_type_allowed_values: + raise ValueError( + f"Invalid value for `metastore_type`, must be one of { metastore_type_allowed_values }" + ) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVATING", "ACTIVE", "INACTIVE", "UPDATING", "FAILED", "DELETING", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -4541,21 +6014,16 @@ def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kw f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - query_params = { - "compartmentId": compartment_id, + "metastoreType": kwargs.get("metastore_type", missing), + "metastoreId": kwargs.get("metastore_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "bdsApiKeyId": kwargs.get("bds_api_key_id", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing) + "displayName": kwargs.get("display_name", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4582,7 +6050,7 @@ def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kw path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[AutoScalingConfigurationSummary]", + response_type="list[BdsMetastoreConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4594,27 +6062,22 @@ def list_auto_scaling_configurations(self, compartment_id, bds_instance_id, **kw path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[AutoScalingConfigurationSummary]", + response_type="list[BdsMetastoreConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_bds_api_keys(self, bds_instance_id, **kwargs): + def list_identity_configurations(self, bds_instance_id, compartment_id, **kwargs): """ - Returns a list of all API keys associated with this Big Data Service cluster. + Returns a list of all identity configurations associated with this Big Data Service cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param str lifecycle_state: (optional) - The state of the API key. - - Allowed values are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" - - :param str user_id: (optional) - The OCID of the user for whom the API key belongs. + :param str compartment_id: (required) + The OCID of the compartment. :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. @@ -4632,12 +6095,17 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. - :param str opc_request_id: (optional) The client request ID for tracing. + :param str lifecycle_state: (optional) + The state of the identity config + + Allowed values are: "ACTIVE", "DELETED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -4650,36 +6118,35 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsApiKeySummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.IdentityConfigurationSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_bds_api_keys API. + Click `here `__ to see an example of how to use list_identity_configurations API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/apiKeys" + required_arguments = ['bdsInstanceId', 'compartmentId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations" method = "GET" - operation_name = "list_bds_api_keys" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsApiKey/ListBdsApiKeys" + operation_name = "list_identity_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/ListIdentityConfigurations" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "lifecycle_state", - "user_id", "page", "limit", "sort_by", "sort_order", - "display_name", - "opc_request_id" + "opc_request_id", + "lifecycle_state", + "display_name" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_bds_api_keys got unknown kwargs: {extra_kwargs!r}") + f"list_identity_configurations got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -4691,13 +6158,6 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -4712,13 +6172,20 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACTIVE", "DELETED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + query_params = { - "lifecycleState": kwargs.get("lifecycle_state", missing), - "userId": kwargs.get("user_id", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), + "compartmentId": compartment_id, "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), "displayName": kwargs.get("display_name", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4746,7 +6213,7 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[BdsApiKeySummary]", + response_type="list[IdentityConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4758,24 +6225,19 @@ def list_bds_api_keys(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[BdsApiKeySummary]", + response_type="list[IdentityConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_bds_instances(self, compartment_id, **kwargs): + def list_node_backup_configurations(self, bds_instance_id, **kwargs): """ - Returns a list of all Big Data Service clusters in a compartment. - - - :param str compartment_id: (required) - The OCID of the compartment. + Returns information about the NodeBackupConfigurations. - :param str lifecycle_state: (optional) - The state of the cluster. - Allowed values are: "CREATING", "ACTIVE", "UPDATING", "SUSPENDING", "SUSPENDED", "RESUMING", "DELETING", "DELETED", "FAILED", "INACTIVE" + :param str bds_instance_id: (required) + The OCID of the cluster. :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. @@ -4796,6 +6258,11 @@ def list_bds_instances(self, compartment_id, **kwargs): :param str display_name: (optional) A filter to return only resources that match the entire display name given. + :param str lifecycle_state: (optional) + The state of the NodeBackupConfiguration configuration. + + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + :param str opc_request_id: (optional) The client request ID for tracing. @@ -4811,42 +6278,45 @@ def list_bds_instances(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsInstanceSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeBackupConfigurationSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_bds_instances API. + Click `here `__ to see an example of how to use list_node_backup_configurations API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['compartmentId'] - resource_path = "/bdsInstances" + required_arguments = ['bdsInstanceId'] + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations" method = "GET" - operation_name = "list_bds_instances" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstanceSummary/ListBdsInstances" + operation_name = "list_node_backup_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeBackupConfigurations" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "lifecycle_state", "page", "limit", "sort_by", "sort_order", "display_name", + "lifecycle_state", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_bds_instances got unknown kwargs: {extra_kwargs!r}") + f"list_node_backup_configurations got unknown kwargs: {extra_kwargs!r}") - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "SUSPENDING", "SUSPENDED", "RESUMING", "DELETING", "DELETED", "FAILED", "INACTIVE"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) + path_params = { + "bdsInstanceId": bds_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] @@ -4862,14 +6332,20 @@ def list_bds_instances(self, compartment_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + query_params = { - "compartmentId": compartment_id, - "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), - "displayName": kwargs.get("display_name", missing) + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -4893,9 +6369,10 @@ def list_bds_instances(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="list[BdsInstanceSummary]", + response_type="list[NodeBackupConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -4904,38 +6381,23 @@ def list_bds_instances(self, compartment_id, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[BdsInstanceSummary]", + response_type="list[NodeBackupConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): + def list_node_backups(self, bds_instance_id, **kwargs): """ - Returns a list of metastore configurations ssociated with this Big Data Service cluster. + Returns information about the node Backups. :param str bds_instance_id: (required) The OCID of the cluster. - :param str metastore_type: (optional) - The type of the metastore in the metastore configuration - - Allowed values are: "LOCAL", "EXTERNAL" - - :param str metastore_id: (optional) - The OCID of the Data Catalog metastore in the metastore configuration - - :param str lifecycle_state: (optional) - The lifecycle state of the metastore in the metastore configuration - - Allowed values are: "CREATING", "ACTIVATING", "ACTIVE", "INACTIVE", "UPDATING", "FAILED", "DELETING", "DELETED" - - :param str bds_api_key_id: (optional) - The ID of the API key that is associated with the external metastore in the metastore configuration - :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. @@ -4952,12 +6414,20 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. + :param str node_host_name: (optional) + The node host name belonged to a node that has a node backup. + + :param str lifecycle_state: (optional) + The state of the Node's Backup. + + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PARTIAL" :param str opc_request_id: (optional) The client request ID for tracing. + :param str display_name: (optional) + The display name belonged to the node backup. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -4970,38 +6440,36 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.BdsMetastoreConfigurationSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeBackupSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_bds_metastore_configurations API. + Click `here `__ to see an example of how to use list_node_backups API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/metastoreConfigs" + resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups" method = "GET" - operation_name = "list_bds_metastore_configurations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsMetastoreConfiguration/ListBdsMetastoreConfigurations" + operation_name = "list_node_backups" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeBackups" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "metastore_type", - "metastore_id", - "lifecycle_state", - "bds_api_key_id", "page", "limit", "sort_by", "sort_order", - "display_name", - "opc_request_id" + "node_host_name", + "lifecycle_state", + "opc_request_id", + "display_name" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_bds_metastore_configurations got unknown kwargs: {extra_kwargs!r}") + f"list_node_backups got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5013,20 +6481,6 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - if 'metastore_type' in kwargs: - metastore_type_allowed_values = ["LOCAL", "EXTERNAL"] - if kwargs['metastore_type'] not in metastore_type_allowed_values: - raise ValueError( - f"Invalid value for `metastore_type`, must be one of { metastore_type_allowed_values }" - ) - - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVATING", "ACTIVE", "INACTIVE", "UPDATING", "FAILED", "DELETING", "DELETED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -5041,15 +6495,20 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PARTIAL"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + query_params = { - "metastoreType": kwargs.get("metastore_type", missing), - "metastoreId": kwargs.get("metastore_id", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "bdsApiKeyId": kwargs.get("bds_api_key_id", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), + "nodeHostName": kwargs.get("node_host_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), "displayName": kwargs.get("display_name", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5077,7 +6536,7 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[BdsMetastoreConfigurationSummary]", + response_type="list[NodeBackupSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5089,15 +6548,15 @@ def list_bds_metastore_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[BdsMetastoreConfigurationSummary]", + response_type="list[NodeBackupSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_node_backup_configurations(self, bds_instance_id, **kwargs): + def list_node_replace_configurations(self, bds_instance_id, **kwargs): """ - Returns information about the NodeBackupConfigurations. + Returns information about the NodeReplaceConfiguration. :param str bds_instance_id: (required) @@ -5123,7 +6582,7 @@ def list_node_backup_configurations(self, bds_instance_id, **kwargs): A filter to return only resources that match the entire display name given. :param str lifecycle_state: (optional) - The state of the NodeBackupConfiguration configuration. + The state of the NodeReplaceConfiguration. Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" @@ -5142,18 +6601,18 @@ def list_node_backup_configurations(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeBackupConfigurationSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeReplaceConfigurationSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_node_backup_configurations API. + Click `here `__ to see an example of how to use list_node_replace_configurations API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations" + resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations" method = "GET" - operation_name = "list_node_backup_configurations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeBackupConfigurations" + operation_name = "list_node_replace_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeReplaceConfigurations" # Don't accept unknown kwargs expected_kwargs = [ @@ -5170,7 +6629,7 @@ def list_node_backup_configurations(self, bds_instance_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_node_backup_configurations got unknown kwargs: {extra_kwargs!r}") + f"list_node_replace_configurations got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5236,7 +6695,7 @@ def list_node_backup_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeBackupConfigurationSummary]", + response_type="list[NodeReplaceConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5248,15 +6707,15 @@ def list_node_backup_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeBackupConfigurationSummary]", + response_type="list[NodeReplaceConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_node_backups(self, bds_instance_id, **kwargs): + def list_os_patches(self, bds_instance_id, **kwargs): """ - Returns information about the node Backups. + List all available os patches for a given cluster :param str bds_instance_id: (required) @@ -5278,19 +6737,22 @@ def list_node_backups(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str node_host_name: (optional) - The node host name belonged to a node that has a node backup. - - :param str lifecycle_state: (optional) - The state of the Node's Backup. - - Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PARTIAL" - :param str opc_request_id: (optional) The client request ID for tracing. - :param str display_name: (optional) - The display name belonged to the node backup. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -5304,18 +6766,18 @@ def list_node_backups(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeBackupSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.OsPatchSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_node_backups API. + Click `here `__ to see an example of how to use list_os_patches API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeBackups" - method = "GET" - operation_name = "list_node_backups" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeBackups" + resource_path = "/bdsInstances/{bdsInstanceId}/actions/listOsPatches" + method = "POST" + operation_name = "list_os_patches" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListOsPatches" # Don't accept unknown kwargs expected_kwargs = [ @@ -5325,15 +6787,14 @@ def list_node_backups(self, bds_instance_id, **kwargs): "limit", "sort_by", "sort_order", - "node_host_name", - "lifecycle_state", "opc_request_id", - "display_name" + "if_match", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_node_backups got unknown kwargs: {extra_kwargs!r}") + f"list_os_patches got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5359,28 +6820,20 @@ def list_node_backups(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PARTIAL"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - query_params = { "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), - "nodeHostName": kwargs.get("node_host_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "displayName": kwargs.get("display_name", missing) + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -5391,6 +6844,7 @@ def list_node_backups(self, bds_instance_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( @@ -5400,7 +6854,7 @@ def list_node_backups(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeBackupSummary]", + response_type="list[OsPatchSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5412,25 +6866,30 @@ def list_node_backups(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeBackupSummary]", + response_type="list[OsPatchSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_node_replace_configurations(self, bds_instance_id, **kwargs): + def list_patch_histories(self, bds_instance_id, **kwargs): """ - Returns information about the NodeReplaceConfiguration. + List the patch history of this cluster. :param str bds_instance_id: (required) The OCID of the cluster. - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + :param str opc_request_id: (optional) + The client request ID for tracing. - :param int limit: (optional) - The maximum number of items to return. + :param str lifecycle_state: (optional) + The status of the patch. + + Allowed values are: "INSTALLING", "INSTALLED", "FAILED" + + :param str patch_version: (optional) + The version of the patch :param str sort_by: (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. @@ -5442,16 +6901,16 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param str lifecycle_state: (optional) - The state of the NodeReplaceConfiguration. + :param int limit: (optional) + The maximum number of items to return. - Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + :param str patch_type: (optional) + The type of a BDS patch history entity. - :param str opc_request_id: (optional) - The client request ID for tracing. + Allowed values are: "ODH", "OS" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -5465,35 +6924,36 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.NodeReplaceConfigurationSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.PatchHistorySummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_node_replace_configurations API. + Click `here `__ to see an example of how to use list_patch_histories API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations" + resource_path = "/bdsInstances/{bdsInstanceId}/patchHistory" method = "GET" - operation_name = "list_node_replace_configurations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListNodeReplaceConfigurations" + operation_name = "list_patch_histories" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListPatchHistories" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "page", - "limit", + "opc_request_id", + "lifecycle_state", + "patch_version", "sort_by", "sort_order", - "display_name", - "lifecycle_state", - "opc_request_id" + "page", + "limit", + "patch_type" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_node_replace_configurations got unknown kwargs: {extra_kwargs!r}") + f"list_patch_histories got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5505,6 +6965,13 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["INSTALLING", "INSTALLED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -5519,20 +6986,21 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + if 'patch_type' in kwargs: + patch_type_allowed_values = ["ODH", "OS"] + if kwargs['patch_type'] not in patch_type_allowed_values: raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + f"Invalid value for `patch_type`, must be one of { patch_type_allowed_values }" ) query_params = { - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "patchVersion": kwargs.get("patch_version", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing) + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "patchType": kwargs.get("patch_type", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5559,7 +7027,7 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeReplaceConfigurationSummary]", + response_type="list[PatchHistorySummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5571,53 +7039,29 @@ def list_node_replace_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[NodeReplaceConfigurationSummary]", + response_type="list[PatchHistorySummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_os_patches(self, bds_instance_id, **kwargs): + def list_patches(self, bds_instance_id, **kwargs): """ - List all available os patches for a given cluster + List all the available patches for this cluster. :param str bds_instance_id: (required) The OCID of the cluster. + :param str opc_request_id: (optional) + The client request ID for tracing. + :param str page: (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. :param int limit: (optional) The maximum number of items to return. - :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. - - Allowed values are: "timeCreated", "displayName" - - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. - - Allowed values are: "ASC", "DESC" - - :param str opc_request_id: (optional) - The client request ID for tracing. - - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call - for a resource, set the `if-match` parameter to the value of the - etag from a previous GET or POST response for that resource. - The resource will be updated or deleted only if the etag you - provide matches the resource's current etag value. - - :param str opc_retry_token: (optional) - A token that uniquely identifies a request so it can be retried in case of a timeout or - server error, without risk of executing that same action again. Retry tokens expire after 24 - hours but can be invalidated before then due to conflicting operations. For example, if a resource - has been deleted and purged from the system, then a retry of the original creation request - might be rejected. - :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -5630,35 +7074,31 @@ def list_os_patches(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.OsPatchSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.PatchSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_os_patches API. + Click `here `__ to see an example of how to use list_patches API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/actions/listOsPatches" - method = "POST" - operation_name = "list_os_patches" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListOsPatches" + resource_path = "/bdsInstances/{bdsInstanceId}/patches" + method = "GET" + operation_name = "list_patches" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListPatches" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "page", - "limit", - "sort_by", - "sort_order", "opc_request_id", - "if_match", - "opc_retry_token" + "page", + "limit" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_os_patches got unknown kwargs: {extra_kwargs!r}") + f"list_patches got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5670,34 +7110,16 @@ def list_os_patches(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" - ) - query_params = { "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", 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), - "if-match": kwargs.get("if_match", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -5708,7 +7130,6 @@ def list_os_patches(self, bds_instance_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( @@ -5718,7 +7139,7 @@ def list_os_patches(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[OsPatchSummary]", + response_type="list[PatchSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5730,30 +7151,25 @@ def list_os_patches(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[OsPatchSummary]", + response_type="list[PatchSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_patch_histories(self, bds_instance_id, **kwargs): + def list_resource_principal_configurations(self, bds_instance_id, **kwargs): """ - List the patch history of this cluster. - - - :param str bds_instance_id: (required) - The OCID of the cluster. + Returns information about the ResourcePrincipalConfiguration. - :param str opc_request_id: (optional) - The client request ID for tracing. - :param str lifecycle_state: (optional) - The status of the patch. + :param str bds_instance_id: (required) + The OCID of the cluster. - Allowed values are: "INSTALLING", "INSTALLED", "FAILED" + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param str patch_version: (optional) - The version of the patch + :param int limit: (optional) + The maximum number of items to return. :param str sort_by: (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. @@ -5765,16 +7181,16 @@ def list_patch_histories(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. - :param int limit: (optional) - The maximum number of items to return. + :param str lifecycle_state: (optional) + The state of the ResourcePrincipalConfiguration. - :param str patch_type: (optional) - The type of a BDS patch history entity. + Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" - Allowed values are: "ODH", "OS" + :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. @@ -5788,36 +7204,35 @@ def list_patch_histories(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.PatchHistorySummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.ResourcePrincipalConfigurationSummary` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_patch_histories API. + Click `here `__ to see an example of how to use list_resource_principal_configurations API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/patchHistory" + resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations" method = "GET" - operation_name = "list_patch_histories" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListPatchHistories" + operation_name = "list_resource_principal_configurations" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListResourcePrincipalConfigurations" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "lifecycle_state", - "patch_version", - "sort_by", - "sort_order", "page", "limit", - "patch_type" + "sort_by", + "sort_order", + "display_name", + "lifecycle_state", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_patch_histories got unknown kwargs: {extra_kwargs!r}") + f"list_resource_principal_configurations got unknown kwargs: {extra_kwargs!r}") path_params = { "bdsInstanceId": bds_instance_id @@ -5829,13 +7244,6 @@ def list_patch_histories(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["INSTALLING", "INSTALLED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: @@ -5850,21 +7258,20 @@ def list_patch_histories(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) - if 'patch_type' in kwargs: - patch_type_allowed_values = ["ODH", "OS"] - if kwargs['patch_type'] not in patch_type_allowed_values: + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: raise ValueError( - f"Invalid value for `patch_type`, must be one of { patch_type_allowed_values }" + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" ) query_params = { - "lifecycleState": kwargs.get("lifecycle_state", missing), - "patchVersion": kwargs.get("patch_version", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), - "patchType": kwargs.get("patch_type", missing) + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5891,7 +7298,7 @@ def list_patch_histories(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[PatchHistorySummary]", + response_type="list[ResourcePrincipalConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -5903,22 +7310,19 @@ def list_patch_histories(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[PatchHistorySummary]", + response_type="list[ResourcePrincipalConfigurationSummary]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_patches(self, bds_instance_id, **kwargs): + def list_work_request_errors(self, work_request_id, **kwargs): """ - List all the available patches for this cluster. - + Returns a paginated list of errors for a work request identified by the given ID. - :param str bds_instance_id: (required) - The OCID of the cluster. - :param str opc_request_id: (optional) - The client request ID for tracing. + :param str work_request_id: (required) + The ID of the asynchronous request. :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. @@ -5926,6 +7330,19 @@ def list_patches(self, bds_instance_id, **kwargs): :param int limit: (optional) The maximum number of items to return. + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + The client request ID for tracing. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -5938,34 +7355,36 @@ def list_patches(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.PatchSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequestError` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_patches API. + Click `here `__ to see an example of how to use list_work_request_errors API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/patches" + required_arguments = ['workRequestId'] + resource_path = "/workRequests/{workRequestId}/errors" method = "GET" - operation_name = "list_patches" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListPatches" + operation_name = "list_work_request_errors" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequestError/ListWorkRequestErrors" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", "page", - "limit" + "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( - f"list_patches got unknown kwargs: {extra_kwargs!r}") + f"list_work_request_errors got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "workRequestId": work_request_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -5974,9 +7393,25 @@ def list_patches(self, bds_instance_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + query_params = { "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6003,7 +7438,7 @@ def list_patches(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[PatchSummary]", + response_type="list[WorkRequestError]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6015,19 +7450,19 @@ def list_patches(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[PatchSummary]", + response_type="list[WorkRequestError]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_resource_principal_configurations(self, bds_instance_id, **kwargs): + def list_work_request_logs(self, work_request_id, **kwargs): """ - Returns information about the ResourcePrincipalConfiguration. + Returns a paginated list of logs for a given work request. - :param str bds_instance_id: (required) - The OCID of the cluster. + :param str work_request_id: (required) + The ID of the asynchronous request. :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. @@ -6045,14 +7480,6 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): Allowed values are: "ASC", "DESC" - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. - - :param str lifecycle_state: (optional) - The state of the ResourcePrincipalConfiguration. - - Allowed values are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" - :param str opc_request_id: (optional) The client request ID for tracing. @@ -6068,18 +7495,18 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.ResourcePrincipalConfigurationSummary` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequestLogEntry` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_resource_principal_configurations API. + Click `here `__ to see an example of how to use list_work_request_logs API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['bdsInstanceId'] - resource_path = "/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations" + required_arguments = ['workRequestId'] + resource_path = "/workRequests/{workRequestId}/logs" method = "GET" - operation_name = "list_resource_principal_configurations" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/BdsInstance/ListResourcePrincipalConfigurations" + operation_name = "list_work_request_logs" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequestLogEntry/ListWorkRequestLogs" # Don't accept unknown kwargs expected_kwargs = [ @@ -6089,17 +7516,15 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): "limit", "sort_by", "sort_order", - "display_name", - "lifecycle_state", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_resource_principal_configurations got unknown kwargs: {extra_kwargs!r}") + f"list_work_request_logs got unknown kwargs: {extra_kwargs!r}") path_params = { - "bdsInstanceId": bds_instance_id + "workRequestId": work_request_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6122,20 +7547,11 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" - ) - query_params = { "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing), - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", 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} @@ -6162,7 +7578,7 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[ResourcePrincipalConfigurationSummary]", + response_type="list[WorkRequestLogEntry]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6174,19 +7590,22 @@ def list_resource_principal_configurations(self, bds_instance_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[ResourcePrincipalConfigurationSummary]", + response_type="list[WorkRequestLogEntry]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_request_errors(self, work_request_id, **kwargs): + def list_work_requests(self, compartment_id, **kwargs): """ - Returns a paginated list of errors for a work request identified by the given ID. + Lists the work requests in a compartment. - :param str work_request_id: (required) - The ID of the asynchronous request. + :param str compartment_id: (required) + The OCID of the compartment. + + :param str resource_id: (optional) + The OCID of the resource. :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. @@ -6219,23 +7638,24 @@ def list_work_request_errors(self, work_request_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequestError` + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequest` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_work_request_errors API. + Click `here `__ to see an example of how to use list_work_requests API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['workRequestId'] - resource_path = "/workRequests/{workRequestId}/errors" + required_arguments = ['compartmentId'] + resource_path = "/workRequests" method = "GET" - operation_name = "list_work_request_errors" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequestError/ListWorkRequestErrors" + operation_name = "list_work_requests" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequest/ListWorkRequests" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "resource_id", "page", "limit", "sort_by", @@ -6245,17 +7665,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_request_errors got unknown kwargs: {extra_kwargs!r}") - - path_params = { - "workRequestId": work_request_id - } - - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + f"list_work_requests got unknown kwargs: {extra_kwargs!r}") if 'sort_by' in kwargs: sort_by_allowed_values = ["timeCreated", "displayName"] @@ -6272,6 +7682,8 @@ def list_work_request_errors(self, work_request_id, **kwargs): ) query_params = { + "compartmentId": compartment_id, + "resourceId": kwargs.get("resource_id", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing), "sortBy": kwargs.get("sort_by", missing), @@ -6299,10 +7711,9 @@ def list_work_request_errors(self, work_request_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="list[WorkRequestError]", + response_type="list[WorkRequest]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6311,38 +7722,41 @@ def list_work_request_errors(self, work_request_id, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, - path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[WorkRequestError]", + response_type="list[WorkRequest]", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_request_logs(self, work_request_id, **kwargs): + def refresh_confidential_application(self, bds_instance_id, identity_configuration_id, refresh_confidential_application_details, **kwargs): """ - Returns a paginated list of logs for a given work request. - - - :param str work_request_id: (required) - The ID of the asynchronous request. + Refresh confidential application for the given identity configuration in case of any update to the confidential application (e.g. regenerated client secret) - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param int limit: (optional) - The maximum number of items to return. + :param str bds_instance_id: (required) + The OCID of the cluster. - :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + :param str identity_configuration_id: (required) + The OCID of the identity configuration - Allowed values are: "timeCreated", "displayName" + :param oci.bds.models.RefreshConfidentialApplicationDetails refresh_confidential_application_details: (required) + Details for refreshing confidential application - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. + :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. - Allowed values are: "ASC", "DESC" + :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. @@ -6359,36 +7773,35 @@ def list_work_request_logs(self, work_request_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequestLogEntry` + :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 list_work_request_logs API. + Click `here `__ to see an example of how to use refresh_confidential_application API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['workRequestId'] - resource_path = "/workRequests/{workRequestId}/logs" - method = "GET" - operation_name = "list_work_request_logs" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequestLogEntry/ListWorkRequestLogs" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshConfidentialApplication" + method = "POST" + operation_name = "refresh_confidential_application" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/RefreshConfidentialApplication" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "page", - "limit", - "sort_by", - "sort_order", + "opc_retry_token", + "if_match", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_request_logs got unknown kwargs: {extra_kwargs!r}") + f"refresh_confidential_application got unknown kwargs: {extra_kwargs!r}") path_params = { - "workRequestId": work_request_id + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6397,31 +7810,11 @@ def list_work_request_logs(self, work_request_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) - - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" - ) - - query_params = { - "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing), - "sortBy": kwargs.get("sort_by", missing), - "sortOrder": kwargs.get("sort_order", missing) - } - query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} - header_params = { "accept": "application/json", "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -6433,6 +7826,7 @@ def list_work_request_logs(self, work_request_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( @@ -6440,9 +7834,8 @@ def list_work_request_logs(self, work_request_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="list[WorkRequestLogEntry]", + body=refresh_confidential_application_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6452,44 +7845,44 @@ def list_work_request_logs(self, work_request_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="list[WorkRequestLogEntry]", + body=refresh_confidential_application_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_requests(self, compartment_id, **kwargs): + def refresh_upst_token_exchange_keytab(self, bds_instance_id, identity_configuration_id, refresh_upst_token_exchange_keytab_details, **kwargs): """ - Lists the work requests in a compartment. - - - :param str compartment_id: (required) - The OCID of the compartment. - - :param str resource_id: (optional) - The OCID of the resource. - - :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. + Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration - :param int limit: (optional) - The maximum number of items to return. - :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + :param str bds_instance_id: (required) + The OCID of the cluster. - Allowed values are: "timeCreated", "displayName" + :param str identity_configuration_id: (required) + The OCID of the identity configuration - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. + :param oci.bds.models.RefreshUpstTokenExchangeKeytabDetails refresh_upst_token_exchange_keytab_details: (required) + Details for refreshing User Principal Session (UPST) token exchange keytab - Allowed values are: "ASC", "DESC" + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. :param str opc_request_id: (optional) The client request ID for tracing. + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6502,63 +7895,49 @@ def list_work_requests(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.bds.models.WorkRequest` + :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 list_work_requests API. + Click `here `__ to see an example of how to use refresh_upst_token_exchange_keytab API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['compartmentId'] - resource_path = "/workRequests" - method = "GET" - operation_name = "list_work_requests" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/WorkRequest/ListWorkRequests" + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshUpstTokenExchangeKeytab" + method = "POST" + operation_name = "refresh_upst_token_exchange_keytab" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/RefreshUpstTokenExchangeKeytab" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "resource_id", - "page", - "limit", - "sort_by", - "sort_order", - "opc_request_id" + "opc_retry_token", + "opc_request_id", + "if_match" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_requests got unknown kwargs: {extra_kwargs!r}") + f"refresh_upst_token_exchange_keytab got unknown kwargs: {extra_kwargs!r}") - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) + path_params = { + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id + } - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" - ) + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - query_params = { - "compartmentId": compartment_id, - "resourceId": kwargs.get("resource_id", 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} + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -6569,15 +7948,16 @@ def list_work_requests(self, compartment_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( self.base_client.call_api, resource_path=resource_path, method=method, - query_params=query_params, + path_params=path_params, header_params=header_params, - response_type="list[WorkRequest]", + body=refresh_upst_token_exchange_keytab_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6586,9 +7966,9 @@ def list_work_requests(self, compartment_id, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, - query_params=query_params, + path_params=path_params, header_params=header_params, - response_type="list[WorkRequest]", + body=refresh_upst_token_exchange_keytab_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -8421,6 +9801,128 @@ def update_bds_metastore_configuration(self, bds_instance_id, metastore_config_i api_reference_link=api_reference_link, required_arguments=required_arguments) + def update_identity_configuration(self, bds_instance_id, identity_configuration_id, update_identity_configuration_details, **kwargs): + """ + Update the IAM user sync and UPST configuration for the specified identity configuration + + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.UpdateIdentityConfigurationDetails update_identity_configuration_details: (required) + Details for updating an identity configuration + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_identity_configuration API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['bdsInstanceId', 'identityConfigurationId'] + resource_path = "/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}" + method = "PUT" + operation_name = "update_identity_configuration" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/bigdata/20190531/IdentityConfiguration/UpdateIdentityConfiguration" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"update_identity_configuration got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "bdsInstanceId": bds_instance_id, + "identityConfigurationId": identity_configuration_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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=update_identity_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_identity_configuration_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def update_node_backup_configuration(self, bds_instance_id, node_backup_configuration_id, update_node_backup_configuration_details, **kwargs): """ Updates fields on NodeBackupConfiguration, including the name, the schedule. diff --git a/src/oci/bds/bds_client_composite_operations.py b/src/oci/bds/bds_client_composite_operations.py index 3d19d0ec8b..953f17d434 100644 --- a/src/oci/bds/bds_client_composite_operations.py +++ b/src/oci/bds/bds_client_composite_operations.py @@ -70,6 +70,96 @@ def activate_bds_metastore_configuration_and_wait_for_state(self, bds_instance_i except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def activate_iam_user_sync_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, activate_iam_user_sync_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.activate_iam_user_sync_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.ActivateIamUserSyncConfigurationDetails activate_iam_user_sync_configuration_details: (required) + Details for activating a new IAM user sync config. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.activate_iam_user_sync_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.activate_iam_user_sync_configuration(bds_instance_id, identity_configuration_id, activate_iam_user_sync_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def activate_upst_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, activate_upst_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.activate_upst_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.ActivateUpstConfigurationDetails activate_upst_configuration_details: (required) + Details for activating UPST config + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.activate_upst_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.activate_upst_configuration(bds_instance_id, identity_configuration_id, activate_upst_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def add_auto_scaling_configuration_and_wait_for_state(self, bds_instance_id, add_auto_scaling_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.add_auto_scaling_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` @@ -613,6 +703,48 @@ def create_bds_metastore_configuration_and_wait_for_state(self, bds_instance_id, except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_identity_configuration_and_wait_for_state(self, bds_instance_id, create_identity_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.create_identity_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param oci.bds.models.CreateIdentityConfigurationDetails create_identity_configuration_details: (required) + Details for creating an identity configuration + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.create_identity_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_identity_configuration(bds_instance_id, create_identity_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_node_backup_configuration_and_wait_for_state(self, bds_instance_id, create_node_backup_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.create_node_backup_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` @@ -739,6 +871,96 @@ def create_resource_principal_configuration_and_wait_for_state(self, bds_instanc except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def deactivate_iam_user_sync_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, deactivate_iam_user_sync_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.deactivate_iam_user_sync_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.DeactivateIamUserSyncConfigurationDetails deactivate_iam_user_sync_configuration_details: (required) + Details for deactivating the IAM user sync config + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.deactivate_iam_user_sync_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.deactivate_iam_user_sync_configuration(bds_instance_id, identity_configuration_id, deactivate_iam_user_sync_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def deactivate_upst_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, deactivate_upst_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.deactivate_upst_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.DeactivateUpstConfigurationDetails deactivate_upst_configuration_details: (required) + Details for deactivating the UPST config + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.deactivate_upst_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.deactivate_upst_configuration(bds_instance_id, identity_configuration_id, deactivate_upst_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_bds_api_key_and_wait_for_state(self, bds_instance_id, api_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.delete_bds_api_key` and waits for the :py:class:`~oci.bds.models.WorkRequest` @@ -886,6 +1108,56 @@ def delete_bds_metastore_configuration_and_wait_for_state(self, bds_instance_id, except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_identity_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.delete_identity_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.delete_identity_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = None + try: + operation_result = self.client.delete_identity_configuration(bds_instance_id, identity_configuration_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_node_backup_and_wait_for_state(self, bds_instance_id, node_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.delete_node_backup` and waits for the :py:class:`~oci.bds.models.WorkRequest` @@ -1241,6 +1513,96 @@ def install_patch_and_wait_for_state(self, bds_instance_id, install_patch_detail except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def refresh_confidential_application_and_wait_for_state(self, bds_instance_id, identity_configuration_id, refresh_confidential_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.refresh_confidential_application` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.RefreshConfidentialApplicationDetails refresh_confidential_application_details: (required) + Details for refreshing confidential application + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.refresh_confidential_application` + + :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.refresh_confidential_application(bds_instance_id, identity_configuration_id, refresh_confidential_application_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def refresh_upst_token_exchange_keytab_and_wait_for_state(self, bds_instance_id, identity_configuration_id, refresh_upst_token_exchange_keytab_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.refresh_upst_token_exchange_keytab` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.RefreshUpstTokenExchangeKeytabDetails refresh_upst_token_exchange_keytab_details: (required) + Details for refreshing User Principal Session (UPST) token exchange keytab + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.refresh_upst_token_exchange_keytab` + + :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.refresh_upst_token_exchange_keytab(bds_instance_id, identity_configuration_id, refresh_upst_token_exchange_keytab_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def remove_auto_scaling_configuration_and_wait_for_state(self, bds_instance_id, auto_scaling_configuration_id, remove_auto_scaling_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.remove_auto_scaling_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` @@ -1934,6 +2296,51 @@ def update_bds_metastore_configuration_and_wait_for_state(self, bds_instance_id, except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_identity_configuration_and_wait_for_state(self, bds_instance_id, identity_configuration_id, update_identity_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.bds.BdsClient.update_identity_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` + to enter the given state(s). + + :param str bds_instance_id: (required) + The OCID of the cluster. + + :param str identity_configuration_id: (required) + The OCID of the identity configuration + + :param oci.bds.models.UpdateIdentityConfigurationDetails update_identity_configuration_details: (required) + Details for updating an identity configuration + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.bds.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.bds.BdsClient.update_identity_configuration` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_identity_configuration(bds_instance_id, identity_configuration_id, update_identity_configuration_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_node_backup_configuration_and_wait_for_state(self, bds_instance_id, node_backup_configuration_id, update_node_backup_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.bds.BdsClient.update_node_backup_configuration` and waits for the :py:class:`~oci.bds.models.WorkRequest` diff --git a/src/oci/bds/models/__init__.py b/src/oci/bds/models/__init__.py index 2c2e03e2e7..50e27938cc 100644 --- a/src/oci/bds/models/__init__.py +++ b/src/oci/bds/models/__init__.py @@ -7,6 +7,8 @@ from __future__ import absolute_import from .activate_bds_metastore_configuration_details import ActivateBdsMetastoreConfigurationDetails +from .activate_iam_user_sync_configuration_details import ActivateIamUserSyncConfigurationDetails +from .activate_upst_configuration_details import ActivateUpstConfigurationDetails from .add_auto_scale_policy_details import AddAutoScalePolicyDetails from .add_auto_scaling_configuration_details import AddAutoScalingConfigurationDetails from .add_block_storage_details import AddBlockStorageDetails @@ -30,6 +32,7 @@ from .batching_based_patching_configs import BatchingBasedPatchingConfigs from .bds_api_key import BdsApiKey from .bds_api_key_summary import BdsApiKeySummary +from .bds_cluster_version_summary import BdsClusterVersionSummary from .bds_instance import BdsInstance from .bds_instance_summary import BdsInstanceSummary from .bds_metastore_configuration import BdsMetastoreConfiguration @@ -44,12 +47,15 @@ from .create_bds_api_key_details import CreateBdsApiKeyDetails from .create_bds_instance_details import CreateBdsInstanceDetails from .create_bds_metastore_configuration_details import CreateBdsMetastoreConfigurationDetails +from .create_identity_configuration_details import CreateIdentityConfigurationDetails from .create_node_backup_configuration_details import CreateNodeBackupConfigurationDetails from .create_node_details import CreateNodeDetails from .create_node_replace_configuration_details import CreateNodeReplaceConfigurationDetails from .create_resource_principal_configuration_details import CreateResourcePrincipalConfigurationDetails from .day_based_horizontal_scaling_schedule_details import DayBasedHorizontalScalingScheduleDetails from .day_based_vertical_scaling_schedule_details import DayBasedVerticalScalingScheduleDetails +from .deactivate_iam_user_sync_configuration_details import DeactivateIamUserSyncConfigurationDetails +from .deactivate_upst_configuration_details import DeactivateUpstConfigurationDetails from .default_error import DefaultError from .disable_certificate_details import DisableCertificateDetails from .domain_based_odh_patching_config import DomainBasedOdhPatchingConfig @@ -62,6 +68,10 @@ from .horizontal_scaling_schedule_details import HorizontalScalingScheduleDetails from .host_cert_details import HostCertDetails from .host_specific_certificate_details import HostSpecificCertificateDetails +from .iam_user_sync_configuration import IamUserSyncConfiguration +from .iam_user_sync_configuration_details import IamUserSyncConfigurationDetails +from .identity_configuration import IdentityConfiguration +from .identity_configuration_summary import IdentityConfigurationSummary from .install_os_patch_details import InstallOsPatchDetails from .install_patch_details import InstallPatchDetails from .kerberos_details import KerberosDetails @@ -83,6 +93,7 @@ from .node_replace_configuration import NodeReplaceConfiguration from .node_replace_configuration_summary import NodeReplaceConfigurationSummary from .node_type_level_details import NodeTypeLevelDetails +from .node_type_shape_config import NodeTypeShapeConfig from .odh_patching_config import OdhPatchingConfig from .os_patch_details import OsPatchDetails from .os_patch_package_summary import OsPatchPackageSummary @@ -90,6 +101,8 @@ from .patch_history_summary import PatchHistorySummary from .patch_summary import PatchSummary from .patching_configs import PatchingConfigs +from .refresh_confidential_application_details import RefreshConfidentialApplicationDetails +from .refresh_upst_token_exchange_keytab_details import RefreshUpstTokenExchangeKeytabDetails from .remove_auto_scaling_configuration_details import RemoveAutoScalingConfigurationDetails from .remove_cloud_sql_details import RemoveCloudSqlDetails from .remove_kafka_details import RemoveKafkaDetails @@ -105,6 +118,7 @@ from .schedule_based_vertical_scaling_policy_details import ScheduleBasedVerticalScalingPolicyDetails from .shape_config_details import ShapeConfigDetails from .start_bds_instance_details import StartBdsInstanceDetails +from .start_cluster_shape_configs import StartClusterShapeConfigs from .stop_bds_instance_details import StopBdsInstanceDetails from .test_bds_metastore_configuration_details import TestBdsMetastoreConfigurationDetails from .test_bds_object_storage_connection_details import TestBdsObjectStorageConnectionDetails @@ -114,6 +128,7 @@ from .update_auto_scaling_configuration_details import UpdateAutoScalingConfigurationDetails from .update_bds_instance_details import UpdateBdsInstanceDetails from .update_bds_metastore_configuration_details import UpdateBdsMetastoreConfigurationDetails +from .update_identity_configuration_details import UpdateIdentityConfigurationDetails from .update_metric_based_horizontal_scaling_policy_details import UpdateMetricBasedHorizontalScalingPolicyDetails from .update_metric_based_vertical_scaling_policy_details import UpdateMetricBasedVerticalScalingPolicyDetails from .update_node_backup_configuration_details import UpdateNodeBackupConfigurationDetails @@ -121,6 +136,8 @@ from .update_resource_principal_configuration_details import UpdateResourcePrincipalConfigurationDetails from .update_schedule_based_horizontal_scaling_policy_details import UpdateScheduleBasedHorizontalScalingPolicyDetails from .update_schedule_based_vertical_scaling_policy_details import UpdateScheduleBasedVerticalScalingPolicyDetails +from .upst_configuration import UpstConfiguration +from .upst_configuration_details import UpstConfigurationDetails from .vertical_scaling_schedule_details import VerticalScalingScheduleDetails from .volume_attachment_detail import VolumeAttachmentDetail from .work_request import WorkRequest @@ -131,6 +148,8 @@ # Maps type names to classes for bds services. bds_type_mapping = { "ActivateBdsMetastoreConfigurationDetails": ActivateBdsMetastoreConfigurationDetails, + "ActivateIamUserSyncConfigurationDetails": ActivateIamUserSyncConfigurationDetails, + "ActivateUpstConfigurationDetails": ActivateUpstConfigurationDetails, "AddAutoScalePolicyDetails": AddAutoScalePolicyDetails, "AddAutoScalingConfigurationDetails": AddAutoScalingConfigurationDetails, "AddBlockStorageDetails": AddBlockStorageDetails, @@ -154,6 +173,7 @@ "BatchingBasedPatchingConfigs": BatchingBasedPatchingConfigs, "BdsApiKey": BdsApiKey, "BdsApiKeySummary": BdsApiKeySummary, + "BdsClusterVersionSummary": BdsClusterVersionSummary, "BdsInstance": BdsInstance, "BdsInstanceSummary": BdsInstanceSummary, "BdsMetastoreConfiguration": BdsMetastoreConfiguration, @@ -168,12 +188,15 @@ "CreateBdsApiKeyDetails": CreateBdsApiKeyDetails, "CreateBdsInstanceDetails": CreateBdsInstanceDetails, "CreateBdsMetastoreConfigurationDetails": CreateBdsMetastoreConfigurationDetails, + "CreateIdentityConfigurationDetails": CreateIdentityConfigurationDetails, "CreateNodeBackupConfigurationDetails": CreateNodeBackupConfigurationDetails, "CreateNodeDetails": CreateNodeDetails, "CreateNodeReplaceConfigurationDetails": CreateNodeReplaceConfigurationDetails, "CreateResourcePrincipalConfigurationDetails": CreateResourcePrincipalConfigurationDetails, "DayBasedHorizontalScalingScheduleDetails": DayBasedHorizontalScalingScheduleDetails, "DayBasedVerticalScalingScheduleDetails": DayBasedVerticalScalingScheduleDetails, + "DeactivateIamUserSyncConfigurationDetails": DeactivateIamUserSyncConfigurationDetails, + "DeactivateUpstConfigurationDetails": DeactivateUpstConfigurationDetails, "DefaultError": DefaultError, "DisableCertificateDetails": DisableCertificateDetails, "DomainBasedOdhPatchingConfig": DomainBasedOdhPatchingConfig, @@ -186,6 +209,10 @@ "HorizontalScalingScheduleDetails": HorizontalScalingScheduleDetails, "HostCertDetails": HostCertDetails, "HostSpecificCertificateDetails": HostSpecificCertificateDetails, + "IamUserSyncConfiguration": IamUserSyncConfiguration, + "IamUserSyncConfigurationDetails": IamUserSyncConfigurationDetails, + "IdentityConfiguration": IdentityConfiguration, + "IdentityConfigurationSummary": IdentityConfigurationSummary, "InstallOsPatchDetails": InstallOsPatchDetails, "InstallPatchDetails": InstallPatchDetails, "KerberosDetails": KerberosDetails, @@ -207,6 +234,7 @@ "NodeReplaceConfiguration": NodeReplaceConfiguration, "NodeReplaceConfigurationSummary": NodeReplaceConfigurationSummary, "NodeTypeLevelDetails": NodeTypeLevelDetails, + "NodeTypeShapeConfig": NodeTypeShapeConfig, "OdhPatchingConfig": OdhPatchingConfig, "OsPatchDetails": OsPatchDetails, "OsPatchPackageSummary": OsPatchPackageSummary, @@ -214,6 +242,8 @@ "PatchHistorySummary": PatchHistorySummary, "PatchSummary": PatchSummary, "PatchingConfigs": PatchingConfigs, + "RefreshConfidentialApplicationDetails": RefreshConfidentialApplicationDetails, + "RefreshUpstTokenExchangeKeytabDetails": RefreshUpstTokenExchangeKeytabDetails, "RemoveAutoScalingConfigurationDetails": RemoveAutoScalingConfigurationDetails, "RemoveCloudSqlDetails": RemoveCloudSqlDetails, "RemoveKafkaDetails": RemoveKafkaDetails, @@ -229,6 +259,7 @@ "ScheduleBasedVerticalScalingPolicyDetails": ScheduleBasedVerticalScalingPolicyDetails, "ShapeConfigDetails": ShapeConfigDetails, "StartBdsInstanceDetails": StartBdsInstanceDetails, + "StartClusterShapeConfigs": StartClusterShapeConfigs, "StopBdsInstanceDetails": StopBdsInstanceDetails, "TestBdsMetastoreConfigurationDetails": TestBdsMetastoreConfigurationDetails, "TestBdsObjectStorageConnectionDetails": TestBdsObjectStorageConnectionDetails, @@ -238,6 +269,7 @@ "UpdateAutoScalingConfigurationDetails": UpdateAutoScalingConfigurationDetails, "UpdateBdsInstanceDetails": UpdateBdsInstanceDetails, "UpdateBdsMetastoreConfigurationDetails": UpdateBdsMetastoreConfigurationDetails, + "UpdateIdentityConfigurationDetails": UpdateIdentityConfigurationDetails, "UpdateMetricBasedHorizontalScalingPolicyDetails": UpdateMetricBasedHorizontalScalingPolicyDetails, "UpdateMetricBasedVerticalScalingPolicyDetails": UpdateMetricBasedVerticalScalingPolicyDetails, "UpdateNodeBackupConfigurationDetails": UpdateNodeBackupConfigurationDetails, @@ -245,6 +277,8 @@ "UpdateResourcePrincipalConfigurationDetails": UpdateResourcePrincipalConfigurationDetails, "UpdateScheduleBasedHorizontalScalingPolicyDetails": UpdateScheduleBasedHorizontalScalingPolicyDetails, "UpdateScheduleBasedVerticalScalingPolicyDetails": UpdateScheduleBasedVerticalScalingPolicyDetails, + "UpstConfiguration": UpstConfiguration, + "UpstConfigurationDetails": UpstConfigurationDetails, "VerticalScalingScheduleDetails": VerticalScalingScheduleDetails, "VolumeAttachmentDetail": VolumeAttachmentDetail, "WorkRequest": WorkRequest, diff --git a/src/oci/bds/models/activate_iam_user_sync_configuration_details.py b/src/oci/bds/models/activate_iam_user_sync_configuration_details.py new file mode 100644 index 0000000000..85710de37b --- /dev/null +++ b/src/oci/bds/models/activate_iam_user_sync_configuration_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ActivateIamUserSyncConfigurationDetails(object): + """ + Details for activating IAM user sync configuration + """ + + def __init__(self, **kwargs): + """ + Initializes a new ActivateIamUserSyncConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this ActivateIamUserSyncConfigurationDetails. + :type cluster_admin_password: str + + :param is_posix_attributes_addition_required: + The value to assign to the is_posix_attributes_addition_required property of this ActivateIamUserSyncConfigurationDetails. + :type is_posix_attributes_addition_required: bool + + """ + self.swagger_types = { + 'cluster_admin_password': 'str', + 'is_posix_attributes_addition_required': 'bool' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword', + 'is_posix_attributes_addition_required': 'isPosixAttributesAdditionRequired' + } + + self._cluster_admin_password = None + self._is_posix_attributes_addition_required = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this ActivateIamUserSyncConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this ActivateIamUserSyncConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this ActivateIamUserSyncConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this ActivateIamUserSyncConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_password + + @property + def is_posix_attributes_addition_required(self): + """ + Gets the is_posix_attributes_addition_required of this ActivateIamUserSyncConfigurationDetails. + whether posix attribute needs to be appended to users + + + :return: The is_posix_attributes_addition_required of this ActivateIamUserSyncConfigurationDetails. + :rtype: bool + """ + return self._is_posix_attributes_addition_required + + @is_posix_attributes_addition_required.setter + def is_posix_attributes_addition_required(self, is_posix_attributes_addition_required): + """ + Sets the is_posix_attributes_addition_required of this ActivateIamUserSyncConfigurationDetails. + whether posix attribute needs to be appended to users + + + :param is_posix_attributes_addition_required: The is_posix_attributes_addition_required of this ActivateIamUserSyncConfigurationDetails. + :type: bool + """ + self._is_posix_attributes_addition_required = is_posix_attributes_addition_required + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/activate_upst_configuration_details.py b/src/oci/bds/models/activate_upst_configuration_details.py new file mode 100644 index 0000000000..7e4f754deb --- /dev/null +++ b/src/oci/bds/models/activate_upst_configuration_details.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ActivateUpstConfigurationDetails(object): + """ + Details for activating UPST config on the cluster + """ + + def __init__(self, **kwargs): + """ + Initializes a new ActivateUpstConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this ActivateUpstConfigurationDetails. + :type cluster_admin_password: str + + :param vault_id: + The value to assign to the vault_id property of this ActivateUpstConfigurationDetails. + :type vault_id: str + + :param master_encryption_key_id: + The value to assign to the master_encryption_key_id property of this ActivateUpstConfigurationDetails. + :type master_encryption_key_id: str + + """ + self.swagger_types = { + 'cluster_admin_password': 'str', + 'vault_id': 'str', + 'master_encryption_key_id': 'str' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword', + 'vault_id': 'vaultId', + 'master_encryption_key_id': 'masterEncryptionKeyId' + } + + self._cluster_admin_password = None + self._vault_id = None + self._master_encryption_key_id = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this ActivateUpstConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this ActivateUpstConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this ActivateUpstConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this ActivateUpstConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_password + + @property + def vault_id(self): + """ + **[Required]** Gets the vault_id of this ActivateUpstConfigurationDetails. + OCID of the vault to store token exchange service principal keyta, required for creating UPST configb + + + :return: The vault_id of this ActivateUpstConfigurationDetails. + :rtype: str + """ + return self._vault_id + + @vault_id.setter + def vault_id(self, vault_id): + """ + Sets the vault_id of this ActivateUpstConfigurationDetails. + OCID of the vault to store token exchange service principal keyta, required for creating UPST configb + + + :param vault_id: The vault_id of this ActivateUpstConfigurationDetails. + :type: str + """ + self._vault_id = vault_id + + @property + def master_encryption_key_id(self): + """ + **[Required]** Gets the master_encryption_key_id of this ActivateUpstConfigurationDetails. + OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for creating UPST config + + + :return: The master_encryption_key_id of this ActivateUpstConfigurationDetails. + :rtype: str + """ + return self._master_encryption_key_id + + @master_encryption_key_id.setter + def master_encryption_key_id(self, master_encryption_key_id): + """ + Sets the master_encryption_key_id of this ActivateUpstConfigurationDetails. + OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for creating UPST config + + + :param master_encryption_key_id: The master_encryption_key_id of this ActivateUpstConfigurationDetails. + :type: str + """ + self._master_encryption_key_id = master_encryption_key_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/batching_based_odh_patching_config.py b/src/oci/bds/models/batching_based_odh_patching_config.py index f0a40a797a..9188f6cfc9 100644 --- a/src/oci/bds/models/batching_based_odh_patching_config.py +++ b/src/oci/bds/models/batching_based_odh_patching_config.py @@ -34,22 +34,29 @@ def __init__(self, **kwargs): The value to assign to the wait_time_between_batch_in_seconds property of this BatchingBasedOdhPatchingConfig. :type wait_time_between_batch_in_seconds: int + :param tolerance_threshold_per_batch: + The value to assign to the tolerance_threshold_per_batch property of this BatchingBasedOdhPatchingConfig. + :type tolerance_threshold_per_batch: int + """ self.swagger_types = { 'patching_config_strategy': 'str', 'batch_size': 'int', - 'wait_time_between_batch_in_seconds': 'int' + 'wait_time_between_batch_in_seconds': 'int', + 'tolerance_threshold_per_batch': 'int' } self.attribute_map = { 'patching_config_strategy': 'patchingConfigStrategy', 'batch_size': 'batchSize', - 'wait_time_between_batch_in_seconds': 'waitTimeBetweenBatchInSeconds' + 'wait_time_between_batch_in_seconds': 'waitTimeBetweenBatchInSeconds', + 'tolerance_threshold_per_batch': 'toleranceThresholdPerBatch' } self._patching_config_strategy = None self._batch_size = None self._wait_time_between_batch_in_seconds = None + self._tolerance_threshold_per_batch = None self._patching_config_strategy = 'BATCHING_BASED' @property @@ -100,6 +107,30 @@ def wait_time_between_batch_in_seconds(self, wait_time_between_batch_in_seconds) """ self._wait_time_between_batch_in_seconds = wait_time_between_batch_in_seconds + @property + def tolerance_threshold_per_batch(self): + """ + Gets the tolerance_threshold_per_batch of this BatchingBasedOdhPatchingConfig. + Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes. + + + :return: The tolerance_threshold_per_batch of this BatchingBasedOdhPatchingConfig. + :rtype: int + """ + return self._tolerance_threshold_per_batch + + @tolerance_threshold_per_batch.setter + def tolerance_threshold_per_batch(self, tolerance_threshold_per_batch): + """ + Sets the tolerance_threshold_per_batch of this BatchingBasedOdhPatchingConfig. + Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes. + + + :param tolerance_threshold_per_batch: The tolerance_threshold_per_batch of this BatchingBasedOdhPatchingConfig. + :type: int + """ + self._tolerance_threshold_per_batch = tolerance_threshold_per_batch + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/bds_api_key.py b/src/oci/bds/models/bds_api_key.py index d288103ad4..1038f9ec88 100644 --- a/src/oci/bds/models/bds_api_key.py +++ b/src/oci/bds/models/bds_api_key.py @@ -78,6 +78,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param domain_ocid: + The value to assign to the domain_ocid property of this BdsApiKey. + :type domain_ocid: str + """ self.swagger_types = { 'id': 'str', @@ -88,7 +92,8 @@ def __init__(self, **kwargs): 'fingerprint': 'str', 'pemfilepath': 'str', 'time_created': 'datetime', - 'lifecycle_state': 'str' + 'lifecycle_state': 'str', + 'domain_ocid': 'str' } self.attribute_map = { @@ -100,7 +105,8 @@ def __init__(self, **kwargs): 'fingerprint': 'fingerprint', 'pemfilepath': 'pemfilepath', 'time_created': 'timeCreated', - 'lifecycle_state': 'lifecycleState' + 'lifecycle_state': 'lifecycleState', + 'domain_ocid': 'domainOcid' } self._id = None @@ -112,6 +118,7 @@ def __init__(self, **kwargs): self._pemfilepath = None self._time_created = None self._lifecycle_state = None + self._domain_ocid = None @property def id(self): @@ -339,6 +346,30 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def domain_ocid(self): + """ + Gets the domain_ocid of this BdsApiKey. + Identity domain OCID ,where user is present. For default domain ,this field will be optional. + + + :return: The domain_ocid of this BdsApiKey. + :rtype: str + """ + return self._domain_ocid + + @domain_ocid.setter + def domain_ocid(self, domain_ocid): + """ + Sets the domain_ocid of this BdsApiKey. + Identity domain OCID ,where user is present. For default domain ,this field will be optional. + + + :param domain_ocid: The domain_ocid of this BdsApiKey. + :type: str + """ + self._domain_ocid = domain_ocid + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/bds_cluster_version_summary.py b/src/oci/bds/models/bds_cluster_version_summary.py new file mode 100644 index 0000000000..bbb33478d5 --- /dev/null +++ b/src/oci/bds/models/bds_cluster_version_summary.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class BdsClusterVersionSummary(object): + """ + Cluster version details including bds and odh version information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new BdsClusterVersionSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param bds_version: + The value to assign to the bds_version property of this BdsClusterVersionSummary. + :type bds_version: str + + :param odh_version: + The value to assign to the odh_version property of this BdsClusterVersionSummary. + :type odh_version: str + + """ + self.swagger_types = { + 'bds_version': 'str', + 'odh_version': 'str' + } + + self.attribute_map = { + 'bds_version': 'bdsVersion', + 'odh_version': 'odhVersion' + } + + self._bds_version = None + self._odh_version = None + + @property + def bds_version(self): + """ + **[Required]** Gets the bds_version of this BdsClusterVersionSummary. + BDS version to be used for cluster creation + + + :return: The bds_version of this BdsClusterVersionSummary. + :rtype: str + """ + return self._bds_version + + @bds_version.setter + def bds_version(self, bds_version): + """ + Sets the bds_version of this BdsClusterVersionSummary. + BDS version to be used for cluster creation + + + :param bds_version: The bds_version of this BdsClusterVersionSummary. + :type: str + """ + self._bds_version = bds_version + + @property + def odh_version(self): + """ + Gets the odh_version of this BdsClusterVersionSummary. + ODH version to be used for cluster creation + + + :return: The odh_version of this BdsClusterVersionSummary. + :rtype: str + """ + return self._odh_version + + @odh_version.setter + def odh_version(self, odh_version): + """ + Sets the odh_version of this BdsClusterVersionSummary. + ODH version to be used for cluster creation + + + :param odh_version: The odh_version of this BdsClusterVersionSummary. + :type: str + """ + self._odh_version = odh_version + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/bds_instance.py b/src/oci/bds/models/bds_instance.py index 736466f614..e04dadd485 100644 --- a/src/oci/bds/models/bds_instance.py +++ b/src/oci/bds/models/bds_instance.py @@ -206,6 +206,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type cluster_profile: str + :param bds_cluster_version_summary: + The value to assign to the bds_cluster_version_summary property of this BdsInstance. + :type bds_cluster_version_summary: oci.bds.models.BdsClusterVersionSummary + """ self.swagger_types = { 'id': 'str', @@ -230,7 +234,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'kms_key_id': 'str', - 'cluster_profile': 'str' + 'cluster_profile': 'str', + 'bds_cluster_version_summary': 'BdsClusterVersionSummary' } self.attribute_map = { @@ -256,7 +261,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'kms_key_id': 'kmsKeyId', - 'cluster_profile': 'clusterProfile' + 'cluster_profile': 'clusterProfile', + 'bds_cluster_version_summary': 'bdsClusterVersionSummary' } self._id = None @@ -282,6 +288,7 @@ def __init__(self, **kwargs): self._defined_tags = None self._kms_key_id = None self._cluster_profile = None + self._bds_cluster_version_summary = None @property def id(self): @@ -845,6 +852,26 @@ def cluster_profile(self, cluster_profile): cluster_profile = 'UNKNOWN_ENUM_VALUE' self._cluster_profile = cluster_profile + @property + def bds_cluster_version_summary(self): + """ + Gets the bds_cluster_version_summary of this BdsInstance. + + :return: The bds_cluster_version_summary of this BdsInstance. + :rtype: oci.bds.models.BdsClusterVersionSummary + """ + return self._bds_cluster_version_summary + + @bds_cluster_version_summary.setter + def bds_cluster_version_summary(self, bds_cluster_version_summary): + """ + Sets the bds_cluster_version_summary of this BdsInstance. + + :param bds_cluster_version_summary: The bds_cluster_version_summary of this BdsInstance. + :type: oci.bds.models.BdsClusterVersionSummary + """ + self._bds_cluster_version_summary = bds_cluster_version_summary + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/create_bds_api_key_details.py b/src/oci/bds/models/create_bds_api_key_details.py index 4736ace085..e92627e91a 100644 --- a/src/oci/bds/models/create_bds_api_key_details.py +++ b/src/oci/bds/models/create_bds_api_key_details.py @@ -36,25 +36,32 @@ def __init__(self, **kwargs): The value to assign to the key_alias property of this CreateBdsApiKeyDetails. :type key_alias: str + :param domain_ocid: + The value to assign to the domain_ocid property of this CreateBdsApiKeyDetails. + :type domain_ocid: str + """ self.swagger_types = { 'user_id': 'str', 'passphrase': 'str', 'default_region': 'str', - 'key_alias': 'str' + 'key_alias': 'str', + 'domain_ocid': 'str' } self.attribute_map = { 'user_id': 'userId', 'passphrase': 'passphrase', 'default_region': 'defaultRegion', - 'key_alias': 'keyAlias' + 'key_alias': 'keyAlias', + 'domain_ocid': 'domainOcid' } self._user_id = None self._passphrase = None self._default_region = None self._key_alias = None + self._domain_ocid = None @property def user_id(self): @@ -156,6 +163,30 @@ def key_alias(self, key_alias): """ self._key_alias = key_alias + @property + def domain_ocid(self): + """ + Gets the domain_ocid of this CreateBdsApiKeyDetails. + Identity domain OCID , where user is present. For default domain , this field will be optional. + + + :return: The domain_ocid of this CreateBdsApiKeyDetails. + :rtype: str + """ + return self._domain_ocid + + @domain_ocid.setter + def domain_ocid(self, domain_ocid): + """ + Sets the domain_ocid of this CreateBdsApiKeyDetails. + Identity domain OCID , where user is present. For default domain , this field will be optional. + + + :param domain_ocid: The domain_ocid of this CreateBdsApiKeyDetails. + :type: str + """ + self._domain_ocid = domain_ocid + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/create_bds_instance_details.py b/src/oci/bds/models/create_bds_instance_details.py index fb3df08e39..e38ec67f99 100644 --- a/src/oci/bds/models/create_bds_instance_details.py +++ b/src/oci/bds/models/create_bds_instance_details.py @@ -80,6 +80,10 @@ def __init__(self, **kwargs): The value to assign to the cluster_profile property of this CreateBdsInstanceDetails. :type cluster_profile: str + :param bds_cluster_version_summary: + The value to assign to the bds_cluster_version_summary property of this CreateBdsInstanceDetails. + :type bds_cluster_version_summary: oci.bds.models.BdsClusterVersionSummary + """ self.swagger_types = { 'compartment_id': 'str', @@ -96,7 +100,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'kms_key_id': 'str', - 'cluster_profile': 'str' + 'cluster_profile': 'str', + 'bds_cluster_version_summary': 'BdsClusterVersionSummary' } self.attribute_map = { @@ -114,7 +119,8 @@ def __init__(self, **kwargs): 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'kms_key_id': 'kmsKeyId', - 'cluster_profile': 'clusterProfile' + 'cluster_profile': 'clusterProfile', + 'bds_cluster_version_summary': 'bdsClusterVersionSummary' } self._compartment_id = None @@ -132,6 +138,7 @@ def __init__(self, **kwargs): self._defined_tags = None self._kms_key_id = None self._cluster_profile = None + self._bds_cluster_version_summary = None @property def compartment_id(self): @@ -493,6 +500,26 @@ def cluster_profile(self, cluster_profile): """ self._cluster_profile = cluster_profile + @property + def bds_cluster_version_summary(self): + """ + Gets the bds_cluster_version_summary of this CreateBdsInstanceDetails. + + :return: The bds_cluster_version_summary of this CreateBdsInstanceDetails. + :rtype: oci.bds.models.BdsClusterVersionSummary + """ + return self._bds_cluster_version_summary + + @bds_cluster_version_summary.setter + def bds_cluster_version_summary(self, bds_cluster_version_summary): + """ + Sets the bds_cluster_version_summary of this CreateBdsInstanceDetails. + + :param bds_cluster_version_summary: The bds_cluster_version_summary of this CreateBdsInstanceDetails. + :type: oci.bds.models.BdsClusterVersionSummary + """ + self._bds_cluster_version_summary = bds_cluster_version_summary + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/create_identity_configuration_details.py b/src/oci/bds/models/create_identity_configuration_details.py new file mode 100644 index 0000000000..6b33723b73 --- /dev/null +++ b/src/oci/bds/models/create_identity_configuration_details.py @@ -0,0 +1,219 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateIdentityConfigurationDetails(object): + """ + Details for creating the identity configuration. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateIdentityConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this CreateIdentityConfigurationDetails. + :type cluster_admin_password: str + + :param display_name: + The value to assign to the display_name property of this CreateIdentityConfigurationDetails. + :type display_name: str + + :param identity_domain_id: + The value to assign to the identity_domain_id property of this CreateIdentityConfigurationDetails. + :type identity_domain_id: str + + :param confidential_application_id: + The value to assign to the confidential_application_id property of this CreateIdentityConfigurationDetails. + :type confidential_application_id: str + + :param upst_configuration_details: + The value to assign to the upst_configuration_details property of this CreateIdentityConfigurationDetails. + :type upst_configuration_details: oci.bds.models.UpstConfigurationDetails + + :param iam_user_sync_configuration_details: + The value to assign to the iam_user_sync_configuration_details property of this CreateIdentityConfigurationDetails. + :type iam_user_sync_configuration_details: oci.bds.models.IamUserSyncConfigurationDetails + + """ + self.swagger_types = { + 'cluster_admin_password': 'str', + 'display_name': 'str', + 'identity_domain_id': 'str', + 'confidential_application_id': 'str', + 'upst_configuration_details': 'UpstConfigurationDetails', + 'iam_user_sync_configuration_details': 'IamUserSyncConfigurationDetails' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword', + 'display_name': 'displayName', + 'identity_domain_id': 'identityDomainId', + 'confidential_application_id': 'confidentialApplicationId', + 'upst_configuration_details': 'upstConfigurationDetails', + 'iam_user_sync_configuration_details': 'iamUserSyncConfigurationDetails' + } + + self._cluster_admin_password = None + self._display_name = None + self._identity_domain_id = None + self._confidential_application_id = None + self._upst_configuration_details = None + self._iam_user_sync_configuration_details = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this CreateIdentityConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this CreateIdentityConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this CreateIdentityConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this CreateIdentityConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_password + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateIdentityConfigurationDetails. + Display name of the identity configuration, required for creating identity configuration. + + + :return: The display_name of this CreateIdentityConfigurationDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateIdentityConfigurationDetails. + Display name of the identity configuration, required for creating identity configuration. + + + :param display_name: The display_name of this CreateIdentityConfigurationDetails. + :type: str + """ + self._display_name = display_name + + @property + def identity_domain_id(self): + """ + **[Required]** Gets the identity_domain_id of this CreateIdentityConfigurationDetails. + Identity domain OCID to use for identity config, required for creating identity configuration + + + :return: The identity_domain_id of this CreateIdentityConfigurationDetails. + :rtype: str + """ + return self._identity_domain_id + + @identity_domain_id.setter + def identity_domain_id(self, identity_domain_id): + """ + Sets the identity_domain_id of this CreateIdentityConfigurationDetails. + Identity domain OCID to use for identity config, required for creating identity configuration + + + :param identity_domain_id: The identity_domain_id of this CreateIdentityConfigurationDetails. + :type: str + """ + self._identity_domain_id = identity_domain_id + + @property + def confidential_application_id(self): + """ + **[Required]** Gets the confidential_application_id of this CreateIdentityConfigurationDetails. + Identity domain confidential application ID for the identity config, required for creating identity configuration + + + :return: The confidential_application_id of this CreateIdentityConfigurationDetails. + :rtype: str + """ + return self._confidential_application_id + + @confidential_application_id.setter + def confidential_application_id(self, confidential_application_id): + """ + Sets the confidential_application_id of this CreateIdentityConfigurationDetails. + Identity domain confidential application ID for the identity config, required for creating identity configuration + + + :param confidential_application_id: The confidential_application_id of this CreateIdentityConfigurationDetails. + :type: str + """ + self._confidential_application_id = confidential_application_id + + @property + def upst_configuration_details(self): + """ + Gets the upst_configuration_details of this CreateIdentityConfigurationDetails. + + :return: The upst_configuration_details of this CreateIdentityConfigurationDetails. + :rtype: oci.bds.models.UpstConfigurationDetails + """ + return self._upst_configuration_details + + @upst_configuration_details.setter + def upst_configuration_details(self, upst_configuration_details): + """ + Sets the upst_configuration_details of this CreateIdentityConfigurationDetails. + + :param upst_configuration_details: The upst_configuration_details of this CreateIdentityConfigurationDetails. + :type: oci.bds.models.UpstConfigurationDetails + """ + self._upst_configuration_details = upst_configuration_details + + @property + def iam_user_sync_configuration_details(self): + """ + Gets the iam_user_sync_configuration_details of this CreateIdentityConfigurationDetails. + + :return: The iam_user_sync_configuration_details of this CreateIdentityConfigurationDetails. + :rtype: oci.bds.models.IamUserSyncConfigurationDetails + """ + return self._iam_user_sync_configuration_details + + @iam_user_sync_configuration_details.setter + def iam_user_sync_configuration_details(self, iam_user_sync_configuration_details): + """ + Sets the iam_user_sync_configuration_details of this CreateIdentityConfigurationDetails. + + :param iam_user_sync_configuration_details: The iam_user_sync_configuration_details of this CreateIdentityConfigurationDetails. + :type: oci.bds.models.IamUserSyncConfigurationDetails + """ + self._iam_user_sync_configuration_details = iam_user_sync_configuration_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/bds/models/deactivate_iam_user_sync_configuration_details.py b/src/oci/bds/models/deactivate_iam_user_sync_configuration_details.py new file mode 100644 index 0000000000..bddee5c999 --- /dev/null +++ b/src/oci/bds/models/deactivate_iam_user_sync_configuration_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DeactivateIamUserSyncConfigurationDetails(object): + """ + Details for deactivating an IAM user sync configuration + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeactivateIamUserSyncConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this DeactivateIamUserSyncConfigurationDetails. + :type cluster_admin_password: str + + """ + self.swagger_types = { + 'cluster_admin_password': 'str' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword' + } + + self._cluster_admin_password = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this DeactivateIamUserSyncConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this DeactivateIamUserSyncConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this DeactivateIamUserSyncConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this DeactivateIamUserSyncConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_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/bds/models/deactivate_upst_configuration_details.py b/src/oci/bds/models/deactivate_upst_configuration_details.py new file mode 100644 index 0000000000..f51f344e32 --- /dev/null +++ b/src/oci/bds/models/deactivate_upst_configuration_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DeactivateUpstConfigurationDetails(object): + """ + Details for deleting UPST config from cluster + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeactivateUpstConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this DeactivateUpstConfigurationDetails. + :type cluster_admin_password: str + + """ + self.swagger_types = { + 'cluster_admin_password': 'str' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword' + } + + self._cluster_admin_password = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this DeactivateUpstConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this DeactivateUpstConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this DeactivateUpstConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this DeactivateUpstConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_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/bds/models/domain_based_odh_patching_config.py b/src/oci/bds/models/domain_based_odh_patching_config.py index d0061d57b5..e3a9b64667 100644 --- a/src/oci/bds/models/domain_based_odh_patching_config.py +++ b/src/oci/bds/models/domain_based_odh_patching_config.py @@ -30,19 +30,26 @@ def __init__(self, **kwargs): The value to assign to the wait_time_between_domain_in_seconds property of this DomainBasedOdhPatchingConfig. :type wait_time_between_domain_in_seconds: int + :param tolerance_threshold_per_domain: + The value to assign to the tolerance_threshold_per_domain property of this DomainBasedOdhPatchingConfig. + :type tolerance_threshold_per_domain: int + """ self.swagger_types = { 'patching_config_strategy': 'str', - 'wait_time_between_domain_in_seconds': 'int' + 'wait_time_between_domain_in_seconds': 'int', + 'tolerance_threshold_per_domain': 'int' } self.attribute_map = { 'patching_config_strategy': 'patchingConfigStrategy', - 'wait_time_between_domain_in_seconds': 'waitTimeBetweenDomainInSeconds' + 'wait_time_between_domain_in_seconds': 'waitTimeBetweenDomainInSeconds', + 'tolerance_threshold_per_domain': 'toleranceThresholdPerDomain' } self._patching_config_strategy = None self._wait_time_between_domain_in_seconds = None + self._tolerance_threshold_per_domain = None self._patching_config_strategy = 'DOMAIN_BASED' @property @@ -69,6 +76,30 @@ def wait_time_between_domain_in_seconds(self, wait_time_between_domain_in_second """ self._wait_time_between_domain_in_seconds = wait_time_between_domain_in_seconds + @property + def tolerance_threshold_per_domain(self): + """ + Gets the tolerance_threshold_per_domain of this DomainBasedOdhPatchingConfig. + Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes. + + + :return: The tolerance_threshold_per_domain of this DomainBasedOdhPatchingConfig. + :rtype: int + """ + return self._tolerance_threshold_per_domain + + @tolerance_threshold_per_domain.setter + def tolerance_threshold_per_domain(self, tolerance_threshold_per_domain): + """ + Sets the tolerance_threshold_per_domain of this DomainBasedOdhPatchingConfig. + Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes. + + + :param tolerance_threshold_per_domain: The tolerance_threshold_per_domain of this DomainBasedOdhPatchingConfig. + :type: int + """ + self._tolerance_threshold_per_domain = tolerance_threshold_per_domain + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/iam_user_sync_configuration.py b/src/oci/bds/models/iam_user_sync_configuration.py new file mode 100644 index 0000000000..44605177ee --- /dev/null +++ b/src/oci/bds/models/iam_user_sync_configuration.py @@ -0,0 +1,197 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class IamUserSyncConfiguration(object): + """ + Information about the IAM user sync configuration. + """ + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a IamUserSyncConfiguration. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new IamUserSyncConfiguration object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_posix_attributes_addition_required: + The value to assign to the is_posix_attributes_addition_required property of this IamUserSyncConfiguration. + :type is_posix_attributes_addition_required: bool + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this IamUserSyncConfiguration. + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "UPDATING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param time_created: + The value to assign to the time_created property of this IamUserSyncConfiguration. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this IamUserSyncConfiguration. + :type time_updated: datetime + + """ + self.swagger_types = { + 'is_posix_attributes_addition_required': 'bool', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'is_posix_attributes_addition_required': 'isPosixAttributesAdditionRequired', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated' + } + + self._is_posix_attributes_addition_required = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + + @property + def is_posix_attributes_addition_required(self): + """ + **[Required]** Gets the is_posix_attributes_addition_required of this IamUserSyncConfiguration. + whether to append POSIX attributes to IAM users + + + :return: The is_posix_attributes_addition_required of this IamUserSyncConfiguration. + :rtype: bool + """ + return self._is_posix_attributes_addition_required + + @is_posix_attributes_addition_required.setter + def is_posix_attributes_addition_required(self, is_posix_attributes_addition_required): + """ + Sets the is_posix_attributes_addition_required of this IamUserSyncConfiguration. + whether to append POSIX attributes to IAM users + + + :param is_posix_attributes_addition_required: The is_posix_attributes_addition_required of this IamUserSyncConfiguration. + :type: bool + """ + self._is_posix_attributes_addition_required = is_posix_attributes_addition_required + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this IamUserSyncConfiguration. + Lifecycle state of the IAM user sync config + + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "UPDATING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this IamUserSyncConfiguration. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this IamUserSyncConfiguration. + Lifecycle state of the IAM user sync config + + + :param lifecycle_state: The lifecycle_state of this IamUserSyncConfiguration. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "DELETING", "UPDATING", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this IamUserSyncConfiguration. + Time when this IAM user sync config was created, shown as an RFC 3339 formatted datetime string. + + + :return: The time_created of this IamUserSyncConfiguration. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this IamUserSyncConfiguration. + Time when this IAM user sync config was created, shown as an RFC 3339 formatted datetime string. + + + :param time_created: The time_created of this IamUserSyncConfiguration. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this IamUserSyncConfiguration. + Time when this IAM user sync config was updated, shown as an RFC 3339 formatted datetime string. + + + :return: The time_updated of this IamUserSyncConfiguration. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this IamUserSyncConfiguration. + Time when this IAM user sync config was updated, shown as an RFC 3339 formatted datetime string. + + + :param time_updated: The time_updated of this IamUserSyncConfiguration. + :type: datetime + """ + self._time_updated = time_updated + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/iam_user_sync_configuration_details.py b/src/oci/bds/models/iam_user_sync_configuration_details.py new file mode 100644 index 0000000000..4a52da5396 --- /dev/null +++ b/src/oci/bds/models/iam_user_sync_configuration_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class IamUserSyncConfigurationDetails(object): + """ + Details for activating/updating an IAM user sync configuration + """ + + def __init__(self, **kwargs): + """ + Initializes a new IamUserSyncConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_posix_attributes_addition_required: + The value to assign to the is_posix_attributes_addition_required property of this IamUserSyncConfigurationDetails. + :type is_posix_attributes_addition_required: bool + + """ + self.swagger_types = { + 'is_posix_attributes_addition_required': 'bool' + } + + self.attribute_map = { + 'is_posix_attributes_addition_required': 'isPosixAttributesAdditionRequired' + } + + self._is_posix_attributes_addition_required = None + + @property + def is_posix_attributes_addition_required(self): + """ + Gets the is_posix_attributes_addition_required of this IamUserSyncConfigurationDetails. + whether posix attribute needs to be appended to users, required for updating IAM user sync configuration + + + :return: The is_posix_attributes_addition_required of this IamUserSyncConfigurationDetails. + :rtype: bool + """ + return self._is_posix_attributes_addition_required + + @is_posix_attributes_addition_required.setter + def is_posix_attributes_addition_required(self, is_posix_attributes_addition_required): + """ + Sets the is_posix_attributes_addition_required of this IamUserSyncConfigurationDetails. + whether posix attribute needs to be appended to users, required for updating IAM user sync configuration + + + :param is_posix_attributes_addition_required: The is_posix_attributes_addition_required of this IamUserSyncConfigurationDetails. + :type: bool + """ + self._is_posix_attributes_addition_required = is_posix_attributes_addition_required + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/identity_configuration.py b/src/oci/bds/models/identity_configuration.py new file mode 100644 index 0000000000..c3528d1baf --- /dev/null +++ b/src/oci/bds/models/identity_configuration.py @@ -0,0 +1,328 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class IdentityConfiguration(object): + """ + Details about the identity configuration + """ + + #: A constant which can be used with the lifecycle_state property of a IdentityConfiguration. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a IdentityConfiguration. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + def __init__(self, **kwargs): + """ + Initializes a new IdentityConfiguration 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 IdentityConfiguration. + :type id: str + + :param display_name: + The value to assign to the display_name property of this IdentityConfiguration. + :type display_name: str + + :param identity_domain_id: + The value to assign to the identity_domain_id property of this IdentityConfiguration. + :type identity_domain_id: str + + :param confidential_application_id: + The value to assign to the confidential_application_id property of this IdentityConfiguration. + :type confidential_application_id: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this IdentityConfiguration. + Allowed values for this property are: "ACTIVE", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param time_created: + The value to assign to the time_created property of this IdentityConfiguration. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this IdentityConfiguration. + :type time_updated: datetime + + :param iam_user_sync_configuration: + The value to assign to the iam_user_sync_configuration property of this IdentityConfiguration. + :type iam_user_sync_configuration: oci.bds.models.IamUserSyncConfiguration + + :param upst_configuration: + The value to assign to the upst_configuration property of this IdentityConfiguration. + :type upst_configuration: oci.bds.models.UpstConfiguration + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'identity_domain_id': 'str', + 'confidential_application_id': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'iam_user_sync_configuration': 'IamUserSyncConfiguration', + 'upst_configuration': 'UpstConfiguration' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'identity_domain_id': 'identityDomainId', + 'confidential_application_id': 'confidentialApplicationId', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'iam_user_sync_configuration': 'iamUserSyncConfiguration', + 'upst_configuration': 'upstConfiguration' + } + + self._id = None + self._display_name = None + self._identity_domain_id = None + self._confidential_application_id = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._iam_user_sync_configuration = None + self._upst_configuration = None + + @property + def id(self): + """ + **[Required]** Gets the id of this IdentityConfiguration. + The id of the UPST config + + + :return: The id of this IdentityConfiguration. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this IdentityConfiguration. + The id of the UPST config + + + :param id: The id of this IdentityConfiguration. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this IdentityConfiguration. + the display name of the identity configuration + + + :return: The display_name of this IdentityConfiguration. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this IdentityConfiguration. + the display name of the identity configuration + + + :param display_name: The display_name of this IdentityConfiguration. + :type: str + """ + self._display_name = display_name + + @property + def identity_domain_id(self): + """ + **[Required]** Gets the identity_domain_id of this IdentityConfiguration. + Identity domain to use for identity config + + + :return: The identity_domain_id of this IdentityConfiguration. + :rtype: str + """ + return self._identity_domain_id + + @identity_domain_id.setter + def identity_domain_id(self, identity_domain_id): + """ + Sets the identity_domain_id of this IdentityConfiguration. + Identity domain to use for identity config + + + :param identity_domain_id: The identity_domain_id of this IdentityConfiguration. + :type: str + """ + self._identity_domain_id = identity_domain_id + + @property + def confidential_application_id(self): + """ + **[Required]** Gets the confidential_application_id of this IdentityConfiguration. + identity domain confidential application ID for the identity config + + + :return: The confidential_application_id of this IdentityConfiguration. + :rtype: str + """ + return self._confidential_application_id + + @confidential_application_id.setter + def confidential_application_id(self, confidential_application_id): + """ + Sets the confidential_application_id of this IdentityConfiguration. + identity domain confidential application ID for the identity config + + + :param confidential_application_id: The confidential_application_id of this IdentityConfiguration. + :type: str + """ + self._confidential_application_id = confidential_application_id + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this IdentityConfiguration. + Lifecycle state of the identity configuration + + Allowed values for this property are: "ACTIVE", "DELETED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this IdentityConfiguration. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this IdentityConfiguration. + Lifecycle state of the identity configuration + + + :param lifecycle_state: The lifecycle_state of this IdentityConfiguration. + :type: str + """ + allowed_values = ["ACTIVE", "DELETED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this IdentityConfiguration. + Time when this identity configuration was created, shown as an RFC 3339 formatted datetime string. + + + :return: The time_created of this IdentityConfiguration. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this IdentityConfiguration. + Time when this identity configuration was created, shown as an RFC 3339 formatted datetime string. + + + :param time_created: The time_created of this IdentityConfiguration. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this IdentityConfiguration. + Time when this identity configuration config was updated, shown as an RFC 3339 formatted datetime string. + + + :return: The time_updated of this IdentityConfiguration. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this IdentityConfiguration. + Time when this identity configuration config was updated, shown as an RFC 3339 formatted datetime string. + + + :param time_updated: The time_updated of this IdentityConfiguration. + :type: datetime + """ + self._time_updated = time_updated + + @property + def iam_user_sync_configuration(self): + """ + Gets the iam_user_sync_configuration of this IdentityConfiguration. + + :return: The iam_user_sync_configuration of this IdentityConfiguration. + :rtype: oci.bds.models.IamUserSyncConfiguration + """ + return self._iam_user_sync_configuration + + @iam_user_sync_configuration.setter + def iam_user_sync_configuration(self, iam_user_sync_configuration): + """ + Sets the iam_user_sync_configuration of this IdentityConfiguration. + + :param iam_user_sync_configuration: The iam_user_sync_configuration of this IdentityConfiguration. + :type: oci.bds.models.IamUserSyncConfiguration + """ + self._iam_user_sync_configuration = iam_user_sync_configuration + + @property + def upst_configuration(self): + """ + Gets the upst_configuration of this IdentityConfiguration. + + :return: The upst_configuration of this IdentityConfiguration. + :rtype: oci.bds.models.UpstConfiguration + """ + return self._upst_configuration + + @upst_configuration.setter + def upst_configuration(self, upst_configuration): + """ + Sets the upst_configuration of this IdentityConfiguration. + + :param upst_configuration: The upst_configuration of this IdentityConfiguration. + :type: oci.bds.models.UpstConfiguration + """ + self._upst_configuration = upst_configuration + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/identity_configuration_summary.py b/src/oci/bds/models/identity_configuration_summary.py new file mode 100644 index 0000000000..361c129e32 --- /dev/null +++ b/src/oci/bds/models/identity_configuration_summary.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class IdentityConfigurationSummary(object): + """ + Summary of the identity config + """ + + def __init__(self, **kwargs): + """ + Initializes a new IdentityConfigurationSummary 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 IdentityConfigurationSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this IdentityConfigurationSummary. + :type display_name: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this IdentityConfigurationSummary. + :type lifecycle_state: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'lifecycle_state': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'lifecycle_state': 'lifecycleState' + } + + self._id = None + self._display_name = None + self._lifecycle_state = None + + @property + def id(self): + """ + **[Required]** Gets the id of this IdentityConfigurationSummary. + The id of the identity config + + + :return: The id of this IdentityConfigurationSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this IdentityConfigurationSummary. + The id of the identity config + + + :param id: The id of this IdentityConfigurationSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this IdentityConfigurationSummary. + Display name of the identity config + + + :return: The display_name of this IdentityConfigurationSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this IdentityConfigurationSummary. + Display name of the identity config + + + :param display_name: The display_name of this IdentityConfigurationSummary. + :type: str + """ + self._display_name = display_name + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this IdentityConfigurationSummary. + Lifecycle state of the identity config + + + :return: The lifecycle_state of this IdentityConfigurationSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this IdentityConfigurationSummary. + Lifecycle state of the identity config + + + :param lifecycle_state: The lifecycle_state of this IdentityConfigurationSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/node_type_shape_config.py b/src/oci/bds/models/node_type_shape_config.py new file mode 100644 index 0000000000..7572844d36 --- /dev/null +++ b/src/oci/bds/models/node_type_shape_config.py @@ -0,0 +1,105 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NodeTypeShapeConfig(object): + """ + Shape configuration at node type level. Start cluster will start all nodes as is if no config is specified. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NodeTypeShapeConfig object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param node_type: + The value to assign to the node_type property of this NodeTypeShapeConfig. + :type node_type: str + + :param shape: + The value to assign to the shape property of this NodeTypeShapeConfig. + :type shape: str + + """ + self.swagger_types = { + 'node_type': 'str', + 'shape': 'str' + } + + self.attribute_map = { + 'node_type': 'nodeType', + 'shape': 'shape' + } + + self._node_type = None + self._shape = None + + @property + def node_type(self): + """ + **[Required]** Gets the node_type of this NodeTypeShapeConfig. + The Big Data Service cluster node type. + + + :return: The node_type of this NodeTypeShapeConfig. + :rtype: str + """ + return self._node_type + + @node_type.setter + def node_type(self, node_type): + """ + Sets the node_type of this NodeTypeShapeConfig. + The Big Data Service cluster node type. + + + :param node_type: The node_type of this NodeTypeShapeConfig. + :type: str + """ + self._node_type = node_type + + @property + def shape(self): + """ + **[Required]** Gets the shape of this NodeTypeShapeConfig. + Shape of the node. This has to be specified when starting the cluster. Defaults to wn0 for homogeneous clusters and remains empty for heterogeneous clusters. + If provided, all nodes in the node type will adopt the specified shape; otherwise, nodes retain their original shapes. + + + :return: The shape of this NodeTypeShapeConfig. + :rtype: str + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this NodeTypeShapeConfig. + Shape of the node. This has to be specified when starting the cluster. Defaults to wn0 for homogeneous clusters and remains empty for heterogeneous clusters. + If provided, all nodes in the node type will adopt the specified shape; otherwise, nodes retain their original shapes. + + + :param shape: The shape of this NodeTypeShapeConfig. + :type: str + """ + self._shape = shape + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/refresh_confidential_application_details.py b/src/oci/bds/models/refresh_confidential_application_details.py new file mode 100644 index 0000000000..2402142662 --- /dev/null +++ b/src/oci/bds/models/refresh_confidential_application_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RefreshConfidentialApplicationDetails(object): + """ + Details for refreshing confidential application + """ + + def __init__(self, **kwargs): + """ + Initializes a new RefreshConfidentialApplicationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this RefreshConfidentialApplicationDetails. + :type cluster_admin_password: str + + """ + self.swagger_types = { + 'cluster_admin_password': 'str' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword' + } + + self._cluster_admin_password = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this RefreshConfidentialApplicationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this RefreshConfidentialApplicationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this RefreshConfidentialApplicationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this RefreshConfidentialApplicationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_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/bds/models/refresh_upst_token_exchange_keytab_details.py b/src/oci/bds/models/refresh_upst_token_exchange_keytab_details.py new file mode 100644 index 0000000000..9264eb9acd --- /dev/null +++ b/src/oci/bds/models/refresh_upst_token_exchange_keytab_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RefreshUpstTokenExchangeKeytabDetails(object): + """ + Details for refreshing User Principal Session (UPST) token exchange keytab + """ + + def __init__(self, **kwargs): + """ + Initializes a new RefreshUpstTokenExchangeKeytabDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this RefreshUpstTokenExchangeKeytabDetails. + :type cluster_admin_password: str + + """ + self.swagger_types = { + 'cluster_admin_password': 'str' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword' + } + + self._cluster_admin_password = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this RefreshUpstTokenExchangeKeytabDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this RefreshUpstTokenExchangeKeytabDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this RefreshUpstTokenExchangeKeytabDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this RefreshUpstTokenExchangeKeytabDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_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/bds/models/start_bds_instance_details.py b/src/oci/bds/models/start_bds_instance_details.py index 82a2a0b4cd..87cd1bb931 100644 --- a/src/oci/bds/models/start_bds_instance_details.py +++ b/src/oci/bds/models/start_bds_instance_details.py @@ -24,16 +24,23 @@ def __init__(self, **kwargs): The value to assign to the cluster_admin_password property of this StartBdsInstanceDetails. :type cluster_admin_password: str + :param start_cluster_shape_configs: + The value to assign to the start_cluster_shape_configs property of this StartBdsInstanceDetails. + :type start_cluster_shape_configs: oci.bds.models.StartClusterShapeConfigs + """ self.swagger_types = { - 'cluster_admin_password': 'str' + 'cluster_admin_password': 'str', + 'start_cluster_shape_configs': 'StartClusterShapeConfigs' } self.attribute_map = { - 'cluster_admin_password': 'clusterAdminPassword' + 'cluster_admin_password': 'clusterAdminPassword', + 'start_cluster_shape_configs': 'startClusterShapeConfigs' } self._cluster_admin_password = None + self._start_cluster_shape_configs = None @property def cluster_admin_password(self): @@ -59,6 +66,26 @@ def cluster_admin_password(self, cluster_admin_password): """ self._cluster_admin_password = cluster_admin_password + @property + def start_cluster_shape_configs(self): + """ + Gets the start_cluster_shape_configs of this StartBdsInstanceDetails. + + :return: The start_cluster_shape_configs of this StartBdsInstanceDetails. + :rtype: oci.bds.models.StartClusterShapeConfigs + """ + return self._start_cluster_shape_configs + + @start_cluster_shape_configs.setter + def start_cluster_shape_configs(self, start_cluster_shape_configs): + """ + Sets the start_cluster_shape_configs of this StartBdsInstanceDetails. + + :param start_cluster_shape_configs: The start_cluster_shape_configs of this StartBdsInstanceDetails. + :type: oci.bds.models.StartClusterShapeConfigs + """ + self._start_cluster_shape_configs = start_cluster_shape_configs + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/start_cluster_shape_configs.py b/src/oci/bds/models/start_cluster_shape_configs.py new file mode 100644 index 0000000000..4f79919a86 --- /dev/null +++ b/src/oci/bds/models/start_cluster_shape_configs.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StartClusterShapeConfigs(object): + """ + The shape configuration to be used to start the cluster. If the value is not set, the start cluster operation will try to start the cluster as is. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StartClusterShapeConfigs object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param node_type_shape_configs: + The value to assign to the node_type_shape_configs property of this StartClusterShapeConfigs. + :type node_type_shape_configs: list[oci.bds.models.NodeTypeShapeConfig] + + """ + self.swagger_types = { + 'node_type_shape_configs': 'list[NodeTypeShapeConfig]' + } + + self.attribute_map = { + 'node_type_shape_configs': 'nodeTypeShapeConfigs' + } + + self._node_type_shape_configs = None + + @property + def node_type_shape_configs(self): + """ + **[Required]** Gets the node_type_shape_configs of this StartClusterShapeConfigs. + Shape configurations for each node type. + + + :return: The node_type_shape_configs of this StartClusterShapeConfigs. + :rtype: list[oci.bds.models.NodeTypeShapeConfig] + """ + return self._node_type_shape_configs + + @node_type_shape_configs.setter + def node_type_shape_configs(self, node_type_shape_configs): + """ + Sets the node_type_shape_configs of this StartClusterShapeConfigs. + Shape configurations for each node type. + + + :param node_type_shape_configs: The node_type_shape_configs of this StartClusterShapeConfigs. + :type: list[oci.bds.models.NodeTypeShapeConfig] + """ + self._node_type_shape_configs = node_type_shape_configs + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/update_bds_instance_details.py b/src/oci/bds/models/update_bds_instance_details.py index 9e142a5e53..b5a9e5c2d2 100644 --- a/src/oci/bds/models/update_bds_instance_details.py +++ b/src/oci/bds/models/update_bds_instance_details.py @@ -40,13 +40,18 @@ def __init__(self, **kwargs): The value to assign to the kms_key_id property of this UpdateBdsInstanceDetails. :type kms_key_id: str + :param network_config: + The value to assign to the network_config property of this UpdateBdsInstanceDetails. + :type network_config: oci.bds.models.NetworkConfig + """ self.swagger_types = { 'display_name': 'str', 'bootstrap_script_url': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', - 'kms_key_id': 'str' + 'kms_key_id': 'str', + 'network_config': 'NetworkConfig' } self.attribute_map = { @@ -54,7 +59,8 @@ def __init__(self, **kwargs): 'bootstrap_script_url': 'bootstrapScriptUrl', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', - 'kms_key_id': 'kmsKeyId' + 'kms_key_id': 'kmsKeyId', + 'network_config': 'networkConfig' } self._display_name = None @@ -62,6 +68,7 @@ def __init__(self, **kwargs): self._freeform_tags = None self._defined_tags = None self._kms_key_id = None + self._network_config = None @property def display_name(self): @@ -187,6 +194,26 @@ def kms_key_id(self, kms_key_id): """ self._kms_key_id = kms_key_id + @property + def network_config(self): + """ + Gets the network_config of this UpdateBdsInstanceDetails. + + :return: The network_config of this UpdateBdsInstanceDetails. + :rtype: oci.bds.models.NetworkConfig + """ + return self._network_config + + @network_config.setter + def network_config(self, network_config): + """ + Sets the network_config of this UpdateBdsInstanceDetails. + + :param network_config: The network_config of this UpdateBdsInstanceDetails. + :type: oci.bds.models.NetworkConfig + """ + self._network_config = network_config + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/bds/models/update_identity_configuration_details.py b/src/oci/bds/models/update_identity_configuration_details.py new file mode 100644 index 0000000000..a26447a5e3 --- /dev/null +++ b/src/oci/bds/models/update_identity_configuration_details.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateIdentityConfigurationDetails(object): + """ + Details for updating identity config on the cluster + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateIdentityConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param cluster_admin_password: + The value to assign to the cluster_admin_password property of this UpdateIdentityConfigurationDetails. + :type cluster_admin_password: str + + :param upst_configuration_details: + The value to assign to the upst_configuration_details property of this UpdateIdentityConfigurationDetails. + :type upst_configuration_details: oci.bds.models.UpstConfigurationDetails + + :param iam_user_sync_configuration_details: + The value to assign to the iam_user_sync_configuration_details property of this UpdateIdentityConfigurationDetails. + :type iam_user_sync_configuration_details: oci.bds.models.IamUserSyncConfigurationDetails + + """ + self.swagger_types = { + 'cluster_admin_password': 'str', + 'upst_configuration_details': 'UpstConfigurationDetails', + 'iam_user_sync_configuration_details': 'IamUserSyncConfigurationDetails' + } + + self.attribute_map = { + 'cluster_admin_password': 'clusterAdminPassword', + 'upst_configuration_details': 'upstConfigurationDetails', + 'iam_user_sync_configuration_details': 'iamUserSyncConfigurationDetails' + } + + self._cluster_admin_password = None + self._upst_configuration_details = None + self._iam_user_sync_configuration_details = None + + @property + def cluster_admin_password(self): + """ + **[Required]** Gets the cluster_admin_password of this UpdateIdentityConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :return: The cluster_admin_password of this UpdateIdentityConfigurationDetails. + :rtype: str + """ + return self._cluster_admin_password + + @cluster_admin_password.setter + def cluster_admin_password(self, cluster_admin_password): + """ + Sets the cluster_admin_password of this UpdateIdentityConfigurationDetails. + Base-64 encoded password for the cluster admin user. + + + :param cluster_admin_password: The cluster_admin_password of this UpdateIdentityConfigurationDetails. + :type: str + """ + self._cluster_admin_password = cluster_admin_password + + @property + def upst_configuration_details(self): + """ + Gets the upst_configuration_details of this UpdateIdentityConfigurationDetails. + + :return: The upst_configuration_details of this UpdateIdentityConfigurationDetails. + :rtype: oci.bds.models.UpstConfigurationDetails + """ + return self._upst_configuration_details + + @upst_configuration_details.setter + def upst_configuration_details(self, upst_configuration_details): + """ + Sets the upst_configuration_details of this UpdateIdentityConfigurationDetails. + + :param upst_configuration_details: The upst_configuration_details of this UpdateIdentityConfigurationDetails. + :type: oci.bds.models.UpstConfigurationDetails + """ + self._upst_configuration_details = upst_configuration_details + + @property + def iam_user_sync_configuration_details(self): + """ + Gets the iam_user_sync_configuration_details of this UpdateIdentityConfigurationDetails. + + :return: The iam_user_sync_configuration_details of this UpdateIdentityConfigurationDetails. + :rtype: oci.bds.models.IamUserSyncConfigurationDetails + """ + return self._iam_user_sync_configuration_details + + @iam_user_sync_configuration_details.setter + def iam_user_sync_configuration_details(self, iam_user_sync_configuration_details): + """ + Sets the iam_user_sync_configuration_details of this UpdateIdentityConfigurationDetails. + + :param iam_user_sync_configuration_details: The iam_user_sync_configuration_details of this UpdateIdentityConfigurationDetails. + :type: oci.bds.models.IamUserSyncConfigurationDetails + """ + self._iam_user_sync_configuration_details = iam_user_sync_configuration_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/bds/models/upst_configuration.py b/src/oci/bds/models/upst_configuration.py new file mode 100644 index 0000000000..b4ef84b1f4 --- /dev/null +++ b/src/oci/bds/models/upst_configuration.py @@ -0,0 +1,352 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpstConfiguration(object): + """ + Information about the UPST configuration. + """ + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a UpstConfiguration. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new UpstConfiguration object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vault_id: + The value to assign to the vault_id property of this UpstConfiguration. + :type vault_id: str + + :param master_encryption_key_id: + The value to assign to the master_encryption_key_id property of this UpstConfiguration. + :type master_encryption_key_id: str + + :param secret_id: + The value to assign to the secret_id property of this UpstConfiguration. + :type secret_id: str + + :param time_token_exchange_keytab_last_refreshed: + The value to assign to the time_token_exchange_keytab_last_refreshed property of this UpstConfiguration. + :type time_token_exchange_keytab_last_refreshed: datetime + + :param token_exchange_principal_name: + The value to assign to the token_exchange_principal_name property of this UpstConfiguration. + :type token_exchange_principal_name: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this UpstConfiguration. + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "INACTIVE", "UPDATING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param time_created: + The value to assign to the time_created property of this UpstConfiguration. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this UpstConfiguration. + :type time_updated: datetime + + :param keytab_content: + The value to assign to the keytab_content property of this UpstConfiguration. + :type keytab_content: str + + """ + self.swagger_types = { + 'vault_id': 'str', + 'master_encryption_key_id': 'str', + 'secret_id': 'str', + 'time_token_exchange_keytab_last_refreshed': 'datetime', + 'token_exchange_principal_name': 'str', + 'lifecycle_state': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'keytab_content': 'str' + } + + self.attribute_map = { + 'vault_id': 'vaultId', + 'master_encryption_key_id': 'masterEncryptionKeyId', + 'secret_id': 'secretId', + 'time_token_exchange_keytab_last_refreshed': 'timeTokenExchangeKeytabLastRefreshed', + 'token_exchange_principal_name': 'tokenExchangePrincipalName', + 'lifecycle_state': 'lifecycleState', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'keytab_content': 'keytabContent' + } + + self._vault_id = None + self._master_encryption_key_id = None + self._secret_id = None + self._time_token_exchange_keytab_last_refreshed = None + self._token_exchange_principal_name = None + self._lifecycle_state = None + self._time_created = None + self._time_updated = None + self._keytab_content = None + + @property + def vault_id(self): + """ + **[Required]** Gets the vault_id of this UpstConfiguration. + The instance OCID of the node, which is the resource from which the node backup was acquired. + + + :return: The vault_id of this UpstConfiguration. + :rtype: str + """ + return self._vault_id + + @vault_id.setter + def vault_id(self, vault_id): + """ + Sets the vault_id of this UpstConfiguration. + The instance OCID of the node, which is the resource from which the node backup was acquired. + + + :param vault_id: The vault_id of this UpstConfiguration. + :type: str + """ + self._vault_id = vault_id + + @property + def master_encryption_key_id(self): + """ + **[Required]** Gets the master_encryption_key_id of this UpstConfiguration. + Master Encryption key used for encrypting token exchange keytab. + + + :return: The master_encryption_key_id of this UpstConfiguration. + :rtype: str + """ + return self._master_encryption_key_id + + @master_encryption_key_id.setter + def master_encryption_key_id(self, master_encryption_key_id): + """ + Sets the master_encryption_key_id of this UpstConfiguration. + Master Encryption key used for encrypting token exchange keytab. + + + :param master_encryption_key_id: The master_encryption_key_id of this UpstConfiguration. + :type: str + """ + self._master_encryption_key_id = master_encryption_key_id + + @property + def secret_id(self): + """ + **[Required]** Gets the secret_id of this UpstConfiguration. + Secret ID for token exchange keytab + + + :return: The secret_id of this UpstConfiguration. + :rtype: str + """ + return self._secret_id + + @secret_id.setter + def secret_id(self, secret_id): + """ + Sets the secret_id of this UpstConfiguration. + Secret ID for token exchange keytab + + + :param secret_id: The secret_id of this UpstConfiguration. + :type: str + """ + self._secret_id = secret_id + + @property + def time_token_exchange_keytab_last_refreshed(self): + """ + **[Required]** Gets the time_token_exchange_keytab_last_refreshed of this UpstConfiguration. + Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. + + + :return: The time_token_exchange_keytab_last_refreshed of this UpstConfiguration. + :rtype: datetime + """ + return self._time_token_exchange_keytab_last_refreshed + + @time_token_exchange_keytab_last_refreshed.setter + def time_token_exchange_keytab_last_refreshed(self, time_token_exchange_keytab_last_refreshed): + """ + Sets the time_token_exchange_keytab_last_refreshed of this UpstConfiguration. + Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. + + + :param time_token_exchange_keytab_last_refreshed: The time_token_exchange_keytab_last_refreshed of this UpstConfiguration. + :type: datetime + """ + self._time_token_exchange_keytab_last_refreshed = time_token_exchange_keytab_last_refreshed + + @property + def token_exchange_principal_name(self): + """ + Gets the token_exchange_principal_name of this UpstConfiguration. + Token exchange kerberos Principal name in cluster + + + :return: The token_exchange_principal_name of this UpstConfiguration. + :rtype: str + """ + return self._token_exchange_principal_name + + @token_exchange_principal_name.setter + def token_exchange_principal_name(self, token_exchange_principal_name): + """ + Sets the token_exchange_principal_name of this UpstConfiguration. + Token exchange kerberos Principal name in cluster + + + :param token_exchange_principal_name: The token_exchange_principal_name of this UpstConfiguration. + :type: str + """ + self._token_exchange_principal_name = token_exchange_principal_name + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this UpstConfiguration. + Lifecycle state of the UPST config + + Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "INACTIVE", "UPDATING", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this UpstConfiguration. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this UpstConfiguration. + Lifecycle state of the UPST config + + + :param lifecycle_state: The lifecycle_state of this UpstConfiguration. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "DELETING", "INACTIVE", "UPDATING", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this UpstConfiguration. + Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. + + + :return: The time_created of this UpstConfiguration. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this UpstConfiguration. + Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. + + + :param time_created: The time_created of this UpstConfiguration. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this UpstConfiguration. + Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. + + + :return: The time_updated of this UpstConfiguration. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this UpstConfiguration. + Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. + + + :param time_updated: The time_updated of this UpstConfiguration. + :type: datetime + """ + self._time_updated = time_updated + + @property + def keytab_content(self): + """ + **[Required]** Gets the keytab_content of this UpstConfiguration. + The kerberos keytab content used for creating identity propagation trust config, in base64 format + + + :return: The keytab_content of this UpstConfiguration. + :rtype: str + """ + return self._keytab_content + + @keytab_content.setter + def keytab_content(self, keytab_content): + """ + Sets the keytab_content of this UpstConfiguration. + The kerberos keytab content used for creating identity propagation trust config, in base64 format + + + :param keytab_content: The keytab_content of this UpstConfiguration. + :type: str + """ + self._keytab_content = keytab_content + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/upst_configuration_details.py b/src/oci/bds/models/upst_configuration_details.py new file mode 100644 index 0000000000..11b65c9552 --- /dev/null +++ b/src/oci/bds/models/upst_configuration_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpstConfigurationDetails(object): + """ + Details for activating/updating UPST config on the cluster + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpstConfigurationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vault_id: + The value to assign to the vault_id property of this UpstConfigurationDetails. + :type vault_id: str + + :param master_encryption_key_id: + The value to assign to the master_encryption_key_id property of this UpstConfigurationDetails. + :type master_encryption_key_id: str + + """ + self.swagger_types = { + 'vault_id': 'str', + 'master_encryption_key_id': 'str' + } + + self.attribute_map = { + 'vault_id': 'vaultId', + 'master_encryption_key_id': 'masterEncryptionKeyId' + } + + self._vault_id = None + self._master_encryption_key_id = None + + @property + def vault_id(self): + """ + Gets the vault_id of this UpstConfigurationDetails. + OCID of the vault to store token exchange service principal keyta, required for activating UPST config + + + :return: The vault_id of this UpstConfigurationDetails. + :rtype: str + """ + return self._vault_id + + @vault_id.setter + def vault_id(self, vault_id): + """ + Sets the vault_id of this UpstConfigurationDetails. + OCID of the vault to store token exchange service principal keyta, required for activating UPST config + + + :param vault_id: The vault_id of this UpstConfigurationDetails. + :type: str + """ + self._vault_id = vault_id + + @property + def master_encryption_key_id(self): + """ + Gets the master_encryption_key_id of this UpstConfigurationDetails. + OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config + + + :return: The master_encryption_key_id of this UpstConfigurationDetails. + :rtype: str + """ + return self._master_encryption_key_id + + @master_encryption_key_id.setter + def master_encryption_key_id(self, master_encryption_key_id): + """ + Sets the master_encryption_key_id of this UpstConfigurationDetails. + OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config + + + :param master_encryption_key_id: The master_encryption_key_id of this UpstConfigurationDetails. + :type: str + """ + self._master_encryption_key_id = master_encryption_key_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/bds/models/work_request.py b/src/oci/bds/models/work_request.py index a64b655b8c..266e3a8272 100644 --- a/src/oci/bds/models/work_request.py +++ b/src/oci/bds/models/work_request.py @@ -211,6 +211,42 @@ class WorkRequest(object): #: This constant has a value of "REFRESH_RESOURCE_PRINCIPAL" OPERATION_TYPE_REFRESH_RESOURCE_PRINCIPAL = "REFRESH_RESOURCE_PRINCIPAL" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_IDENTITY_CONFIG" + OPERATION_TYPE_CREATE_IDENTITY_CONFIG = "CREATE_IDENTITY_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_IDENTITY_CONFIG" + OPERATION_TYPE_DELETE_IDENTITY_CONFIG = "DELETE_IDENTITY_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_IDENTITY_CONFIG" + OPERATION_TYPE_UPDATE_IDENTITY_CONFIG = "UPDATE_IDENTITY_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "ACTIVATE_UPST_CONFIG" + OPERATION_TYPE_ACTIVATE_UPST_CONFIG = "ACTIVATE_UPST_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DEACTIVATE_UPST_CONFIG" + OPERATION_TYPE_DEACTIVATE_UPST_CONFIG = "DEACTIVATE_UPST_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "REFRESH_CONFIDENTIAL_APPLICATION" + OPERATION_TYPE_REFRESH_CONFIDENTIAL_APPLICATION = "REFRESH_CONFIDENTIAL_APPLICATION" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "REFRESH_TOKEN_EXCHANGE_KEYTAB" + OPERATION_TYPE_REFRESH_TOKEN_EXCHANGE_KEYTAB = "REFRESH_TOKEN_EXCHANGE_KEYTAB" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "ACTIVATE_IAM_USER_SYNC_CONFIG" + OPERATION_TYPE_ACTIVATE_IAM_USER_SYNC_CONFIG = "ACTIVATE_IAM_USER_SYNC_CONFIG" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DEACTIVATE_IAM_USER_SYNC_CONFIG" + OPERATION_TYPE_DEACTIVATE_IAM_USER_SYNC_CONFIG = "DEACTIVATE_IAM_USER_SYNC_CONFIG" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -250,7 +286,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_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL", "CREATE_IDENTITY_CONFIG", "DELETE_IDENTITY_CONFIG", "UPDATE_IDENTITY_CONFIG", "ACTIVATE_UPST_CONFIG", "DEACTIVATE_UPST_CONFIG", "REFRESH_CONFIDENTIAL_APPLICATION", "REFRESH_TOKEN_EXCHANGE_KEYTAB", "ACTIVATE_IAM_USER_SYNC_CONFIG", "DEACTIVATE_IAM_USER_SYNC_CONFIG", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -369,7 +405,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The type of this work request. - Allowed values for this property are: "CREATE_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL", "CREATE_IDENTITY_CONFIG", "DELETE_IDENTITY_CONFIG", "UPDATE_IDENTITY_CONFIG", "ACTIVATE_UPST_CONFIG", "DEACTIVATE_UPST_CONFIG", "REFRESH_CONFIDENTIAL_APPLICATION", "REFRESH_TOKEN_EXCHANGE_KEYTAB", "ACTIVATE_IAM_USER_SYNC_CONFIG", "DEACTIVATE_IAM_USER_SYNC_CONFIG", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -388,7 +424,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL"] + allowed_values = ["CREATE_BDS", "UPDATE_BDS", "DELETE_BDS", "ADD_BLOCK_STORAGE", "ADD_MASTER_NODES", "ADD_UTILITY_NODES", "ADD_WORKER_NODES", "ADD_CLOUD_SQL", "REMOVE_CLOUD_SQL", "CHANGE_COMPARTMENT_FOR_BDS", "CHANGE_SHAPE", "UPDATE_INFRA", "RESTART_NODE", "REMOVE_NODE", "CREATE_AUTOSCALE_CONFIG", "UPDATE_AUTOSCALE_CONFIG", "DELETE_AUTOSCALE_CONFIG", "AUTOSCALE_CONFIG", "AUTOSCALE_RUN", "CREATE_API_KEY", "DELETE_API_KEY", "TEST_OBJECT_STORE_CONNECTION", "CREATE_METASTORE_CONFIG", "DELETE_METASTORE_CONFIG", "UPDATE_METASTORE_CONFIG", "ACTIVATE_METASTORE_CONFIG", "TEST_METASTORE_CONFIG", "PATCH_BDS", "PATCH_ODH", "PATCH_OS", "STOP_BDS", "START_BDS", "ADD_KAFKA", "REMOVE_KAFKA", "EXECUTE_BOOTSTRAP_SCRIPT", "ODH_SERVICE_CERTIFICATE_UPDATE", "CREATE_BACKUP_CONFIG", "UPDATE_BACKUP_CONFIG", "DELETE_BACKUP_CONFIG", "CREATE_NODE_REPLACE_CONFIG", "UPDATE_NODE_REPLACE_CONFIG", "DELETE_NODE_REPLACE_CONFIG", "BACKUP_NODES", "DELETE_NODE_BACKUP", "REPLACE_NODE", "CREATE_RESOURCE_PRINCIPAL_CONFIGURATION", "DELETE_RESOURCE_PRINCIPAL_CONFIGURATION", "UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION", "REFRESH_RESOURCE_PRINCIPAL", "CREATE_IDENTITY_CONFIG", "DELETE_IDENTITY_CONFIG", "UPDATE_IDENTITY_CONFIG", "ACTIVATE_UPST_CONFIG", "DEACTIVATE_UPST_CONFIG", "REFRESH_CONFIDENTIAL_APPLICATION", "REFRESH_TOKEN_EXCHANGE_KEYTAB", "ACTIVATE_IAM_USER_SYNC_CONFIG", "DEACTIVATE_IAM_USER_SYNC_CONFIG"] 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/blockchain_platform.py b/src/oci/blockchain/models/blockchain_platform.py index 1230159e57..bf6c1de7ee 100644 --- a/src/oci/blockchain/models/blockchain_platform.py +++ b/src/oci/blockchain/models/blockchain_platform.py @@ -47,6 +47,18 @@ class BlockchainPlatform(object): #: This constant has a value of "ENTERPRISE_CUSTOM" COMPUTE_SHAPE_ENTERPRISE_CUSTOM = "ENTERPRISE_CUSTOM" + #: A constant which can be used with the compute_shape property of a BlockchainPlatform. + #: This constant has a value of "DIGITAL_ASSETS_MEDIUM" + COMPUTE_SHAPE_DIGITAL_ASSETS_MEDIUM = "DIGITAL_ASSETS_MEDIUM" + + #: A constant which can be used with the compute_shape property of a BlockchainPlatform. + #: This constant has a value of "DIGITAL_ASSETS_LARGE" + COMPUTE_SHAPE_DIGITAL_ASSETS_LARGE = "DIGITAL_ASSETS_LARGE" + + #: A constant which can be used with the compute_shape property of a BlockchainPlatform. + #: This constant has a value of "DIGITAL_ASSETS_EXTRA_LARGE" + COMPUTE_SHAPE_DIGITAL_ASSETS_EXTRA_LARGE = "DIGITAL_ASSETS_EXTRA_LARGE" + #: A constant which can be used with the platform_shape_type property of a BlockchainPlatform. #: This constant has a value of "DEFAULT" PLATFORM_SHAPE_TYPE_DEFAULT = "DEFAULT" @@ -144,7 +156,7 @@ def __init__(self, **kwargs): :param compute_shape: The value to assign to the compute_shape property of this BlockchainPlatform. - Allowed values for this property are: "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", "DIGITAL_ASSETS_MEDIUM", "DIGITAL_ASSETS_LARGE", "DIGITAL_ASSETS_EXTRA_LARGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type compute_shape: str @@ -543,9 +555,9 @@ def platform_role(self, platform_role): def compute_shape(self): """ **[Required]** Gets the compute_shape of this BlockchainPlatform. - Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM + Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM or DIGITAL_ASSETS_MEDIUM or DIGITAL_ASSETS_LARGE or DIGITAL_ASSETS_EXTRA_LARGE - Allowed values for this property are: "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", "DIGITAL_ASSETS_MEDIUM", "DIGITAL_ASSETS_LARGE", "DIGITAL_ASSETS_EXTRA_LARGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -558,13 +570,13 @@ def compute_shape(self): def compute_shape(self, compute_shape): """ Sets the compute_shape of this BlockchainPlatform. - Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM + Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM or DIGITAL_ASSETS_MEDIUM or DIGITAL_ASSETS_LARGE or DIGITAL_ASSETS_EXTRA_LARGE :param compute_shape: The compute_shape of this BlockchainPlatform. :type: str """ - allowed_values = ["STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM"] + allowed_values = ["STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM", "DIGITAL_ASSETS_MEDIUM", "DIGITAL_ASSETS_LARGE", "DIGITAL_ASSETS_EXTRA_LARGE"] if not value_allowed_none_or_none_sentinel(compute_shape, allowed_values): compute_shape = 'UNKNOWN_ENUM_VALUE' self._compute_shape = compute_shape diff --git a/src/oci/blockchain/models/work_request.py b/src/oci/blockchain/models/work_request.py index b6c16f897e..50d261a233 100644 --- a/src/oci/blockchain/models/work_request.py +++ b/src/oci/blockchain/models/work_request.py @@ -51,6 +51,10 @@ class WorkRequest(object): #: This constant has a value of "SCALE_STORAGE" OPERATION_TYPE_SCALE_STORAGE = "SCALE_STORAGE" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "WORKREQUEST_CLEANUP" + OPERATION_TYPE_WORKREQUEST_CLEANUP = "WORKREQUEST_CLEANUP" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -82,7 +86,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", "UPGRADE_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", "WORKREQUEST_CLEANUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -161,7 +165,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", "UPGRADE_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", "WORKREQUEST_CLEANUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -180,7 +184,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_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", "WORKREQUEST_CLEANUP"] 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 9507ff2a4a..eb88032483 100644 --- a/src/oci/blockchain/models/work_request_summary.py +++ b/src/oci/blockchain/models/work_request_summary.py @@ -51,6 +51,10 @@ class WorkRequestSummary(object): #: This constant has a value of "SCALE_STORAGE" OPERATION_TYPE_SCALE_STORAGE = "SCALE_STORAGE" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "WORKREQUEST_CLEANUP" + OPERATION_TYPE_WORKREQUEST_CLEANUP = "WORKREQUEST_CLEANUP" + def __init__(self, **kwargs): """ Initializes a new WorkRequestSummary object with values from keyword arguments. @@ -58,7 +62,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", "UPGRADE_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", "WORKREQUEST_CLEANUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -135,7 +139,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", "UPGRADE_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", "WORKREQUEST_CLEANUP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -154,7 +158,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_PLATFORM", "UPDATE_PLATFORM", "UPGRADE_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", "WORKREQUEST_CLEANUP"] 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_bridge/models/__init__.py b/src/oci/cloud_bridge/models/__init__.py index 4fac9e45d3..298d9aef93 100644 --- a/src/oci/cloud_bridge/models/__init__.py +++ b/src/oci/cloud_bridge/models/__init__.py @@ -29,8 +29,10 @@ from .aws_asset_source import AwsAssetSource from .aws_asset_source_summary import AwsAssetSourceSummary from .aws_ebs_asset import AwsEbsAsset +from .aws_ebs_asset_details import AwsEbsAssetDetails from .aws_ebs_properties import AwsEbsProperties from .aws_ec2_asset import AwsEc2Asset +from .aws_ec2_asset_details import AwsEc2AssetDetails from .aws_ec2_properties import AwsEc2Properties from .change_agent_compartment_details import ChangeAgentCompartmentDetails from .change_agent_dependency_compartment_details import ChangeAgentDependencyCompartmentDetails @@ -98,6 +100,7 @@ from .update_discovery_schedule_details import UpdateDiscoveryScheduleDetails from .update_environment_details import UpdateEnvironmentDetails from .update_inventory_details import UpdateInventoryDetails +from .update_plugin_details import UpdatePluginDetails from .update_vm_asset_details import UpdateVmAssetDetails from .update_vm_ware_asset_source_details import UpdateVmWareAssetSourceDetails from .update_vmware_vm_asset_details import UpdateVmwareVmAssetDetails @@ -143,8 +146,10 @@ "AwsAssetSource": AwsAssetSource, "AwsAssetSourceSummary": AwsAssetSourceSummary, "AwsEbsAsset": AwsEbsAsset, + "AwsEbsAssetDetails": AwsEbsAssetDetails, "AwsEbsProperties": AwsEbsProperties, "AwsEc2Asset": AwsEc2Asset, + "AwsEc2AssetDetails": AwsEc2AssetDetails, "AwsEc2Properties": AwsEc2Properties, "ChangeAgentCompartmentDetails": ChangeAgentCompartmentDetails, "ChangeAgentDependencyCompartmentDetails": ChangeAgentDependencyCompartmentDetails, @@ -212,6 +217,7 @@ "UpdateDiscoveryScheduleDetails": UpdateDiscoveryScheduleDetails, "UpdateEnvironmentDetails": UpdateEnvironmentDetails, "UpdateInventoryDetails": UpdateInventoryDetails, + "UpdatePluginDetails": UpdatePluginDetails, "UpdateVmAssetDetails": UpdateVmAssetDetails, "UpdateVmWareAssetSourceDetails": UpdateVmWareAssetSourceDetails, "UpdateVmwareVmAssetDetails": UpdateVmwareVmAssetDetails, diff --git a/src/oci/cloud_bridge/models/asset_source_credentials.py b/src/oci/cloud_bridge/models/asset_source_credentials.py index 8ceba5435f..0977af0707 100644 --- a/src/oci/cloud_bridge/models/asset_source_credentials.py +++ b/src/oci/cloud_bridge/models/asset_source_credentials.py @@ -88,7 +88,7 @@ def secret_id(self): **[Required]** Gets the secret_id of this AssetSourceCredentials. The `OCID`__ of the secret in a vault. If the type of the credentials is `BASIC`, the secret must contain the username and - password in JSON format, which is in the form of `{ \"username\": \"\", \"password\": \"\" }`. + password in JSON format, which is in the form of `{ \"username\": \"\", \"password\": \"example-password\" }`. If the type of the credentials is `API_KEY`, the secret must contain the accessKeyId and secretAccessKey in JSON format, which is in the form of `{ \"accessKeyId\": \"\", \"secretAccessKey\": \"\" }`. @@ -107,7 +107,7 @@ def secret_id(self, secret_id): Sets the secret_id of this AssetSourceCredentials. The `OCID`__ of the secret in a vault. If the type of the credentials is `BASIC`, the secret must contain the username and - password in JSON format, which is in the form of `{ \"username\": \"\", \"password\": \"\" }`. + password in JSON format, which is in the form of `{ \"username\": \"\", \"password\": \"example-password\" }`. If the type of the credentials is `API_KEY`, the secret must contain the accessKeyId and secretAccessKey in JSON format, which is in the form of `{ \"accessKeyId\": \"\", \"secretAccessKey\": \"\" }`. diff --git a/src/oci/cloud_bridge/models/aws_ebs_asset_details.py b/src/oci/cloud_bridge/models/aws_ebs_asset_details.py new file mode 100644 index 0000000000..ec4b647e1c --- /dev/null +++ b/src/oci/cloud_bridge/models/aws_ebs_asset_details.py @@ -0,0 +1,68 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220509 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AwsEbsAssetDetails(object): + """ + AWS EBS type of asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AwsEbsAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param aws_ebs: + The value to assign to the aws_ebs property of this AwsEbsAssetDetails. + :type aws_ebs: oci.cloud_bridge.models.AwsEbsProperties + + """ + self.swagger_types = { + 'aws_ebs': 'AwsEbsProperties' + } + + self.attribute_map = { + 'aws_ebs': 'awsEbs' + } + + self._aws_ebs = None + + @property + def aws_ebs(self): + """ + **[Required]** Gets the aws_ebs of this AwsEbsAssetDetails. + + :return: The aws_ebs of this AwsEbsAssetDetails. + :rtype: oci.cloud_bridge.models.AwsEbsProperties + """ + return self._aws_ebs + + @aws_ebs.setter + def aws_ebs(self, aws_ebs): + """ + Sets the aws_ebs of this AwsEbsAssetDetails. + + :param aws_ebs: The aws_ebs of this AwsEbsAssetDetails. + :type: oci.cloud_bridge.models.AwsEbsProperties + """ + self._aws_ebs = aws_ebs + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/cloud_bridge/models/aws_ec2_asset_details.py b/src/oci/cloud_bridge/models/aws_ec2_asset_details.py new file mode 100644 index 0000000000..02d66af1ac --- /dev/null +++ b/src/oci/cloud_bridge/models/aws_ec2_asset_details.py @@ -0,0 +1,176 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220509 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AwsEc2AssetDetails(object): + """ + AWS EC2 type of asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AwsEc2AssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param compute: + The value to assign to the compute property of this AwsEc2AssetDetails. + :type compute: oci.cloud_bridge.models.ComputeProperties + + :param vm: + The value to assign to the vm property of this AwsEc2AssetDetails. + :type vm: oci.cloud_bridge.models.VmProperties + + :param aws_ec2: + The value to assign to the aws_ec2 property of this AwsEc2AssetDetails. + :type aws_ec2: oci.cloud_bridge.models.AwsEc2Properties + + :param aws_ec2_cost: + The value to assign to the aws_ec2_cost property of this AwsEc2AssetDetails. + :type aws_ec2_cost: oci.cloud_bridge.models.MonthlyCostSummary + + :param attached_ebs_volumes_cost: + The value to assign to the attached_ebs_volumes_cost property of this AwsEc2AssetDetails. + :type attached_ebs_volumes_cost: oci.cloud_bridge.models.MonthlyCostSummary + + """ + self.swagger_types = { + 'compute': 'ComputeProperties', + 'vm': 'VmProperties', + 'aws_ec2': 'AwsEc2Properties', + 'aws_ec2_cost': 'MonthlyCostSummary', + 'attached_ebs_volumes_cost': 'MonthlyCostSummary' + } + + self.attribute_map = { + 'compute': 'compute', + 'vm': 'vm', + 'aws_ec2': 'awsEc2', + 'aws_ec2_cost': 'awsEc2Cost', + 'attached_ebs_volumes_cost': 'attachedEbsVolumesCost' + } + + self._compute = None + self._vm = None + self._aws_ec2 = None + self._aws_ec2_cost = None + self._attached_ebs_volumes_cost = None + + @property + def compute(self): + """ + **[Required]** Gets the compute of this AwsEc2AssetDetails. + + :return: The compute of this AwsEc2AssetDetails. + :rtype: oci.cloud_bridge.models.ComputeProperties + """ + return self._compute + + @compute.setter + def compute(self, compute): + """ + Sets the compute of this AwsEc2AssetDetails. + + :param compute: The compute of this AwsEc2AssetDetails. + :type: oci.cloud_bridge.models.ComputeProperties + """ + self._compute = compute + + @property + def vm(self): + """ + **[Required]** Gets the vm of this AwsEc2AssetDetails. + + :return: The vm of this AwsEc2AssetDetails. + :rtype: oci.cloud_bridge.models.VmProperties + """ + return self._vm + + @vm.setter + def vm(self, vm): + """ + Sets the vm of this AwsEc2AssetDetails. + + :param vm: The vm of this AwsEc2AssetDetails. + :type: oci.cloud_bridge.models.VmProperties + """ + self._vm = vm + + @property + def aws_ec2(self): + """ + **[Required]** Gets the aws_ec2 of this AwsEc2AssetDetails. + + :return: The aws_ec2 of this AwsEc2AssetDetails. + :rtype: oci.cloud_bridge.models.AwsEc2Properties + """ + return self._aws_ec2 + + @aws_ec2.setter + def aws_ec2(self, aws_ec2): + """ + Sets the aws_ec2 of this AwsEc2AssetDetails. + + :param aws_ec2: The aws_ec2 of this AwsEc2AssetDetails. + :type: oci.cloud_bridge.models.AwsEc2Properties + """ + self._aws_ec2 = aws_ec2 + + @property + def aws_ec2_cost(self): + """ + Gets the aws_ec2_cost of this AwsEc2AssetDetails. + + :return: The aws_ec2_cost of this AwsEc2AssetDetails. + :rtype: oci.cloud_bridge.models.MonthlyCostSummary + """ + return self._aws_ec2_cost + + @aws_ec2_cost.setter + def aws_ec2_cost(self, aws_ec2_cost): + """ + Sets the aws_ec2_cost of this AwsEc2AssetDetails. + + :param aws_ec2_cost: The aws_ec2_cost of this AwsEc2AssetDetails. + :type: oci.cloud_bridge.models.MonthlyCostSummary + """ + self._aws_ec2_cost = aws_ec2_cost + + @property + def attached_ebs_volumes_cost(self): + """ + Gets the attached_ebs_volumes_cost of this AwsEc2AssetDetails. + + :return: The attached_ebs_volumes_cost of this AwsEc2AssetDetails. + :rtype: oci.cloud_bridge.models.MonthlyCostSummary + """ + return self._attached_ebs_volumes_cost + + @attached_ebs_volumes_cost.setter + def attached_ebs_volumes_cost(self, attached_ebs_volumes_cost): + """ + Sets the attached_ebs_volumes_cost of this AwsEc2AssetDetails. + + :param attached_ebs_volumes_cost: The attached_ebs_volumes_cost of this AwsEc2AssetDetails. + :type: oci.cloud_bridge.models.MonthlyCostSummary + """ + self._attached_ebs_volumes_cost = attached_ebs_volumes_cost + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/cloud_bridge/models/disk.py b/src/oci/cloud_bridge/models/disk.py index 742692463f..c54795ca3a 100644 --- a/src/oci/cloud_bridge/models/disk.py +++ b/src/oci/cloud_bridge/models/disk.py @@ -48,6 +48,10 @@ def __init__(self, **kwargs): The value to assign to the persistent_mode property of this Disk. :type persistent_mode: str + :param is_cbt_enabled: + The value to assign to the is_cbt_enabled property of this Disk. + :type is_cbt_enabled: bool + """ self.swagger_types = { 'name': 'str', @@ -56,7 +60,8 @@ def __init__(self, **kwargs): 'uuid_lun': 'str', 'size_in_mbs': 'int', 'location': 'str', - 'persistent_mode': 'str' + 'persistent_mode': 'str', + 'is_cbt_enabled': 'bool' } self.attribute_map = { @@ -66,7 +71,8 @@ def __init__(self, **kwargs): 'uuid_lun': 'uuidLun', 'size_in_mbs': 'sizeInMBs', 'location': 'location', - 'persistent_mode': 'persistentMode' + 'persistent_mode': 'persistentMode', + 'is_cbt_enabled': 'isCbtEnabled' } self._name = None @@ -76,6 +82,7 @@ def __init__(self, **kwargs): self._size_in_mbs = None self._location = None self._persistent_mode = None + self._is_cbt_enabled = None @property def name(self): @@ -245,6 +252,30 @@ def persistent_mode(self, persistent_mode): """ self._persistent_mode = persistent_mode + @property + def is_cbt_enabled(self): + """ + Gets the is_cbt_enabled of this Disk. + Indicates that CBT (change disk tracking) is enabled for this virtual disk. + + + :return: The is_cbt_enabled of this Disk. + :rtype: bool + """ + return self._is_cbt_enabled + + @is_cbt_enabled.setter + def is_cbt_enabled(self, is_cbt_enabled): + """ + Sets the is_cbt_enabled of this Disk. + Indicates that CBT (change disk tracking) is enabled for this virtual disk. + + + :param is_cbt_enabled: The is_cbt_enabled of this Disk. + :type: bool + """ + self._is_cbt_enabled = is_cbt_enabled + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cloud_bridge/models/monthly_cost_summary.py b/src/oci/cloud_bridge/models/monthly_cost_summary.py index fbc273272c..3c82d15c68 100644 --- a/src/oci/cloud_bridge/models/monthly_cost_summary.py +++ b/src/oci/cloud_bridge/models/monthly_cost_summary.py @@ -70,7 +70,7 @@ def amount(self, amount): def currency_code(self): """ **[Required]** Gets the currency_code of this MonthlyCostSummary. - Currency code as defined by ISO-4217. + Currency code :return: The currency_code of this MonthlyCostSummary. @@ -82,7 +82,7 @@ def currency_code(self): def currency_code(self, currency_code): """ Sets the currency_code of this MonthlyCostSummary. - Currency code as defined by ISO-4217. + Currency code :param currency_code: The currency_code of this MonthlyCostSummary. diff --git a/src/oci/cloud_bridge/models/update_plugin_details.py b/src/oci/cloud_bridge/models/update_plugin_details.py new file mode 100644 index 0000000000..1c6649f663 --- /dev/null +++ b/src/oci/cloud_bridge/models/update_plugin_details.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220509 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdatePluginDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdatePluginDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param desired_state: + The value to assign to the desired_state property of this UpdatePluginDetails. + :type desired_state: str + + """ + self.swagger_types = { + 'desired_state': 'str' + } + + self.attribute_map = { + 'desired_state': 'desiredState' + } + + self._desired_state = None + + @property + def desired_state(self): + """ + **[Required]** Gets the desired_state of this UpdatePluginDetails. + State to which the customer wants the plugin to move to. + + + :return: The desired_state of this UpdatePluginDetails. + :rtype: str + """ + return self._desired_state + + @desired_state.setter + def desired_state(self, desired_state): + """ + Sets the desired_state of this UpdatePluginDetails. + State to which the customer wants the plugin to move to. + + + :param desired_state: The desired_state of this UpdatePluginDetails. + :type: str + """ + self._desired_state = desired_state + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/cloud_bridge/models/work_request.py b/src/oci/cloud_bridge/models/work_request.py index 4466715e0e..1df98131bf 100644 --- a/src/oci/cloud_bridge/models/work_request.py +++ b/src/oci/cloud_bridge/models/work_request.py @@ -91,6 +91,10 @@ class WorkRequest(object): #: This constant has a value of "UPDATE_ASSET_SOURCE" OPERATION_TYPE_UPDATE_ASSET_SOURCE = "UPDATE_ASSET_SOURCE" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_PLUGIN_STATE" + OPERATION_TYPE_UPDATE_PLUGIN_STATE = "UPDATE_PLUGIN_STATE" + #: A constant which can be used with the operation_type property of a WorkRequest. #: This constant has a value of "CLOUD_AWS_DISCOVERY" OPERATION_TYPE_CLOUD_AWS_DISCOVERY = "CLOUD_AWS_DISCOVERY" @@ -138,7 +142,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_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -217,7 +221,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. Type of work request. - Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -236,7 +240,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS"] + allowed_values = ["CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS"] 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_bridge/models/work_request_summary.py b/src/oci/cloud_bridge/models/work_request_summary.py index f86be67813..75ac76cd34 100644 --- a/src/oci/cloud_bridge/models/work_request_summary.py +++ b/src/oci/cloud_bridge/models/work_request_summary.py @@ -91,6 +91,10 @@ class WorkRequestSummary(object): #: This constant has a value of "UPDATE_ASSET_SOURCE" OPERATION_TYPE_UPDATE_ASSET_SOURCE = "UPDATE_ASSET_SOURCE" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_PLUGIN_STATE" + OPERATION_TYPE_UPDATE_PLUGIN_STATE = "UPDATE_PLUGIN_STATE" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. #: This constant has a value of "CLOUD_AWS_DISCOVERY" OPERATION_TYPE_CLOUD_AWS_DISCOVERY = "CLOUD_AWS_DISCOVERY" @@ -138,7 +142,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_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -217,7 +221,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. Type of work request. - Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -236,7 +240,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS"] + allowed_values = ["CREATE_ENVIRONMENT", "UPDATE_ENVIRONMENT", "DELETE_ENVIRONMENT", "MOVE_ENVIRONMENT", "CREATE_OCB_AGENT", "UPDATE_OCB_AGENT", "DELETE_OCB_AGENT", "MOVE_OCB_AGENT", "CREATE_AGENT_DEPENDENCY", "UPDATE_AGENT_DEPENDENCY", "DELETE_AGENT_DEPENDENCY", "MOVE_AGENT_DEPENDENCY", "CREATE_INVENTORY", "DELETE_INVENTORY", "IMPORT_INVENTORY", "DELETE_ASSET_SOURCE", "REFRESH_ASSET_SOURCE", "CREATE_ASSET_SOURCE", "UPDATE_ASSET_SOURCE", "UPDATE_PLUGIN_STATE", "CLOUD_AWS_DISCOVERY", "COLLECT_AWS_REALTIME_METRICS", "COLLECT_AWS_HISTORICAL_METRICS"] 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_bridge/ocb_agent_svc_client.py b/src/oci/cloud_bridge/ocb_agent_svc_client.py index 61e83db5d6..0a66ae56fa 100644 --- a/src/oci/cloud_bridge/ocb_agent_svc_client.py +++ b/src/oci/cloud_bridge/ocb_agent_svc_client.py @@ -2709,3 +2709,117 @@ def update_environment(self, environment_id, update_environment_details, **kwarg operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) + + def update_plugin(self, agent_id, plugin_name, update_plugin_details, **kwargs): + """ + Updates the plugin. + + + :param str agent_id: (required) + Unique Agent identifier path parameter. + + :param str plugin_name: (required) + Unique plugin identifier path parameter. + + :param oci.cloud_bridge.models.UpdatePluginDetails update_plugin_details: (required) + The information to be updated. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_plugin API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['agentId', 'pluginName'] + resource_path = "/agents/{agentId}/plugins/{pluginName}" + method = "PUT" + operation_name = "update_plugin" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/OCB/20220509/Plugin/UpdatePlugin" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"update_plugin got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "agentId": agent_id, + "pluginName": plugin_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(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_plugin_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_plugin_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) diff --git a/src/oci/cloud_bridge/ocb_agent_svc_client_composite_operations.py b/src/oci/cloud_bridge/ocb_agent_svc_client_composite_operations.py index 3e22b9abea..b36fe925ee 100644 --- a/src/oci/cloud_bridge/ocb_agent_svc_client_composite_operations.py +++ b/src/oci/cloud_bridge/ocb_agent_svc_client_composite_operations.py @@ -630,3 +630,48 @@ def update_environment_and_wait_for_state(self, environment_id, update_environme raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_plugin_and_wait_for_state(self, agent_id, plugin_name, update_plugin_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.cloud_bridge.OcbAgentSvcClient.update_plugin` and waits for the :py:class:`~oci.cloud_bridge.models.WorkRequest` + to enter the given state(s). + + :param str agent_id: (required) + Unique Agent identifier path parameter. + + :param str plugin_name: (required) + Unique plugin identifier path parameter. + + :param oci.cloud_bridge.models.UpdatePluginDetails update_plugin_details: (required) + The information to be updated. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.cloud_bridge.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.cloud_bridge.OcbAgentSvcClient.update_plugin` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_plugin(agent_id, plugin_name, update_plugin_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/data_science/data_science_client.py b/src/oci/data_science/data_science_client.py index 569d9feadc..46c7d0f25b 100644 --- a/src/oci/data_science/data_science_client.py +++ b/src/oci/data_science/data_science_client.py @@ -6985,7 +6985,7 @@ def list_data_science_private_endpoints(self, compartment_id, **kwargs): :param str data_science_resource_type: (optional) Resource types in the Data Science service such as notebooks. - Allowed values are: "NOTEBOOK_SESSION" + Allowed values are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7053,7 +7053,7 @@ def list_data_science_private_endpoints(self, compartment_id, **kwargs): ) if 'data_science_resource_type' in kwargs: - data_science_resource_type_allowed_values = ["NOTEBOOK_SESSION"] + data_science_resource_type_allowed_values = ["NOTEBOOK_SESSION", "MODEL_DEPLOYMENT"] if kwargs['data_science_resource_type'] not in data_science_resource_type_allowed_values: raise ValueError( f"Invalid value for `data_science_resource_type`, must be one of { data_science_resource_type_allowed_values }" diff --git a/src/oci/data_science/models/create_data_science_private_endpoint_details.py b/src/oci/data_science/models/create_data_science_private_endpoint_details.py index 7d5863d299..6d7c9168c1 100644 --- a/src/oci/data_science/models/create_data_science_private_endpoint_details.py +++ b/src/oci/data_science/models/create_data_science_private_endpoint_details.py @@ -19,6 +19,10 @@ class CreateDataSciencePrivateEndpointDetails(object): #: This constant has a value of "NOTEBOOK_SESSION" DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = "NOTEBOOK_SESSION" + #: A constant which can be used with the data_science_resource_type property of a CreateDataSciencePrivateEndpointDetails. + #: This constant has a value of "MODEL_DEPLOYMENT" + DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = "MODEL_DEPLOYMENT" + def __init__(self, **kwargs): """ Initializes a new CreateDataSciencePrivateEndpointDetails object with values from keyword arguments. @@ -58,7 +62,7 @@ def __init__(self, **kwargs): :param data_science_resource_type: The value to assign to the data_science_resource_type property of this CreateDataSciencePrivateEndpointDetails. - Allowed values for this property are: "NOTEBOOK_SESSION" + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT" :type data_science_resource_type: str """ @@ -310,7 +314,7 @@ def data_science_resource_type(self): **[Required]** Gets the data_science_resource_type of this CreateDataSciencePrivateEndpointDetails. Data Science resource type. - Allowed values for this property are: "NOTEBOOK_SESSION" + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT" :return: The data_science_resource_type of this CreateDataSciencePrivateEndpointDetails. @@ -328,7 +332,7 @@ def data_science_resource_type(self, data_science_resource_type): :param data_science_resource_type: The data_science_resource_type of this CreateDataSciencePrivateEndpointDetails. :type: str """ - allowed_values = ["NOTEBOOK_SESSION"] + allowed_values = ["NOTEBOOK_SESSION", "MODEL_DEPLOYMENT"] if not value_allowed_none_or_none_sentinel(data_science_resource_type, allowed_values): raise ValueError( f"Invalid value for `data_science_resource_type`, must be None or one of {allowed_values}" diff --git a/src/oci/data_science/models/create_job_run_details.py b/src/oci/data_science/models/create_job_run_details.py index a2b285082a..e22fecaf7b 100644 --- a/src/oci/data_science/models/create_job_run_details.py +++ b/src/oci/data_science/models/create_job_run_details.py @@ -95,7 +95,7 @@ def __init__(self, **kwargs): def project_id(self): """ **[Required]** Gets the project_id of this CreateJobRunDetails. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -109,7 +109,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this CreateJobRunDetails. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -123,7 +123,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateJobRunDetails. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -137,7 +137,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateJobRunDetails. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm diff --git a/src/oci/data_science/models/data_science_private_endpoint.py b/src/oci/data_science/models/data_science_private_endpoint.py index 3d24eac892..d14f04bee7 100644 --- a/src/oci/data_science/models/data_science_private_endpoint.py +++ b/src/oci/data_science/models/data_science_private_endpoint.py @@ -47,6 +47,10 @@ class DataSciencePrivateEndpoint(object): #: This constant has a value of "NOTEBOOK_SESSION" DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = "NOTEBOOK_SESSION" + #: A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpoint. + #: This constant has a value of "MODEL_DEPLOYMENT" + DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = "MODEL_DEPLOYMENT" + def __init__(self, **kwargs): """ Initializes a new DataSciencePrivateEndpoint object with values from keyword arguments. @@ -108,7 +112,7 @@ def __init__(self, **kwargs): :param data_science_resource_type: The value to assign to the data_science_resource_type property of this DataSciencePrivateEndpoint. - Allowed values for this property are: "NOTEBOOK_SESSION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type data_science_resource_type: str @@ -522,7 +526,7 @@ def data_science_resource_type(self): Gets the data_science_resource_type of this DataSciencePrivateEndpoint. Data Science resource type. - Allowed values for this property are: "NOTEBOOK_SESSION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -541,7 +545,7 @@ def data_science_resource_type(self, data_science_resource_type): :param data_science_resource_type: The data_science_resource_type of this DataSciencePrivateEndpoint. :type: str """ - allowed_values = ["NOTEBOOK_SESSION"] + allowed_values = ["NOTEBOOK_SESSION", "MODEL_DEPLOYMENT"] if not value_allowed_none_or_none_sentinel(data_science_resource_type, allowed_values): data_science_resource_type = 'UNKNOWN_ENUM_VALUE' self._data_science_resource_type = data_science_resource_type diff --git a/src/oci/data_science/models/data_science_private_endpoint_summary.py b/src/oci/data_science/models/data_science_private_endpoint_summary.py index 1e8a0d5a30..c9605f1344 100644 --- a/src/oci/data_science/models/data_science_private_endpoint_summary.py +++ b/src/oci/data_science/models/data_science_private_endpoint_summary.py @@ -47,6 +47,10 @@ class DataSciencePrivateEndpointSummary(object): #: This constant has a value of "NOTEBOOK_SESSION" DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = "NOTEBOOK_SESSION" + #: A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpointSummary. + #: This constant has a value of "MODEL_DEPLOYMENT" + DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = "MODEL_DEPLOYMENT" + def __init__(self, **kwargs): """ Initializes a new DataSciencePrivateEndpointSummary object with values from keyword arguments. @@ -88,7 +92,7 @@ def __init__(self, **kwargs): :param data_science_resource_type: The value to assign to the data_science_resource_type property of this DataSciencePrivateEndpointSummary. - Allowed values for this property are: "NOTEBOOK_SESSION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type data_science_resource_type: str @@ -391,7 +395,7 @@ def data_science_resource_type(self): **[Required]** Gets the data_science_resource_type of this DataSciencePrivateEndpointSummary. Data Science resource type. - Allowed values for this property are: "NOTEBOOK_SESSION", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTEBOOK_SESSION", "MODEL_DEPLOYMENT", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -410,7 +414,7 @@ def data_science_resource_type(self, data_science_resource_type): :param data_science_resource_type: The data_science_resource_type of this DataSciencePrivateEndpointSummary. :type: str """ - allowed_values = ["NOTEBOOK_SESSION"] + allowed_values = ["NOTEBOOK_SESSION", "MODEL_DEPLOYMENT"] if not value_allowed_none_or_none_sentinel(data_science_resource_type, allowed_values): data_science_resource_type = 'UNKNOWN_ENUM_VALUE' self._data_science_resource_type = data_science_resource_type diff --git a/src/oci/data_science/models/instance_configuration.py b/src/oci/data_science/models/instance_configuration.py index 4c79144c76..b6a19fa1e1 100644 --- a/src/oci/data_science/models/instance_configuration.py +++ b/src/oci/data_science/models/instance_configuration.py @@ -32,22 +32,29 @@ def __init__(self, **kwargs): The value to assign to the subnet_id property of this InstanceConfiguration. :type subnet_id: str + :param private_endpoint_id: + The value to assign to the private_endpoint_id property of this InstanceConfiguration. + :type private_endpoint_id: str + """ self.swagger_types = { 'instance_shape_name': 'str', 'model_deployment_instance_shape_config_details': 'ModelDeploymentInstanceShapeConfigDetails', - 'subnet_id': 'str' + 'subnet_id': 'str', + 'private_endpoint_id': 'str' } self.attribute_map = { 'instance_shape_name': 'instanceShapeName', 'model_deployment_instance_shape_config_details': 'modelDeploymentInstanceShapeConfigDetails', - 'subnet_id': 'subnetId' + 'subnet_id': 'subnetId', + 'private_endpoint_id': 'privateEndpointId' } self._instance_shape_name = None self._model_deployment_instance_shape_config_details = None self._subnet_id = None + self._private_endpoint_id = None @property def instance_shape_name(self): @@ -121,6 +128,30 @@ def subnet_id(self, subnet_id): """ self._subnet_id = subnet_id + @property + def private_endpoint_id(self): + """ + Gets the private_endpoint_id of this InstanceConfiguration. + The OCID of a Data Science private endpoint. + + + :return: The private_endpoint_id of this InstanceConfiguration. + :rtype: str + """ + return self._private_endpoint_id + + @private_endpoint_id.setter + def private_endpoint_id(self, private_endpoint_id): + """ + Sets the private_endpoint_id of this InstanceConfiguration. + The OCID of a Data Science private endpoint. + + + :param private_endpoint_id: The private_endpoint_id of this InstanceConfiguration. + :type: str + """ + self._private_endpoint_id = private_endpoint_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_science/models/job_run.py b/src/oci/data_science/models/job_run.py index 7a7ebc0e19..6f76b4c2a6 100644 --- a/src/oci/data_science/models/job_run.py +++ b/src/oci/data_science/models/job_run.py @@ -339,7 +339,7 @@ def created_by(self, created_by): def project_id(self): """ **[Required]** Gets the project_id of this JobRun. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -353,7 +353,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this JobRun. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -367,7 +367,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this JobRun. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -381,7 +381,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this JobRun. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -395,7 +395,7 @@ def compartment_id(self, compartment_id): def job_id(self): """ **[Required]** Gets the job_id of this JobRun. - The `OCID`__ of the job run. + The `OCID`__ of the job. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -409,7 +409,7 @@ def job_id(self): def job_id(self, job_id): """ Sets the job_id of this JobRun. - The `OCID`__ of the job run. + The `OCID`__ of the job. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm diff --git a/src/oci/data_science/models/job_run_summary.py b/src/oci/data_science/models/job_run_summary.py index b5ae65f4e6..ff01893bbb 100644 --- a/src/oci/data_science/models/job_run_summary.py +++ b/src/oci/data_science/models/job_run_summary.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class JobRunSummary(object): """ - Summary information for a Job. + Summary information for a job run. """ #: A constant which can be used with the lifecycle_state property of a JobRunSummary. @@ -297,7 +297,7 @@ def created_by(self, created_by): def project_id(self): """ **[Required]** Gets the project_id of this JobRunSummary. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -311,7 +311,7 @@ def project_id(self): def project_id(self, project_id): """ Sets the project_id of this JobRunSummary. - The `OCID`__ of the project to associate the job with. + The `OCID`__ of the project to associate the job run with. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -325,7 +325,7 @@ def project_id(self, project_id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this JobRunSummary. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -339,7 +339,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this JobRunSummary. - The `OCID`__ of the compartment where you want to create the job. + The `OCID`__ of the compartment where you want to create the job run. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -353,7 +353,7 @@ def compartment_id(self, compartment_id): def job_id(self): """ **[Required]** Gets the job_id of this JobRunSummary. - The `OCID`__ of the job run. + The `OCID`__ of the job. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -367,7 +367,7 @@ def job_id(self): def job_id(self, job_id): """ Sets the job_id of this JobRunSummary. - The `OCID`__ of the job run. + The `OCID`__ of the job. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -405,7 +405,7 @@ def display_name(self, display_name): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this JobRunSummary. - The state of the job. + The state of the job run. Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", "DELETED", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -420,7 +420,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this JobRunSummary. - The state of the job. + The state of the job run. :param lifecycle_state: The lifecycle_state of this JobRunSummary. diff --git a/src/oci/data_science/models/job_summary.py b/src/oci/data_science/models/job_summary.py index 059e4138d4..3c92098bda 100644 --- a/src/oci/data_science/models/job_summary.py +++ b/src/oci/data_science/models/job_summary.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class JobSummary(object): """ - Summary information for a Job. + Summary information for a job. """ #: A constant which can be used with the lifecycle_state property of a JobSummary. diff --git a/src/oci/data_science/models/metadata.py b/src/oci/data_science/models/metadata.py index f1fd95ddef..4e6a4aa15e 100644 --- a/src/oci/data_science/models/metadata.py +++ b/src/oci/data_science/models/metadata.py @@ -67,7 +67,7 @@ def key(self): * libraryVersion * estimatorClass * hyperParameters - * testartifactresults + * testArtifactresults :return: The key of this Metadata. @@ -86,7 +86,7 @@ def key(self, key): * libraryVersion * estimatorClass * hyperParameters - * testartifactresults + * testArtifactresults :param key: The key of this Metadata. @@ -162,7 +162,7 @@ def description(self, description): def category(self): """ Gets the category of this Metadata. - Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values \"Performance,Training Profile,Training and Validation Datasets,Training Environment,other\". + Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values \"Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other\". :return: The category of this Metadata. @@ -174,7 +174,7 @@ def category(self): def category(self, category): """ Sets the category of this Metadata. - Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values \"Performance,Training Profile,Training and Validation Datasets,Training Environment,other\". + Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values \"Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other\". :param category: The category of this Metadata. diff --git a/src/oci/database/models/autonomous_database.py b/src/oci/database/models/autonomous_database.py index c6e8b5a9a7..25d9c9b2fc 100644 --- a/src/oci/database/models/autonomous_database.py +++ b/src/oci/database/models/autonomous_database.py @@ -466,6 +466,10 @@ def __init__(self, **kwargs): The value to assign to the autonomous_container_database_id property of this AutonomousDatabase. :type autonomous_container_database_id: str + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this AutonomousDatabase. + :type is_backup_retention_locked: bool + :param time_undeleted: The value to assign to the time_undeleted property of this AutonomousDatabase. :type time_undeleted: datetime @@ -873,6 +877,7 @@ def __init__(self, **kwargs): 'infrastructure_type': 'str', 'is_dedicated': 'bool', 'autonomous_container_database_id': 'str', + 'is_backup_retention_locked': 'bool', 'time_undeleted': 'datetime', 'time_created': 'datetime', 'display_name': 'str', @@ -999,6 +1004,7 @@ def __init__(self, **kwargs): 'infrastructure_type': 'infrastructureType', 'is_dedicated': 'isDedicated', 'autonomous_container_database_id': 'autonomousContainerDatabaseId', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'time_undeleted': 'timeUndeleted', 'time_created': 'timeCreated', 'display_name': 'displayName', @@ -1124,6 +1130,7 @@ def __init__(self, **kwargs): self._infrastructure_type = None self._is_dedicated = None self._autonomous_container_database_id = None + self._is_backup_retention_locked = None self._time_undeleted = None self._time_created = None self._display_name = None @@ -2237,6 +2244,30 @@ def autonomous_container_database_id(self, autonomous_container_database_id): """ self._autonomous_container_database_id = autonomous_container_database_id + @property + def is_backup_retention_locked(self): + """ + Gets the is_backup_retention_locked of this AutonomousDatabase. + Indicates if the Autonomous Database is backup retention locked. + + + :return: The is_backup_retention_locked of this AutonomousDatabase. + :rtype: bool + """ + return self._is_backup_retention_locked + + @is_backup_retention_locked.setter + def is_backup_retention_locked(self, is_backup_retention_locked): + """ + Sets the is_backup_retention_locked of this AutonomousDatabase. + Indicates if the Autonomous Database is backup retention locked. + + + :param is_backup_retention_locked: The is_backup_retention_locked of this AutonomousDatabase. + :type: bool + """ + self._is_backup_retention_locked = is_backup_retention_locked + @property def time_undeleted(self): """ diff --git a/src/oci/database/models/autonomous_database_summary.py b/src/oci/database/models/autonomous_database_summary.py index a487e69d5a..37e1a9027c 100644 --- a/src/oci/database/models/autonomous_database_summary.py +++ b/src/oci/database/models/autonomous_database_summary.py @@ -468,6 +468,10 @@ def __init__(self, **kwargs): The value to assign to the autonomous_container_database_id property of this AutonomousDatabaseSummary. :type autonomous_container_database_id: str + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this AutonomousDatabaseSummary. + :type is_backup_retention_locked: bool + :param time_undeleted: The value to assign to the time_undeleted property of this AutonomousDatabaseSummary. :type time_undeleted: datetime @@ -875,6 +879,7 @@ def __init__(self, **kwargs): 'infrastructure_type': 'str', 'is_dedicated': 'bool', 'autonomous_container_database_id': 'str', + 'is_backup_retention_locked': 'bool', 'time_undeleted': 'datetime', 'time_created': 'datetime', 'display_name': 'str', @@ -1001,6 +1006,7 @@ def __init__(self, **kwargs): 'infrastructure_type': 'infrastructureType', 'is_dedicated': 'isDedicated', 'autonomous_container_database_id': 'autonomousContainerDatabaseId', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'time_undeleted': 'timeUndeleted', 'time_created': 'timeCreated', 'display_name': 'displayName', @@ -1126,6 +1132,7 @@ def __init__(self, **kwargs): self._infrastructure_type = None self._is_dedicated = None self._autonomous_container_database_id = None + self._is_backup_retention_locked = None self._time_undeleted = None self._time_created = None self._display_name = None @@ -2239,6 +2246,30 @@ def autonomous_container_database_id(self, autonomous_container_database_id): """ self._autonomous_container_database_id = autonomous_container_database_id + @property + def is_backup_retention_locked(self): + """ + Gets the is_backup_retention_locked of this AutonomousDatabaseSummary. + Indicates if the Autonomous Database is backup retention locked. + + + :return: The is_backup_retention_locked of this AutonomousDatabaseSummary. + :rtype: bool + """ + return self._is_backup_retention_locked + + @is_backup_retention_locked.setter + def is_backup_retention_locked(self, is_backup_retention_locked): + """ + Sets the is_backup_retention_locked of this AutonomousDatabaseSummary. + Indicates if the Autonomous Database is backup retention locked. + + + :param is_backup_retention_locked: The is_backup_retention_locked of this AutonomousDatabaseSummary. + :type: bool + """ + self._is_backup_retention_locked = is_backup_retention_locked + @property def time_undeleted(self): """ diff --git a/src/oci/database/models/create_autonomous_database_base.py b/src/oci/database/models/create_autonomous_database_base.py index e6ea73b426..d544576db5 100644 --- a/src/oci/database/models/create_autonomous_database_base.py +++ b/src/oci/database/models/create_autonomous_database_base.py @@ -320,6 +320,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateAutonomousDatabaseBase. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateAutonomousDatabaseBase. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateAutonomousDatabaseBase. :type secret_id: str @@ -381,6 +385,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int' } @@ -437,6 +442,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber' } @@ -492,6 +498,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None @@ -2099,6 +2106,30 @@ def db_tools_details(self, db_tools_details): """ self._db_tools_details = db_tools_details + @property + def is_backup_retention_locked(self): + """ + Gets the is_backup_retention_locked of this CreateAutonomousDatabaseBase. + True if the Autonomous Database is backup retention locked. + + + :return: The is_backup_retention_locked of this CreateAutonomousDatabaseBase. + :rtype: bool + """ + return self._is_backup_retention_locked + + @is_backup_retention_locked.setter + def is_backup_retention_locked(self, is_backup_retention_locked): + """ + Sets the is_backup_retention_locked of this CreateAutonomousDatabaseBase. + True if the Autonomous Database is backup retention locked. + + + :param is_backup_retention_locked: The is_backup_retention_locked of this CreateAutonomousDatabaseBase. + :type: bool + """ + self._is_backup_retention_locked = is_backup_retention_locked + @property def secret_id(self): """ diff --git a/src/oci/database/models/create_autonomous_database_clone_details.py b/src/oci/database/models/create_autonomous_database_clone_details.py index f07e314583..d07cd6dac2 100644 --- a/src/oci/database/models/create_autonomous_database_clone_details.py +++ b/src/oci/database/models/create_autonomous_database_clone_details.py @@ -238,6 +238,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateAutonomousDatabaseCloneDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateAutonomousDatabaseCloneDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateAutonomousDatabaseCloneDetails. :type secret_id: str @@ -308,6 +312,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str', @@ -366,6 +371,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId', @@ -423,6 +429,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/create_autonomous_database_details.py b/src/oci/database/models/create_autonomous_database_details.py index 9e3b49d2b0..e765b84ebf 100644 --- a/src/oci/database/models/create_autonomous_database_details.py +++ b/src/oci/database/models/create_autonomous_database_details.py @@ -230,6 +230,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateAutonomousDatabaseDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateAutonomousDatabaseDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateAutonomousDatabaseDetails. :type secret_id: str @@ -291,6 +295,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int' } @@ -347,6 +352,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber' } @@ -402,6 +408,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source = 'NONE' diff --git a/src/oci/database/models/create_autonomous_database_from_backup_details.py b/src/oci/database/models/create_autonomous_database_from_backup_details.py index 6ac7334397..343eb9f9b1 100644 --- a/src/oci/database/models/create_autonomous_database_from_backup_details.py +++ b/src/oci/database/models/create_autonomous_database_from_backup_details.py @@ -238,6 +238,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateAutonomousDatabaseFromBackupDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateAutonomousDatabaseFromBackupDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateAutonomousDatabaseFromBackupDetails. :type secret_id: str @@ -308,6 +312,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'autonomous_database_backup_id': 'str', @@ -366,6 +371,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'autonomous_database_backup_id': 'autonomousDatabaseBackupId', @@ -423,6 +429,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._autonomous_database_backup_id = None diff --git a/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py b/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py index 795a6f637d..c115e632fc 100644 --- a/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py +++ b/src/oci/database/models/create_autonomous_database_from_backup_timestamp_details.py @@ -238,6 +238,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateAutonomousDatabaseFromBackupTimestampDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateAutonomousDatabaseFromBackupTimestampDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateAutonomousDatabaseFromBackupTimestampDetails. :type secret_id: str @@ -316,6 +320,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'autonomous_database_id': 'str', @@ -376,6 +381,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'autonomous_database_id': 'autonomousDatabaseId', @@ -435,6 +441,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._autonomous_database_id = None diff --git a/src/oci/database/models/create_cross_region_autonomous_database_data_guard_details.py b/src/oci/database/models/create_cross_region_autonomous_database_data_guard_details.py index b75a83a6b6..c201b079c7 100644 --- a/src/oci/database/models/create_cross_region_autonomous_database_data_guard_details.py +++ b/src/oci/database/models/create_cross_region_autonomous_database_data_guard_details.py @@ -250,6 +250,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateCrossRegionAutonomousDatabaseDataGuardDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateCrossRegionAutonomousDatabaseDataGuardDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateCrossRegionAutonomousDatabaseDataGuardDetails. :type secret_id: str @@ -315,6 +319,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str' @@ -372,6 +377,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId' @@ -428,6 +434,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/create_cross_region_disaster_recovery_details.py b/src/oci/database/models/create_cross_region_disaster_recovery_details.py index 5aaea3d60b..426dd47243 100644 --- a/src/oci/database/models/create_cross_region_disaster_recovery_details.py +++ b/src/oci/database/models/create_cross_region_disaster_recovery_details.py @@ -249,6 +249,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateCrossRegionDisasterRecoveryDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateCrossRegionDisasterRecoveryDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateCrossRegionDisasterRecoveryDetails. :type secret_id: str @@ -322,6 +326,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str', @@ -381,6 +386,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId', @@ -439,6 +445,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/create_cross_tenancy_disaster_recovery_details.py b/src/oci/database/models/create_cross_tenancy_disaster_recovery_details.py index 174b9da2b7..de31b1cd5b 100644 --- a/src/oci/database/models/create_cross_tenancy_disaster_recovery_details.py +++ b/src/oci/database/models/create_cross_tenancy_disaster_recovery_details.py @@ -250,6 +250,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateCrossTenancyDisasterRecoveryDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateCrossTenancyDisasterRecoveryDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateCrossTenancyDisasterRecoveryDetails. :type secret_id: str @@ -323,6 +327,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str', @@ -382,6 +387,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId', @@ -440,6 +446,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py b/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py index feae55f511..051729db2e 100644 --- a/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py +++ b/src/oci/database/models/create_refreshable_autonomous_database_clone_details.py @@ -246,6 +246,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this CreateRefreshableAutonomousDatabaseCloneDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this CreateRefreshableAutonomousDatabaseCloneDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this CreateRefreshableAutonomousDatabaseCloneDetails. :type secret_id: str @@ -333,6 +337,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str', @@ -395,6 +400,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId', @@ -456,6 +462,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/undelete_autonomous_database_details.py b/src/oci/database/models/undelete_autonomous_database_details.py index 14048dd701..761ced843a 100644 --- a/src/oci/database/models/undelete_autonomous_database_details.py +++ b/src/oci/database/models/undelete_autonomous_database_details.py @@ -230,6 +230,10 @@ def __init__(self, **kwargs): The value to assign to the db_tools_details property of this UndeleteAutonomousDatabaseDetails. :type db_tools_details: list[oci.database.models.DatabaseTool] + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this UndeleteAutonomousDatabaseDetails. + :type is_backup_retention_locked: bool + :param secret_id: The value to assign to the secret_id property of this UndeleteAutonomousDatabaseDetails. :type secret_id: str @@ -295,6 +299,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', 'db_tools_details': 'list[DatabaseTool]', + 'is_backup_retention_locked': 'bool', 'secret_id': 'str', 'secret_version_number': 'int', 'source_id': 'str' @@ -352,6 +357,7 @@ def __init__(self, **kwargs): 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', 'db_tools_details': 'dbToolsDetails', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'secret_id': 'secretId', 'secret_version_number': 'secretVersionNumber', 'source_id': 'sourceId' @@ -408,6 +414,7 @@ def __init__(self, **kwargs): self._is_auto_scaling_for_storage_enabled = None self._database_edition = None self._db_tools_details = None + self._is_backup_retention_locked = None self._secret_id = None self._secret_version_number = None self._source_id = None diff --git a/src/oci/database/models/update_autonomous_database_details.py b/src/oci/database/models/update_autonomous_database_details.py index e3660cbbcb..3dde7aab13 100644 --- a/src/oci/database/models/update_autonomous_database_details.py +++ b/src/oci/database/models/update_autonomous_database_details.py @@ -268,6 +268,10 @@ def __init__(self, **kwargs): The value to assign to the resource_pool_summary property of this UpdateAutonomousDatabaseDetails. :type resource_pool_summary: oci.database.models.ResourcePoolSummary + :param is_backup_retention_locked: + The value to assign to the is_backup_retention_locked property of this UpdateAutonomousDatabaseDetails. + :type is_backup_retention_locked: bool + :param scheduled_operations: The value to assign to the scheduled_operations property of this UpdateAutonomousDatabaseDetails. :type scheduled_operations: list[oci.database.models.ScheduledOperationDetails] @@ -343,6 +347,7 @@ def __init__(self, **kwargs): 'is_mtls_connection_required': 'bool', 'resource_pool_leader_id': 'str', 'resource_pool_summary': 'ResourcePoolSummary', + 'is_backup_retention_locked': 'bool', 'scheduled_operations': 'list[ScheduledOperationDetails]', 'is_auto_scaling_for_storage_enabled': 'bool', 'database_edition': 'str', @@ -398,6 +403,7 @@ def __init__(self, **kwargs): 'is_mtls_connection_required': 'isMtlsConnectionRequired', 'resource_pool_leader_id': 'resourcePoolLeaderId', 'resource_pool_summary': 'resourcePoolSummary', + 'is_backup_retention_locked': 'isBackupRetentionLocked', 'scheduled_operations': 'scheduledOperations', 'is_auto_scaling_for_storage_enabled': 'isAutoScalingForStorageEnabled', 'database_edition': 'databaseEdition', @@ -452,6 +458,7 @@ def __init__(self, **kwargs): self._is_mtls_connection_required = None self._resource_pool_leader_id = None self._resource_pool_summary = None + self._is_backup_retention_locked = None self._scheduled_operations = None self._is_auto_scaling_for_storage_enabled = None self._database_edition = None @@ -1914,6 +1921,30 @@ def resource_pool_summary(self, resource_pool_summary): """ self._resource_pool_summary = resource_pool_summary + @property + def is_backup_retention_locked(self): + """ + Gets the is_backup_retention_locked of this UpdateAutonomousDatabaseDetails. + True if the Autonomous Database is backup retention locked. + + + :return: The is_backup_retention_locked of this UpdateAutonomousDatabaseDetails. + :rtype: bool + """ + return self._is_backup_retention_locked + + @is_backup_retention_locked.setter + def is_backup_retention_locked(self, is_backup_retention_locked): + """ + Sets the is_backup_retention_locked of this UpdateAutonomousDatabaseDetails. + True if the Autonomous Database is backup retention locked. + + + :param is_backup_retention_locked: The is_backup_retention_locked of this UpdateAutonomousDatabaseDetails. + :type: bool + """ + self._is_backup_retention_locked = is_backup_retention_locked + @property def scheduled_operations(self): """ diff --git a/src/oci/generative_ai_agent/generative_ai_agent_client.py b/src/oci/generative_ai_agent/generative_ai_agent_client.py index 6c2e1f174a..d4e68f547b 100644 --- a/src/oci/generative_ai_agent/generative_ai_agent_client.py +++ b/src/oci/generative_ai_agent/generative_ai_agent_client.py @@ -22,9 +22,6 @@ class GenerativeAiAgentClient(object): """ - **Generative AI Agents API** - - OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient. OCI Generative AI Agents supports several ways to onboard your data and then allows you and your customers to interact with your data using a chat interface or API. @@ -129,8 +126,6 @@ def __init__(self, config, **kwargs): def cancel_work_request(self, work_request_id, **kwargs): """ - **CancelWorkRequest** - Cancels a work request. @@ -240,8 +235,6 @@ def cancel_work_request(self, work_request_id, **kwargs): def change_agent_compartment(self, agent_id, change_agent_compartment_details, **kwargs): """ - **ChangeAgentCompartment** - Moves an agent into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. @@ -369,8 +362,6 @@ def change_agent_compartment(self, agent_id, change_agent_compartment_details, * def change_agent_endpoint_compartment(self, agent_endpoint_id, change_agent_endpoint_compartment_details, **kwargs): """ - **ChangeAgentEndpointCompartment** - Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. @@ -498,8 +489,6 @@ def change_agent_endpoint_compartment(self, agent_endpoint_id, change_agent_endp def change_knowledge_base_compartment(self, knowledge_base_id, change_knowledge_base_compartment_details, **kwargs): """ - **ChangeKnowledgeBaseCompartment** - Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. @@ -627,8 +616,6 @@ def change_knowledge_base_compartment(self, knowledge_base_id, change_knowledge_ def create_agent(self, create_agent_details, **kwargs): """ - **CreateAgent** - Creates an agent. @@ -730,8 +717,6 @@ def create_agent(self, create_agent_details, **kwargs): def create_agent_endpoint(self, create_agent_endpoint_details, **kwargs): """ - **CreateAgentEndpoint** - Creates an endpoint. @@ -833,8 +818,6 @@ def create_agent_endpoint(self, create_agent_endpoint_details, **kwargs): def create_data_ingestion_job(self, create_data_ingestion_job_details, **kwargs): """ - **CreateDataIngestionJob** - Creates a data ingestion job. @@ -936,8 +919,6 @@ def create_data_ingestion_job(self, create_data_ingestion_job_details, **kwargs) def create_data_source(self, create_data_source_details, **kwargs): """ - **CreateDataSource** - Creates a data source. @@ -1039,8 +1020,6 @@ def create_data_source(self, create_data_source_details, **kwargs): def create_knowledge_base(self, create_knowledge_base_details, **kwargs): """ - **CreateKnowledgeBase** - Creates a knowledge base. @@ -1142,8 +1121,6 @@ def create_knowledge_base(self, create_knowledge_base_details, **kwargs): def delete_agent(self, agent_id, **kwargs): """ - **DeleteAgent** - Deletes an agent. @@ -1253,8 +1230,6 @@ def delete_agent(self, agent_id, **kwargs): def delete_agent_endpoint(self, agent_endpoint_id, **kwargs): """ - **DeleteAgentEndpoint** - Deletes an endpoint. @@ -1364,8 +1339,6 @@ def delete_agent_endpoint(self, agent_endpoint_id, **kwargs): def delete_data_ingestion_job(self, data_ingestion_job_id, **kwargs): """ - **DeleteDataIngestionJob** - Deletes a data ingestion job. @@ -1475,8 +1448,6 @@ def delete_data_ingestion_job(self, data_ingestion_job_id, **kwargs): def delete_data_source(self, data_source_id, **kwargs): """ - **DeleteDataSource** - Deletes a data source. @@ -1586,8 +1557,6 @@ def delete_data_source(self, data_source_id, **kwargs): def delete_knowledge_base(self, knowledge_base_id, **kwargs): """ - **DeleteKnowledgeBase** - Deletes a knowledge base. @@ -1697,8 +1666,6 @@ def delete_knowledge_base(self, knowledge_base_id, **kwargs): def get_agent(self, agent_id, **kwargs): """ - **GetAgent** - Gets information about an agent. @@ -1802,8 +1769,6 @@ def get_agent(self, agent_id, **kwargs): def get_agent_endpoint(self, agent_endpoint_id, **kwargs): """ - **GetAgentEndpoint** - Gets information about an endpoint. @@ -1907,8 +1872,6 @@ def get_agent_endpoint(self, agent_endpoint_id, **kwargs): def get_data_ingestion_job(self, data_ingestion_job_id, **kwargs): """ - **GetDataIngestionJob** - Gets information about a data ingestion job. @@ -2012,8 +1975,6 @@ def get_data_ingestion_job(self, data_ingestion_job_id, **kwargs): def get_data_ingestion_job_log_content(self, data_ingestion_job_id, **kwargs): """ - **GetDataIngestionJobLogContent** - Returns the raw log file for the specified data ingestion job in text format. @@ -2117,8 +2078,6 @@ def get_data_ingestion_job_log_content(self, data_ingestion_job_id, **kwargs): def get_data_source(self, data_source_id, **kwargs): """ - **GetDataSource** - Gets information about a data source. @@ -2222,8 +2181,6 @@ def get_data_source(self, data_source_id, **kwargs): def get_knowledge_base(self, knowledge_base_id, **kwargs): """ - **GetKnowledgeBase** - Gets information about a knowledge base. @@ -2327,8 +2284,6 @@ def get_knowledge_base(self, knowledge_base_id, **kwargs): def get_work_request(self, work_request_id, **kwargs): """ - **GetWorkRequest** - Gets the details of a work request. @@ -2432,8 +2387,6 @@ def get_work_request(self, work_request_id, **kwargs): def list_agent_endpoints(self, **kwargs): """ - **ListAgentEndpoints** - Gets a list of endpoints. @@ -2607,8 +2560,6 @@ def list_agent_endpoints(self, **kwargs): def list_agents(self, **kwargs): """ - **ListAgents** - Gets a list of agents. @@ -2775,8 +2726,6 @@ def list_agents(self, **kwargs): def list_data_ingestion_jobs(self, **kwargs): """ - **ListDataIngestionJobs** - Gets a list of data ingestion jobs. @@ -2950,8 +2899,6 @@ def list_data_ingestion_jobs(self, **kwargs): def list_data_sources(self, **kwargs): """ - **ListDataSources** - Gets a list of data sources. @@ -3125,8 +3072,6 @@ def list_data_sources(self, **kwargs): def list_knowledge_bases(self, **kwargs): """ - **ListKnowledgeBases** - Gets a list of knowledge bases. @@ -3293,8 +3238,6 @@ def list_knowledge_bases(self, **kwargs): def list_work_request_errors(self, work_request_id, **kwargs): """ - **ListWorkRequestErrors** - Lists the errors for a work request. @@ -3450,8 +3393,6 @@ def list_work_request_errors(self, work_request_id, **kwargs): def list_work_request_logs(self, work_request_id, **kwargs): """ - **ListWorkRequestLogs** - Lists the logs for a work request. @@ -3607,8 +3548,6 @@ def list_work_request_logs(self, work_request_id, **kwargs): def list_work_requests(self, **kwargs): """ - **ListWorkRequests** - Lists the work requests in a compartment. @@ -3782,8 +3721,6 @@ def list_work_requests(self, **kwargs): def update_agent(self, agent_id, update_agent_details, **kwargs): """ - **UpdateAgent** - Updates an agent. @@ -3898,8 +3835,6 @@ def update_agent(self, agent_id, update_agent_details, **kwargs): def update_agent_endpoint(self, agent_endpoint_id, update_agent_endpoint_details, **kwargs): """ - **UpdateAgentEndpoint** - Updates an endpoint. @@ -4014,8 +3949,6 @@ def update_agent_endpoint(self, agent_endpoint_id, update_agent_endpoint_details def update_data_source(self, data_source_id, update_data_source_details, **kwargs): """ - **UpdateDataSource** - Updates a data source. @@ -4130,8 +4063,6 @@ def update_data_source(self, data_source_id, update_data_source_details, **kwarg def update_knowledge_base(self, knowledge_base_id, update_knowledge_base_details, **kwargs): """ - **UpdateKnowledgeBase** - Updates a knowledge base. diff --git a/src/oci/generative_ai_agent/models/__init__.py b/src/oci/generative_ai_agent/models/__init__.py index 1982ce0ad8..8de195cbee 100644 --- a/src/oci/generative_ai_agent/models/__init__.py +++ b/src/oci/generative_ai_agent/models/__init__.py @@ -40,6 +40,7 @@ from .index_schema import IndexSchema from .knowledge_base import KnowledgeBase from .knowledge_base_collection import KnowledgeBaseCollection +from .knowledge_base_statistics import KnowledgeBaseStatistics from .knowledge_base_summary import KnowledgeBaseSummary from .object_storage_prefix import ObjectStoragePrefix from .oci_database_config import OciDatabaseConfig @@ -96,6 +97,7 @@ "IndexSchema": IndexSchema, "KnowledgeBase": KnowledgeBase, "KnowledgeBaseCollection": KnowledgeBaseCollection, + "KnowledgeBaseStatistics": KnowledgeBaseStatistics, "KnowledgeBaseSummary": KnowledgeBaseSummary, "ObjectStoragePrefix": ObjectStoragePrefix, "OciDatabaseConfig": OciDatabaseConfig, diff --git a/src/oci/generative_ai_agent/models/agent.py b/src/oci/generative_ai_agent/models/agent.py index 8bc66d3328..24673b5882 100644 --- a/src/oci/generative_ai_agent/models/agent.py +++ b/src/oci/generative_ai_agent/models/agent.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class Agent(object): """ - **Agent** - An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. diff --git a/src/oci/generative_ai_agent/models/agent_collection.py b/src/oci/generative_ai_agent/models/agent_collection.py index 150f065f50..5a3cca41d0 100644 --- a/src/oci/generative_ai_agent/models/agent_collection.py +++ b/src/oci/generative_ai_agent/models/agent_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class AgentCollection(object): """ - **AgentCollection** - Results of an agent search. Contains both AgentSummary items and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/agent_endpoint.py b/src/oci/generative_ai_agent/models/agent_endpoint.py index cef823c16a..1a60156f53 100644 --- a/src/oci/generative_ai_agent/models/agent_endpoint.py +++ b/src/oci/generative_ai_agent/models/agent_endpoint.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class AgentEndpoint(object): """ - **AgentEndpoint** - The endpoint to access a deployed agent. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. diff --git a/src/oci/generative_ai_agent/models/agent_endpoint_collection.py b/src/oci/generative_ai_agent/models/agent_endpoint_collection.py index f68603969b..1a502e309c 100644 --- a/src/oci/generative_ai_agent/models/agent_endpoint_collection.py +++ b/src/oci/generative_ai_agent/models/agent_endpoint_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class AgentEndpointCollection(object): """ - **AgentEndpointCollection** - Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/agent_endpoint_summary.py b/src/oci/generative_ai_agent/models/agent_endpoint_summary.py index 9ca1b97ebb..887222cb6f 100644 --- a/src/oci/generative_ai_agent/models/agent_endpoint_summary.py +++ b/src/oci/generative_ai_agent/models/agent_endpoint_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class AgentEndpointSummary(object): """ - **AgentEndpointSummary** - Summary information about an endpoint. """ diff --git a/src/oci/generative_ai_agent/models/agent_summary.py b/src/oci/generative_ai_agent/models/agent_summary.py index aa52409490..0c495cdce3 100644 --- a/src/oci/generative_ai_agent/models/agent_summary.py +++ b/src/oci/generative_ai_agent/models/agent_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class AgentSummary(object): """ - **AgentSummary** - Summary information about an agent. """ diff --git a/src/oci/generative_ai_agent/models/basic_auth_secret.py b/src/oci/generative_ai_agent/models/basic_auth_secret.py index 1df919e726..b50cf1b457 100644 --- a/src/oci/generative_ai_agent/models/basic_auth_secret.py +++ b/src/oci/generative_ai_agent/models/basic_auth_secret.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class BasicAuthSecret(SecretDetail): """ - **BasicAuthSecret** - The details of Basic authentication configured as in OpenSearch. """ diff --git a/src/oci/generative_ai_agent/models/change_agent_compartment_details.py b/src/oci/generative_ai_agent/models/change_agent_compartment_details.py index 5ad22d4d52..b95ff39551 100644 --- a/src/oci/generative_ai_agent/models/change_agent_compartment_details.py +++ b/src/oci/generative_ai_agent/models/change_agent_compartment_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class ChangeAgentCompartmentDetails(object): """ - **ChangeAgentCompartmentDetails** - The configuration details for the move operation. """ diff --git a/src/oci/generative_ai_agent/models/change_agent_endpoint_compartment_details.py b/src/oci/generative_ai_agent/models/change_agent_endpoint_compartment_details.py index 642906daf0..188426720b 100644 --- a/src/oci/generative_ai_agent/models/change_agent_endpoint_compartment_details.py +++ b/src/oci/generative_ai_agent/models/change_agent_endpoint_compartment_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class ChangeAgentEndpointCompartmentDetails(object): """ - **ChangeAgentEndpointCompartmentDetails** - The configuration details for the move operation. """ diff --git a/src/oci/generative_ai_agent/models/change_knowledge_base_compartment_details.py b/src/oci/generative_ai_agent/models/change_knowledge_base_compartment_details.py index 1202a84efd..e2b054caea 100644 --- a/src/oci/generative_ai_agent/models/change_knowledge_base_compartment_details.py +++ b/src/oci/generative_ai_agent/models/change_knowledge_base_compartment_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class ChangeKnowledgeBaseCompartmentDetails(object): """ - **ChangeKnowledgeBaseCompartmentDetails** - The configuration details for the move operation. """ diff --git a/src/oci/generative_ai_agent/models/create_agent_details.py b/src/oci/generative_ai_agent/models/create_agent_details.py index fd4f731a92..4ee5046cd2 100644 --- a/src/oci/generative_ai_agent/models/create_agent_details.py +++ b/src/oci/generative_ai_agent/models/create_agent_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class CreateAgentDetails(object): """ - **CreateAgentDetails** - The data to create an agent. """ diff --git a/src/oci/generative_ai_agent/models/create_agent_endpoint_details.py b/src/oci/generative_ai_agent/models/create_agent_endpoint_details.py index 81be0c48bf..78756ea638 100644 --- a/src/oci/generative_ai_agent/models/create_agent_endpoint_details.py +++ b/src/oci/generative_ai_agent/models/create_agent_endpoint_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class CreateAgentEndpointDetails(object): """ - **CreateAgentEndpointDetails** - The data to create an endpoint. """ diff --git a/src/oci/generative_ai_agent/models/create_data_ingestion_job_details.py b/src/oci/generative_ai_agent/models/create_data_ingestion_job_details.py index cd0578e938..1b1417f532 100644 --- a/src/oci/generative_ai_agent/models/create_data_ingestion_job_details.py +++ b/src/oci/generative_ai_agent/models/create_data_ingestion_job_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class CreateDataIngestionJobDetails(object): """ - **CreateDataIngestionJobDetails** - The data to create a data ingestion job. """ diff --git a/src/oci/generative_ai_agent/models/create_data_source_details.py b/src/oci/generative_ai_agent/models/create_data_source_details.py index 5efc20d981..c467f07b9e 100644 --- a/src/oci/generative_ai_agent/models/create_data_source_details.py +++ b/src/oci/generative_ai_agent/models/create_data_source_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class CreateDataSourceDetails(object): """ - **CreateDataSourceDetails** - The data to create a data source. """ diff --git a/src/oci/generative_ai_agent/models/create_knowledge_base_details.py b/src/oci/generative_ai_agent/models/create_knowledge_base_details.py index 567ab585b6..1bfc2e213a 100644 --- a/src/oci/generative_ai_agent/models/create_knowledge_base_details.py +++ b/src/oci/generative_ai_agent/models/create_knowledge_base_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class CreateKnowledgeBaseDetails(object): """ - **CreateKnowledgeBaseDetails** - The data to create a knowledge base. """ diff --git a/src/oci/generative_ai_agent/models/data_ingestion_job.py b/src/oci/generative_ai_agent/models/data_ingestion_job.py index 156bcbe07c..4b736a13c2 100644 --- a/src/oci/generative_ai_agent/models/data_ingestion_job.py +++ b/src/oci/generative_ai_agent/models/data_ingestion_job.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataIngestionJob(object): """ - **DataIngestionJob** - When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. @@ -74,6 +72,10 @@ def __init__(self, **kwargs): The value to assign to the data_source_id property of this DataIngestionJob. :type data_source_id: str + :param knowledge_base_id: + The value to assign to the knowledge_base_id property of this DataIngestionJob. + :type knowledge_base_id: str + :param data_ingestion_job_statistics: The value to assign to the data_ingestion_job_statistics property of this DataIngestionJob. :type data_ingestion_job_statistics: oci.generative_ai_agent.models.DataIngestionJobStatistics @@ -115,6 +117,7 @@ def __init__(self, **kwargs): 'description': 'str', 'compartment_id': 'str', 'data_source_id': 'str', + 'knowledge_base_id': 'str', 'data_ingestion_job_statistics': 'DataIngestionJobStatistics', 'time_created': 'datetime', 'time_updated': 'datetime', @@ -131,6 +134,7 @@ def __init__(self, **kwargs): 'description': 'description', 'compartment_id': 'compartmentId', 'data_source_id': 'dataSourceId', + 'knowledge_base_id': 'knowledgeBaseId', 'data_ingestion_job_statistics': 'dataIngestionJobStatistics', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', @@ -146,6 +150,7 @@ def __init__(self, **kwargs): self._description = None self._compartment_id = None self._data_source_id = None + self._knowledge_base_id = None self._data_ingestion_job_statistics = None self._time_created = None self._time_updated = None @@ -287,6 +292,34 @@ def data_source_id(self, data_source_id): """ self._data_source_id = data_source_id + @property + def knowledge_base_id(self): + """ + Gets the knowledge_base_id of this DataIngestionJob. + The `OCID`__ of the parent KnowledgeBase. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The knowledge_base_id of this DataIngestionJob. + :rtype: str + """ + return self._knowledge_base_id + + @knowledge_base_id.setter + def knowledge_base_id(self, knowledge_base_id): + """ + Sets the knowledge_base_id of this DataIngestionJob. + The `OCID`__ of the parent KnowledgeBase. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param knowledge_base_id: The knowledge_base_id of this DataIngestionJob. + :type: str + """ + self._knowledge_base_id = knowledge_base_id + @property def data_ingestion_job_statistics(self): """ diff --git a/src/oci/generative_ai_agent/models/data_ingestion_job_collection.py b/src/oci/generative_ai_agent/models/data_ingestion_job_collection.py index 770db92aa7..6d4df26990 100644 --- a/src/oci/generative_ai_agent/models/data_ingestion_job_collection.py +++ b/src/oci/generative_ai_agent/models/data_ingestion_job_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataIngestionJobCollection(object): """ - **DataIngestionJobCollection** - Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/data_ingestion_job_statistics.py b/src/oci/generative_ai_agent/models/data_ingestion_job_statistics.py index 0701dc7177..77bb247e23 100644 --- a/src/oci/generative_ai_agent/models/data_ingestion_job_statistics.py +++ b/src/oci/generative_ai_agent/models/data_ingestion_job_statistics.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataIngestionJobStatistics(object): """ - **DataIngestionJobStatistics** - The statistics of data ingestion job. """ diff --git a/src/oci/generative_ai_agent/models/data_ingestion_job_summary.py b/src/oci/generative_ai_agent/models/data_ingestion_job_summary.py index d4a83e930d..ef08f28be3 100644 --- a/src/oci/generative_ai_agent/models/data_ingestion_job_summary.py +++ b/src/oci/generative_ai_agent/models/data_ingestion_job_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataIngestionJobSummary(object): """ - **DataIngestionJobSummary** - Summary information about a data ingestion job. """ diff --git a/src/oci/generative_ai_agent/models/data_source.py b/src/oci/generative_ai_agent/models/data_source.py index 5019139064..aea0b1cddb 100644 --- a/src/oci/generative_ai_agent/models/data_source.py +++ b/src/oci/generative_ai_agent/models/data_source.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataSource(object): """ - **DataSource** - A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. diff --git a/src/oci/generative_ai_agent/models/data_source_collection.py b/src/oci/generative_ai_agent/models/data_source_collection.py index 4750098f64..f637741254 100644 --- a/src/oci/generative_ai_agent/models/data_source_collection.py +++ b/src/oci/generative_ai_agent/models/data_source_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataSourceCollection(object): """ - **DataSourceCollection** - Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/data_source_config.py b/src/oci/generative_ai_agent/models/data_source_config.py index 7d5c5e3fb7..4be812d4be 100644 --- a/src/oci/generative_ai_agent/models/data_source_config.py +++ b/src/oci/generative_ai_agent/models/data_source_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataSourceConfig(object): """ - **DataSourceConfig** - The details of data source. """ @@ -30,6 +28,10 @@ def __init__(self, **kwargs): The following keyword arguments are supported (corresponding to the getters/setters of this class): + :param should_enable_multi_modality: + The value to assign to the should_enable_multi_modality property of this DataSourceConfig. + :type should_enable_multi_modality: bool + :param data_source_config_type: The value to assign to the data_source_config_type property of this DataSourceConfig. Allowed values for this property are: "OCI_OBJECT_STORAGE", 'UNKNOWN_ENUM_VALUE'. @@ -38,13 +40,16 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'should_enable_multi_modality': 'bool', 'data_source_config_type': 'str' } self.attribute_map = { + 'should_enable_multi_modality': 'shouldEnableMultiModality', 'data_source_config_type': 'dataSourceConfigType' } + self._should_enable_multi_modality = None self._data_source_config_type = None @staticmethod @@ -60,6 +65,30 @@ def get_subtype(object_dictionary): else: return 'DataSourceConfig' + @property + def should_enable_multi_modality(self): + """ + Gets the should_enable_multi_modality of this DataSourceConfig. + Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion. + + + :return: The should_enable_multi_modality of this DataSourceConfig. + :rtype: bool + """ + return self._should_enable_multi_modality + + @should_enable_multi_modality.setter + def should_enable_multi_modality(self, should_enable_multi_modality): + """ + Sets the should_enable_multi_modality of this DataSourceConfig. + Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion. + + + :param should_enable_multi_modality: The should_enable_multi_modality of this DataSourceConfig. + :type: bool + """ + self._should_enable_multi_modality = should_enable_multi_modality + @property def data_source_config_type(self): """ diff --git a/src/oci/generative_ai_agent/models/data_source_summary.py b/src/oci/generative_ai_agent/models/data_source_summary.py index 8373e7fb01..6b407d7208 100644 --- a/src/oci/generative_ai_agent/models/data_source_summary.py +++ b/src/oci/generative_ai_agent/models/data_source_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DataSourceSummary(object): """ - **DataSourceSummary** - Summary information about a data source. """ diff --git a/src/oci/generative_ai_agent/models/database_connection.py b/src/oci/generative_ai_agent/models/database_connection.py index 1b043b2ca0..e944a6156f 100644 --- a/src/oci/generative_ai_agent/models/database_connection.py +++ b/src/oci/generative_ai_agent/models/database_connection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DatabaseConnection(object): """ - **DatabaseConnection** - The connection type for Databases. """ diff --git a/src/oci/generative_ai_agent/models/database_function.py b/src/oci/generative_ai_agent/models/database_function.py index 85cf4b793d..37fafcaf05 100644 --- a/src/oci/generative_ai_agent/models/database_function.py +++ b/src/oci/generative_ai_agent/models/database_function.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DatabaseFunction(object): """ - **DatabaseFunction** - The details of Database function. """ diff --git a/src/oci/generative_ai_agent/models/database_tool_connection.py b/src/oci/generative_ai_agent/models/database_tool_connection.py index 62c234a4e8..74bd5bacea 100644 --- a/src/oci/generative_ai_agent/models/database_tool_connection.py +++ b/src/oci/generative_ai_agent/models/database_tool_connection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DatabaseToolConnection(DatabaseConnection): """ - **DatabaseToolConnection** - The details of the customer Database Tools Connection. """ diff --git a/src/oci/generative_ai_agent/models/default_index_config.py b/src/oci/generative_ai_agent/models/default_index_config.py index eb75cad808..f9ba5f71ec 100644 --- a/src/oci/generative_ai_agent/models/default_index_config.py +++ b/src/oci/generative_ai_agent/models/default_index_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class DefaultIndexConfig(IndexConfig): """ - **DefaultIndexConfig** - The default index is service managed vector store on behalf of the customer. """ diff --git a/src/oci/generative_ai_agent/models/idcs_secret.py b/src/oci/generative_ai_agent/models/idcs_secret.py index 26bd267c62..3092f581be 100644 --- a/src/oci/generative_ai_agent/models/idcs_secret.py +++ b/src/oci/generative_ai_agent/models/idcs_secret.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class IdcsSecret(SecretDetail): """ - **IdcsSecret** - The details of IDCS configured as OpenID setting in OpenSearch. """ diff --git a/src/oci/generative_ai_agent/models/index.py b/src/oci/generative_ai_agent/models/index.py index 134c092d71..1b5dc3fc0c 100644 --- a/src/oci/generative_ai_agent/models/index.py +++ b/src/oci/generative_ai_agent/models/index.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class Index(object): """ - **Index** - OCI OpenSearch index details. """ diff --git a/src/oci/generative_ai_agent/models/index_config.py b/src/oci/generative_ai_agent/models/index_config.py index dce7beb833..4b7fb5e421 100644 --- a/src/oci/generative_ai_agent/models/index_config.py +++ b/src/oci/generative_ai_agent/models/index_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class IndexConfig(object): """ - **IndexConfig** - The index configuration of Knowledge bases. """ diff --git a/src/oci/generative_ai_agent/models/index_schema.py b/src/oci/generative_ai_agent/models/index_schema.py index c5474b432d..0d6ee5a014 100644 --- a/src/oci/generative_ai_agent/models/index_schema.py +++ b/src/oci/generative_ai_agent/models/index_schema.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class IndexSchema(object): """ - **IndexSchema** - The index schema details. """ diff --git a/src/oci/generative_ai_agent/models/knowledge_base.py b/src/oci/generative_ai_agent/models/knowledge_base.py index d842603e44..5cf300fcfd 100644 --- a/src/oci/generative_ai_agent/models/knowledge_base.py +++ b/src/oci/generative_ai_agent/models/knowledge_base.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class KnowledgeBase(object): """ - **KnowledgeBase** - A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. @@ -74,6 +72,10 @@ def __init__(self, **kwargs): The value to assign to the index_config property of this KnowledgeBase. :type index_config: oci.generative_ai_agent.models.IndexConfig + :param knowledge_base_statistics: + The value to assign to the knowledge_base_statistics property of this KnowledgeBase. + :type knowledge_base_statistics: oci.generative_ai_agent.models.KnowledgeBaseStatistics + :param time_created: The value to assign to the time_created property of this KnowledgeBase. :type time_created: datetime @@ -111,6 +113,7 @@ def __init__(self, **kwargs): 'description': 'str', 'compartment_id': 'str', 'index_config': 'IndexConfig', + 'knowledge_base_statistics': 'KnowledgeBaseStatistics', 'time_created': 'datetime', 'time_updated': 'datetime', 'lifecycle_state': 'str', @@ -126,6 +129,7 @@ def __init__(self, **kwargs): 'description': 'description', 'compartment_id': 'compartmentId', 'index_config': 'indexConfig', + 'knowledge_base_statistics': 'knowledgeBaseStatistics', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', @@ -140,6 +144,7 @@ def __init__(self, **kwargs): self._description = None self._compartment_id = None self._index_config = None + self._knowledge_base_statistics = None self._time_created = None self._time_updated = None self._lifecycle_state = None @@ -272,6 +277,26 @@ def index_config(self, index_config): """ self._index_config = index_config + @property + def knowledge_base_statistics(self): + """ + Gets the knowledge_base_statistics of this KnowledgeBase. + + :return: The knowledge_base_statistics of this KnowledgeBase. + :rtype: oci.generative_ai_agent.models.KnowledgeBaseStatistics + """ + return self._knowledge_base_statistics + + @knowledge_base_statistics.setter + def knowledge_base_statistics(self, knowledge_base_statistics): + """ + Sets the knowledge_base_statistics of this KnowledgeBase. + + :param knowledge_base_statistics: The knowledge_base_statistics of this KnowledgeBase. + :type: oci.generative_ai_agent.models.KnowledgeBaseStatistics + """ + self._knowledge_base_statistics = knowledge_base_statistics + @property def time_created(self): """ diff --git a/src/oci/generative_ai_agent/models/knowledge_base_collection.py b/src/oci/generative_ai_agent/models/knowledge_base_collection.py index 90a44cadb6..887c712ca8 100644 --- a/src/oci/generative_ai_agent/models/knowledge_base_collection.py +++ b/src/oci/generative_ai_agent/models/knowledge_base_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class KnowledgeBaseCollection(object): """ - **KnowledgeBaseCollection** - Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/knowledge_base_statistics.py b/src/oci/generative_ai_agent/models/knowledge_base_statistics.py new file mode 100644 index 0000000000..4b8cdd4736 --- /dev/null +++ b/src/oci/generative_ai_agent/models/knowledge_base_statistics.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KnowledgeBaseStatistics(object): + """ + Statistics for Default Knowledge Base. + """ + + def __init__(self, **kwargs): + """ + Initializes a new KnowledgeBaseStatistics object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param size_in_bytes: + The value to assign to the size_in_bytes property of this KnowledgeBaseStatistics. + :type size_in_bytes: int + + """ + self.swagger_types = { + 'size_in_bytes': 'int' + } + + self.attribute_map = { + 'size_in_bytes': 'sizeInBytes' + } + + self._size_in_bytes = None + + @property + def size_in_bytes(self): + """ + Gets the size_in_bytes of this KnowledgeBaseStatistics. + Knowledge Base size in bytes. + + + :return: The size_in_bytes of this KnowledgeBaseStatistics. + :rtype: int + """ + return self._size_in_bytes + + @size_in_bytes.setter + def size_in_bytes(self, size_in_bytes): + """ + Sets the size_in_bytes of this KnowledgeBaseStatistics. + Knowledge Base size in bytes. + + + :param size_in_bytes: The size_in_bytes of this KnowledgeBaseStatistics. + :type: int + """ + self._size_in_bytes = size_in_bytes + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/generative_ai_agent/models/knowledge_base_summary.py b/src/oci/generative_ai_agent/models/knowledge_base_summary.py index f01290afb8..054a2ff125 100644 --- a/src/oci/generative_ai_agent/models/knowledge_base_summary.py +++ b/src/oci/generative_ai_agent/models/knowledge_base_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class KnowledgeBaseSummary(object): """ - **KnowledgeBaseSummary** - Summary information about a knowledge base. """ diff --git a/src/oci/generative_ai_agent/models/object_storage_prefix.py b/src/oci/generative_ai_agent/models/object_storage_prefix.py index 29e8034905..ab1672cde1 100644 --- a/src/oci/generative_ai_agent/models/object_storage_prefix.py +++ b/src/oci/generative_ai_agent/models/object_storage_prefix.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class ObjectStoragePrefix(object): """ - **ObjectStoragePrefix** - The details of OCI Object Storage object. """ diff --git a/src/oci/generative_ai_agent/models/oci_database_config.py b/src/oci/generative_ai_agent/models/oci_database_config.py index d6d21f360e..616e309e6f 100644 --- a/src/oci/generative_ai_agent/models/oci_database_config.py +++ b/src/oci/generative_ai_agent/models/oci_database_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class OciDatabaseConfig(IndexConfig): """ - **OciDatabaseConfig** - The details of the customer Database Connection. """ diff --git a/src/oci/generative_ai_agent/models/oci_object_storage_data_source_config.py b/src/oci/generative_ai_agent/models/oci_object_storage_data_source_config.py index 88e1a78a5e..553c5a685c 100644 --- a/src/oci/generative_ai_agent/models/oci_object_storage_data_source_config.py +++ b/src/oci/generative_ai_agent/models/oci_object_storage_data_source_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class OciObjectStorageDataSourceConfig(DataSourceConfig): """ - **OciObjectStorageDataSourceConfig** - The details of OCI Search with OpenSearch data source information. """ @@ -23,6 +21,10 @@ def __init__(self, **kwargs): of this class is ``OCI_OBJECT_STORAGE`` and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class): + :param should_enable_multi_modality: + The value to assign to the should_enable_multi_modality property of this OciObjectStorageDataSourceConfig. + :type should_enable_multi_modality: bool + :param data_source_config_type: The value to assign to the data_source_config_type property of this OciObjectStorageDataSourceConfig. Allowed values for this property are: "OCI_OBJECT_STORAGE" @@ -34,15 +36,18 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'should_enable_multi_modality': 'bool', 'data_source_config_type': 'str', 'object_storage_prefixes': 'list[ObjectStoragePrefix]' } self.attribute_map = { + 'should_enable_multi_modality': 'shouldEnableMultiModality', 'data_source_config_type': 'dataSourceConfigType', 'object_storage_prefixes': 'objectStoragePrefixes' } + self._should_enable_multi_modality = None self._data_source_config_type = None self._object_storage_prefixes = None self._data_source_config_type = 'OCI_OBJECT_STORAGE' @@ -50,7 +55,7 @@ def __init__(self, **kwargs): @property def object_storage_prefixes(self): """ - **[Required]** Gets the object_storage_prefixes of this OciObjectStorageDataSourceConfig. + Gets the object_storage_prefixes of this OciObjectStorageDataSourceConfig. The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). diff --git a/src/oci/generative_ai_agent/models/oci_open_search_index_config.py b/src/oci/generative_ai_agent/models/oci_open_search_index_config.py index 3e0ec53bd9..c0912cbc9b 100644 --- a/src/oci/generative_ai_agent/models/oci_open_search_index_config.py +++ b/src/oci/generative_ai_agent/models/oci_open_search_index_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class OciOpenSearchIndexConfig(IndexConfig): """ - **OciOpenSearchIndexConfig** - The details of customer managed OCI OpenSearch. """ diff --git a/src/oci/generative_ai_agent/models/secret_detail.py b/src/oci/generative_ai_agent/models/secret_detail.py index b52fc65242..19cbe95d50 100644 --- a/src/oci/generative_ai_agent/models/secret_detail.py +++ b/src/oci/generative_ai_agent/models/secret_detail.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class SecretDetail(object): """ - **SecretDetail** - The details of configured security configuration on OpenSearch. """ diff --git a/src/oci/generative_ai_agent/models/session_config.py b/src/oci/generative_ai_agent/models/session_config.py index d34a5f84dc..bc698a4052 100644 --- a/src/oci/generative_ai_agent/models/session_config.py +++ b/src/oci/generative_ai_agent/models/session_config.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class SessionConfig(object): """ - **SessionConfig** - Session Configuration on AgentEndpoint. """ diff --git a/src/oci/generative_ai_agent/models/update_agent_details.py b/src/oci/generative_ai_agent/models/update_agent_details.py index 6ff70cf0db..f06958616b 100644 --- a/src/oci/generative_ai_agent/models/update_agent_details.py +++ b/src/oci/generative_ai_agent/models/update_agent_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class UpdateAgentDetails(object): """ - **UpdateAgentDetails** - The data to update an agent. """ diff --git a/src/oci/generative_ai_agent/models/update_agent_endpoint_details.py b/src/oci/generative_ai_agent/models/update_agent_endpoint_details.py index 9ecddbbd02..98af765dff 100644 --- a/src/oci/generative_ai_agent/models/update_agent_endpoint_details.py +++ b/src/oci/generative_ai_agent/models/update_agent_endpoint_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class UpdateAgentEndpointDetails(object): """ - **UpdateAgentEndpointDetails** - The data to update an endpoint. """ diff --git a/src/oci/generative_ai_agent/models/update_data_source_details.py b/src/oci/generative_ai_agent/models/update_data_source_details.py index f13f9141d9..0d8693adeb 100644 --- a/src/oci/generative_ai_agent/models/update_data_source_details.py +++ b/src/oci/generative_ai_agent/models/update_data_source_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class UpdateDataSourceDetails(object): """ - **UpdateDataSourceDetails** - The data to update a data source. """ diff --git a/src/oci/generative_ai_agent/models/update_knowledge_base_details.py b/src/oci/generative_ai_agent/models/update_knowledge_base_details.py index b43d2356bb..749f0083d8 100644 --- a/src/oci/generative_ai_agent/models/update_knowledge_base_details.py +++ b/src/oci/generative_ai_agent/models/update_knowledge_base_details.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class UpdateKnowledgeBaseDetails(object): """ - **UpdateKnowledgeBaseDetails** - The data to update a knowledge base. """ diff --git a/src/oci/generative_ai_agent/models/work_request.py b/src/oci/generative_ai_agent/models/work_request.py index 36c727bf72..e70bea3a2a 100644 --- a/src/oci/generative_ai_agent/models/work_request.py +++ b/src/oci/generative_ai_agent/models/work_request.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequest(object): """ - **WorkRequest** - An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. @@ -87,6 +85,18 @@ class WorkRequest(object): #: This constant has a value of "DELETE_DATA_INGESTION_JOB" OPERATION_TYPE_DELETE_DATA_INGESTION_JOB = "DELETE_DATA_INGESTION_JOB" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE_TOOL" + OPERATION_TYPE_CREATE_TOOL = "CREATE_TOOL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_TOOL" + OPERATION_TYPE_UPDATE_TOOL = "UPDATE_TOOL" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE_TOOL" + OPERATION_TYPE_DELETE_TOOL = "DELETE_TOOL" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -126,7 +136,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_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -212,7 +222,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The asynchronous operation tracked by this work request. - Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -231,7 +241,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB"] + allowed_values = ["CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL"] 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/generative_ai_agent/models/work_request_error.py b/src/oci/generative_ai_agent/models/work_request_error.py index 16cb212d1c..5f3d5421e9 100644 --- a/src/oci/generative_ai_agent/models/work_request_error.py +++ b/src/oci/generative_ai_agent/models/work_request_error.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestError(object): """ - **WorkRequestError** - An error encountered while performing an operation that is tracked by a work request. """ diff --git a/src/oci/generative_ai_agent/models/work_request_error_collection.py b/src/oci/generative_ai_agent/models/work_request_error_collection.py index a1e2479e79..6a83ebd501 100644 --- a/src/oci/generative_ai_agent/models/work_request_error_collection.py +++ b/src/oci/generative_ai_agent/models/work_request_error_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestErrorCollection(object): """ - **WorkRequestErrorCollection** - A list of work request errors. Can contain both errors and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/work_request_log_entry.py b/src/oci/generative_ai_agent/models/work_request_log_entry.py index a43578cbd7..32a5456ac9 100644 --- a/src/oci/generative_ai_agent/models/work_request_log_entry.py +++ b/src/oci/generative_ai_agent/models/work_request_log_entry.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestLogEntry(object): """ - **WorkRequestLogEntry** - A log message from performing an operation that is tracked by a work request. """ diff --git a/src/oci/generative_ai_agent/models/work_request_log_entry_collection.py b/src/oci/generative_ai_agent/models/work_request_log_entry_collection.py index 50172d232a..e68812be35 100644 --- a/src/oci/generative_ai_agent/models/work_request_log_entry_collection.py +++ b/src/oci/generative_ai_agent/models/work_request_log_entry_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestLogEntryCollection(object): """ - **WorkRequestLogEntryCollection** - A list of work request logs. Can contain both logs and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent/models/work_request_resource.py b/src/oci/generative_ai_agent/models/work_request_resource.py index bc3f0e2e72..9d9dce879b 100644 --- a/src/oci/generative_ai_agent/models/work_request_resource.py +++ b/src/oci/generative_ai_agent/models/work_request_resource.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestResource(object): """ - **WorkRequestResource** - A resource created or operated on by a work request. """ diff --git a/src/oci/generative_ai_agent/models/work_request_summary.py b/src/oci/generative_ai_agent/models/work_request_summary.py index 05b573e66c..885dd36dab 100644 --- a/src/oci/generative_ai_agent/models/work_request_summary.py +++ b/src/oci/generative_ai_agent/models/work_request_summary.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestSummary(object): """ - **WorkRequestSummary** - Summary information about an asynchronous work request. """ @@ -85,6 +83,18 @@ class WorkRequestSummary(object): #: This constant has a value of "DELETE_DATA_INGESTION_JOB" OPERATION_TYPE_DELETE_DATA_INGESTION_JOB = "DELETE_DATA_INGESTION_JOB" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE_TOOL" + OPERATION_TYPE_CREATE_TOOL = "CREATE_TOOL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_TOOL" + OPERATION_TYPE_UPDATE_TOOL = "UPDATE_TOOL" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE_TOOL" + OPERATION_TYPE_DELETE_TOOL = "DELETE_TOOL" + #: A constant which can be used with the status property of a WorkRequestSummary. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -124,7 +134,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_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -210,7 +220,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. The asynchronous operation tracked by this work request. - Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -229,7 +239,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB"] + allowed_values = ["CREATE_AGENT", "UPDATE_AGENT", "DELETE_AGENT", "MOVE_AGENT", "CREATE_AGENT_ENDPOINT", "UPDATE_AGENT_ENDPOINT", "DELETE_AGENT_ENDPOINT", "MOVE_AGENT_ENDPOINT", "CREATE_DATA_SOURCE", "UPDATE_DATA_SOURCE", "DELETE_DATA_SOURCE", "CREATE_KNOWLEDGE_BASE", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "MOVE_KNOWLEDGE_BASE", "CREATE_DATA_INGESTION_JOB", "DELETE_DATA_INGESTION_JOB", "CREATE_TOOL", "UPDATE_TOOL", "DELETE_TOOL"] 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/generative_ai_agent/models/work_request_summary_collection.py b/src/oci/generative_ai_agent/models/work_request_summary_collection.py index 6bfc28ba76..797d03a951 100644 --- a/src/oci/generative_ai_agent/models/work_request_summary_collection.py +++ b/src/oci/generative_ai_agent/models/work_request_summary_collection.py @@ -12,8 +12,6 @@ @init_model_state_from_kwargs class WorkRequestSummaryCollection(object): """ - **WorkRequestSummaryCollection** - A list of work requests. Can contain both work requests and other information, such as metadata. """ diff --git a/src/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.py b/src/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.py index 530b6a447a..4d82cc2041 100644 --- a/src/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.py +++ b/src/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.py @@ -175,7 +175,7 @@ def chat(self, agent_endpoint_id, chat_details, **kwargs): resource_path = "/agentEndpoints/{agentEndpointId}/actions/chat" method = "POST" operation_name = "chat" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/generative-ai-agents-client/20240531/Session/Chat" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/generative-ai-agents-client/20240531/AgentEndpoint/Chat" # Don't accept unknown kwargs expected_kwargs = [ diff --git a/src/oci/generative_ai_agent_runtime/models/chat_details.py b/src/oci/generative_ai_agent_runtime/models/chat_details.py index d2bcd52bc9..3e90614f9c 100644 --- a/src/oci/generative_ai_agent_runtime/models/chat_details.py +++ b/src/oci/generative_ai_agent_runtime/models/chat_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ChatDetails(object): """ - Chat details. + Chat details for managing user interactions and tool executions. """ def __init__(self, **kwargs): diff --git a/src/oci/generative_ai_agent_runtime/models/citation.py b/src/oci/generative_ai_agent_runtime/models/citation.py index 15ce5a9098..8a3f320ad7 100644 --- a/src/oci/generative_ai_agent_runtime/models/citation.py +++ b/src/oci/generative_ai_agent_runtime/models/citation.py @@ -28,19 +28,40 @@ def __init__(self, **kwargs): The value to assign to the source_location property of this Citation. :type source_location: oci.generative_ai_agent_runtime.models.SourceLocation + :param title: + The value to assign to the title property of this Citation. + :type title: str + + :param doc_id: + The value to assign to the doc_id property of this Citation. + :type doc_id: str + + :param page_numbers: + The value to assign to the page_numbers property of this Citation. + :type page_numbers: list[int] + """ self.swagger_types = { 'source_text': 'str', - 'source_location': 'SourceLocation' + 'source_location': 'SourceLocation', + 'title': 'str', + 'doc_id': 'str', + 'page_numbers': 'list[int]' } self.attribute_map = { 'source_text': 'sourceText', - 'source_location': 'sourceLocation' + 'source_location': 'sourceLocation', + 'title': 'title', + 'doc_id': 'docId', + 'page_numbers': 'pageNumbers' } self._source_text = None self._source_location = None + self._title = None + self._doc_id = None + self._page_numbers = None @property def source_text(self): @@ -86,6 +107,78 @@ def source_location(self, source_location): """ self._source_location = source_location + @property + def title(self): + """ + Gets the title of this Citation. + The title of the source text, if available. + + + :return: The title of this Citation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this Citation. + The title of the source text, if available. + + + :param title: The title of this Citation. + :type: str + """ + self._title = title + + @property + def doc_id(self): + """ + Gets the doc_id of this Citation. + The id of the retrieved document, if available. + + + :return: The doc_id of this Citation. + :rtype: str + """ + return self._doc_id + + @doc_id.setter + def doc_id(self, doc_id): + """ + Sets the doc_id of this Citation. + The id of the retrieved document, if available. + + + :param doc_id: The doc_id of this Citation. + :type: str + """ + self._doc_id = doc_id + + @property + def page_numbers(self): + """ + Gets the page_numbers of this Citation. + The page numbers on the retrieved document, if available. + + + :return: The page_numbers of this Citation. + :rtype: list[int] + """ + return self._page_numbers + + @page_numbers.setter + def page_numbers(self, page_numbers): + """ + Sets the page_numbers of this Citation. + The page numbers on the retrieved document, if available. + + + :param page_numbers: The page_numbers of this Citation. + :type: list[int] + """ + self._page_numbers = page_numbers + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/golden_gate/golden_gate_client.py b/src/oci/golden_gate/golden_gate_client.py index 61cdfaac32..e8178dd0ad 100644 --- a/src/oci/golden_gate/golden_gate_client.py +++ b/src/oci/golden_gate/golden_gate_client.py @@ -1337,6 +1337,142 @@ def change_deployment_compartment(self, deployment_id, change_deployment_compart api_reference_link=api_reference_link, required_arguments=required_arguments) + def change_pipeline_compartment(self, pipeline_id, change_pipeline_compartment_details, **kwargs): + """ + Moves the Pipeline into a different compartment within the same tenancy. When + provided, If-Match is checked against ETag values of the resource. For information about + moving resources between compartments, see `Moving Resources Between + Compartments`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes + + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.ChangePipelineCompartmentDetails change_pipeline_compartment_details: (required) + Properties to change the compartment of a Pipeline. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_pipeline_compartment API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/actions/changeCompartment" + method = "POST" + operation_name = "change_pipeline_compartment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ChangePipelineCompartment" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "is_lock_override", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"change_pipeline_compartment got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "pipelineId": pipeline_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=change_pipeline_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=change_pipeline_compartment_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def collect_deployment_diagnostic(self, deployment_id, collect_deployment_diagnostic_details, **kwargs): """ Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource. @@ -2193,6 +2329,103 @@ def create_deployment_backup(self, create_deployment_backup_details, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def create_pipeline(self, create_pipeline_details, **kwargs): + """ + Creates a new Pipeline. + + + :param oci.golden_gate.models.CreatePipelineDetails create_pipeline_details: (required) + Specification of the pipeline to create. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is rejected. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Pipeline` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_pipeline API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = [] + resource_path = "/pipelines" + method = "POST" + operation_name = "create_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/CreatePipeline" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"create_pipeline got unknown kwargs: {extra_kwargs!r}") + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_pipeline_details, + response_type="Pipeline", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_pipeline_details, + response_type="Pipeline", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def delete_certificate(self, deployment_id, certificate_key, **kwargs): """ Deletes the certificate from truststore. @@ -2881,16 +3114,15 @@ def delete_deployment_backup(self, deployment_backup_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_details, **kwargs): + def delete_pipeline(self, pipeline_id, **kwargs): """ - Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource. + Deletes a Pipeline. - :param str deployment_id: (required) - A unique Deployment identifier. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. - :param oci.golden_gate.models.DeploymentWalletExistsDetails deployment_wallet_exists_details: (required) - A placeholder for any additional metadata to describe the deployment start. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -2901,11 +3133,8 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai :param str opc_request_id: (optional) The client request ID for tracing. - :param str opc_retry_token: (optional) - A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, - without the risk of executing that same action again. Retry tokens expire after 24 hours but can be - invalidated before then due to conflicting operations. For example, if a resource was deleted and purged - from the system, then a retry of the original creation request is rejected. + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -2919,18 +3148,18 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentWalletExistsResponseDetails` + :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 deployment_wallet_exists API. + Click `here `__ to see an example of how to use delete_pipeline API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId'] - resource_path = "/deployments/{deploymentId}/actions/walletExists" - method = "POST" - operation_name = "deployment_wallet_exists" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/DeploymentWalletExists" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}" + method = "DELETE" + operation_name = "delete_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/DeletePipeline" # Don't accept unknown kwargs expected_kwargs = [ @@ -2938,15 +3167,15 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai "retry_strategy", "if_match", "opc_request_id", - "opc_retry_token" + "is_lock_override" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"deployment_wallet_exists got unknown kwargs: {extra_kwargs!r}") + f"delete_pipeline got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentId": deployment_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -2955,12 +3184,16 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + header_params = { "accept": "application/json", "content-type": "application/json", "if-match": kwargs.get("if_match", missing), - "opc-request-id": kwargs.get("opc_request_id", missing), - "opc-retry-token": kwargs.get("opc_retry_token", missing) + "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -2973,7 +3206,6 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai 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( @@ -2981,9 +3213,8 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=deployment_wallet_exists_details, - response_type="DeploymentWalletExistsResponseDetails", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -2993,24 +3224,23 @@ def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_detai resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=deployment_wallet_exists_details, - response_type="DeploymentWalletExistsResponseDetails", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def export_deployment_wallet(self, deployment_id, export_deployment_wallet_details, **kwargs): + def deployment_wallet_exists(self, deployment_id, deployment_wallet_exists_details, **kwargs): """ - Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource. + Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource. :param str deployment_id: (required) A unique Deployment identifier. - :param oci.golden_gate.models.ExportDeploymentWalletDetails export_deployment_wallet_details: (required) - Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to + :param oci.golden_gate.models.DeploymentWalletExistsDetails deployment_wallet_exists_details: (required) + A placeholder for any additional metadata to describe the deployment start. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -3039,11 +3269,131 @@ def export_deployment_wallet(self, deployment_id, export_deployment_wallet_detai allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentWalletExistsResponseDetails` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use export_deployment_wallet API. + Click `here `__ to see an example of how to use deployment_wallet_exists API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['deploymentId'] + resource_path = "/deployments/{deploymentId}/actions/walletExists" + method = "POST" + operation_name = "deployment_wallet_exists" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/DeploymentWalletExists" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"deployment_wallet_exists got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "deploymentId": deployment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=deployment_wallet_exists_details, + response_type="DeploymentWalletExistsResponseDetails", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=deployment_wallet_exists_details, + response_type="DeploymentWalletExistsResponseDetails", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def export_deployment_wallet(self, deployment_id, export_deployment_wallet_details, **kwargs): + """ + Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource. + + + :param str deployment_id: (required) + A unique Deployment identifier. + + :param oci.golden_gate.models.ExportDeploymentWalletDetails export_deployment_wallet_details: (required) + Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use export_deployment_wallet API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['deploymentId'] @@ -3934,6 +4284,106 @@ def get_deployment_upgrade(self, deployment_upgrade_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def get_pipeline(self, pipeline_id, **kwargs): + """ + Retrieves a Pipeline details. + + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ 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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Pipeline` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_pipeline API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}" + method = "GET" + operation_name = "get_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/GetPipeline" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"get_pipeline got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "pipelineId": pipeline_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Pipeline", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Pipeline", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def get_work_request(self, work_request_id, **kwargs): """ Retrieve the WorkRequest identified by the given OCID. @@ -6093,42 +6543,19 @@ def list_messages(self, deployment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_trail_files(self, deployment_id, **kwargs): + def list_pipeline_initialization_steps(self, pipeline_id, **kwargs): """ - Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c. + Retrieves a Pipeline recipe steps and its progress details. - :param str deployment_id: (required) - A unique Deployment identifier. - - :param str display_name: (optional) - A filter to return only the resources that match the entire 'displayName' given. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. - :param str trail_file_id: (optional) - A Trail File identifier + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) The client request ID for tracing. - :param int limit: (optional) - The maximum number of items to return. - - :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually - retrieved from a previous list call. - - :param str sort_by: (optional) - The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is - descending. Default order for 'displayName' is ascending. If no value is specified - displayName is the default. - - Allowed values are: "timeLastUpdated", "displayName" - - :param str sort_order: (optional) - The sort order to use, either 'asc' or 'desc'. - - Allowed values are: "ASC", "DESC" - :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6141,60 +6568,39 @@ def list_trail_files(self, deployment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TrailFileCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.PipelineInitializationSteps` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_trail_files API. + Click `here `__ to see an example of how to use list_pipeline_initialization_steps API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId'] - resource_path = "/trailFiles" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/initializationSteps" method = "GET" - operation_name = "list_trail_files" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/TrailFileSummary/ListTrailFiles" + operation_name = "list_pipeline_initialization_steps" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ListPipelineInitializationSteps" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "display_name", - "trail_file_id", - "opc_request_id", - "limit", - "page", - "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( - f"list_trail_files got unknown kwargs: {extra_kwargs!r}") + f"list_pipeline_initialization_steps got unknown kwargs: {extra_kwargs!r}") - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeLastUpdated", "displayName"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) + path_params = { + "pipelineId": pipeline_id + } - if 'sort_order' in kwargs: - sort_order_allowed_values = ["ASC", "DESC"] - if kwargs['sort_order'] not in sort_order_allowed_values: - raise ValueError( - f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" - ) + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} - query_params = { - "deploymentId": deployment_id, - "displayName": kwargs.get("display_name", missing), - "trailFileId": kwargs.get("trail_file_id", 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} + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') header_params = { "accept": "application/json", @@ -6218,9 +6624,9 @@ def list_trail_files(self, deployment_id, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, - query_params=query_params, + path_params=path_params, header_params=header_params, - response_type="TrailFileCollection", + response_type="PipelineInitializationSteps", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6229,33 +6635,23 @@ def list_trail_files(self, deployment_id, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, - query_params=query_params, + path_params=path_params, header_params=header_params, - response_type="TrailFileCollection", + response_type="PipelineInitializationSteps", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_trail_sequences(self, deployment_id, trail_file_id, **kwargs): + def list_pipeline_running_processes(self, pipeline_id, **kwargs): """ - Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c. - - - :param str deployment_id: (required) - A unique Deployment identifier. - - :param str trail_file_id: (required) - A Trail File identifier + Retrieves a Pipeline's running replication process's status like extracts/replicats. - :param str trail_sequence_id: (optional) - A Trail Sequence identifier - :param str display_name: (optional) - A filter to return only the resources that match the entire 'displayName' given. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. - :param str opc_request_id: (optional) - The client request ID for tracing. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param int limit: (optional) The maximum number of items to return. @@ -6264,18 +6660,21 @@ def list_trail_sequences(self, deployment_id, trail_file_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 sort_by: (optional) - The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is - descending. Default order for 'displayName' is ascending. If no value is specified - displayName is the default. - - Allowed values are: "timeLastUpdated", "displayName" - :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: "ASC", "DESC" + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is + descending. Default order for 'displayName' is ascending. If no value is specified + timeCreated is the default. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6288,42 +6687,43 @@ def list_trail_sequences(self, deployment_id, trail_file_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TrailSequenceCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.PipelineRunningProcessCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_trail_sequences API. + Click `here `__ to see an example of how to use list_pipeline_running_processes API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId', 'trailFileId'] - resource_path = "/trailSequences" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/runningProcesses" method = "GET" - operation_name = "list_trail_sequences" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/TrailSequenceSummary/ListTrailSequences" + operation_name = "list_pipeline_running_processes" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ListPipelineRunningProcesses" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "trail_sequence_id", - "display_name", - "opc_request_id", "limit", "page", + "sort_order", "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( - f"list_trail_sequences got unknown kwargs: {extra_kwargs!r}") + f"list_pipeline_running_processes got unknown kwargs: {extra_kwargs!r}") - if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeLastUpdated", "displayName"] - if kwargs['sort_by'] not in sort_by_allowed_values: - raise ValueError( - f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" - ) + path_params = { + "pipelineId": pipeline_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] @@ -6332,15 +6732,18 @@ def list_trail_sequences(self, deployment_id, trail_file_id, **kwargs): f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" ) + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + query_params = { - "deploymentId": deployment_id, - "trailFileId": trail_file_id, - "trailSequenceId": kwargs.get("trail_sequence_id", missing), - "displayName": kwargs.get("display_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), + "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} @@ -6366,9 +6769,10 @@ def list_trail_sequences(self, deployment_id, trail_file_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="TrailSequenceCollection", + response_type="PipelineRunningProcessCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6377,33 +6781,55 @@ def list_trail_sequences(self, deployment_id, trail_file_id, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, + path_params=path_params, query_params=query_params, header_params=header_params, - response_type="TrailSequenceCollection", + response_type="PipelineRunningProcessCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_request_errors(self, work_request_id, **kwargs): + def list_pipeline_schema_tables(self, pipeline_id, source_schema_name, target_schema_name, **kwargs): """ - Lists work request errors. + Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params. - :param str work_request_id: (required) - The `OCID`__ of the asynchronous request. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str source_schema_name: (required) + Name of the source schema obtained from get schema endpoint of the created pipeline. + + :param str target_schema_name: (required) + Name of the target schema obtained from get schema endpoint of the created pipeline. + + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. + :param str opc_request_id: (optional) The client request ID for tracing. + :param int limit: (optional) + The maximum number of items to return. + :param str page: (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param int limit: (optional) - The maximum number of items to return. + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is + descending. Default order for 'displayName' is ascending. If no value is specified + timeCreated is the default. + + Allowed values are: "timeCreated", "displayName" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6417,34 +6843,37 @@ def list_work_request_errors(self, work_request_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequestError` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.PipelineSchemaTableCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_work_request_errors API. + Click `here `__ to see an example of how to use list_pipeline_schema_tables API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['workRequestId'] - resource_path = "/workRequests/{workRequestId}/errors" + required_arguments = ['pipelineId', 'sourceSchemaName', 'targetSchemaName'] + resource_path = "/pipelines/{pipelineId}/schemaTables" method = "GET" - operation_name = "list_work_request_errors" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequestError/ListWorkRequestErrors" + operation_name = "list_pipeline_schema_tables" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ListPipelineSchemaTables" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "display_name", "opc_request_id", + "limit", "page", - "limit" + "sort_order", + "sort_by" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_request_errors got unknown kwargs: {extra_kwargs!r}") + f"list_pipeline_schema_tables got unknown kwargs: {extra_kwargs!r}") path_params = { - "workRequestId": work_request_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6453,9 +6882,28 @@ def list_work_request_errors(self, work_request_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + query_params = { + "sourceSchemaName": source_schema_name, + "targetSchemaName": target_schema_name, + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6484,7 +6932,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[WorkRequestError]", + response_type="PipelineSchemaTableCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6496,31 +6944,46 @@ def list_work_request_errors(self, work_request_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[WorkRequestError]", + response_type="PipelineSchemaTableCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_request_logs(self, work_request_id, **kwargs): + def list_pipeline_schemas(self, pipeline_id, **kwargs): """ - Lists work request logs. + Returns an array of schemas based on mapping rules for a pipeline. - :param str work_request_id: (required) - The `OCID`__ of the asynchronous request. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. + :param str opc_request_id: (optional) The client request ID for tracing. + :param int limit: (optional) + The maximum number of items to return. + :param str page: (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param int limit: (optional) - The maximum number of items to return. + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is + descending. Default order for 'displayName' is ascending. If no value is specified + timeCreated is the default. + + Allowed values are: "timeCreated", "displayName" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6534,34 +6997,37 @@ def list_work_request_logs(self, work_request_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequestLogEntry` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.PipelineSchemaCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_work_request_logs API. + Click `here `__ to see an example of how to use list_pipeline_schemas API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['workRequestId'] - resource_path = "/workRequests/{workRequestId}/logs" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/schemas" method = "GET" - operation_name = "list_work_request_logs" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequestLogEntry/ListWorkRequestLogs" + operation_name = "list_pipeline_schemas" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ListPipelineSchemas" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "display_name", "opc_request_id", + "limit", "page", - "limit" + "sort_order", + "sort_by" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_request_logs got unknown kwargs: {extra_kwargs!r}") + f"list_pipeline_schemas got unknown kwargs: {extra_kwargs!r}") path_params = { - "workRequestId": work_request_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6570,9 +7036,26 @@ def list_work_request_logs(self, work_request_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + query_params = { + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6601,7 +7084,7 @@ def list_work_request_logs(self, work_request_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[WorkRequestLogEntry]", + response_type="PipelineSchemaCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6613,15 +7096,15 @@ def list_work_request_logs(self, work_request_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="list[WorkRequestLogEntry]", + response_type="PipelineSchemaCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_work_requests(self, compartment_id, **kwargs): + def list_pipelines(self, compartment_id, **kwargs): """ - Lists the work requests in the compartment. + Lists the Pipelines in the compartment. :param str compartment_id: (required) @@ -6630,20 +7113,40 @@ def list_work_requests(self, compartment_id, **kwargs): multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. - :param str resource_id: (optional) - The `OCID`__ of the resource in which to list resources. + :param str lifecycle_state: (optional) + A filtered list of pipelines to return for a given lifecycleState. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED" - :param str opc_request_id: (optional) - The client request ID for tracing. + :param str lifecycle_sub_state: (optional) + A filtered list of pipelines to return for a given lifecycleSubState. + + Allowed values are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING" + + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. + + :param int limit: (optional) + The maximum number of items to return. :param str page: (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. - :param int limit: (optional) - The maximum number of items to return. + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is + descending. Default order for 'displayName' is ascending. If no value is specified + timeCreated is the default. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6657,38 +7160,74 @@ def list_work_requests(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequest` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.PipelineCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_work_requests API. + Click `here `__ to see an example of how to use list_pipelines API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['compartmentId'] - resource_path = "/workRequests" + resource_path = "/pipelines" method = "GET" - operation_name = "list_work_requests" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequest/ListWorkRequests" + operation_name = "list_pipelines" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/ListPipelines" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "resource_id", - "opc_request_id", + "lifecycle_state", + "lifecycle_sub_state", + "display_name", + "limit", "page", - "limit" + "sort_order", + "sort_by", + "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"list_work_requests got unknown kwargs: {extra_kwargs!r}") + f"list_pipelines got unknown kwargs: {extra_kwargs!r}") + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }" + ) + + if 'lifecycle_sub_state' in kwargs: + lifecycle_sub_state_allowed_values = ["STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING"] + if kwargs['lifecycle_sub_state'] not in lifecycle_sub_state_allowed_values: + raise ValueError( + f"Invalid value for `lifecycle_sub_state`, must be one of { lifecycle_sub_state_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) query_params = { "compartmentId": compartment_id, - "resourceId": kwargs.get("resource_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "lifecycleSubState": kwargs.get("lifecycle_sub_state", missing), + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6716,7 +7255,7 @@ def list_work_requests(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="list[WorkRequest]", + response_type="PipelineCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6727,36 +7266,52 @@ def list_work_requests(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="list[WorkRequest]", + response_type="PipelineCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def refresh_connection(self, connection_id, refresh_connection_details, **kwargs): + def list_recipes(self, compartment_id, **kwargs): """ - Refresh the external Connection attributes. + Returns an array of Recipe Summary. - :param str connection_id: (required) - The `OCID`__ of a Connection. + :param str compartment_id: (required) + 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 concerns + 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. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param str recipe_type: (optional) + The pipeline's recipe type. The default value is ZERO_ETL. - :param oci.golden_gate.models.RefreshConnectionDetails refresh_connection_details: (required) - Details of refresh external Connection attributes. + Allowed values are: "ZERO_ETL" - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call for a resource, set the - `if-match` parameter to the value of the etag from a previous GET or POST response for that - resource. The resource is updated or deleted only if the etag you provide matches the - resource's current etag value. + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. :param str opc_request_id: (optional) The client request ID for tracing. - :param bool is_lock_override: (optional) - Whether to override locks (if any exist). + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is + descending. Default order for 'displayName' is ascending. If no value is specified + timeCreated is the default. + + Allowed values are: "timeCreated", "displayName" :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -6770,51 +7325,71 @@ def refresh_connection(self, connection_id, refresh_connection_details, **kwargs allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.RecipeSummaryCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use refresh_connection API. + Click `here `__ to see an example of how to use list_recipes API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['connectionId'] - resource_path = "/connections/{connectionId}/actions/refresh" - method = "POST" - operation_name = "refresh_connection" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Connection/RefreshConnection" + required_arguments = ['compartmentId'] + resource_path = "/recipes" + method = "GET" + operation_name = "list_recipes" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/RecipeSummaryCollection/ListRecipes" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", + "recipe_type", + "display_name", "opc_request_id", - "is_lock_override" + "limit", + "page", + "sort_order", + "sort_by" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"refresh_connection got unknown kwargs: {extra_kwargs!r}") + f"list_recipes got unknown kwargs: {extra_kwargs!r}") - path_params = { - "connectionId": connection_id - } + if 'recipe_type' in kwargs: + recipe_type_allowed_values = ["ZERO_ETL"] + if kwargs['recipe_type'] not in recipe_type_allowed_values: + raise ValueError( + f"Invalid value for `recipe_type`, must be one of { recipe_type_allowed_values }" + ) - path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) - for (k, v) in six.iteritems(path_params): - if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): - raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) query_params = { - "isLockOverride": kwargs.get("is_lock_override", missing) + "compartmentId": compartment_id, + "recipeType": kwargs.get("recipe_type", missing), + "displayName": kwargs.get("display_name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} header_params = { "accept": "application/json", "content-type": "application/json", - "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -6834,10 +7409,9 @@ def refresh_connection(self, connection_id, refresh_connection_details, **kwargs self.base_client.call_api, resource_path=resource_path, method=method, - path_params=path_params, query_params=query_params, header_params=header_params, - body=refresh_connection_details, + response_type="RecipeSummaryCollection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6846,36 +7420,1138 @@ def refresh_connection(self, connection_id, refresh_connection_details, **kwargs return self.base_client.call_api( resource_path=resource_path, method=method, - path_params=path_params, query_params=query_params, header_params=header_params, - body=refresh_connection_details, + response_type="RecipeSummaryCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_trail_files(self, deployment_id, **kwargs): + """ + Lists the TrailFiles for a deployment. + Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c. + + + :param str deployment_id: (required) + A unique Deployment identifier. + + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. + + :param str trail_file_id: (optional) + A Trail File identifier + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is + descending. Default order for 'displayName' is ascending. If no value is specified + displayName is the default. + + Allowed values are: "timeLastUpdated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TrailFileCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_trail_files API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['deploymentId'] + resource_path = "/trailFiles" + method = "GET" + operation_name = "list_trail_files" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/TrailFileSummary/ListTrailFiles" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "trail_file_id", + "opc_request_id", + "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( + f"list_trail_files got unknown kwargs: {extra_kwargs!r}") + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeLastUpdated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "deploymentId": deployment_id, + "displayName": kwargs.get("display_name", missing), + "trailFileId": kwargs.get("trail_file_id", 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 is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TrailFileCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TrailFileCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_trail_sequences(self, deployment_id, trail_file_id, **kwargs): + """ + Lists the Trail Sequences for a TrailFile in a given deployment. + Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c. + + + :param str deployment_id: (required) + A unique Deployment identifier. + + :param str trail_file_id: (required) + A Trail File identifier + + :param str trail_sequence_id: (optional) + A Trail Sequence identifier + + :param str display_name: (optional) + A filter to return only the resources that match the entire 'displayName' given. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param str sort_by: (optional) + The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is + descending. Default order for 'displayName' is ascending. If no value is specified + displayName is the default. + + Allowed values are: "timeLastUpdated", "displayName" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TrailSequenceCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_trail_sequences API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['deploymentId', 'trailFileId'] + resource_path = "/trailSequences" + method = "GET" + operation_name = "list_trail_sequences" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/TrailSequenceSummary/ListTrailSequences" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "trail_sequence_id", + "display_name", + "opc_request_id", + "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( + f"list_trail_sequences got unknown kwargs: {extra_kwargs!r}") + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeLastUpdated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }" + ) + + query_params = { + "deploymentId": deployment_id, + "trailFileId": trail_file_id, + "trailSequenceId": kwargs.get("trail_sequence_id", missing), + "displayName": kwargs.get("display_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 is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TrailSequenceCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TrailSequenceCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Lists work request errors. + + + :param str work_request_id: (required) + The `OCID`__ of the asynchronous request. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequestError` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['workRequestId'] + resource_path = "/workRequests/{workRequestId}/errors" + method = "GET" + operation_name = "list_work_request_errors" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequestError/ListWorkRequestErrors" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_work_request_errors got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + 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 is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequestError]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequestError]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Lists work request logs. + + + :param str work_request_id: (required) + The `OCID`__ of the asynchronous request. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequestLogEntry` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['workRequestId'] + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + operation_name = "list_work_request_logs" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequestLogEntry/ListWorkRequestLogs" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_work_request_logs got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + 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 is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequestLogEntry]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequestLogEntry]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def list_work_requests(self, compartment_id, **kwargs): + """ + Lists the work requests in the compartment. + + + :param str compartment_id: (required) + 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 concerns + multiple resources, and those resources are not in the same compartment, it is up to the service team + to pick the primary resource whose compartment should be used. + + :param str resource_id: (optional) + The `OCID`__ of the resource in which to list resources. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually + retrieved from a previous list call. + + :param int limit: (optional) + The maximum number of items to return. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.golden_gate.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['compartmentId'] + resource_path = "/workRequests" + method = "GET" + operation_name = "list_work_requests" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/WorkRequest/ListWorkRequests" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "resource_id", + "opc_request_id", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"list_work_requests got unknown kwargs: {extra_kwargs!r}") + + query_params = { + "compartmentId": compartment_id, + "resourceId": kwargs.get("resource_id", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequest]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="list[WorkRequest]", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def refresh_connection(self, connection_id, refresh_connection_details, **kwargs): + """ + Refresh the external Connection attributes. + + + :param str connection_id: (required) + The `OCID`__ of a Connection. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.RefreshConnectionDetails refresh_connection_details: (required) + Details of refresh external Connection attributes. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use refresh_connection API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['connectionId'] + resource_path = "/connections/{connectionId}/actions/refresh" + method = "POST" + operation_name = "refresh_connection" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Connection/RefreshConnection" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "is_lock_override" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"refresh_connection got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "connectionId": connection_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=refresh_connection_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=refresh_connection_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def remove_connection_lock(self, connection_id, remove_resource_lock_details, **kwargs): + """ + Removes a lock from a Connection resource. + + + :param str connection_id: (required) + The `OCID`__ of a Connection. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) + RemoveResourceLockDetails body parameter + + :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 str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Connection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use remove_connection_lock API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['connectionId'] + resource_path = "/connections/{connectionId}/actions/removeLock" + method = "POST" + operation_name = "remove_connection_lock" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Connection/RemoveConnectionLock" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"remove_connection_lock got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "connectionId": connection_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="Connection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="Connection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lock_details, **kwargs): + """ + Removes a lock from a DeploymentBackup resource. + + + :param str deployment_backup_id: (required) + A unique DeploymentBackup identifier. + + :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) + RemoveResourceLockDetails body parameter + + :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 str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentBackup` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use remove_deployment_backup_lock API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['deploymentBackupId'] + resource_path = "/deploymentBackups/{deploymentBackupId}/actions/removeLock" + method = "POST" + operation_name = "remove_deployment_backup_lock" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentBackup/RemoveDeploymentBackupLock" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"remove_deployment_backup_lock got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "deploymentBackupId": deployment_backup_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="DeploymentBackup", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="DeploymentBackup", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, **kwargs): + """ + Removes a lock from a Deployment resource. + + + :param str deployment_id: (required) + A unique Deployment identifier. + + :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) + RemoveResourceLockDetails body parameter + + :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 str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Deployment` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use remove_deployment_lock API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['deploymentId'] + resource_path = "/deployments/{deploymentId}/actions/removeLock" + method = "POST" + operation_name = "remove_deployment_lock" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/RemoveDeploymentLock" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"remove_deployment_lock got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "deploymentId": deployment_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="Deployment", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=remove_resource_lock_details, + response_type="Deployment", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def remove_connection_lock(self, connection_id, remove_resource_lock_details, **kwargs): + def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deployment_upgrade_details, **kwargs): """ - Removes a lock from a Connection resource. + Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource. - :param str connection_id: (required) - The `OCID`__ of a Connection. + :param str deployment_upgrade_id: (required) + A unique Deployment Upgrade identifier. - __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + :param oci.golden_gate.models.RescheduleDeploymentUpgradeDetails reschedule_deployment_upgrade_details: (required) + Properties to reschedule DeploymentUpgrade. - :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) - RemoveResourceLockDetails body parameter + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. :param str opc_request_id: (optional) - Unique identifier for the request. - If you need to contact Oracle about a particular request, please provide the request ID. + The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` - parameter to the value of the etag from a previous GET or POST response for that resource. The resource - will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is 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. @@ -6889,33 +8565,34 @@ def remove_connection_lock(self, connection_id, remove_resource_lock_details, ** allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Connection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentUpgrade` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use remove_connection_lock API. + Click `here `__ to see an example of how to use reschedule_deployment_upgrade API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['connectionId'] - resource_path = "/connections/{connectionId}/actions/removeLock" + required_arguments = ['deploymentUpgradeId'] + resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/reschedule" method = "POST" - operation_name = "remove_connection_lock" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Connection/RemoveConnectionLock" + operation_name = "reschedule_deployment_upgrade" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/RescheduleDeploymentUpgrade" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "if_match", "opc_request_id", - "if_match" + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"remove_connection_lock got unknown kwargs: {extra_kwargs!r}") + f"reschedule_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") path_params = { - "connectionId": connection_id + "deploymentUpgradeId": deployment_upgrade_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6927,8 +8604,9 @@ def remove_connection_lock(self, connection_id, remove_resource_lock_details, ** header_params = { "accept": "application/json", "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing), - "if-match": kwargs.get("if_match", missing) + "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -6941,6 +8619,7 @@ def remove_connection_lock(self, connection_id, remove_resource_lock_details, ** if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -6949,8 +8628,8 @@ def remove_connection_lock(self, connection_id, remove_resource_lock_details, ** method=method, path_params=path_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="Connection", + body=reschedule_deployment_upgrade_details, + response_type="DeploymentUpgrade", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -6961,32 +8640,41 @@ def remove_connection_lock(self, connection_id, remove_resource_lock_details, ** method=method, path_params=path_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="Connection", + body=reschedule_deployment_upgrade_details, + response_type="DeploymentUpgrade", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lock_details, **kwargs): + def restore_deployment(self, deployment_backup_id, restore_deployment_details, **kwargs): """ - Removes a lock from a DeploymentBackup resource. + Restores a Deployment from a Deployment Backup created from the same Deployment. :param str deployment_backup_id: (required) A unique DeploymentBackup identifier. - :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) - RemoveResourceLockDetails body parameter + :param oci.golden_gate.models.RestoreDeploymentDetails restore_deployment_details: (required) + A placeholder for any additional metadata to describe the deployment restore. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. :param str opc_request_id: (optional) - Unique identifier for the request. - If you need to contact Oracle about a particular request, please provide the request ID. + The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` - parameter to the value of the etag from a previous GET or POST response for that resource. The resource - will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is rejected. + + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7000,30 +8688,32 @@ def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lo allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentBackup` + :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 remove_deployment_backup_lock API. + Click `here `__ to see an example of how to use restore_deployment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['deploymentBackupId'] - resource_path = "/deploymentBackups/{deploymentBackupId}/actions/removeLock" + resource_path = "/deploymentBackups/{deploymentBackupId}/actions/restore" method = "POST" - operation_name = "remove_deployment_backup_lock" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentBackup/RemoveDeploymentBackupLock" + operation_name = "restore_deployment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentBackup/RestoreDeployment" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "if_match", "opc_request_id", - "if_match" + "opc_retry_token", + "is_lock_override" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"remove_deployment_backup_lock got unknown kwargs: {extra_kwargs!r}") + f"restore_deployment got unknown kwargs: {extra_kwargs!r}") path_params = { "deploymentBackupId": deployment_backup_id @@ -7035,11 +8725,17 @@ def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lo if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + header_params = { "accept": "application/json", "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing), - "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} @@ -7052,6 +8748,7 @@ def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lo 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( @@ -7059,9 +8756,9 @@ def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lo resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="DeploymentBackup", + body=restore_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7071,33 +8768,42 @@ def remove_deployment_backup_lock(self, deployment_backup_id, remove_resource_lo resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="DeploymentBackup", + body=restore_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, **kwargs): + def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment_upgrade_details, **kwargs): """ - Removes a lock from a Deployment resource. + Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource. - :param str deployment_id: (required) - A unique Deployment identifier. + :param str deployment_upgrade_id: (required) + A unique Deployment Upgrade identifier. - :param oci.golden_gate.models.RemoveResourceLockDetails remove_resource_lock_details: (required) - RemoveResourceLockDetails body parameter + :param oci.golden_gate.models.RollbackDeploymentUpgradeDetails rollback_deployment_upgrade_details: (required) + A placeholder for any additional metadata to describe the deployment rollback. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. :param str opc_request_id: (optional) - Unique identifier for the request. - If you need to contact Oracle about a particular request, please provide the request ID. + The client request ID for tracing. - :param str if_match: (optional) - For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` - parameter to the value of the etag from a previous GET or POST response for that resource. The resource - will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, + without the risk of executing that same action again. Retry tokens expire after 24 hours but can be + invalidated before then due to conflicting operations. For example, if a resource was deleted and purged + from the system, then a retry of the original creation request is rejected. + + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7111,33 +8817,35 @@ def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, ** allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.Deployment` + :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 remove_deployment_lock API. + Click `here `__ to see an example of how to use rollback_deployment_upgrade API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId'] - resource_path = "/deployments/{deploymentId}/actions/removeLock" + required_arguments = ['deploymentUpgradeId'] + resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/rollback" method = "POST" - operation_name = "remove_deployment_lock" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/RemoveDeploymentLock" + operation_name = "rollback_deployment_upgrade" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/RollbackDeploymentUpgrade" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "if_match", "opc_request_id", - "if_match" + "opc_retry_token", + "is_lock_override" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"remove_deployment_lock got unknown kwargs: {extra_kwargs!r}") + f"rollback_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentId": deployment_id + "deploymentUpgradeId": deployment_upgrade_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7146,11 +8854,17 @@ def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, ** if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + header_params = { "accept": "application/json", "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing), - "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} @@ -7163,6 +8877,7 @@ def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, ** if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -7170,9 +8885,9 @@ def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, ** resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="Deployment", + body=rollback_deployment_upgrade_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7182,24 +8897,24 @@ def remove_deployment_lock(self, deployment_id, remove_resource_lock_details, ** resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=remove_resource_lock_details, - response_type="Deployment", + body=rollback_deployment_upgrade_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deployment_upgrade_details, **kwargs): + def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upgrade_details, **kwargs): """ - Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource. + Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource. :param str deployment_upgrade_id: (required) A unique Deployment Upgrade identifier. - :param oci.golden_gate.models.RescheduleDeploymentUpgradeDetails reschedule_deployment_upgrade_details: (required) - Properties to reschedule DeploymentUpgrade. + :param oci.golden_gate.models.SnoozeDeploymentUpgradeDetails snooze_deployment_upgrade_details: (required) + A placeholder for any additional metadata to describe the snooze of deployment upgrade. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7228,18 +8943,18 @@ def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deploy allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.DeploymentUpgrade` + :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 reschedule_deployment_upgrade API. + Click `here `__ to see an example of how to use snooze_deployment_upgrade API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. required_arguments = ['deploymentUpgradeId'] - resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/reschedule" + resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/snooze" method = "POST" - operation_name = "reschedule_deployment_upgrade" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/RescheduleDeploymentUpgrade" + operation_name = "snooze_deployment_upgrade" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/SnoozeDeploymentUpgrade" # Don't accept unknown kwargs expected_kwargs = [ @@ -7252,7 +8967,7 @@ def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deploy extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"reschedule_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") + f"snooze_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") path_params = { "deploymentUpgradeId": deployment_upgrade_id @@ -7291,8 +9006,7 @@ def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deploy method=method, path_params=path_params, header_params=header_params, - body=reschedule_deployment_upgrade_details, - response_type="DeploymentUpgrade", + body=snooze_deployment_upgrade_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7303,23 +9017,22 @@ def reschedule_deployment_upgrade(self, deployment_upgrade_id, reschedule_deploy method=method, path_params=path_params, header_params=header_params, - body=reschedule_deployment_upgrade_details, - response_type="DeploymentUpgrade", + body=snooze_deployment_upgrade_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def restore_deployment(self, deployment_backup_id, restore_deployment_details, **kwargs): + def start_deployment(self, deployment_id, start_deployment_details, **kwargs): """ - Restores a Deployment from a Deployment Backup created from the same Deployment. + Starts a Deployment. When provided, If-Match is checked against ETag values of the resource. - :param str deployment_backup_id: (required) - A unique DeploymentBackup identifier. + :param str deployment_id: (required) + A unique Deployment identifier. - :param oci.golden_gate.models.RestoreDeploymentDetails restore_deployment_details: (required) - A placeholder for any additional metadata to describe the deployment restore. + :param oci.golden_gate.models.StartDeploymentDetails start_deployment_details: (required) + A placeholder for any additional metadata to describe the deployment start. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7355,14 +9068,14 @@ def restore_deployment(self, deployment_backup_id, restore_deployment_details, * :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use restore_deployment API. + Click `here `__ to see an example of how to use start_deployment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentBackupId'] - resource_path = "/deploymentBackups/{deploymentBackupId}/actions/restore" + required_arguments = ['deploymentId'] + resource_path = "/deployments/{deploymentId}/actions/start" method = "POST" - operation_name = "restore_deployment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentBackup/RestoreDeployment" + operation_name = "start_deployment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/StartDeployment" # Don't accept unknown kwargs expected_kwargs = [ @@ -7376,10 +9089,10 @@ def restore_deployment(self, deployment_backup_id, restore_deployment_details, * extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"restore_deployment got unknown kwargs: {extra_kwargs!r}") + f"start_deployment got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentBackupId": deployment_backup_id + "deploymentId": deployment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7421,7 +9134,7 @@ def restore_deployment(self, deployment_backup_id, restore_deployment_details, * path_params=path_params, query_params=query_params, header_params=header_params, - body=restore_deployment_details, + body=start_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7433,22 +9146,24 @@ def restore_deployment(self, deployment_backup_id, restore_deployment_details, * path_params=path_params, query_params=query_params, header_params=header_params, - body=restore_deployment_details, + body=start_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment_upgrade_details, **kwargs): + def start_pipeline(self, pipeline_id, start_pipeline_details, **kwargs): """ - Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource. + Starts the pipeline for data replication. - :param str deployment_upgrade_id: (required) - A unique Deployment Upgrade identifier. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param oci.golden_gate.models.RollbackDeploymentUpgradeDetails rollback_deployment_upgrade_details: (required) - A placeholder for any additional metadata to describe the deployment rollback. + :param oci.golden_gate.models.StartPipelineDetails start_pipeline_details: (required) + Details to start Pipeline. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7484,14 +9199,14 @@ def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use rollback_deployment_upgrade API. + Click `here `__ to see an example of how to use start_pipeline API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentUpgradeId'] - resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/rollback" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/actions/start" method = "POST" - operation_name = "rollback_deployment_upgrade" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/RollbackDeploymentUpgrade" + operation_name = "start_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/StartPipeline" # Don't accept unknown kwargs expected_kwargs = [ @@ -7505,10 +9220,10 @@ def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"rollback_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") + f"start_pipeline got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentUpgradeId": deployment_upgrade_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7550,7 +9265,7 @@ def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment path_params=path_params, query_params=query_params, header_params=header_params, - body=rollback_deployment_upgrade_details, + body=start_pipeline_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7562,22 +9277,22 @@ def rollback_deployment_upgrade(self, deployment_upgrade_id, rollback_deployment path_params=path_params, query_params=query_params, header_params=header_params, - body=rollback_deployment_upgrade_details, + body=start_pipeline_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upgrade_details, **kwargs): + def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): """ - Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource. + Stops a Deployment. When provided, If-Match is checked against ETag values of the resource. - :param str deployment_upgrade_id: (required) - A unique Deployment Upgrade identifier. + :param str deployment_id: (required) + A unique Deployment identifier. - :param oci.golden_gate.models.SnoozeDeploymentUpgradeDetails snooze_deployment_upgrade_details: (required) - A placeholder for any additional metadata to describe the snooze of deployment upgrade. + :param oci.golden_gate.models.StopDeploymentDetails stop_deployment_details: (required) + A placeholder for any additional metadata to describe the deployment stop. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7594,6 +9309,9 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7610,14 +9328,14 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use snooze_deployment_upgrade API. + Click `here `__ to see an example of how to use stop_deployment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentUpgradeId'] - resource_path = "/deploymentUpgrades/{deploymentUpgradeId}/actions/snooze" + required_arguments = ['deploymentId'] + resource_path = "/deployments/{deploymentId}/actions/stop" method = "POST" - operation_name = "snooze_deployment_upgrade" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/DeploymentUpgrade/SnoozeDeploymentUpgrade" + operation_name = "stop_deployment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/StopDeployment" # Don't accept unknown kwargs expected_kwargs = [ @@ -7625,15 +9343,16 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg "retry_strategy", "if_match", "opc_request_id", - "opc_retry_token" + "opc_retry_token", + "is_lock_override" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"snooze_deployment_upgrade got unknown kwargs: {extra_kwargs!r}") + f"stop_deployment got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentUpgradeId": deployment_upgrade_id + "deploymentId": deployment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7642,6 +9361,11 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + query_params = { + "isLockOverride": kwargs.get("is_lock_override", 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", @@ -7668,8 +9392,9 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=snooze_deployment_upgrade_details, + body=stop_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7679,23 +9404,26 @@ def snooze_deployment_upgrade(self, deployment_upgrade_id, snooze_deployment_upg resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, - body=snooze_deployment_upgrade_details, + body=stop_deployment_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def start_deployment(self, deployment_id, start_deployment_details, **kwargs): + def stop_pipeline(self, pipeline_id, stop_pipeline_details, **kwargs): """ - Starts a Deployment. When provided, If-Match is checked against ETag values of the resource. + Stops the pipeline for data replication. - :param str deployment_id: (required) - A unique Deployment identifier. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. - :param oci.golden_gate.models.StartDeploymentDetails start_deployment_details: (required) - A placeholder for any additional metadata to describe the deployment start. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.StopPipelineDetails stop_pipeline_details: (required) + Details to stop the pipeline. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7731,14 +9459,14 @@ def start_deployment(self, deployment_id, start_deployment_details, **kwargs): :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use start_deployment API. + Click `here `__ to see an example of how to use stop_pipeline API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId'] - resource_path = "/deployments/{deploymentId}/actions/start" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/actions/stop" method = "POST" - operation_name = "start_deployment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/StartDeployment" + operation_name = "stop_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/StopPipeline" # Don't accept unknown kwargs expected_kwargs = [ @@ -7752,10 +9480,10 @@ def start_deployment(self, deployment_id, start_deployment_details, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"start_deployment got unknown kwargs: {extra_kwargs!r}") + f"stop_pipeline got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentId": deployment_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7797,7 +9525,7 @@ def start_deployment(self, deployment_id, start_deployment_details, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - body=start_deployment_details, + body=stop_pipeline_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7809,22 +9537,25 @@ def start_deployment(self, deployment_id, start_deployment_details, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - body=start_deployment_details, + body=stop_pipeline_details, allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): + def test_connection_assignment(self, connection_assignment_id, test_connection_assignment_details, **kwargs): """ - Stops a Deployment. When provided, If-Match is checked against ETag values of the resource. + Tests the connectivity between given GoldenGate deployment and one of the associated database / service. + When provided, If-Match is checked against ETag values of the resource. - :param str deployment_id: (required) - A unique Deployment identifier. + :param str connection_assignment_id: (required) + The `OCID`__ of the Connection Assignment. - :param oci.golden_gate.models.StopDeploymentDetails stop_deployment_details: (required) - A placeholder for any additional metadata to describe the deployment stop. + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.TestConnectionAssignmentDetails test_connection_assignment_details: (required) + A placeholder for any additional metadata to describe the requested tests of the assigned connection. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7841,9 +9572,6 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. - :param bool is_lock_override: (optional) - Whether to override locks (if any exist). - :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7856,18 +9584,18 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type None + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TestConnectionAssignmentResult` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use stop_deployment API. + Click `here `__ to see an example of how to use test_connection_assignment API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['deploymentId'] - resource_path = "/deployments/{deploymentId}/actions/stop" + required_arguments = ['connectionAssignmentId'] + resource_path = "/connectionAssignments/{connectionAssignmentId}/actions/test" method = "POST" - operation_name = "stop_deployment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Deployment/StopDeployment" + operation_name = "test_connection_assignment" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/ConnectionAssignment/TestConnectionAssignment" # Don't accept unknown kwargs expected_kwargs = [ @@ -7875,16 +9603,15 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): "retry_strategy", "if_match", "opc_request_id", - "opc_retry_token", - "is_lock_override" + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"stop_deployment got unknown kwargs: {extra_kwargs!r}") + f"test_connection_assignment got unknown kwargs: {extra_kwargs!r}") path_params = { - "deploymentId": deployment_id + "connectionAssignmentId": connection_assignment_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -7893,11 +9620,6 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') - query_params = { - "isLockOverride": kwargs.get("is_lock_override", 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", @@ -7924,9 +9646,9 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - body=stop_deployment_details, + body=test_connection_assignment_details, + response_type="TestConnectionAssignmentResult", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -7936,27 +9658,30 @@ def stop_deployment(self, deployment_id, stop_deployment_details, **kwargs): resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - body=stop_deployment_details, + body=test_connection_assignment_details, + response_type="TestConnectionAssignmentResult", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, required_arguments=required_arguments) - def test_connection_assignment(self, connection_assignment_id, test_connection_assignment_details, **kwargs): + def test_pipeline_connection(self, pipeline_id, test_pipeline_connection_details, **kwargs): """ - Tests the connectivity between given GoldenGate deployment and one of the associated database / service. + Tests pipeline connections against pipeline to verify the connectivity. When provided, If-Match is checked against ETag values of the resource. - :param str connection_assignment_id: (required) - The `OCID`__ of the Connection Assignment. + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm - :param oci.golden_gate.models.TestConnectionAssignmentDetails test_connection_assignment_details: (required) - A placeholder for any additional metadata to describe the requested tests of the assigned connection. + :param oci.golden_gate.models.TestPipelineConnectionDetails test_pipeline_connection_details: (required) + Additional metadata required to test the connection assigned to the pipeline. + + :param str opc_request_id: (optional) + The client request ID for tracing. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the @@ -7964,9 +9689,6 @@ def test_connection_assignment(self, connection_assignment_id, test_connection_a resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value. - :param str opc_request_id: (optional) - The client request ID for tracing. - :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be @@ -7985,34 +9707,34 @@ def test_connection_assignment(self, connection_assignment_id, test_connection_a allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TestConnectionAssignmentResult` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.golden_gate.models.TestPipelineConnectionResult` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use test_connection_assignment API. + Click `here `__ to see an example of how to use test_pipeline_connection API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['connectionAssignmentId'] - resource_path = "/connectionAssignments/{connectionAssignmentId}/actions/test" + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}/actions/testConnection" method = "POST" - operation_name = "test_connection_assignment" - api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/ConnectionAssignment/TestConnectionAssignment" + operation_name = "test_pipeline_connection" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/TestPipelineConnection" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "if_match", "opc_request_id", + "if_match", "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - f"test_connection_assignment got unknown kwargs: {extra_kwargs!r}") + f"test_pipeline_connection got unknown kwargs: {extra_kwargs!r}") path_params = { - "connectionAssignmentId": connection_assignment_id + "pipelineId": pipeline_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -8024,8 +9746,8 @@ def test_connection_assignment(self, connection_assignment_id, test_connection_a header_params = { "accept": "application/json", "content-type": "application/json", - "if-match": kwargs.get("if_match", missing), "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing), "opc-retry-token": kwargs.get("opc_retry_token", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -8048,8 +9770,8 @@ def test_connection_assignment(self, connection_assignment_id, test_connection_a method=method, path_params=path_params, header_params=header_params, - body=test_connection_assignment_details, - response_type="TestConnectionAssignmentResult", + body=test_pipeline_connection_details, + response_type="TestPipelineConnectionResult", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -8060,8 +9782,8 @@ def test_connection_assignment(self, connection_assignment_id, test_connection_a method=method, path_params=path_params, header_params=header_params, - body=test_connection_assignment_details, - response_type="TestConnectionAssignmentResult", + body=test_pipeline_connection_details, + response_type="TestPipelineConnectionResult", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link, @@ -8541,6 +10263,128 @@ def update_deployment_backup(self, deployment_backup_id, update_deployment_backu api_reference_link=api_reference_link, required_arguments=required_arguments) + def update_pipeline(self, pipeline_id, update_pipeline_details, **kwargs): + """ + Updates the Pipeline. + + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.UpdatePipelineDetails update_pipeline_details: (required) + The existing pipeline specifications to apply. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the + `if-match` parameter to the value of the etag from a previous GET or POST response for that + resource. The resource is updated or deleted only if the etag you provide matches the + resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param bool is_lock_override: (optional) + Whether to override locks (if any exist). + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_pipeline API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['pipelineId'] + resource_path = "/pipelines/{pipelineId}" + method = "PUT" + operation_name = "update_pipeline" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/goldengate/20200407/Pipeline/UpdatePipeline" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "is_lock_override" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + f"update_pipeline got unknown kwargs: {extra_kwargs!r}") + + path_params = { + "pipelineId": pipeline_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string') + + query_params = { + "isLockOverride": kwargs.get("is_lock_override", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=update_pipeline_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=update_pipeline_details, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def upgrade_deployment(self, deployment_id, upgrade_deployment_details, **kwargs): """ Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource. diff --git a/src/oci/golden_gate/golden_gate_client_composite_operations.py b/src/oci/golden_gate/golden_gate_client_composite_operations.py index 74ba1b91b1..50db227480 100644 --- a/src/oci/golden_gate/golden_gate_client_composite_operations.py +++ b/src/oci/golden_gate/golden_gate_client_composite_operations.py @@ -377,6 +377,50 @@ def change_deployment_compartment_and_wait_for_state(self, deployment_id, change except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def change_pipeline_compartment_and_wait_for_state(self, pipeline_id, change_pipeline_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.change_pipeline_compartment` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.ChangePipelineCompartmentDetails change_pipeline_compartment_details: (required) + Properties to change the compartment of a Pipeline. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.change_pipeline_compartment` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.change_pipeline_compartment(pipeline_id, change_pipeline_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def collect_deployment_diagnostic_and_wait_for_state(self, deployment_id, collect_deployment_diagnostic_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.collect_deployment_diagnostic` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` @@ -698,6 +742,45 @@ def create_deployment_backup_and_wait_for_state(self, create_deployment_backup_d except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def create_pipeline_and_wait_for_state(self, create_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.create_pipeline` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param oci.golden_gate.models.CreatePipelineDetails create_pipeline_details: (required) + Specification of the pipeline to create. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.create_pipeline` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.create_pipeline(create_pipeline_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_certificate_and_wait_for_state(self, deployment_id, certificate_key, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.delete_certificate` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` @@ -987,6 +1070,55 @@ def delete_deployment_backup_and_wait_for_state(self, deployment_backup_id, wait except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def delete_pipeline_and_wait_for_state(self, pipeline_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.delete_pipeline` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.delete_pipeline` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = None + try: + operation_result = self.client.delete_pipeline(pipeline_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def export_deployment_wallet_and_wait_for_state(self, deployment_id, export_deployment_wallet_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.export_deployment_wallet` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` @@ -1423,6 +1555,50 @@ def start_deployment_and_wait_for_state(self, deployment_id, start_deployment_de except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def start_pipeline_and_wait_for_state(self, pipeline_id, start_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.start_pipeline` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.StartPipelineDetails start_pipeline_details: (required) + Details to start Pipeline. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.start_pipeline` + + :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.start_pipeline(pipeline_id, start_pipeline_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def stop_deployment_and_wait_for_state(self, deployment_id, stop_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.stop_deployment` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` @@ -1465,6 +1641,50 @@ def stop_deployment_and_wait_for_state(self, deployment_id, stop_deployment_deta except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def stop_pipeline_and_wait_for_state(self, pipeline_id, stop_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.stop_pipeline` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.StopPipelineDetails stop_pipeline_details: (required) + Details to stop the pipeline. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.stop_pipeline` + + :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.stop_pipeline(pipeline_id, stop_pipeline_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_connection_and_wait_for_state(self, connection_id, update_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.update_connection` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` @@ -1638,6 +1858,50 @@ def update_deployment_backup_and_wait_for_state(self, deployment_backup_id, upda except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def update_pipeline_and_wait_for_state(self, pipeline_id, update_pipeline_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.golden_gate.GoldenGateClient.update_pipeline` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` + to enter the given state(s). + + :param str pipeline_id: (required) + The `OCID`__ of the pipeline created. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param oci.golden_gate.models.UpdatePipelineDetails update_pipeline_details: (required) + The existing pipeline specifications to apply. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.golden_gate.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.golden_gate.GoldenGateClient.update_pipeline` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_pipeline(pipeline_id, update_pipeline_details, **operation_kwargs) + if not wait_for_states: + return operation_result + lowered_wait_for_states = [w.lower() for w in wait_for_states] + if 'opc-work-request-id' not in operation_result.headers: + return operation_result + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def upgrade_deployment_and_wait_for_state(self, deployment_id, upgrade_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.golden_gate.GoldenGateClient.upgrade_deployment` and waits for the :py:class:`~oci.golden_gate.models.WorkRequest` diff --git a/src/oci/golden_gate/models/__init__.py b/src/oci/golden_gate/models/__init__.py index 847b27e2c6..c85c81f3b1 100644 --- a/src/oci/golden_gate/models/__init__.py +++ b/src/oci/golden_gate/models/__init__.py @@ -27,6 +27,7 @@ from .change_database_registration_compartment_details import ChangeDatabaseRegistrationCompartmentDetails from .change_deployment_backup_compartment_details import ChangeDeploymentBackupCompartmentDetails from .change_deployment_compartment_details import ChangeDeploymentCompartmentDetails +from .change_pipeline_compartment_details import ChangePipelineCompartmentDetails from .collect_deployment_diagnostic_details import CollectDeploymentDiagnosticDetails from .connection import Connection from .connection_assignment import ConnectionAssignment @@ -65,9 +66,11 @@ from .create_ogg_deployment_details import CreateOggDeploymentDetails from .create_oracle_connection_details import CreateOracleConnectionDetails from .create_oracle_nosql_connection_details import CreateOracleNosqlConnectionDetails +from .create_pipeline_details import CreatePipelineDetails from .create_postgresql_connection_details import CreatePostgresqlConnectionDetails from .create_redis_connection_details import CreateRedisConnectionDetails from .create_snowflake_connection_details import CreateSnowflakeConnectionDetails +from .create_zero_etl_pipeline_details import CreateZeroEtlPipelineDetails from .database_registration import DatabaseRegistration from .database_registration_collection import DatabaseRegistrationCollection from .database_registration_summary import DatabaseRegistrationSummary @@ -82,8 +85,11 @@ from .default_rollback_deployment_upgrade_details import DefaultRollbackDeploymentUpgradeDetails from .default_snooze_deployment_upgrade_details import DefaultSnoozeDeploymentUpgradeDetails from .default_start_deployment_details import DefaultStartDeploymentDetails +from .default_start_pipeline_details import DefaultStartPipelineDetails from .default_stop_deployment_details import DefaultStopDeploymentDetails +from .default_stop_pipeline_details import DefaultStopPipelineDetails from .default_test_connection_assignment_details import DefaultTestConnectionAssignmentDetails +from .default_test_pipeline_connection_details import DefaultTestPipelineConnectionDetails from .default_upgrade_deployment_upgrade_details import DefaultUpgradeDeploymentUpgradeDetails from .deployment import Deployment from .deployment_backup import DeploymentBackup @@ -124,6 +130,7 @@ from .hdfs_connection_summary import HdfsConnectionSummary from .import_deployment_wallet_details import ImportDeploymentWalletDetails from .ingress_ip_details import IngressIpDetails +from .initial_data_load import InitialDataLoad from .java_message_service_connection import JavaMessageServiceConnection from .java_message_service_connection_summary import JavaMessageServiceConnectionSummary from .kafka_bootstrap_server import KafkaBootstrapServer @@ -134,6 +141,7 @@ from .library_url import LibraryUrl from .maintenance_configuration import MaintenanceConfiguration from .maintenance_window import MaintenanceWindow +from .mapping_rule import MappingRule from .message_summary import MessageSummary from .microsoft_sqlserver_connection import MicrosoftSqlserverConnection from .microsoft_sqlserver_connection_summary import MicrosoftSqlserverConnectionSummary @@ -149,12 +157,27 @@ from .oracle_connection_summary import OracleConnectionSummary from .oracle_nosql_connection import OracleNosqlConnection from .oracle_nosql_connection_summary import OracleNosqlConnectionSummary +from .pipeline import Pipeline +from .pipeline_collection import PipelineCollection +from .pipeline_initialization_step import PipelineInitializationStep +from .pipeline_initialization_steps import PipelineInitializationSteps +from .pipeline_running_process_collection import PipelineRunningProcessCollection +from .pipeline_running_process_summary import PipelineRunningProcessSummary +from .pipeline_schema_collection import PipelineSchemaCollection +from .pipeline_schema_summary import PipelineSchemaSummary +from .pipeline_schema_table_collection import PipelineSchemaTableCollection +from .pipeline_schema_table_summary import PipelineSchemaTableSummary +from .pipeline_summary import PipelineSummary from .postgresql_connection import PostgresqlConnection from .postgresql_connection_summary import PostgresqlConnectionSummary +from .process_options import ProcessOptions +from .recipe_summary import RecipeSummary +from .recipe_summary_collection import RecipeSummaryCollection from .redis_connection import RedisConnection from .redis_connection_summary import RedisConnectionSummary from .refresh_connection_details import RefreshConnectionDetails from .remove_resource_lock_details import RemoveResourceLockDetails +from .replicate_schema_change import ReplicateSchemaChange from .reschedule_deployment_upgrade_details import RescheduleDeploymentUpgradeDetails from .reschedule_deployment_upgrade_to_date_details import RescheduleDeploymentUpgradeToDateDetails from .resource_lock import ResourceLock @@ -163,11 +186,19 @@ from .snooze_deployment_upgrade_details import SnoozeDeploymentUpgradeDetails from .snowflake_connection import SnowflakeConnection from .snowflake_connection_summary import SnowflakeConnectionSummary +from .source_pipeline_connection_details import SourcePipelineConnectionDetails from .start_deployment_details import StartDeploymentDetails +from .start_pipeline_details import StartPipelineDetails +from .step_message import StepMessage from .stop_deployment_details import StopDeploymentDetails +from .stop_pipeline_details import StopPipelineDetails +from .target_pipeline_connection_details import TargetPipelineConnectionDetails from .test_connection_assignment_details import TestConnectionAssignmentDetails from .test_connection_assignment_error import TestConnectionAssignmentError from .test_connection_assignment_result import TestConnectionAssignmentResult +from .test_pipeline_connection_details import TestPipelineConnectionDetails +from .test_pipeline_connection_error import TestPipelineConnectionError +from .test_pipeline_connection_result import TestPipelineConnectionResult from .trail_file_collection import TrailFileCollection from .trail_file_summary import TrailFileSummary from .trail_sequence_collection import TrailSequenceCollection @@ -201,9 +232,11 @@ from .update_ogg_deployment_details import UpdateOggDeploymentDetails from .update_oracle_connection_details import UpdateOracleConnectionDetails from .update_oracle_nosql_connection_details import UpdateOracleNosqlConnectionDetails +from .update_pipeline_details import UpdatePipelineDetails from .update_postgresql_connection_details import UpdatePostgresqlConnectionDetails from .update_redis_connection_details import UpdateRedisConnectionDetails from .update_snowflake_connection_details import UpdateSnowflakeConnectionDetails +from .update_zero_etl_pipeline_details import UpdateZeroEtlPipelineDetails from .upgrade_deployment_current_release_details import UpgradeDeploymentCurrentReleaseDetails from .upgrade_deployment_details import UpgradeDeploymentDetails from .upgrade_deployment_specific_release_details import UpgradeDeploymentSpecificReleaseDetails @@ -212,6 +245,8 @@ from .work_request_error import WorkRequestError from .work_request_log_entry import WorkRequestLogEntry from .work_request_resource import WorkRequestResource +from .zero_etl_pipeline import ZeroEtlPipeline +from .zero_etl_pipeline_summary import ZeroEtlPipelineSummary # Maps type names to classes for golden_gate services. golden_gate_type_mapping = { @@ -236,6 +271,7 @@ "ChangeDatabaseRegistrationCompartmentDetails": ChangeDatabaseRegistrationCompartmentDetails, "ChangeDeploymentBackupCompartmentDetails": ChangeDeploymentBackupCompartmentDetails, "ChangeDeploymentCompartmentDetails": ChangeDeploymentCompartmentDetails, + "ChangePipelineCompartmentDetails": ChangePipelineCompartmentDetails, "CollectDeploymentDiagnosticDetails": CollectDeploymentDiagnosticDetails, "Connection": Connection, "ConnectionAssignment": ConnectionAssignment, @@ -274,9 +310,11 @@ "CreateOggDeploymentDetails": CreateOggDeploymentDetails, "CreateOracleConnectionDetails": CreateOracleConnectionDetails, "CreateOracleNosqlConnectionDetails": CreateOracleNosqlConnectionDetails, + "CreatePipelineDetails": CreatePipelineDetails, "CreatePostgresqlConnectionDetails": CreatePostgresqlConnectionDetails, "CreateRedisConnectionDetails": CreateRedisConnectionDetails, "CreateSnowflakeConnectionDetails": CreateSnowflakeConnectionDetails, + "CreateZeroEtlPipelineDetails": CreateZeroEtlPipelineDetails, "DatabaseRegistration": DatabaseRegistration, "DatabaseRegistrationCollection": DatabaseRegistrationCollection, "DatabaseRegistrationSummary": DatabaseRegistrationSummary, @@ -291,8 +329,11 @@ "DefaultRollbackDeploymentUpgradeDetails": DefaultRollbackDeploymentUpgradeDetails, "DefaultSnoozeDeploymentUpgradeDetails": DefaultSnoozeDeploymentUpgradeDetails, "DefaultStartDeploymentDetails": DefaultStartDeploymentDetails, + "DefaultStartPipelineDetails": DefaultStartPipelineDetails, "DefaultStopDeploymentDetails": DefaultStopDeploymentDetails, + "DefaultStopPipelineDetails": DefaultStopPipelineDetails, "DefaultTestConnectionAssignmentDetails": DefaultTestConnectionAssignmentDetails, + "DefaultTestPipelineConnectionDetails": DefaultTestPipelineConnectionDetails, "DefaultUpgradeDeploymentUpgradeDetails": DefaultUpgradeDeploymentUpgradeDetails, "Deployment": Deployment, "DeploymentBackup": DeploymentBackup, @@ -333,6 +374,7 @@ "HdfsConnectionSummary": HdfsConnectionSummary, "ImportDeploymentWalletDetails": ImportDeploymentWalletDetails, "IngressIpDetails": IngressIpDetails, + "InitialDataLoad": InitialDataLoad, "JavaMessageServiceConnection": JavaMessageServiceConnection, "JavaMessageServiceConnectionSummary": JavaMessageServiceConnectionSummary, "KafkaBootstrapServer": KafkaBootstrapServer, @@ -343,6 +385,7 @@ "LibraryUrl": LibraryUrl, "MaintenanceConfiguration": MaintenanceConfiguration, "MaintenanceWindow": MaintenanceWindow, + "MappingRule": MappingRule, "MessageSummary": MessageSummary, "MicrosoftSqlserverConnection": MicrosoftSqlserverConnection, "MicrosoftSqlserverConnectionSummary": MicrosoftSqlserverConnectionSummary, @@ -358,12 +401,27 @@ "OracleConnectionSummary": OracleConnectionSummary, "OracleNosqlConnection": OracleNosqlConnection, "OracleNosqlConnectionSummary": OracleNosqlConnectionSummary, + "Pipeline": Pipeline, + "PipelineCollection": PipelineCollection, + "PipelineInitializationStep": PipelineInitializationStep, + "PipelineInitializationSteps": PipelineInitializationSteps, + "PipelineRunningProcessCollection": PipelineRunningProcessCollection, + "PipelineRunningProcessSummary": PipelineRunningProcessSummary, + "PipelineSchemaCollection": PipelineSchemaCollection, + "PipelineSchemaSummary": PipelineSchemaSummary, + "PipelineSchemaTableCollection": PipelineSchemaTableCollection, + "PipelineSchemaTableSummary": PipelineSchemaTableSummary, + "PipelineSummary": PipelineSummary, "PostgresqlConnection": PostgresqlConnection, "PostgresqlConnectionSummary": PostgresqlConnectionSummary, + "ProcessOptions": ProcessOptions, + "RecipeSummary": RecipeSummary, + "RecipeSummaryCollection": RecipeSummaryCollection, "RedisConnection": RedisConnection, "RedisConnectionSummary": RedisConnectionSummary, "RefreshConnectionDetails": RefreshConnectionDetails, "RemoveResourceLockDetails": RemoveResourceLockDetails, + "ReplicateSchemaChange": ReplicateSchemaChange, "RescheduleDeploymentUpgradeDetails": RescheduleDeploymentUpgradeDetails, "RescheduleDeploymentUpgradeToDateDetails": RescheduleDeploymentUpgradeToDateDetails, "ResourceLock": ResourceLock, @@ -372,11 +430,19 @@ "SnoozeDeploymentUpgradeDetails": SnoozeDeploymentUpgradeDetails, "SnowflakeConnection": SnowflakeConnection, "SnowflakeConnectionSummary": SnowflakeConnectionSummary, + "SourcePipelineConnectionDetails": SourcePipelineConnectionDetails, "StartDeploymentDetails": StartDeploymentDetails, + "StartPipelineDetails": StartPipelineDetails, + "StepMessage": StepMessage, "StopDeploymentDetails": StopDeploymentDetails, + "StopPipelineDetails": StopPipelineDetails, + "TargetPipelineConnectionDetails": TargetPipelineConnectionDetails, "TestConnectionAssignmentDetails": TestConnectionAssignmentDetails, "TestConnectionAssignmentError": TestConnectionAssignmentError, "TestConnectionAssignmentResult": TestConnectionAssignmentResult, + "TestPipelineConnectionDetails": TestPipelineConnectionDetails, + "TestPipelineConnectionError": TestPipelineConnectionError, + "TestPipelineConnectionResult": TestPipelineConnectionResult, "TrailFileCollection": TrailFileCollection, "TrailFileSummary": TrailFileSummary, "TrailSequenceCollection": TrailSequenceCollection, @@ -410,9 +476,11 @@ "UpdateOggDeploymentDetails": UpdateOggDeploymentDetails, "UpdateOracleConnectionDetails": UpdateOracleConnectionDetails, "UpdateOracleNosqlConnectionDetails": UpdateOracleNosqlConnectionDetails, + "UpdatePipelineDetails": UpdatePipelineDetails, "UpdatePostgresqlConnectionDetails": UpdatePostgresqlConnectionDetails, "UpdateRedisConnectionDetails": UpdateRedisConnectionDetails, "UpdateSnowflakeConnectionDetails": UpdateSnowflakeConnectionDetails, + "UpdateZeroEtlPipelineDetails": UpdateZeroEtlPipelineDetails, "UpgradeDeploymentCurrentReleaseDetails": UpgradeDeploymentCurrentReleaseDetails, "UpgradeDeploymentDetails": UpgradeDeploymentDetails, "UpgradeDeploymentSpecificReleaseDetails": UpgradeDeploymentSpecificReleaseDetails, @@ -420,5 +488,7 @@ "WorkRequest": WorkRequest, "WorkRequestError": WorkRequestError, "WorkRequestLogEntry": WorkRequestLogEntry, - "WorkRequestResource": WorkRequestResource + "WorkRequestResource": WorkRequestResource, + "ZeroEtlPipeline": ZeroEtlPipeline, + "ZeroEtlPipelineSummary": ZeroEtlPipelineSummary } diff --git a/src/oci/golden_gate/models/change_pipeline_compartment_details.py b/src/oci/golden_gate/models/change_pipeline_compartment_details.py new file mode 100644 index 0000000000..986460b7dd --- /dev/null +++ b/src/oci/golden_gate/models/change_pipeline_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangePipelineCompartmentDetails(object): + """ + The new compartment for a Pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangePipelineCompartmentDetails 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 ChangePipelineCompartmentDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'compartment_id': 'str' + } + + self.attribute_map = { + 'compartment_id': 'compartmentId' + } + + self._compartment_id = None + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ChangePipelineCompartmentDetails. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangePipelineCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangePipelineCompartmentDetails. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangePipelineCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/create_mysql_connection_details.py b/src/oci/golden_gate/models/create_mysql_connection_details.py index 41c1b62924..0799e876e0 100644 --- a/src/oci/golden_gate/models/create_mysql_connection_details.py +++ b/src/oci/golden_gate/models/create_mysql_connection_details.py @@ -558,7 +558,7 @@ def ssl_cert(self, ssl_cert): def ssl_key(self): """ Gets the ssl_key of this CreateMysqlConnectionDetails. - Client Key \u2013 The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). + Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). :return: The ssl_key of this CreateMysqlConnectionDetails. @@ -570,7 +570,7 @@ def ssl_key(self): def ssl_key(self, ssl_key): """ Sets the ssl_key of this CreateMysqlConnectionDetails. - Client Key \u2013 The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). + Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). :param ssl_key: The ssl_key of this CreateMysqlConnectionDetails. diff --git a/src/oci/golden_gate/models/create_pipeline_details.py b/src/oci/golden_gate/models/create_pipeline_details.py new file mode 100644 index 0000000000..7a86592a34 --- /dev/null +++ b/src/oci/golden_gate/models/create_pipeline_details.py @@ -0,0 +1,402 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreatePipelineDetails(object): + """ + Details with which to create a pipeline. + """ + + #: A constant which can be used with the recipe_type property of a CreatePipelineDetails. + #: This constant has a value of "ZERO_ETL" + RECIPE_TYPE_ZERO_ETL = "ZERO_ETL" + + #: A constant which can be used with the license_model property of a CreatePipelineDetails. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a CreatePipelineDetails. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + def __init__(self, **kwargs): + """ + Initializes a new CreatePipelineDetails 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.golden_gate.models.CreateZeroEtlPipelineDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this CreatePipelineDetails. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param display_name: + The value to assign to the display_name property of this CreatePipelineDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreatePipelineDetails. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreatePipelineDetails. + :type compartment_id: str + + :param license_model: + The value to assign to the license_model property of this CreatePipelineDetails. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreatePipelineDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreatePipelineDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this CreatePipelineDetails. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param source_connection_details: + The value to assign to the source_connection_details property of this CreatePipelineDetails. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this CreatePipelineDetails. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'license_model': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'license_model': 'licenseModel', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'locks': 'locks', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails' + } + + self._recipe_type = None + self._display_name = None + self._description = None + self._compartment_id = None + self._license_model = None + self._freeform_tags = None + self._defined_tags = None + self._locks = None + self._source_connection_details = None + self._target_connection_details = 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['recipeType'] + + if type == 'ZERO_ETL': + return 'CreateZeroEtlPipelineDetails' + else: + return 'CreatePipelineDetails' + + @property + def recipe_type(self): + """ + **[Required]** Gets the recipe_type of this CreatePipelineDetails. + The type of the recipe + + Allowed values for this property are: "ZERO_ETL" + + + :return: The recipe_type of this CreatePipelineDetails. + :rtype: str + """ + return self._recipe_type + + @recipe_type.setter + def recipe_type(self, recipe_type): + """ + Sets the recipe_type of this CreatePipelineDetails. + The type of the recipe + + + :param recipe_type: The recipe_type of this CreatePipelineDetails. + :type: str + """ + allowed_values = ["ZERO_ETL"] + if not value_allowed_none_or_none_sentinel(recipe_type, allowed_values): + raise ValueError( + f"Invalid value for `recipe_type`, must be None or one of {allowed_values}" + ) + self._recipe_type = recipe_type + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreatePipelineDetails. + An object's Display Name. + + + :return: The display_name of this CreatePipelineDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreatePipelineDetails. + An object's Display Name. + + + :param display_name: The display_name of this CreatePipelineDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this CreatePipelineDetails. + Metadata about this specific object. + + + :return: The description of this CreatePipelineDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreatePipelineDetails. + Metadata about this specific object. + + + :param description: The description of this CreatePipelineDetails. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreatePipelineDetails. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this CreatePipelineDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreatePipelineDetails. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this CreatePipelineDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def license_model(self): + """ + **[Required]** Gets the license_model of this CreatePipelineDetails. + The Oracle license model that applies to a Deployment. + + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + + + :return: The license_model of this CreatePipelineDetails. + :rtype: str + """ + return self._license_model + + @license_model.setter + def license_model(self, license_model): + """ + Sets the license_model of this CreatePipelineDetails. + The Oracle license model that applies to a Deployment. + + + :param license_model: The license_model of this CreatePipelineDetails. + :type: str + """ + allowed_values = ["LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE"] + if not value_allowed_none_or_none_sentinel(license_model, allowed_values): + raise ValueError( + f"Invalid value for `license_model`, must be None or one of {allowed_values}" + ) + self._license_model = license_model + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreatePipelineDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this CreatePipelineDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreatePipelineDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this CreatePipelineDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreatePipelineDetails. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreatePipelineDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this CreatePipelineDetails. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreatePipelineDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def locks(self): + """ + Gets the locks of this CreatePipelineDetails. + Locks associated with this resource. + + + :return: The locks of this CreatePipelineDetails. + :rtype: list[oci.golden_gate.models.ResourceLock] + """ + return self._locks + + @locks.setter + def locks(self, locks): + """ + Sets the locks of this CreatePipelineDetails. + Locks associated with this resource. + + + :param locks: The locks of this CreatePipelineDetails. + :type: list[oci.golden_gate.models.ResourceLock] + """ + self._locks = locks + + @property + def source_connection_details(self): + """ + **[Required]** Gets the source_connection_details of this CreatePipelineDetails. + + :return: The source_connection_details of this CreatePipelineDetails. + :rtype: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + return self._source_connection_details + + @source_connection_details.setter + def source_connection_details(self, source_connection_details): + """ + Sets the source_connection_details of this CreatePipelineDetails. + + :param source_connection_details: The source_connection_details of this CreatePipelineDetails. + :type: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + self._source_connection_details = source_connection_details + + @property + def target_connection_details(self): + """ + **[Required]** Gets the target_connection_details of this CreatePipelineDetails. + + :return: The target_connection_details of this CreatePipelineDetails. + :rtype: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + return self._target_connection_details + + @target_connection_details.setter + def target_connection_details(self, target_connection_details): + """ + Sets the target_connection_details of this CreatePipelineDetails. + + :param target_connection_details: The target_connection_details of this CreatePipelineDetails. + :type: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + self._target_connection_details = target_connection_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/golden_gate/models/create_zero_etl_pipeline_details.py b/src/oci/golden_gate/models/create_zero_etl_pipeline_details.py new file mode 100644 index 0000000000..c927e93590 --- /dev/null +++ b/src/oci/golden_gate/models/create_zero_etl_pipeline_details.py @@ -0,0 +1,142 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .create_pipeline_details import CreatePipelineDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateZeroEtlPipelineDetails(CreatePipelineDetails): + """ + Creation details for a new ZeroETL pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateZeroEtlPipelineDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.CreateZeroEtlPipelineDetails.recipe_type` attribute + of this class is ``ZERO_ETL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this CreateZeroEtlPipelineDetails. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param display_name: + The value to assign to the display_name property of this CreateZeroEtlPipelineDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this CreateZeroEtlPipelineDetails. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateZeroEtlPipelineDetails. + :type compartment_id: str + + :param license_model: + The value to assign to the license_model property of this CreateZeroEtlPipelineDetails. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateZeroEtlPipelineDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateZeroEtlPipelineDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this CreateZeroEtlPipelineDetails. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param source_connection_details: + The value to assign to the source_connection_details property of this CreateZeroEtlPipelineDetails. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this CreateZeroEtlPipelineDetails. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + :param process_options: + The value to assign to the process_options property of this CreateZeroEtlPipelineDetails. + :type process_options: oci.golden_gate.models.ProcessOptions + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'license_model': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails', + 'process_options': 'ProcessOptions' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'license_model': 'licenseModel', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'locks': 'locks', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails', + 'process_options': 'processOptions' + } + + self._recipe_type = None + self._display_name = None + self._description = None + self._compartment_id = None + self._license_model = None + self._freeform_tags = None + self._defined_tags = None + self._locks = None + self._source_connection_details = None + self._target_connection_details = None + self._process_options = None + self._recipe_type = 'ZERO_ETL' + + @property + def process_options(self): + """ + Gets the process_options of this CreateZeroEtlPipelineDetails. + + :return: The process_options of this CreateZeroEtlPipelineDetails. + :rtype: oci.golden_gate.models.ProcessOptions + """ + return self._process_options + + @process_options.setter + def process_options(self, process_options): + """ + Sets the process_options of this CreateZeroEtlPipelineDetails. + + :param process_options: The process_options of this CreateZeroEtlPipelineDetails. + :type: oci.golden_gate.models.ProcessOptions + """ + self._process_options = process_options + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/default_start_pipeline_details.py b/src/oci/golden_gate/models/default_start_pipeline_details.py new file mode 100644 index 0000000000..f5470d4196 --- /dev/null +++ b/src/oci/golden_gate/models/default_start_pipeline_details.py @@ -0,0 +1,51 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .start_pipeline_details import StartPipelineDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DefaultStartPipelineDetails(StartPipelineDetails): + """ + Attribute details for a default pipeline start. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DefaultStartPipelineDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.DefaultStartPipelineDetails.type` attribute + of this class is ``DEFAULT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this DefaultStartPipelineDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'DEFAULT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/default_stop_pipeline_details.py b/src/oci/golden_gate/models/default_stop_pipeline_details.py new file mode 100644 index 0000000000..8af5642bce --- /dev/null +++ b/src/oci/golden_gate/models/default_stop_pipeline_details.py @@ -0,0 +1,51 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .stop_pipeline_details import StopPipelineDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DefaultStopPipelineDetails(StopPipelineDetails): + """ + Attribute details for a default pipeline stop. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DefaultStopPipelineDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.DefaultStopPipelineDetails.type` attribute + of this class is ``DEFAULT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this DefaultStopPipelineDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + self._type = 'DEFAULT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/default_test_pipeline_connection_details.py b/src/oci/golden_gate/models/default_test_pipeline_connection_details.py new file mode 100644 index 0000000000..24f0e4f2dd --- /dev/null +++ b/src/oci/golden_gate/models/default_test_pipeline_connection_details.py @@ -0,0 +1,88 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .test_pipeline_connection_details import TestPipelineConnectionDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DefaultTestPipelineConnectionDetails(TestPipelineConnectionDetails): + """ + Additional attribute with which to test the pipeline's connection. The connectionId must be one of the pipeline's assigned connections. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DefaultTestPipelineConnectionDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.DefaultTestPipelineConnectionDetails.type` attribute + of this class is ``DEFAULT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this DefaultTestPipelineConnectionDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + :param connection_id: + The value to assign to the connection_id property of this DefaultTestPipelineConnectionDetails. + :type connection_id: str + + """ + self.swagger_types = { + 'type': 'str', + 'connection_id': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'connection_id': 'connectionId' + } + + self._type = None + self._connection_id = None + self._type = 'DEFAULT' + + @property + def connection_id(self): + """ + **[Required]** Gets the connection_id of this DefaultTestPipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The connection_id of this DefaultTestPipelineConnectionDetails. + :rtype: str + """ + return self._connection_id + + @connection_id.setter + def connection_id(self, connection_id): + """ + Sets the connection_id of this DefaultTestPipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param connection_id: The connection_id of this DefaultTestPipelineConnectionDetails. + :type: str + """ + self._connection_id = connection_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/golden_gate/models/initial_data_load.py b/src/oci/golden_gate/models/initial_data_load.py new file mode 100644 index 0000000000..1f486ac9c5 --- /dev/null +++ b/src/oci/golden_gate/models/initial_data_load.py @@ -0,0 +1,143 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class InitialDataLoad(object): + """ + Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. + """ + + #: A constant which can be used with the is_initial_load property of a InitialDataLoad. + #: This constant has a value of "ENABLED" + IS_INITIAL_LOAD_ENABLED = "ENABLED" + + #: A constant which can be used with the is_initial_load property of a InitialDataLoad. + #: This constant has a value of "DISABLED" + IS_INITIAL_LOAD_DISABLED = "DISABLED" + + #: A constant which can be used with the action_on_existing_table property of a InitialDataLoad. + #: This constant has a value of "TRUNCATE" + ACTION_ON_EXISTING_TABLE_TRUNCATE = "TRUNCATE" + + #: A constant which can be used with the action_on_existing_table property of a InitialDataLoad. + #: This constant has a value of "REPLACE" + ACTION_ON_EXISTING_TABLE_REPLACE = "REPLACE" + + #: A constant which can be used with the action_on_existing_table property of a InitialDataLoad. + #: This constant has a value of "APPEND" + ACTION_ON_EXISTING_TABLE_APPEND = "APPEND" + + #: A constant which can be used with the action_on_existing_table property of a InitialDataLoad. + #: This constant has a value of "SKIP" + ACTION_ON_EXISTING_TABLE_SKIP = "SKIP" + + def __init__(self, **kwargs): + """ + Initializes a new InitialDataLoad object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param is_initial_load: + The value to assign to the is_initial_load property of this InitialDataLoad. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type is_initial_load: str + + :param action_on_existing_table: + The value to assign to the action_on_existing_table property of this InitialDataLoad. + Allowed values for this property are: "TRUNCATE", "REPLACE", "APPEND", "SKIP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_on_existing_table: str + + """ + self.swagger_types = { + 'is_initial_load': 'str', + 'action_on_existing_table': 'str' + } + + self.attribute_map = { + 'is_initial_load': 'isInitialLoad', + 'action_on_existing_table': 'actionOnExistingTable' + } + + self._is_initial_load = None + self._action_on_existing_table = None + + @property + def is_initial_load(self): + """ + **[Required]** Gets the is_initial_load of this InitialDataLoad. + If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The is_initial_load of this InitialDataLoad. + :rtype: str + """ + return self._is_initial_load + + @is_initial_load.setter + def is_initial_load(self, is_initial_load): + """ + Sets the is_initial_load of this InitialDataLoad. + If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline. + + + :param is_initial_load: The is_initial_load of this InitialDataLoad. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(is_initial_load, allowed_values): + is_initial_load = 'UNKNOWN_ENUM_VALUE' + self._is_initial_load = is_initial_load + + @property + def action_on_existing_table(self): + """ + Gets the action_on_existing_table of this InitialDataLoad. + Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true. + + Allowed values for this property are: "TRUNCATE", "REPLACE", "APPEND", "SKIP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_on_existing_table of this InitialDataLoad. + :rtype: str + """ + return self._action_on_existing_table + + @action_on_existing_table.setter + def action_on_existing_table(self, action_on_existing_table): + """ + Sets the action_on_existing_table of this InitialDataLoad. + Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true. + + + :param action_on_existing_table: The action_on_existing_table of this InitialDataLoad. + :type: str + """ + allowed_values = ["TRUNCATE", "REPLACE", "APPEND", "SKIP"] + if not value_allowed_none_or_none_sentinel(action_on_existing_table, allowed_values): + action_on_existing_table = 'UNKNOWN_ENUM_VALUE' + self._action_on_existing_table = action_on_existing_table + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/mapping_rule.py b/src/oci/golden_gate/models/mapping_rule.py new file mode 100644 index 0000000000..a60032d5cf --- /dev/null +++ b/src/oci/golden_gate/models/mapping_rule.py @@ -0,0 +1,152 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class MappingRule(object): + """ + Mapping rule for source and target schemas for the pipeline data replication. + For example: + \"{mappingType: INCLUDE, source: HR.*, target: HR.*}\" for rule \"Include HR.*\" which will include all the tables under HR schema. + """ + + #: A constant which can be used with the mapping_type property of a MappingRule. + #: This constant has a value of "INCLUDE" + MAPPING_TYPE_INCLUDE = "INCLUDE" + + #: A constant which can be used with the mapping_type property of a MappingRule. + #: This constant has a value of "EXCLUDE" + MAPPING_TYPE_EXCLUDE = "EXCLUDE" + + def __init__(self, **kwargs): + """ + Initializes a new MappingRule object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param mapping_type: + The value to assign to the mapping_type property of this MappingRule. + Allowed values for this property are: "INCLUDE", "EXCLUDE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type mapping_type: str + + :param source: + The value to assign to the source property of this MappingRule. + :type source: str + + :param target: + The value to assign to the target property of this MappingRule. + :type target: str + + """ + self.swagger_types = { + 'mapping_type': 'str', + 'source': 'str', + 'target': 'str' + } + + self.attribute_map = { + 'mapping_type': 'mappingType', + 'source': 'source', + 'target': 'target' + } + + self._mapping_type = None + self._source = None + self._target = None + + @property + def mapping_type(self): + """ + **[Required]** Gets the mapping_type of this MappingRule. + Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline. + + Allowed values for this property are: "INCLUDE", "EXCLUDE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The mapping_type of this MappingRule. + :rtype: str + """ + return self._mapping_type + + @mapping_type.setter + def mapping_type(self, mapping_type): + """ + Sets the mapping_type of this MappingRule. + Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline. + + + :param mapping_type: The mapping_type of this MappingRule. + :type: str + """ + allowed_values = ["INCLUDE", "EXCLUDE"] + if not value_allowed_none_or_none_sentinel(mapping_type, allowed_values): + mapping_type = 'UNKNOWN_ENUM_VALUE' + self._mapping_type = mapping_type + + @property + def source(self): + """ + **[Required]** Gets the source of this MappingRule. + The source schema/table combination for replication to target. + + + :return: The source of this MappingRule. + :rtype: str + """ + return self._source + + @source.setter + def source(self, source): + """ + Sets the source of this MappingRule. + The source schema/table combination for replication to target. + + + :param source: The source of this MappingRule. + :type: str + """ + self._source = source + + @property + def target(self): + """ + Gets the target of this MappingRule. + The target schema/table combination for replication from the source. + + + :return: The target of this MappingRule. + :rtype: str + """ + return self._target + + @target.setter + def target(self, target): + """ + Sets the target of this MappingRule. + The target schema/table combination for replication from the source. + + + :param target: The target of this MappingRule. + :type: str + """ + self._target = target + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/pipeline.py b/src/oci/golden_gate/models/pipeline.py new file mode 100644 index 0000000000..c7e7b040d0 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline.py @@ -0,0 +1,775 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Pipeline(object): + """ + Represents the metadata details of a pipeline in the same compartment. + """ + + #: A constant which can be used with the recipe_type property of a Pipeline. + #: This constant has a value of "ZERO_ETL" + RECIPE_TYPE_ZERO_ETL = "ZERO_ETL" + + #: A constant which can be used with the license_model property of a Pipeline. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a Pipeline. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "NEEDS_ATTENTION" + LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Pipeline. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_sub_state property of a Pipeline. + #: This constant has a value of "STARTING" + LIFECYCLE_SUB_STATE_STARTING = "STARTING" + + #: A constant which can be used with the lifecycle_sub_state property of a Pipeline. + #: This constant has a value of "STOPPING" + LIFECYCLE_SUB_STATE_STOPPING = "STOPPING" + + #: A constant which can be used with the lifecycle_sub_state property of a Pipeline. + #: This constant has a value of "STOPPED" + LIFECYCLE_SUB_STATE_STOPPED = "STOPPED" + + #: A constant which can be used with the lifecycle_sub_state property of a Pipeline. + #: This constant has a value of "MOVING" + LIFECYCLE_SUB_STATE_MOVING = "MOVING" + + #: A constant which can be used with the lifecycle_sub_state property of a Pipeline. + #: This constant has a value of "RUNNING" + LIFECYCLE_SUB_STATE_RUNNING = "RUNNING" + + def __init__(self, **kwargs): + """ + Initializes a new Pipeline 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.golden_gate.models.ZeroEtlPipeline` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this Pipeline. + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type recipe_type: str + + :param id: + The value to assign to the id property of this Pipeline. + :type id: str + + :param display_name: + The value to assign to the display_name property of this Pipeline. + :type display_name: str + + :param description: + The value to assign to the description property of this Pipeline. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this Pipeline. + :type compartment_id: str + + :param license_model: + The value to assign to the license_model property of this Pipeline. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type license_model: str + + :param cpu_core_count: + The value to assign to the cpu_core_count property of this Pipeline. + :type cpu_core_count: int + + :param is_auto_scaling_enabled: + The value to assign to the is_auto_scaling_enabled property of this Pipeline. + :type is_auto_scaling_enabled: bool + + :param source_connection_details: + The value to assign to the source_connection_details property of this Pipeline. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this Pipeline. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this Pipeline. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Pipeline. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this Pipeline. + :type system_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this Pipeline. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Pipeline. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_sub_state: + The value to assign to the lifecycle_sub_state property of this Pipeline. + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_sub_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Pipeline. + :type lifecycle_details: str + + :param time_created: + The value to assign to the time_created property of this Pipeline. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Pipeline. + :type time_updated: datetime + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'license_model': 'str', + 'cpu_core_count': 'int', + 'is_auto_scaling_enabled': 'bool', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'lifecycle_state': 'str', + 'lifecycle_sub_state': 'str', + 'lifecycle_details': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'license_model': 'licenseModel', + 'cpu_core_count': 'cpuCoreCount', + 'is_auto_scaling_enabled': 'isAutoScalingEnabled', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'locks': 'locks', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_sub_state': 'lifecycleSubState', + 'lifecycle_details': 'lifecycleDetails', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated' + } + + self._recipe_type = None + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._license_model = None + self._cpu_core_count = None + self._is_auto_scaling_enabled = None + self._source_connection_details = None + self._target_connection_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._locks = None + self._lifecycle_state = None + self._lifecycle_sub_state = None + self._lifecycle_details = None + self._time_created = None + self._time_updated = 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['recipeType'] + + if type == 'ZERO_ETL': + return 'ZeroEtlPipeline' + else: + return 'Pipeline' + + @property + def recipe_type(self): + """ + **[Required]** Gets the recipe_type of this Pipeline. + The type of the recipe + + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The recipe_type of this Pipeline. + :rtype: str + """ + return self._recipe_type + + @recipe_type.setter + def recipe_type(self, recipe_type): + """ + Sets the recipe_type of this Pipeline. + The type of the recipe + + + :param recipe_type: The recipe_type of this Pipeline. + :type: str + """ + allowed_values = ["ZERO_ETL"] + if not value_allowed_none_or_none_sentinel(recipe_type, allowed_values): + recipe_type = 'UNKNOWN_ENUM_VALUE' + self._recipe_type = recipe_type + + @property + def id(self): + """ + **[Required]** Gets the id of this Pipeline. + The `OCID`__ of the pipeline. This option applies when retrieving a pipeline. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The id of this Pipeline. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Pipeline. + The `OCID`__ of the pipeline. This option applies when retrieving a pipeline. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param id: The id of this Pipeline. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this Pipeline. + An object's Display Name. + + + :return: The display_name of this Pipeline. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Pipeline. + An object's Display Name. + + + :param display_name: The display_name of this Pipeline. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this Pipeline. + Metadata about this specific object. + + + :return: The description of this Pipeline. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Pipeline. + Metadata about this specific object. + + + :param description: The description of this Pipeline. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this Pipeline. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this Pipeline. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Pipeline. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this Pipeline. + :type: str + """ + self._compartment_id = compartment_id + + @property + def license_model(self): + """ + **[Required]** Gets the license_model of this Pipeline. + The Oracle license model that applies to a Deployment. + + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The license_model of this Pipeline. + :rtype: str + """ + return self._license_model + + @license_model.setter + def license_model(self, license_model): + """ + Sets the license_model of this Pipeline. + The Oracle license model that applies to a Deployment. + + + :param license_model: The license_model of this Pipeline. + :type: str + """ + allowed_values = ["LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE"] + if not value_allowed_none_or_none_sentinel(license_model, allowed_values): + license_model = 'UNKNOWN_ENUM_VALUE' + self._license_model = license_model + + @property + def cpu_core_count(self): + """ + **[Required]** Gets the cpu_core_count of this Pipeline. + The Minimum number of OCPUs to be made available for this Deployment. + + + :return: The cpu_core_count of this Pipeline. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this Pipeline. + The Minimum number of OCPUs to be made available for this Deployment. + + + :param cpu_core_count: The cpu_core_count of this Pipeline. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def is_auto_scaling_enabled(self): + """ + **[Required]** Gets the is_auto_scaling_enabled of this Pipeline. + Indicates if auto scaling is enabled for the Deployment's CPU core count. + + + :return: The is_auto_scaling_enabled of this Pipeline. + :rtype: bool + """ + return self._is_auto_scaling_enabled + + @is_auto_scaling_enabled.setter + def is_auto_scaling_enabled(self, is_auto_scaling_enabled): + """ + Sets the is_auto_scaling_enabled of this Pipeline. + Indicates if auto scaling is enabled for the Deployment's CPU core count. + + + :param is_auto_scaling_enabled: The is_auto_scaling_enabled of this Pipeline. + :type: bool + """ + self._is_auto_scaling_enabled = is_auto_scaling_enabled + + @property + def source_connection_details(self): + """ + **[Required]** Gets the source_connection_details of this Pipeline. + + :return: The source_connection_details of this Pipeline. + :rtype: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + return self._source_connection_details + + @source_connection_details.setter + def source_connection_details(self, source_connection_details): + """ + Sets the source_connection_details of this Pipeline. + + :param source_connection_details: The source_connection_details of this Pipeline. + :type: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + self._source_connection_details = source_connection_details + + @property + def target_connection_details(self): + """ + **[Required]** Gets the target_connection_details of this Pipeline. + + :return: The target_connection_details of this Pipeline. + :rtype: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + return self._target_connection_details + + @target_connection_details.setter + def target_connection_details(self, target_connection_details): + """ + Sets the target_connection_details of this Pipeline. + + :param target_connection_details: The target_connection_details of this Pipeline. + :type: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + self._target_connection_details = target_connection_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this Pipeline. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this Pipeline. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Pipeline. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this Pipeline. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this Pipeline. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this Pipeline. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this Pipeline. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this Pipeline. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this Pipeline. + The system tags associated with this resource, if any. The system tags are set by Oracle + Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more + information, see `Resource Tags`__. + + Example: `{orcl-cloud: {free-tier-retain: true}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The system_tags of this Pipeline. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this Pipeline. + The system tags associated with this resource, if any. The system tags are set by Oracle + Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more + information, see `Resource Tags`__. + + Example: `{orcl-cloud: {free-tier-retain: true}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param system_tags: The system_tags of this Pipeline. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_tags + + @property + def locks(self): + """ + Gets the locks of this Pipeline. + Locks associated with this resource. + + + :return: The locks of this Pipeline. + :rtype: list[oci.golden_gate.models.ResourceLock] + """ + return self._locks + + @locks.setter + def locks(self, locks): + """ + Sets the locks of this Pipeline. + Locks associated with this resource. + + + :param locks: The locks of this Pipeline. + :type: list[oci.golden_gate.models.ResourceLock] + """ + self._locks = locks + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this Pipeline. + Lifecycle state of the pipeline. + + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this Pipeline. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Pipeline. + Lifecycle state of the pipeline. + + + :param lifecycle_state: The lifecycle_state of this Pipeline. + :type: str + """ + allowed_values = ["CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_sub_state(self): + """ + Gets the lifecycle_sub_state of this Pipeline. + Possible lifecycle substates when retrieving a pipeline. + + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_sub_state of this Pipeline. + :rtype: str + """ + return self._lifecycle_sub_state + + @lifecycle_sub_state.setter + def lifecycle_sub_state(self, lifecycle_sub_state): + """ + Sets the lifecycle_sub_state of this Pipeline. + Possible lifecycle substates when retrieving a pipeline. + + + :param lifecycle_sub_state: The lifecycle_sub_state of this Pipeline. + :type: str + """ + allowed_values = ["STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING"] + if not value_allowed_none_or_none_sentinel(lifecycle_sub_state, allowed_values): + lifecycle_sub_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_sub_state = lifecycle_sub_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Pipeline. + Describes the object's current state in detail. For example, it can be used to provide + actionable information for a resource in a Failed state. + + + :return: The lifecycle_details of this Pipeline. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Pipeline. + Describes the object's current state in detail. For example, it can be used to provide + actionable information for a resource in a Failed state. + + + :param lifecycle_details: The lifecycle_details of this Pipeline. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this Pipeline. + The time the resource was created. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this Pipeline. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Pipeline. + The time the resource was created. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this Pipeline. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this Pipeline. + The time the resource was last updated. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this Pipeline. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Pipeline. + The time the resource was last updated. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this Pipeline. + :type: datetime + """ + self._time_updated = time_updated + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/pipeline_collection.py b/src/oci/golden_gate/models/pipeline_collection.py new file mode 100644 index 0000000000..e84bd801f4 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineCollection(object): + """ + List of pipeline summary objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineCollection 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 PipelineCollection. + :type items: list[oci.golden_gate.models.PipelineSummary] + + """ + self.swagger_types = { + 'items': 'list[PipelineSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this PipelineCollection. + An array of Pipeline summaries. + + + :return: The items of this PipelineCollection. + :rtype: list[oci.golden_gate.models.PipelineSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PipelineCollection. + An array of Pipeline summaries. + + + :param items: The items of this PipelineCollection. + :type: list[oci.golden_gate.models.PipelineSummary] + """ + 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/golden_gate/models/pipeline_initialization_step.py b/src/oci/golden_gate/models/pipeline_initialization_step.py new file mode 100644 index 0000000000..d57f844430 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_initialization_step.py @@ -0,0 +1,263 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineInitializationStep(object): + """ + The step and its progress based on the recipe type. + """ + + #: A constant which can be used with the status property of a PipelineInitializationStep. + #: This constant has a value of "PENDING" + STATUS_PENDING = "PENDING" + + #: A constant which can be used with the status property of a PipelineInitializationStep. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a PipelineInitializationStep. + #: This constant has a value of "COMPLETED" + STATUS_COMPLETED = "COMPLETED" + + #: A constant which can be used with the status property of a PipelineInitializationStep. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new PipelineInitializationStep 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 PipelineInitializationStep. + :type name: str + + :param status: + The value to assign to the status property of this PipelineInitializationStep. + Allowed values for this property are: "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param percent_complete: + The value to assign to the percent_complete property of this PipelineInitializationStep. + :type percent_complete: int + + :param time_started: + The value to assign to the time_started property of this PipelineInitializationStep. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this PipelineInitializationStep. + :type time_finished: datetime + + :param messages: + The value to assign to the messages property of this PipelineInitializationStep. + :type messages: list[oci.golden_gate.models.StepMessage] + + """ + self.swagger_types = { + 'name': 'str', + 'status': 'str', + 'percent_complete': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'messages': 'list[StepMessage]' + } + + self.attribute_map = { + 'name': 'name', + 'status': 'status', + 'percent_complete': 'percentComplete', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'messages': 'messages' + } + + self._name = None + self._status = None + self._percent_complete = None + self._time_started = None + self._time_finished = None + self._messages = None + + @property + def name(self): + """ + **[Required]** Gets the name of this PipelineInitializationStep. + An object's Display Name. + + + :return: The name of this PipelineInitializationStep. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this PipelineInitializationStep. + An object's Display Name. + + + :param name: The name of this PipelineInitializationStep. + :type: str + """ + self._name = name + + @property + def status(self): + """ + **[Required]** Gets the status of this PipelineInitializationStep. + Status of the steps in a recipe. This option applies during pipeline initialization. + + Allowed values for this property are: "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this PipelineInitializationStep. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PipelineInitializationStep. + Status of the steps in a recipe. This option applies during pipeline initialization. + + + :param status: The status of this PipelineInitializationStep. + :type: str + """ + allowed_values = ["PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this PipelineInitializationStep. + Shows the percentage complete of each recipe step during pipeline initialization. + + + :return: The percent_complete of this PipelineInitializationStep. + :rtype: int + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this PipelineInitializationStep. + Shows the percentage complete of each recipe step during pipeline initialization. + + + :param percent_complete: The percent_complete of this PipelineInitializationStep. + :type: int + """ + self._percent_complete = percent_complete + + @property + def time_started(self): + """ + **[Required]** Gets the time_started of this PipelineInitializationStep. + The date and time the request was started. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_started of this PipelineInitializationStep. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this PipelineInitializationStep. + The date and time the request was started. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_started: The time_started of this PipelineInitializationStep. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + **[Required]** Gets the time_finished of this PipelineInitializationStep. + The date and time the request was finished. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_finished of this PipelineInitializationStep. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this PipelineInitializationStep. + The date and time the request was finished. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_finished: The time_finished of this PipelineInitializationStep. + :type: datetime + """ + self._time_finished = time_finished + + @property + def messages(self): + """ + Gets the messages of this PipelineInitializationStep. + The list of messages for each step while running. + + + :return: The messages of this PipelineInitializationStep. + :rtype: list[oci.golden_gate.models.StepMessage] + """ + return self._messages + + @messages.setter + def messages(self, messages): + """ + Sets the messages of this PipelineInitializationStep. + The list of messages for each step while running. + + + :param messages: The messages of this PipelineInitializationStep. + :type: list[oci.golden_gate.models.StepMessage] + """ + self._messages = messages + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/pipeline_initialization_steps.py b/src/oci/golden_gate/models/pipeline_initialization_steps.py new file mode 100644 index 0000000000..94254130a1 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_initialization_steps.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineInitializationSteps(object): + """ + The steps and their progress, based on the recipe type. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineInitializationSteps 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 PipelineInitializationSteps. + :type items: list[oci.golden_gate.models.PipelineInitializationStep] + + """ + self.swagger_types = { + 'items': 'list[PipelineInitializationStep]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this PipelineInitializationSteps. + The sequence of pipeline steps based on the recipe type. + + + :return: The items of this PipelineInitializationSteps. + :rtype: list[oci.golden_gate.models.PipelineInitializationStep] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PipelineInitializationSteps. + The sequence of pipeline steps based on the recipe type. + + + :param items: The items of this PipelineInitializationSteps. + :type: list[oci.golden_gate.models.PipelineInitializationStep] + """ + 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/golden_gate/models/pipeline_running_process_collection.py b/src/oci/golden_gate/models/pipeline_running_process_collection.py new file mode 100644 index 0000000000..d76bc91303 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_running_process_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineRunningProcessCollection(object): + """ + The complete replication process and its details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineRunningProcessCollection 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 PipelineRunningProcessCollection. + :type items: list[oci.golden_gate.models.PipelineRunningProcessSummary] + + """ + self.swagger_types = { + 'items': 'list[PipelineRunningProcessSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this PipelineRunningProcessCollection. + The list of replication processes and their details. + + + :return: The items of this PipelineRunningProcessCollection. + :rtype: list[oci.golden_gate.models.PipelineRunningProcessSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PipelineRunningProcessCollection. + The list of replication processes and their details. + + + :param items: The items of this PipelineRunningProcessCollection. + :type: list[oci.golden_gate.models.PipelineRunningProcessSummary] + """ + 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/golden_gate/models/pipeline_running_process_summary.py b/src/oci/golden_gate/models/pipeline_running_process_summary.py new file mode 100644 index 0000000000..ff67005f2b --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_running_process_summary.py @@ -0,0 +1,238 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineRunningProcessSummary(object): + """ + Each replication process and their summary details. + """ + + #: A constant which can be used with the process_type property of a PipelineRunningProcessSummary. + #: This constant has a value of "EXTRACT" + PROCESS_TYPE_EXTRACT = "EXTRACT" + + #: A constant which can be used with the process_type property of a PipelineRunningProcessSummary. + #: This constant has a value of "REPLICAT" + PROCESS_TYPE_REPLICAT = "REPLICAT" + + #: A constant which can be used with the status property of a PipelineRunningProcessSummary. + #: This constant has a value of "STOPPED" + STATUS_STOPPED = "STOPPED" + + #: A constant which can be used with the status property of a PipelineRunningProcessSummary. + #: This constant has a value of "RUNNING" + STATUS_RUNNING = "RUNNING" + + #: A constant which can be used with the status property of a PipelineRunningProcessSummary. + #: This constant has a value of "ERROR" + STATUS_ERROR = "ERROR" + + def __init__(self, **kwargs): + """ + Initializes a new PipelineRunningProcessSummary 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 PipelineRunningProcessSummary. + :type name: str + + :param process_type: + The value to assign to the process_type property of this PipelineRunningProcessSummary. + Allowed values for this property are: "EXTRACT", "REPLICAT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type process_type: str + + :param status: + The value to assign to the status property of this PipelineRunningProcessSummary. + Allowed values for this property are: "STOPPED", "RUNNING", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param last_record_lag_in_seconds: + The value to assign to the last_record_lag_in_seconds property of this PipelineRunningProcessSummary. + :type last_record_lag_in_seconds: float + + :param time_last_processed: + The value to assign to the time_last_processed property of this PipelineRunningProcessSummary. + :type time_last_processed: datetime + + """ + self.swagger_types = { + 'name': 'str', + 'process_type': 'str', + 'status': 'str', + 'last_record_lag_in_seconds': 'float', + 'time_last_processed': 'datetime' + } + + self.attribute_map = { + 'name': 'name', + 'process_type': 'processType', + 'status': 'status', + 'last_record_lag_in_seconds': 'lastRecordLagInSeconds', + 'time_last_processed': 'timeLastProcessed' + } + + self._name = None + self._process_type = None + self._status = None + self._last_record_lag_in_seconds = None + self._time_last_processed = None + + @property + def name(self): + """ + **[Required]** Gets the name of this PipelineRunningProcessSummary. + An object's Display Name. + + + :return: The name of this PipelineRunningProcessSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this PipelineRunningProcessSummary. + An object's Display Name. + + + :param name: The name of this PipelineRunningProcessSummary. + :type: str + """ + self._name = name + + @property + def process_type(self): + """ + **[Required]** Gets the process_type of this PipelineRunningProcessSummary. + The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes. + + Allowed values for this property are: "EXTRACT", "REPLICAT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The process_type of this PipelineRunningProcessSummary. + :rtype: str + """ + return self._process_type + + @process_type.setter + def process_type(self, process_type): + """ + Sets the process_type of this PipelineRunningProcessSummary. + The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes. + + + :param process_type: The process_type of this PipelineRunningProcessSummary. + :type: str + """ + allowed_values = ["EXTRACT", "REPLICAT"] + if not value_allowed_none_or_none_sentinel(process_type, allowed_values): + process_type = 'UNKNOWN_ENUM_VALUE' + self._process_type = process_type + + @property + def status(self): + """ + **[Required]** Gets the status of this PipelineRunningProcessSummary. + The status of the Extract or Replicat process. This option applies when retrieving running processes. + + Allowed values for this property are: "STOPPED", "RUNNING", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this PipelineRunningProcessSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PipelineRunningProcessSummary. + The status of the Extract or Replicat process. This option applies when retrieving running processes. + + + :param status: The status of this PipelineRunningProcessSummary. + :type: str + """ + allowed_values = ["STOPPED", "RUNNING", "ERROR"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def last_record_lag_in_seconds(self): + """ + **[Required]** Gets the last_record_lag_in_seconds of this PipelineRunningProcessSummary. + The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes. + + + :return: The last_record_lag_in_seconds of this PipelineRunningProcessSummary. + :rtype: float + """ + return self._last_record_lag_in_seconds + + @last_record_lag_in_seconds.setter + def last_record_lag_in_seconds(self, last_record_lag_in_seconds): + """ + Sets the last_record_lag_in_seconds of this PipelineRunningProcessSummary. + The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes. + + + :param last_record_lag_in_seconds: The last_record_lag_in_seconds of this PipelineRunningProcessSummary. + :type: float + """ + self._last_record_lag_in_seconds = last_record_lag_in_seconds + + @property + def time_last_processed(self): + """ + **[Required]** Gets the time_last_processed of this PipelineRunningProcessSummary. + The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes. + The format is defined by `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_last_processed of this PipelineRunningProcessSummary. + :rtype: datetime + """ + return self._time_last_processed + + @time_last_processed.setter + def time_last_processed(self, time_last_processed): + """ + Sets the time_last_processed of this PipelineRunningProcessSummary. + The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes. + The format is defined by `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_last_processed: The time_last_processed of this PipelineRunningProcessSummary. + :type: datetime + """ + self._time_last_processed = time_last_processed + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/pipeline_schema_collection.py b/src/oci/golden_gate/models/pipeline_schema_collection.py new file mode 100644 index 0000000000..939c664d04 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_schema_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineSchemaCollection(object): + """ + The list of schemas present in the source/target connection database of a pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineSchemaCollection 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 PipelineSchemaCollection. + :type items: list[oci.golden_gate.models.PipelineSchemaSummary] + + """ + self.swagger_types = { + 'items': 'list[PipelineSchemaSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this PipelineSchemaCollection. + Array of pipeline schemas + + + :return: The items of this PipelineSchemaCollection. + :rtype: list[oci.golden_gate.models.PipelineSchemaSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PipelineSchemaCollection. + Array of pipeline schemas + + + :param items: The items of this PipelineSchemaCollection. + :type: list[oci.golden_gate.models.PipelineSchemaSummary] + """ + 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/golden_gate/models/pipeline_schema_summary.py b/src/oci/golden_gate/models/pipeline_schema_summary.py new file mode 100644 index 0000000000..174985d80d --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_schema_summary.py @@ -0,0 +1,105 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineSchemaSummary(object): + """ + List of source and target schemas of a pipeline's assigned connection. + 1. If there is no explicit mapping defined for the pipeline then only matched source and target schema names will be returned. + 2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema names, the matched source and target schema names also will be returned. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineSchemaSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_schema_name: + The value to assign to the source_schema_name property of this PipelineSchemaSummary. + :type source_schema_name: str + + :param target_schema_name: + The value to assign to the target_schema_name property of this PipelineSchemaSummary. + :type target_schema_name: str + + """ + self.swagger_types = { + 'source_schema_name': 'str', + 'target_schema_name': 'str' + } + + self.attribute_map = { + 'source_schema_name': 'sourceSchemaName', + 'target_schema_name': 'targetSchemaName' + } + + self._source_schema_name = None + self._target_schema_name = None + + @property + def source_schema_name(self): + """ + **[Required]** Gets the source_schema_name of this PipelineSchemaSummary. + The schema name from the database connection. + + + :return: The source_schema_name of this PipelineSchemaSummary. + :rtype: str + """ + return self._source_schema_name + + @source_schema_name.setter + def source_schema_name(self, source_schema_name): + """ + Sets the source_schema_name of this PipelineSchemaSummary. + The schema name from the database connection. + + + :param source_schema_name: The source_schema_name of this PipelineSchemaSummary. + :type: str + """ + self._source_schema_name = source_schema_name + + @property + def target_schema_name(self): + """ + **[Required]** Gets the target_schema_name of this PipelineSchemaSummary. + The schema name from the database connection. + + + :return: The target_schema_name of this PipelineSchemaSummary. + :rtype: str + """ + return self._target_schema_name + + @target_schema_name.setter + def target_schema_name(self, target_schema_name): + """ + Sets the target_schema_name of this PipelineSchemaSummary. + The schema name from the database connection. + + + :param target_schema_name: The target_schema_name of this PipelineSchemaSummary. + :type: str + """ + self._target_schema_name = target_schema_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/golden_gate/models/pipeline_schema_table_collection.py b/src/oci/golden_gate/models/pipeline_schema_table_collection.py new file mode 100644 index 0000000000..363bda7ac7 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_schema_table_collection.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineSchemaTableCollection(object): + """ + List of source or target schema tables of a pipeline's assigned connection. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineSchemaTableCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_schema_name: + The value to assign to the source_schema_name property of this PipelineSchemaTableCollection. + :type source_schema_name: str + + :param target_schema_name: + The value to assign to the target_schema_name property of this PipelineSchemaTableCollection. + :type target_schema_name: str + + :param items: + The value to assign to the items property of this PipelineSchemaTableCollection. + :type items: list[oci.golden_gate.models.PipelineSchemaTableSummary] + + """ + self.swagger_types = { + 'source_schema_name': 'str', + 'target_schema_name': 'str', + 'items': 'list[PipelineSchemaTableSummary]' + } + + self.attribute_map = { + 'source_schema_name': 'sourceSchemaName', + 'target_schema_name': 'targetSchemaName', + 'items': 'items' + } + + self._source_schema_name = None + self._target_schema_name = None + self._items = None + + @property + def source_schema_name(self): + """ + Gets the source_schema_name of this PipelineSchemaTableCollection. + The schema name from the database connection. + + + :return: The source_schema_name of this PipelineSchemaTableCollection. + :rtype: str + """ + return self._source_schema_name + + @source_schema_name.setter + def source_schema_name(self, source_schema_name): + """ + Sets the source_schema_name of this PipelineSchemaTableCollection. + The schema name from the database connection. + + + :param source_schema_name: The source_schema_name of this PipelineSchemaTableCollection. + :type: str + """ + self._source_schema_name = source_schema_name + + @property + def target_schema_name(self): + """ + Gets the target_schema_name of this PipelineSchemaTableCollection. + The schema name from the database connection. + + + :return: The target_schema_name of this PipelineSchemaTableCollection. + :rtype: str + """ + return self._target_schema_name + + @target_schema_name.setter + def target_schema_name(self, target_schema_name): + """ + Sets the target_schema_name of this PipelineSchemaTableCollection. + The schema name from the database connection. + + + :param target_schema_name: The target_schema_name of this PipelineSchemaTableCollection. + :type: str + """ + self._target_schema_name = target_schema_name + + @property + def items(self): + """ + **[Required]** Gets the items of this PipelineSchemaTableCollection. + Array of source or target schema tables of a pipeline's assigned connection. + + + :return: The items of this PipelineSchemaTableCollection. + :rtype: list[oci.golden_gate.models.PipelineSchemaTableSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PipelineSchemaTableCollection. + Array of source or target schema tables of a pipeline's assigned connection. + + + :param items: The items of this PipelineSchemaTableCollection. + :type: list[oci.golden_gate.models.PipelineSchemaTableSummary] + """ + 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/golden_gate/models/pipeline_schema_table_summary.py b/src/oci/golden_gate/models/pipeline_schema_table_summary.py new file mode 100644 index 0000000000..bc0ed273a1 --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_schema_table_summary.py @@ -0,0 +1,105 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineSchemaTableSummary(object): + """ + Summary of source or target schema tables of a pipeline's assigned connection. + 1. If there is no explicit mapping defined for the pipeline then only matched source and target schema's table names will be returned + 2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema's table names, the matched source and target schema's table names also will be returned. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PipelineSchemaTableSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param source_table_name: + The value to assign to the source_table_name property of this PipelineSchemaTableSummary. + :type source_table_name: str + + :param target_table_name: + The value to assign to the target_table_name property of this PipelineSchemaTableSummary. + :type target_table_name: str + + """ + self.swagger_types = { + 'source_table_name': 'str', + 'target_table_name': 'str' + } + + self.attribute_map = { + 'source_table_name': 'sourceTableName', + 'target_table_name': 'targetTableName' + } + + self._source_table_name = None + self._target_table_name = None + + @property + def source_table_name(self): + """ + **[Required]** Gets the source_table_name of this PipelineSchemaTableSummary. + The table name from the schema of database connection. + + + :return: The source_table_name of this PipelineSchemaTableSummary. + :rtype: str + """ + return self._source_table_name + + @source_table_name.setter + def source_table_name(self, source_table_name): + """ + Sets the source_table_name of this PipelineSchemaTableSummary. + The table name from the schema of database connection. + + + :param source_table_name: The source_table_name of this PipelineSchemaTableSummary. + :type: str + """ + self._source_table_name = source_table_name + + @property + def target_table_name(self): + """ + **[Required]** Gets the target_table_name of this PipelineSchemaTableSummary. + The table name from the schema of database connection. + + + :return: The target_table_name of this PipelineSchemaTableSummary. + :rtype: str + """ + return self._target_table_name + + @target_table_name.setter + def target_table_name(self, target_table_name): + """ + Sets the target_table_name of this PipelineSchemaTableSummary. + The table name from the schema of database connection. + + + :param target_table_name: The target_table_name of this PipelineSchemaTableSummary. + :type: str + """ + self._target_table_name = target_table_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/golden_gate/models/pipeline_summary.py b/src/oci/golden_gate/models/pipeline_summary.py new file mode 100644 index 0000000000..093620f7aa --- /dev/null +++ b/src/oci/golden_gate/models/pipeline_summary.py @@ -0,0 +1,739 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PipelineSummary(object): + """ + Summary details of the pipeline. + """ + + #: A constant which can be used with the recipe_type property of a PipelineSummary. + #: This constant has a value of "ZERO_ETL" + RECIPE_TYPE_ZERO_ETL = "ZERO_ETL" + + #: A constant which can be used with the license_model property of a PipelineSummary. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a PipelineSummary. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + #: A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. + #: This constant has a value of "STARTING" + LIFECYCLE_SUB_STATE_STARTING = "STARTING" + + #: A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. + #: This constant has a value of "STOPPING" + LIFECYCLE_SUB_STATE_STOPPING = "STOPPING" + + #: A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. + #: This constant has a value of "STOPPED" + LIFECYCLE_SUB_STATE_STOPPED = "STOPPED" + + #: A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. + #: This constant has a value of "MOVING" + LIFECYCLE_SUB_STATE_MOVING = "MOVING" + + #: A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. + #: This constant has a value of "RUNNING" + LIFECYCLE_SUB_STATE_RUNNING = "RUNNING" + + def __init__(self, **kwargs): + """ + Initializes a new PipelineSummary 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.golden_gate.models.ZeroEtlPipelineSummary` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this PipelineSummary. + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type recipe_type: str + + :param id: + The value to assign to the id property of this PipelineSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this PipelineSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this PipelineSummary. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this PipelineSummary. + :type compartment_id: str + + :param source_connection_details: + The value to assign to the source_connection_details property of this PipelineSummary. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this PipelineSummary. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this PipelineSummary. + :type freeform_tags: dict(str, str) + + :param license_model: + The value to assign to the license_model property of this PipelineSummary. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type license_model: str + + :param cpu_core_count: + The value to assign to the cpu_core_count property of this PipelineSummary. + :type cpu_core_count: int + + :param is_auto_scaling_enabled: + The value to assign to the is_auto_scaling_enabled property of this PipelineSummary. + :type is_auto_scaling_enabled: bool + + :param defined_tags: + The value to assign to the defined_tags property of this PipelineSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this PipelineSummary. + :type system_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this PipelineSummary. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this PipelineSummary. + :type lifecycle_state: str + + :param lifecycle_sub_state: + The value to assign to the lifecycle_sub_state property of this PipelineSummary. + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_sub_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this PipelineSummary. + :type lifecycle_details: str + + :param time_created: + The value to assign to the time_created property of this PipelineSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this PipelineSummary. + :type time_updated: datetime + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails', + 'freeform_tags': 'dict(str, str)', + 'license_model': 'str', + 'cpu_core_count': 'int', + 'is_auto_scaling_enabled': 'bool', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'lifecycle_state': 'str', + 'lifecycle_sub_state': 'str', + 'lifecycle_details': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails', + 'freeform_tags': 'freeformTags', + 'license_model': 'licenseModel', + 'cpu_core_count': 'cpuCoreCount', + 'is_auto_scaling_enabled': 'isAutoScalingEnabled', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'locks': 'locks', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_sub_state': 'lifecycleSubState', + 'lifecycle_details': 'lifecycleDetails', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated' + } + + self._recipe_type = None + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._source_connection_details = None + self._target_connection_details = None + self._freeform_tags = None + self._license_model = None + self._cpu_core_count = None + self._is_auto_scaling_enabled = None + self._defined_tags = None + self._system_tags = None + self._locks = None + self._lifecycle_state = None + self._lifecycle_sub_state = None + self._lifecycle_details = None + self._time_created = None + self._time_updated = 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['recipeType'] + + if type == 'ZERO_ETL': + return 'ZeroEtlPipelineSummary' + else: + return 'PipelineSummary' + + @property + def recipe_type(self): + """ + **[Required]** Gets the recipe_type of this PipelineSummary. + The type of the recipe + + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The recipe_type of this PipelineSummary. + :rtype: str + """ + return self._recipe_type + + @recipe_type.setter + def recipe_type(self, recipe_type): + """ + Sets the recipe_type of this PipelineSummary. + The type of the recipe + + + :param recipe_type: The recipe_type of this PipelineSummary. + :type: str + """ + allowed_values = ["ZERO_ETL"] + if not value_allowed_none_or_none_sentinel(recipe_type, allowed_values): + recipe_type = 'UNKNOWN_ENUM_VALUE' + self._recipe_type = recipe_type + + @property + def id(self): + """ + **[Required]** Gets the id of this PipelineSummary. + The `OCID`__ of the pipeline. This option applies when retrieving a pipeline. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The id of this PipelineSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this PipelineSummary. + The `OCID`__ of the pipeline. This option applies when retrieving a pipeline. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param id: The id of this PipelineSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this PipelineSummary. + An object's Display Name. + + + :return: The display_name of this PipelineSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this PipelineSummary. + An object's Display Name. + + + :param display_name: The display_name of this PipelineSummary. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this PipelineSummary. + Metadata about this specific object. + + + :return: The description of this PipelineSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this PipelineSummary. + Metadata about this specific object. + + + :param description: The description of this PipelineSummary. + :type: str + """ + self._description = description + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this PipelineSummary. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this PipelineSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this PipelineSummary. + The `OCID`__ of the compartment being referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this PipelineSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def source_connection_details(self): + """ + **[Required]** Gets the source_connection_details of this PipelineSummary. + + :return: The source_connection_details of this PipelineSummary. + :rtype: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + return self._source_connection_details + + @source_connection_details.setter + def source_connection_details(self, source_connection_details): + """ + Sets the source_connection_details of this PipelineSummary. + + :param source_connection_details: The source_connection_details of this PipelineSummary. + :type: oci.golden_gate.models.SourcePipelineConnectionDetails + """ + self._source_connection_details = source_connection_details + + @property + def target_connection_details(self): + """ + **[Required]** Gets the target_connection_details of this PipelineSummary. + + :return: The target_connection_details of this PipelineSummary. + :rtype: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + return self._target_connection_details + + @target_connection_details.setter + def target_connection_details(self, target_connection_details): + """ + Sets the target_connection_details of this PipelineSummary. + + :param target_connection_details: The target_connection_details of this PipelineSummary. + :type: oci.golden_gate.models.TargetPipelineConnectionDetails + """ + self._target_connection_details = target_connection_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this PipelineSummary. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this PipelineSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this PipelineSummary. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this PipelineSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def license_model(self): + """ + **[Required]** Gets the license_model of this PipelineSummary. + The Oracle license model that applies to a Deployment. + + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The license_model of this PipelineSummary. + :rtype: str + """ + return self._license_model + + @license_model.setter + def license_model(self, license_model): + """ + Sets the license_model of this PipelineSummary. + The Oracle license model that applies to a Deployment. + + + :param license_model: The license_model of this PipelineSummary. + :type: str + """ + allowed_values = ["LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE"] + if not value_allowed_none_or_none_sentinel(license_model, allowed_values): + license_model = 'UNKNOWN_ENUM_VALUE' + self._license_model = license_model + + @property + def cpu_core_count(self): + """ + **[Required]** Gets the cpu_core_count of this PipelineSummary. + The Minimum number of OCPUs to be made available for this Deployment. + + + :return: The cpu_core_count of this PipelineSummary. + :rtype: int + """ + return self._cpu_core_count + + @cpu_core_count.setter + def cpu_core_count(self, cpu_core_count): + """ + Sets the cpu_core_count of this PipelineSummary. + The Minimum number of OCPUs to be made available for this Deployment. + + + :param cpu_core_count: The cpu_core_count of this PipelineSummary. + :type: int + """ + self._cpu_core_count = cpu_core_count + + @property + def is_auto_scaling_enabled(self): + """ + **[Required]** Gets the is_auto_scaling_enabled of this PipelineSummary. + Indicates if auto scaling is enabled for the Deployment's CPU core count. + + + :return: The is_auto_scaling_enabled of this PipelineSummary. + :rtype: bool + """ + return self._is_auto_scaling_enabled + + @is_auto_scaling_enabled.setter + def is_auto_scaling_enabled(self, is_auto_scaling_enabled): + """ + Sets the is_auto_scaling_enabled of this PipelineSummary. + Indicates if auto scaling is enabled for the Deployment's CPU core count. + + + :param is_auto_scaling_enabled: The is_auto_scaling_enabled of this PipelineSummary. + :type: bool + """ + self._is_auto_scaling_enabled = is_auto_scaling_enabled + + @property + def defined_tags(self): + """ + Gets the defined_tags of this PipelineSummary. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this PipelineSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this PipelineSummary. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this PipelineSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this PipelineSummary. + The system tags associated with this resource, if any. The system tags are set by Oracle + Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more + information, see `Resource Tags`__. + + Example: `{orcl-cloud: {free-tier-retain: true}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :return: The system_tags of this PipelineSummary. + :rtype: dict(str, dict(str, object)) + """ + return self._system_tags + + @system_tags.setter + def system_tags(self, system_tags): + """ + Sets the system_tags of this PipelineSummary. + The system tags associated with this resource, if any. The system tags are set by Oracle + Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more + information, see `Resource Tags`__. + + Example: `{orcl-cloud: {free-tier-retain: true}}` + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm + + + :param system_tags: The system_tags of this PipelineSummary. + :type: dict(str, dict(str, object)) + """ + self._system_tags = system_tags + + @property + def locks(self): + """ + Gets the locks of this PipelineSummary. + Locks associated with this resource. + + + :return: The locks of this PipelineSummary. + :rtype: list[oci.golden_gate.models.ResourceLock] + """ + return self._locks + + @locks.setter + def locks(self, locks): + """ + Sets the locks of this PipelineSummary. + Locks associated with this resource. + + + :param locks: The locks of this PipelineSummary. + :type: list[oci.golden_gate.models.ResourceLock] + """ + self._locks = locks + + @property + def lifecycle_state(self): + """ + **[Required]** Gets the lifecycle_state of this PipelineSummary. + Lifecycle state for the pipeline summary. + + + :return: The lifecycle_state of this PipelineSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this PipelineSummary. + Lifecycle state for the pipeline summary. + + + :param lifecycle_state: The lifecycle_state of this PipelineSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_sub_state(self): + """ + Gets the lifecycle_sub_state of this PipelineSummary. + Possible lifecycle substates when retrieving a pipeline. + + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_sub_state of this PipelineSummary. + :rtype: str + """ + return self._lifecycle_sub_state + + @lifecycle_sub_state.setter + def lifecycle_sub_state(self, lifecycle_sub_state): + """ + Sets the lifecycle_sub_state of this PipelineSummary. + Possible lifecycle substates when retrieving a pipeline. + + + :param lifecycle_sub_state: The lifecycle_sub_state of this PipelineSummary. + :type: str + """ + allowed_values = ["STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING"] + if not value_allowed_none_or_none_sentinel(lifecycle_sub_state, allowed_values): + lifecycle_sub_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_sub_state = lifecycle_sub_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this PipelineSummary. + Describes the object's current state in detail. For example, it can be used to provide + actionable information for a resource in a Failed state. + + + :return: The lifecycle_details of this PipelineSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this PipelineSummary. + Describes the object's current state in detail. For example, it can be used to provide + actionable information for a resource in a Failed state. + + + :param lifecycle_details: The lifecycle_details of this PipelineSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def time_created(self): + """ + **[Required]** Gets the time_created of this PipelineSummary. + The time the resource was created. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this PipelineSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this PipelineSummary. + The time the resource was created. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this PipelineSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + **[Required]** Gets the time_updated of this PipelineSummary. + The time the resource was last updated. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this PipelineSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this PipelineSummary. + The time the resource was last updated. The format is defined by + `RFC3339`__, such as `2016-08-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this PipelineSummary. + :type: datetime + """ + self._time_updated = time_updated + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/process_options.py b/src/oci/golden_gate/models/process_options.py new file mode 100644 index 0000000000..d8600682bb --- /dev/null +++ b/src/oci/golden_gate/models/process_options.py @@ -0,0 +1,142 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProcessOptions(object): + """ + Required pipeline options to configure the replication process (Extract or Replicat). + """ + + #: A constant which can be used with the should_restart_on_failure property of a ProcessOptions. + #: This constant has a value of "ENABLED" + SHOULD_RESTART_ON_FAILURE_ENABLED = "ENABLED" + + #: A constant which can be used with the should_restart_on_failure property of a ProcessOptions. + #: This constant has a value of "DISABLED" + SHOULD_RESTART_ON_FAILURE_DISABLED = "DISABLED" + + def __init__(self, **kwargs): + """ + Initializes a new ProcessOptions object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param initial_data_load: + The value to assign to the initial_data_load property of this ProcessOptions. + :type initial_data_load: oci.golden_gate.models.InitialDataLoad + + :param replicate_schema_change: + The value to assign to the replicate_schema_change property of this ProcessOptions. + :type replicate_schema_change: oci.golden_gate.models.ReplicateSchemaChange + + :param should_restart_on_failure: + The value to assign to the should_restart_on_failure property of this ProcessOptions. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type should_restart_on_failure: str + + """ + self.swagger_types = { + 'initial_data_load': 'InitialDataLoad', + 'replicate_schema_change': 'ReplicateSchemaChange', + 'should_restart_on_failure': 'str' + } + + self.attribute_map = { + 'initial_data_load': 'initialDataLoad', + 'replicate_schema_change': 'replicateSchemaChange', + 'should_restart_on_failure': 'shouldRestartOnFailure' + } + + self._initial_data_load = None + self._replicate_schema_change = None + self._should_restart_on_failure = None + + @property + def initial_data_load(self): + """ + **[Required]** Gets the initial_data_load of this ProcessOptions. + + :return: The initial_data_load of this ProcessOptions. + :rtype: oci.golden_gate.models.InitialDataLoad + """ + return self._initial_data_load + + @initial_data_load.setter + def initial_data_load(self, initial_data_load): + """ + Sets the initial_data_load of this ProcessOptions. + + :param initial_data_load: The initial_data_load of this ProcessOptions. + :type: oci.golden_gate.models.InitialDataLoad + """ + self._initial_data_load = initial_data_load + + @property + def replicate_schema_change(self): + """ + **[Required]** Gets the replicate_schema_change of this ProcessOptions. + + :return: The replicate_schema_change of this ProcessOptions. + :rtype: oci.golden_gate.models.ReplicateSchemaChange + """ + return self._replicate_schema_change + + @replicate_schema_change.setter + def replicate_schema_change(self, replicate_schema_change): + """ + Sets the replicate_schema_change of this ProcessOptions. + + :param replicate_schema_change: The replicate_schema_change of this ProcessOptions. + :type: oci.golden_gate.models.ReplicateSchemaChange + """ + self._replicate_schema_change = replicate_schema_change + + @property + def should_restart_on_failure(self): + """ + **[Required]** Gets the should_restart_on_failure of this ProcessOptions. + If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The should_restart_on_failure of this ProcessOptions. + :rtype: str + """ + return self._should_restart_on_failure + + @should_restart_on_failure.setter + def should_restart_on_failure(self, should_restart_on_failure): + """ + Sets the should_restart_on_failure of this ProcessOptions. + If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline. + + + :param should_restart_on_failure: The should_restart_on_failure of this ProcessOptions. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(should_restart_on_failure, allowed_values): + should_restart_on_failure = 'UNKNOWN_ENUM_VALUE' + self._should_restart_on_failure = should_restart_on_failure + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/recipe_summary.py b/src/oci/golden_gate/models/recipe_summary.py new file mode 100644 index 0000000000..547f5b0934 --- /dev/null +++ b/src/oci/golden_gate/models/recipe_summary.py @@ -0,0 +1,239 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RecipeSummary(object): + """ + The list of recipe details to create pipelines. + """ + + #: A constant which can be used with the recipe_type property of a RecipeSummary. + #: This constant has a value of "ZERO_ETL" + RECIPE_TYPE_ZERO_ETL = "ZERO_ETL" + + def __init__(self, **kwargs): + """ + Initializes a new RecipeSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this RecipeSummary. + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type recipe_type: str + + :param name: + The value to assign to the name property of this RecipeSummary. + :type name: str + + :param display_name: + The value to assign to the display_name property of this RecipeSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this RecipeSummary. + :type description: str + + :param supported_source_technology_types: + The value to assign to the supported_source_technology_types property of this RecipeSummary. + :type supported_source_technology_types: list[oci.golden_gate.models.TechnologyType] + + :param supported_target_technology_types: + The value to assign to the supported_target_technology_types property of this RecipeSummary. + :type supported_target_technology_types: list[oci.golden_gate.models.TechnologyType] + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'name': 'str', + 'display_name': 'str', + 'description': 'str', + 'supported_source_technology_types': 'list[TechnologyType]', + 'supported_target_technology_types': 'list[TechnologyType]' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'name': 'name', + 'display_name': 'displayName', + 'description': 'description', + 'supported_source_technology_types': 'supportedSourceTechnologyTypes', + 'supported_target_technology_types': 'supportedTargetTechnologyTypes' + } + + self._recipe_type = None + self._name = None + self._display_name = None + self._description = None + self._supported_source_technology_types = None + self._supported_target_technology_types = None + + @property + def recipe_type(self): + """ + **[Required]** Gets the recipe_type of this RecipeSummary. + The type of the recipe + + Allowed values for this property are: "ZERO_ETL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The recipe_type of this RecipeSummary. + :rtype: str + """ + return self._recipe_type + + @recipe_type.setter + def recipe_type(self, recipe_type): + """ + Sets the recipe_type of this RecipeSummary. + The type of the recipe + + + :param recipe_type: The recipe_type of this RecipeSummary. + :type: str + """ + allowed_values = ["ZERO_ETL"] + if not value_allowed_none_or_none_sentinel(recipe_type, allowed_values): + recipe_type = 'UNKNOWN_ENUM_VALUE' + self._recipe_type = recipe_type + + @property + def name(self): + """ + **[Required]** Gets the name of this RecipeSummary. + An object's Display Name. + + + :return: The name of this RecipeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this RecipeSummary. + An object's Display Name. + + + :param name: The name of this RecipeSummary. + :type: str + """ + self._name = name + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this RecipeSummary. + An object's Display Name. + + + :return: The display_name of this RecipeSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this RecipeSummary. + An object's Display Name. + + + :param display_name: The display_name of this RecipeSummary. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this RecipeSummary. + Metadata about this specific object. + + + :return: The description of this RecipeSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this RecipeSummary. + Metadata about this specific object. + + + :param description: The description of this RecipeSummary. + :type: str + """ + self._description = description + + @property + def supported_source_technology_types(self): + """ + **[Required]** Gets the supported_source_technology_types of this RecipeSummary. + Array of supported technology types for this recipe. + + + :return: The supported_source_technology_types of this RecipeSummary. + :rtype: list[oci.golden_gate.models.TechnologyType] + """ + return self._supported_source_technology_types + + @supported_source_technology_types.setter + def supported_source_technology_types(self, supported_source_technology_types): + """ + Sets the supported_source_technology_types of this RecipeSummary. + Array of supported technology types for this recipe. + + + :param supported_source_technology_types: The supported_source_technology_types of this RecipeSummary. + :type: list[oci.golden_gate.models.TechnologyType] + """ + self._supported_source_technology_types = supported_source_technology_types + + @property + def supported_target_technology_types(self): + """ + **[Required]** Gets the supported_target_technology_types of this RecipeSummary. + Array of supported technology types for this recipe. + + + :return: The supported_target_technology_types of this RecipeSummary. + :rtype: list[oci.golden_gate.models.TechnologyType] + """ + return self._supported_target_technology_types + + @supported_target_technology_types.setter + def supported_target_technology_types(self, supported_target_technology_types): + """ + Sets the supported_target_technology_types of this RecipeSummary. + Array of supported technology types for this recipe. + + + :param supported_target_technology_types: The supported_target_technology_types of this RecipeSummary. + :type: list[oci.golden_gate.models.TechnologyType] + """ + self._supported_target_technology_types = supported_target_technology_types + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/recipe_summary_collection.py b/src/oci/golden_gate/models/recipe_summary_collection.py new file mode 100644 index 0000000000..5463bc2a79 --- /dev/null +++ b/src/oci/golden_gate/models/recipe_summary_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RecipeSummaryCollection(object): + """ + The list of Recipe objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RecipeSummaryCollection 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 RecipeSummaryCollection. + :type items: list[oci.golden_gate.models.RecipeSummary] + + """ + self.swagger_types = { + 'items': 'list[RecipeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this RecipeSummaryCollection. + Array of Recipe Summary + + + :return: The items of this RecipeSummaryCollection. + :rtype: list[oci.golden_gate.models.RecipeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this RecipeSummaryCollection. + Array of Recipe Summary + + + :param items: The items of this RecipeSummaryCollection. + :type: list[oci.golden_gate.models.RecipeSummary] + """ + 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/golden_gate/models/replicate_schema_change.py b/src/oci/golden_gate/models/replicate_schema_change.py new file mode 100644 index 0000000000..e088835987 --- /dev/null +++ b/src/oci/golden_gate/models/replicate_schema_change.py @@ -0,0 +1,190 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReplicateSchemaChange(object): + """ + Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. + """ + + #: A constant which can be used with the can_replicate_schema_change property of a ReplicateSchemaChange. + #: This constant has a value of "ENABLED" + CAN_REPLICATE_SCHEMA_CHANGE_ENABLED = "ENABLED" + + #: A constant which can be used with the can_replicate_schema_change property of a ReplicateSchemaChange. + #: This constant has a value of "DISABLED" + CAN_REPLICATE_SCHEMA_CHANGE_DISABLED = "DISABLED" + + #: A constant which can be used with the action_on_ddl_error property of a ReplicateSchemaChange. + #: This constant has a value of "TERMINATE" + ACTION_ON_DDL_ERROR_TERMINATE = "TERMINATE" + + #: A constant which can be used with the action_on_ddl_error property of a ReplicateSchemaChange. + #: This constant has a value of "DISCARD" + ACTION_ON_DDL_ERROR_DISCARD = "DISCARD" + + #: A constant which can be used with the action_on_ddl_error property of a ReplicateSchemaChange. + #: This constant has a value of "IGNORE" + ACTION_ON_DDL_ERROR_IGNORE = "IGNORE" + + #: A constant which can be used with the action_on_dml_error property of a ReplicateSchemaChange. + #: This constant has a value of "TERMINATE" + ACTION_ON_DML_ERROR_TERMINATE = "TERMINATE" + + #: A constant which can be used with the action_on_dml_error property of a ReplicateSchemaChange. + #: This constant has a value of "DISCARD" + ACTION_ON_DML_ERROR_DISCARD = "DISCARD" + + #: A constant which can be used with the action_on_dml_error property of a ReplicateSchemaChange. + #: This constant has a value of "IGNORE" + ACTION_ON_DML_ERROR_IGNORE = "IGNORE" + + def __init__(self, **kwargs): + """ + Initializes a new ReplicateSchemaChange object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param can_replicate_schema_change: + The value to assign to the can_replicate_schema_change property of this ReplicateSchemaChange. + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type can_replicate_schema_change: str + + :param action_on_ddl_error: + The value to assign to the action_on_ddl_error property of this ReplicateSchemaChange. + Allowed values for this property are: "TERMINATE", "DISCARD", "IGNORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_on_ddl_error: str + + :param action_on_dml_error: + The value to assign to the action_on_dml_error property of this ReplicateSchemaChange. + Allowed values for this property are: "TERMINATE", "DISCARD", "IGNORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_on_dml_error: str + + """ + self.swagger_types = { + 'can_replicate_schema_change': 'str', + 'action_on_ddl_error': 'str', + 'action_on_dml_error': 'str' + } + + self.attribute_map = { + 'can_replicate_schema_change': 'canReplicateSchemaChange', + 'action_on_ddl_error': 'actionOnDdlError', + 'action_on_dml_error': 'actionOnDmlError' + } + + self._can_replicate_schema_change = None + self._action_on_ddl_error = None + self._action_on_dml_error = None + + @property + def can_replicate_schema_change(self): + """ + **[Required]** Gets the can_replicate_schema_change of this ReplicateSchemaChange. + If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline. + + Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The can_replicate_schema_change of this ReplicateSchemaChange. + :rtype: str + """ + return self._can_replicate_schema_change + + @can_replicate_schema_change.setter + def can_replicate_schema_change(self, can_replicate_schema_change): + """ + Sets the can_replicate_schema_change of this ReplicateSchemaChange. + If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline. + + + :param can_replicate_schema_change: The can_replicate_schema_change of this ReplicateSchemaChange. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(can_replicate_schema_change, allowed_values): + can_replicate_schema_change = 'UNKNOWN_ENUM_VALUE' + self._can_replicate_schema_change = can_replicate_schema_change + + @property + def action_on_ddl_error(self): + """ + Gets the action_on_ddl_error of this ReplicateSchemaChange. + Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true + + Allowed values for this property are: "TERMINATE", "DISCARD", "IGNORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_on_ddl_error of this ReplicateSchemaChange. + :rtype: str + """ + return self._action_on_ddl_error + + @action_on_ddl_error.setter + def action_on_ddl_error(self, action_on_ddl_error): + """ + Sets the action_on_ddl_error of this ReplicateSchemaChange. + Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true + + + :param action_on_ddl_error: The action_on_ddl_error of this ReplicateSchemaChange. + :type: str + """ + allowed_values = ["TERMINATE", "DISCARD", "IGNORE"] + if not value_allowed_none_or_none_sentinel(action_on_ddl_error, allowed_values): + action_on_ddl_error = 'UNKNOWN_ENUM_VALUE' + self._action_on_ddl_error = action_on_ddl_error + + @property + def action_on_dml_error(self): + """ + Gets the action_on_dml_error of this ReplicateSchemaChange. + Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true + + Allowed values for this property are: "TERMINATE", "DISCARD", "IGNORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_on_dml_error of this ReplicateSchemaChange. + :rtype: str + """ + return self._action_on_dml_error + + @action_on_dml_error.setter + def action_on_dml_error(self, action_on_dml_error): + """ + Sets the action_on_dml_error of this ReplicateSchemaChange. + Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true + + + :param action_on_dml_error: The action_on_dml_error of this ReplicateSchemaChange. + :type: str + """ + allowed_values = ["TERMINATE", "DISCARD", "IGNORE"] + if not value_allowed_none_or_none_sentinel(action_on_dml_error, allowed_values): + action_on_dml_error = 'UNKNOWN_ENUM_VALUE' + self._action_on_dml_error = action_on_dml_error + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/source_pipeline_connection_details.py b/src/oci/golden_gate/models/source_pipeline_connection_details.py new file mode 100644 index 0000000000..9d93eb4169 --- /dev/null +++ b/src/oci/golden_gate/models/source_pipeline_connection_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SourcePipelineConnectionDetails(object): + """ + The source connection details for creating a pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SourcePipelineConnectionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param connection_id: + The value to assign to the connection_id property of this SourcePipelineConnectionDetails. + :type connection_id: str + + """ + self.swagger_types = { + 'connection_id': 'str' + } + + self.attribute_map = { + 'connection_id': 'connectionId' + } + + self._connection_id = None + + @property + def connection_id(self): + """ + **[Required]** Gets the connection_id of this SourcePipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The connection_id of this SourcePipelineConnectionDetails. + :rtype: str + """ + return self._connection_id + + @connection_id.setter + def connection_id(self, connection_id): + """ + Sets the connection_id of this SourcePipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param connection_id: The connection_id of this SourcePipelineConnectionDetails. + :type: str + """ + self._connection_id = connection_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/golden_gate/models/start_pipeline_details.py b/src/oci/golden_gate/models/start_pipeline_details.py new file mode 100644 index 0000000000..5de3d20ec3 --- /dev/null +++ b/src/oci/golden_gate/models/start_pipeline_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StartPipelineDetails(object): + """ + Details with which to start a pipeline. + """ + + #: A constant which can be used with the type property of a StartPipelineDetails. + #: This constant has a value of "DEFAULT" + TYPE_DEFAULT = "DEFAULT" + + def __init__(self, **kwargs): + """ + Initializes a new StartPipelineDetails 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.golden_gate.models.DefaultStartPipelineDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this StartPipelineDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['type'] + + if type == 'DEFAULT': + return 'DefaultStartPipelineDetails' + else: + return 'StartPipelineDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this StartPipelineDetails. + Type of pipeline start. This option applies when starting a pipeline. + + Allowed values for this property are: "DEFAULT" + + + :return: The type of this StartPipelineDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this StartPipelineDetails. + Type of pipeline start. This option applies when starting a pipeline. + + + :param type: The type of this StartPipelineDetails. + :type: str + """ + allowed_values = ["DEFAULT"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + f"Invalid value for `type`, must be None or one of {allowed_values}" + ) + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/step_message.py b/src/oci/golden_gate/models/step_message.py new file mode 100644 index 0000000000..0554036e00 --- /dev/null +++ b/src/oci/golden_gate/models/step_message.py @@ -0,0 +1,197 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StepMessage(object): + """ + Contents of a step message. + """ + + #: A constant which can be used with the severity property of a StepMessage. + #: This constant has a value of "INFO" + SEVERITY_INFO = "INFO" + + #: A constant which can be used with the severity property of a StepMessage. + #: This constant has a value of "ERROR" + SEVERITY_ERROR = "ERROR" + + #: A constant which can be used with the severity property of a StepMessage. + #: This constant has a value of "WARNING" + SEVERITY_WARNING = "WARNING" + + def __init__(self, **kwargs): + """ + Initializes a new StepMessage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param message: + The value to assign to the message property of this StepMessage. + :type message: str + + :param code: + The value to assign to the code property of this StepMessage. + :type code: str + + :param timestamp: + The value to assign to the timestamp property of this StepMessage. + :type timestamp: datetime + + :param severity: + The value to assign to the severity property of this StepMessage. + Allowed values for this property are: "INFO", "ERROR", "WARNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + """ + self.swagger_types = { + 'message': 'str', + 'code': 'str', + 'timestamp': 'datetime', + 'severity': 'str' + } + + self.attribute_map = { + 'message': 'message', + 'code': 'code', + 'timestamp': 'timestamp', + 'severity': 'severity' + } + + self._message = None + self._code = None + self._timestamp = None + self._severity = None + + @property + def message(self): + """ + **[Required]** Gets the message of this StepMessage. + The status message of the steps in a recipe during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html + + + :return: The message of this StepMessage. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this StepMessage. + The status message of the steps in a recipe during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html + + + :param message: The message of this StepMessage. + :type: str + """ + self._message = message + + @property + def code(self): + """ + **[Required]** Gets the code of this StepMessage. + The code returned when GoldenGate reports an error while running a step during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2 + + + :return: The code of this StepMessage. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this StepMessage. + The code returned when GoldenGate reports an error while running a step during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2 + + + :param code: The code of this StepMessage. + :type: str + """ + self._code = code + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this StepMessage. + Date and time of a message issued by steps in a recipe during pipeline initialization. + The format is defined by `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The timestamp of this StepMessage. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this StepMessage. + Date and time of a message issued by steps in a recipe during pipeline initialization. + The format is defined by `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param timestamp: The timestamp of this StepMessage. + :type: datetime + """ + self._timestamp = timestamp + + @property + def severity(self): + """ + **[Required]** Gets the severity of this StepMessage. + The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html + + Allowed values for this property are: "INFO", "ERROR", "WARNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this StepMessage. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this StepMessage. + The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization. + https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html + + + :param severity: The severity of this StepMessage. + :type: str + """ + allowed_values = ["INFO", "ERROR", "WARNING"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/stop_pipeline_details.py b/src/oci/golden_gate/models/stop_pipeline_details.py new file mode 100644 index 0000000000..e181c3f3c5 --- /dev/null +++ b/src/oci/golden_gate/models/stop_pipeline_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StopPipelineDetails(object): + """ + Details for a pipeline stop. + """ + + #: A constant which can be used with the type property of a StopPipelineDetails. + #: This constant has a value of "DEFAULT" + TYPE_DEFAULT = "DEFAULT" + + def __init__(self, **kwargs): + """ + Initializes a new StopPipelineDetails 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.golden_gate.models.DefaultStopPipelineDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this StopPipelineDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['type'] + + if type == 'DEFAULT': + return 'DefaultStopPipelineDetails' + else: + return 'StopPipelineDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this StopPipelineDetails. + Type of a pipeline stop. This option applies when stopping a pipeline. + + Allowed values for this property are: "DEFAULT" + + + :return: The type of this StopPipelineDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this StopPipelineDetails. + Type of a pipeline stop. This option applies when stopping a pipeline. + + + :param type: The type of this StopPipelineDetails. + :type: str + """ + allowed_values = ["DEFAULT"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + f"Invalid value for `type`, must be None or one of {allowed_values}" + ) + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/target_pipeline_connection_details.py b/src/oci/golden_gate/models/target_pipeline_connection_details.py new file mode 100644 index 0000000000..a5251b9fd8 --- /dev/null +++ b/src/oci/golden_gate/models/target_pipeline_connection_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TargetPipelineConnectionDetails(object): + """ + The target connection details for creating a pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TargetPipelineConnectionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param connection_id: + The value to assign to the connection_id property of this TargetPipelineConnectionDetails. + :type connection_id: str + + """ + self.swagger_types = { + 'connection_id': 'str' + } + + self.attribute_map = { + 'connection_id': 'connectionId' + } + + self._connection_id = None + + @property + def connection_id(self): + """ + **[Required]** Gets the connection_id of this TargetPipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The connection_id of this TargetPipelineConnectionDetails. + :rtype: str + """ + return self._connection_id + + @connection_id.setter + def connection_id(self, connection_id): + """ + Sets the connection_id of this TargetPipelineConnectionDetails. + The `OCID`__ of the connection being + referenced. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param connection_id: The connection_id of this TargetPipelineConnectionDetails. + :type: str + """ + self._connection_id = connection_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/golden_gate/models/test_pipeline_connection_details.py b/src/oci/golden_gate/models/test_pipeline_connection_details.py new file mode 100644 index 0000000000..6cd5cff5a8 --- /dev/null +++ b/src/oci/golden_gate/models/test_pipeline_connection_details.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestPipelineConnectionDetails(object): + """ + Details about testing the pipeline's assigned connection. + """ + + #: A constant which can be used with the type property of a TestPipelineConnectionDetails. + #: This constant has a value of "DEFAULT" + TYPE_DEFAULT = "DEFAULT" + + def __init__(self, **kwargs): + """ + Initializes a new TestPipelineConnectionDetails 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.golden_gate.models.DefaultTestPipelineConnectionDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this TestPipelineConnectionDetails. + Allowed values for this property are: "DEFAULT" + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['type'] + + if type == 'DEFAULT': + return 'DefaultTestPipelineConnectionDetails' + else: + return 'TestPipelineConnectionDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this TestPipelineConnectionDetails. + Type of test for an assigned pipeline connection. This option applies when testing a pipeline connection. + + Allowed values for this property are: "DEFAULT" + + + :return: The type of this TestPipelineConnectionDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this TestPipelineConnectionDetails. + Type of test for an assigned pipeline connection. This option applies when testing a pipeline connection. + + + :param type: The type of this TestPipelineConnectionDetails. + :type: str + """ + allowed_values = ["DEFAULT"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + f"Invalid value for `type`, must be None or one of {allowed_values}" + ) + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/test_pipeline_connection_error.py b/src/oci/golden_gate/models/test_pipeline_connection_error.py new file mode 100644 index 0000000000..4139e1cc05 --- /dev/null +++ b/src/oci/golden_gate/models/test_pipeline_connection_error.py @@ -0,0 +1,165 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestPipelineConnectionError(object): + """ + The error returned when a pipeline connection fails to connect. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TestPipelineConnectionError object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param code: + The value to assign to the code property of this TestPipelineConnectionError. + :type code: str + + :param message: + The value to assign to the message property of this TestPipelineConnectionError. + :type message: str + + :param issue: + The value to assign to the issue property of this TestPipelineConnectionError. + :type issue: str + + :param action: + The value to assign to the action property of this TestPipelineConnectionError. + :type action: str + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'issue': 'str', + 'action': 'str' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'issue': 'issue', + 'action': 'action' + } + + self._code = None + self._message = None + self._issue = None + self._action = None + + @property + def code(self): + """ + **[Required]** Gets the code of this TestPipelineConnectionError. + A short error code that defines the error, meant for programmatic parsing. + + + :return: The code of this TestPipelineConnectionError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this TestPipelineConnectionError. + A short error code that defines the error, meant for programmatic parsing. + + + :param code: The code of this TestPipelineConnectionError. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this TestPipelineConnectionError. + A human-readable error string. + + + :return: The message of this TestPipelineConnectionError. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this TestPipelineConnectionError. + A human-readable error string. + + + :param message: The message of this TestPipelineConnectionError. + :type: str + """ + self._message = message + + @property + def issue(self): + """ + Gets the issue of this TestPipelineConnectionError. + The text describing the root cause of the reported issue. + + + :return: The issue of this TestPipelineConnectionError. + :rtype: str + """ + return self._issue + + @issue.setter + def issue(self, issue): + """ + Sets the issue of this TestPipelineConnectionError. + The text describing the root cause of the reported issue. + + + :param issue: The issue of this TestPipelineConnectionError. + :type: str + """ + self._issue = issue + + @property + def action(self): + """ + Gets the action of this TestPipelineConnectionError. + The text describing the action required to fix the issue. + + + :return: The action of this TestPipelineConnectionError. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this TestPipelineConnectionError. + The text describing the action required to fix the issue. + + + :param action: The action of this TestPipelineConnectionError. + :type: str + """ + self._action = action + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/test_pipeline_connection_result.py b/src/oci/golden_gate/models/test_pipeline_connection_result.py new file mode 100644 index 0000000000..22ee623574 --- /dev/null +++ b/src/oci/golden_gate/models/test_pipeline_connection_result.py @@ -0,0 +1,119 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestPipelineConnectionResult(object): + """ + Result of the connectivity test performed on a pipeline's assigned connection. + """ + + #: A constant which can be used with the result_type property of a TestPipelineConnectionResult. + #: This constant has a value of "SUCCEEDED" + RESULT_TYPE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the result_type property of a TestPipelineConnectionResult. + #: This constant has a value of "FAILED" + RESULT_TYPE_FAILED = "FAILED" + + #: A constant which can be used with the result_type property of a TestPipelineConnectionResult. + #: This constant has a value of "TIMED_OUT" + RESULT_TYPE_TIMED_OUT = "TIMED_OUT" + + def __init__(self, **kwargs): + """ + Initializes a new TestPipelineConnectionResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param result_type: + The value to assign to the result_type property of this TestPipelineConnectionResult. + Allowed values for this property are: "SUCCEEDED", "FAILED", "TIMED_OUT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type result_type: str + + :param error: + The value to assign to the error property of this TestPipelineConnectionResult. + :type error: oci.golden_gate.models.TestPipelineConnectionError + + """ + self.swagger_types = { + 'result_type': 'str', + 'error': 'TestPipelineConnectionError' + } + + self.attribute_map = { + 'result_type': 'resultType', + 'error': 'error' + } + + self._result_type = None + self._error = None + + @property + def result_type(self): + """ + **[Required]** Gets the result_type of this TestPipelineConnectionResult. + Type of result, either Succeeded, Failed, or Timed out. + + Allowed values for this property are: "SUCCEEDED", "FAILED", "TIMED_OUT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The result_type of this TestPipelineConnectionResult. + :rtype: str + """ + return self._result_type + + @result_type.setter + def result_type(self, result_type): + """ + Sets the result_type of this TestPipelineConnectionResult. + Type of result, either Succeeded, Failed, or Timed out. + + + :param result_type: The result_type of this TestPipelineConnectionResult. + :type: str + """ + allowed_values = ["SUCCEEDED", "FAILED", "TIMED_OUT"] + if not value_allowed_none_or_none_sentinel(result_type, allowed_values): + result_type = 'UNKNOWN_ENUM_VALUE' + self._result_type = result_type + + @property + def error(self): + """ + Gets the error of this TestPipelineConnectionResult. + + :return: The error of this TestPipelineConnectionResult. + :rtype: oci.golden_gate.models.TestPipelineConnectionError + """ + return self._error + + @error.setter + def error(self, error): + """ + Sets the error of this TestPipelineConnectionResult. + + :param error: The error of this TestPipelineConnectionResult. + :type: oci.golden_gate.models.TestPipelineConnectionError + """ + self._error = error + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/update_mysql_connection_details.py b/src/oci/golden_gate/models/update_mysql_connection_details.py index 299a7f1887..49bc0dec5d 100644 --- a/src/oci/golden_gate/models/update_mysql_connection_details.py +++ b/src/oci/golden_gate/models/update_mysql_connection_details.py @@ -513,7 +513,7 @@ def ssl_cert(self, ssl_cert): def ssl_key(self): """ Gets the ssl_key of this UpdateMysqlConnectionDetails. - Client Key \u2013 The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). + Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). :return: The ssl_key of this UpdateMysqlConnectionDetails. @@ -525,7 +525,7 @@ def ssl_key(self): def ssl_key(self, ssl_key): """ Sets the ssl_key of this UpdateMysqlConnectionDetails. - Client Key \u2013 The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). + Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). :param ssl_key: The ssl_key of this UpdateMysqlConnectionDetails. diff --git a/src/oci/golden_gate/models/update_pipeline_details.py b/src/oci/golden_gate/models/update_pipeline_details.py new file mode 100644 index 0000000000..4255abf6ae --- /dev/null +++ b/src/oci/golden_gate/models/update_pipeline_details.py @@ -0,0 +1,282 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdatePipelineDetails(object): + """ + Information with which to update a pipeline. + """ + + #: A constant which can be used with the recipe_type property of a UpdatePipelineDetails. + #: This constant has a value of "ZERO_ETL" + RECIPE_TYPE_ZERO_ETL = "ZERO_ETL" + + #: A constant which can be used with the license_model property of a UpdatePipelineDetails. + #: This constant has a value of "LICENSE_INCLUDED" + LICENSE_MODEL_LICENSE_INCLUDED = "LICENSE_INCLUDED" + + #: A constant which can be used with the license_model property of a UpdatePipelineDetails. + #: This constant has a value of "BRING_YOUR_OWN_LICENSE" + LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = "BRING_YOUR_OWN_LICENSE" + + def __init__(self, **kwargs): + """ + Initializes a new UpdatePipelineDetails 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.golden_gate.models.UpdateZeroEtlPipelineDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this UpdatePipelineDetails. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param display_name: + The value to assign to the display_name property of this UpdatePipelineDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdatePipelineDetails. + :type description: str + + :param license_model: + The value to assign to the license_model property of this UpdatePipelineDetails. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdatePipelineDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdatePipelineDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'display_name': 'str', + 'description': 'str', + 'license_model': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'display_name': 'displayName', + 'description': 'description', + 'license_model': 'licenseModel', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._recipe_type = None + self._display_name = None + self._description = None + self._license_model = None + self._freeform_tags = None + self._defined_tags = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['recipeType'] + + if type == 'ZERO_ETL': + return 'UpdateZeroEtlPipelineDetails' + else: + return 'UpdatePipelineDetails' + + @property + def recipe_type(self): + """ + Gets the recipe_type of this UpdatePipelineDetails. + The type of the recipe + + Allowed values for this property are: "ZERO_ETL" + + + :return: The recipe_type of this UpdatePipelineDetails. + :rtype: str + """ + return self._recipe_type + + @recipe_type.setter + def recipe_type(self, recipe_type): + """ + Sets the recipe_type of this UpdatePipelineDetails. + The type of the recipe + + + :param recipe_type: The recipe_type of this UpdatePipelineDetails. + :type: str + """ + allowed_values = ["ZERO_ETL"] + if not value_allowed_none_or_none_sentinel(recipe_type, allowed_values): + raise ValueError( + f"Invalid value for `recipe_type`, must be None or one of {allowed_values}" + ) + self._recipe_type = recipe_type + + @property + def display_name(self): + """ + Gets the display_name of this UpdatePipelineDetails. + An object's Display Name. + + + :return: The display_name of this UpdatePipelineDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdatePipelineDetails. + An object's Display Name. + + + :param display_name: The display_name of this UpdatePipelineDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdatePipelineDetails. + Metadata about this specific object. + + + :return: The description of this UpdatePipelineDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdatePipelineDetails. + Metadata about this specific object. + + + :param description: The description of this UpdatePipelineDetails. + :type: str + """ + self._description = description + + @property + def license_model(self): + """ + Gets the license_model of this UpdatePipelineDetails. + The Oracle license model that applies to a Deployment. + + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + + + :return: The license_model of this UpdatePipelineDetails. + :rtype: str + """ + return self._license_model + + @license_model.setter + def license_model(self, license_model): + """ + Sets the license_model of this UpdatePipelineDetails. + The Oracle license model that applies to a Deployment. + + + :param license_model: The license_model of this UpdatePipelineDetails. + :type: str + """ + allowed_values = ["LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE"] + if not value_allowed_none_or_none_sentinel(license_model, allowed_values): + raise ValueError( + f"Invalid value for `license_model`, must be None or one of {allowed_values}" + ) + self._license_model = license_model + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdatePipelineDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :return: The freeform_tags of this UpdatePipelineDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdatePipelineDetails. + A simple key-value pair that is applied without any predefined name, type, or scope. Exists + for cross-compatibility only. + + Example: `{\"bar-key\": \"value\"}` + + + :param freeform_tags: The freeform_tags of this UpdatePipelineDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdatePipelineDetails. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdatePipelineDetails. + :rtype: dict(str, dict(str, object)) + """ + return self._defined_tags + + @defined_tags.setter + def defined_tags(self, defined_tags): + """ + Sets the defined_tags of this UpdatePipelineDetails. + Tags defined for this resource. Each key is predefined and scoped to a namespace. + + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdatePipelineDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/update_zero_etl_pipeline_details.py b/src/oci/golden_gate/models/update_zero_etl_pipeline_details.py new file mode 100644 index 0000000000..4cb1200d3f --- /dev/null +++ b/src/oci/golden_gate/models/update_zero_etl_pipeline_details.py @@ -0,0 +1,145 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .update_pipeline_details import UpdatePipelineDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateZeroEtlPipelineDetails(UpdatePipelineDetails): + """ + Information to update for an existing ZeroETL pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateZeroEtlPipelineDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.UpdateZeroEtlPipelineDetails.recipe_type` attribute + of this class is ``ZERO_ETL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this UpdateZeroEtlPipelineDetails. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param display_name: + The value to assign to the display_name property of this UpdateZeroEtlPipelineDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateZeroEtlPipelineDetails. + :type description: str + + :param license_model: + The value to assign to the license_model property of this UpdateZeroEtlPipelineDetails. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateZeroEtlPipelineDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateZeroEtlPipelineDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param process_options: + The value to assign to the process_options property of this UpdateZeroEtlPipelineDetails. + :type process_options: oci.golden_gate.models.ProcessOptions + + :param mapping_rules: + The value to assign to the mapping_rules property of this UpdateZeroEtlPipelineDetails. + :type mapping_rules: list[oci.golden_gate.models.MappingRule] + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'display_name': 'str', + 'description': 'str', + 'license_model': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'process_options': 'ProcessOptions', + 'mapping_rules': 'list[MappingRule]' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'display_name': 'displayName', + 'description': 'description', + 'license_model': 'licenseModel', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'process_options': 'processOptions', + 'mapping_rules': 'mappingRules' + } + + self._recipe_type = None + self._display_name = None + self._description = None + self._license_model = None + self._freeform_tags = None + self._defined_tags = None + self._process_options = None + self._mapping_rules = None + self._recipe_type = 'ZERO_ETL' + + @property + def process_options(self): + """ + Gets the process_options of this UpdateZeroEtlPipelineDetails. + + :return: The process_options of this UpdateZeroEtlPipelineDetails. + :rtype: oci.golden_gate.models.ProcessOptions + """ + return self._process_options + + @process_options.setter + def process_options(self, process_options): + """ + Sets the process_options of this UpdateZeroEtlPipelineDetails. + + :param process_options: The process_options of this UpdateZeroEtlPipelineDetails. + :type: oci.golden_gate.models.ProcessOptions + """ + self._process_options = process_options + + @property + def mapping_rules(self): + """ + Gets the mapping_rules of this UpdateZeroEtlPipelineDetails. + Mapping for source/target schema/tables for the pipeline data replication. + + + :return: The mapping_rules of this UpdateZeroEtlPipelineDetails. + :rtype: list[oci.golden_gate.models.MappingRule] + """ + return self._mapping_rules + + @mapping_rules.setter + def mapping_rules(self, mapping_rules): + """ + Sets the mapping_rules of this UpdateZeroEtlPipelineDetails. + Mapping for source/target schema/tables for the pipeline data replication. + + + :param mapping_rules: The mapping_rules of this UpdateZeroEtlPipelineDetails. + :type: list[oci.golden_gate.models.MappingRule] + """ + self._mapping_rules = mapping_rules + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/work_request.py b/src/oci/golden_gate/models/work_request.py index 41fcffd903..627ba9d674 100644 --- a/src/oci/golden_gate/models/work_request.py +++ b/src/oci/golden_gate/models/work_request.py @@ -146,6 +146,30 @@ class WorkRequest(object): #: This constant has a value of "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE" OPERATION_TYPE_GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE = "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_CREATE" + OPERATION_TYPE_GOLDENGATE_PIPELINE_CREATE = "GOLDENGATE_PIPELINE_CREATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_START" + OPERATION_TYPE_GOLDENGATE_PIPELINE_START = "GOLDENGATE_PIPELINE_START" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_STOP" + OPERATION_TYPE_GOLDENGATE_PIPELINE_STOP = "GOLDENGATE_PIPELINE_STOP" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_UPDATE" + OPERATION_TYPE_GOLDENGATE_PIPELINE_UPDATE = "GOLDENGATE_PIPELINE_UPDATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_DELETE" + OPERATION_TYPE_GOLDENGATE_PIPELINE_DELETE = "GOLDENGATE_PIPELINE_DELETE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "GOLDENGATE_PIPELINE_MOVE" + OPERATION_TYPE_GOLDENGATE_PIPELINE_MOVE = "GOLDENGATE_PIPELINE_MOVE" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -173,7 +197,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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE", "GOLDENGATE_PIPELINE_CREATE", "GOLDENGATE_PIPELINE_START", "GOLDENGATE_PIPELINE_STOP", "GOLDENGATE_PIPELINE_UPDATE", "GOLDENGATE_PIPELINE_DELETE", "GOLDENGATE_PIPELINE_MOVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -252,7 +276,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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE", "GOLDENGATE_PIPELINE_CREATE", "GOLDENGATE_PIPELINE_START", "GOLDENGATE_PIPELINE_STOP", "GOLDENGATE_PIPELINE_UPDATE", "GOLDENGATE_PIPELINE_DELETE", "GOLDENGATE_PIPELINE_MOVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -271,7 +295,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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_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_UPGRADE", "GOLDENGATE_DEPLOYMENT_BACKUP_CREATE", "GOLDENGATE_DEPLOYMENT_BACKUP_DELETE", "GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL", "GOLDENGATE_DEPLOYMENT_BACKUP_COPY", "GOLDENGATE_CONNECTION_CREATE", "GOLDENGATE_CONNECTION_UPDATE", "GOLDENGATE_CONNECTION_DELETE", "GOLDENGATE_CONNECTION_MOVE", "GOLDENGATE_CONNECTION_REFRESH", "GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE", "GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE", "GOLDENGATE_CONNECTION_ASSIGMNENT_DELETE", "GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT", "GOLDENGATE_DEPLOYMENT_WALLET_EXPORT", "GOLDENGATE_DEPLOYMENT_WALLET_IMPORT", "GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE", "GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK", "GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE", "GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE", "GOLDENGATE_PIPELINE_CREATE", "GOLDENGATE_PIPELINE_START", "GOLDENGATE_PIPELINE_STOP", "GOLDENGATE_PIPELINE_UPDATE", "GOLDENGATE_PIPELINE_DELETE", "GOLDENGATE_PIPELINE_MOVE"] 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/golden_gate/models/zero_etl_pipeline.py b/src/oci/golden_gate/models/zero_etl_pipeline.py new file mode 100644 index 0000000000..d5d035afb0 --- /dev/null +++ b/src/oci/golden_gate/models/zero_etl_pipeline.py @@ -0,0 +1,275 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .pipeline import Pipeline +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ZeroEtlPipeline(Pipeline): + """ + The details of a ZeroETL pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ZeroEtlPipeline object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.ZeroEtlPipeline.recipe_type` attribute + of this class is ``ZERO_ETL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this ZeroEtlPipeline. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param id: + The value to assign to the id property of this ZeroEtlPipeline. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ZeroEtlPipeline. + :type display_name: str + + :param description: + The value to assign to the description property of this ZeroEtlPipeline. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this ZeroEtlPipeline. + :type compartment_id: str + + :param license_model: + The value to assign to the license_model property of this ZeroEtlPipeline. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param cpu_core_count: + The value to assign to the cpu_core_count property of this ZeroEtlPipeline. + :type cpu_core_count: int + + :param is_auto_scaling_enabled: + The value to assign to the is_auto_scaling_enabled property of this ZeroEtlPipeline. + :type is_auto_scaling_enabled: bool + + :param source_connection_details: + The value to assign to the source_connection_details property of this ZeroEtlPipeline. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this ZeroEtlPipeline. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this ZeroEtlPipeline. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this ZeroEtlPipeline. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ZeroEtlPipeline. + :type system_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this ZeroEtlPipeline. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ZeroEtlPipeline. + Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "NEEDS_ATTENTION", "DELETING", "DELETED", "FAILED" + :type lifecycle_state: str + + :param lifecycle_sub_state: + The value to assign to the lifecycle_sub_state property of this ZeroEtlPipeline. + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING" + :type lifecycle_sub_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this ZeroEtlPipeline. + :type lifecycle_details: str + + :param time_created: + The value to assign to the time_created property of this ZeroEtlPipeline. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ZeroEtlPipeline. + :type time_updated: datetime + + :param mapping_rules: + The value to assign to the mapping_rules property of this ZeroEtlPipeline. + :type mapping_rules: list[oci.golden_gate.models.MappingRule] + + :param process_options: + The value to assign to the process_options property of this ZeroEtlPipeline. + :type process_options: oci.golden_gate.models.ProcessOptions + + :param time_last_recorded: + The value to assign to the time_last_recorded property of this ZeroEtlPipeline. + :type time_last_recorded: datetime + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'license_model': 'str', + 'cpu_core_count': 'int', + 'is_auto_scaling_enabled': 'bool', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'lifecycle_state': 'str', + 'lifecycle_sub_state': 'str', + 'lifecycle_details': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'mapping_rules': 'list[MappingRule]', + 'process_options': 'ProcessOptions', + 'time_last_recorded': 'datetime' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'license_model': 'licenseModel', + 'cpu_core_count': 'cpuCoreCount', + 'is_auto_scaling_enabled': 'isAutoScalingEnabled', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'locks': 'locks', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_sub_state': 'lifecycleSubState', + 'lifecycle_details': 'lifecycleDetails', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'mapping_rules': 'mappingRules', + 'process_options': 'processOptions', + 'time_last_recorded': 'timeLastRecorded' + } + + self._recipe_type = None + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._license_model = None + self._cpu_core_count = None + self._is_auto_scaling_enabled = None + self._source_connection_details = None + self._target_connection_details = None + self._freeform_tags = None + self._defined_tags = None + self._system_tags = None + self._locks = None + self._lifecycle_state = None + self._lifecycle_sub_state = None + self._lifecycle_details = None + self._time_created = None + self._time_updated = None + self._mapping_rules = None + self._process_options = None + self._time_last_recorded = None + self._recipe_type = 'ZERO_ETL' + + @property + def mapping_rules(self): + """ + Gets the mapping_rules of this ZeroEtlPipeline. + Mapping for source/target schema/tables for the pipeline data replication. + + + :return: The mapping_rules of this ZeroEtlPipeline. + :rtype: list[oci.golden_gate.models.MappingRule] + """ + return self._mapping_rules + + @mapping_rules.setter + def mapping_rules(self, mapping_rules): + """ + Sets the mapping_rules of this ZeroEtlPipeline. + Mapping for source/target schema/tables for the pipeline data replication. + + + :param mapping_rules: The mapping_rules of this ZeroEtlPipeline. + :type: list[oci.golden_gate.models.MappingRule] + """ + self._mapping_rules = mapping_rules + + @property + def process_options(self): + """ + Gets the process_options of this ZeroEtlPipeline. + + :return: The process_options of this ZeroEtlPipeline. + :rtype: oci.golden_gate.models.ProcessOptions + """ + return self._process_options + + @process_options.setter + def process_options(self, process_options): + """ + Sets the process_options of this ZeroEtlPipeline. + + :param process_options: The process_options of this ZeroEtlPipeline. + :type: oci.golden_gate.models.ProcessOptions + """ + self._process_options = process_options + + @property + def time_last_recorded(self): + """ + Gets the time_last_recorded of this ZeroEtlPipeline. + When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by + `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_last_recorded of this ZeroEtlPipeline. + :rtype: datetime + """ + return self._time_last_recorded + + @time_last_recorded.setter + def time_last_recorded(self, time_last_recorded): + """ + Sets the time_last_recorded of this ZeroEtlPipeline. + When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by + `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_last_recorded: The time_last_recorded of this ZeroEtlPipeline. + :type: datetime + """ + self._time_last_recorded = time_last_recorded + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/golden_gate/models/zero_etl_pipeline_summary.py b/src/oci/golden_gate/models/zero_etl_pipeline_summary.py new file mode 100644 index 0000000000..91a4c96cb9 --- /dev/null +++ b/src/oci/golden_gate/models/zero_etl_pipeline_summary.py @@ -0,0 +1,243 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407 + +from .pipeline_summary import PipelineSummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ZeroEtlPipelineSummary(PipelineSummary): + """ + Summary of the ZeroETL pipeline. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ZeroEtlPipelineSummary object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.ZeroEtlPipelineSummary.recipe_type` attribute + of this class is ``ZERO_ETL`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param recipe_type: + The value to assign to the recipe_type property of this ZeroEtlPipelineSummary. + Allowed values for this property are: "ZERO_ETL" + :type recipe_type: str + + :param id: + The value to assign to the id property of this ZeroEtlPipelineSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this ZeroEtlPipelineSummary. + :type display_name: str + + :param description: + The value to assign to the description property of this ZeroEtlPipelineSummary. + :type description: str + + :param compartment_id: + The value to assign to the compartment_id property of this ZeroEtlPipelineSummary. + :type compartment_id: str + + :param source_connection_details: + The value to assign to the source_connection_details property of this ZeroEtlPipelineSummary. + :type source_connection_details: oci.golden_gate.models.SourcePipelineConnectionDetails + + :param target_connection_details: + The value to assign to the target_connection_details property of this ZeroEtlPipelineSummary. + :type target_connection_details: oci.golden_gate.models.TargetPipelineConnectionDetails + + :param freeform_tags: + The value to assign to the freeform_tags property of this ZeroEtlPipelineSummary. + :type freeform_tags: dict(str, str) + + :param license_model: + The value to assign to the license_model property of this ZeroEtlPipelineSummary. + Allowed values for this property are: "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" + :type license_model: str + + :param cpu_core_count: + The value to assign to the cpu_core_count property of this ZeroEtlPipelineSummary. + :type cpu_core_count: int + + :param is_auto_scaling_enabled: + The value to assign to the is_auto_scaling_enabled property of this ZeroEtlPipelineSummary. + :type is_auto_scaling_enabled: bool + + :param defined_tags: + The value to assign to the defined_tags property of this ZeroEtlPipelineSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this ZeroEtlPipelineSummary. + :type system_tags: dict(str, dict(str, object)) + + :param locks: + The value to assign to the locks property of this ZeroEtlPipelineSummary. + :type locks: list[oci.golden_gate.models.ResourceLock] + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this ZeroEtlPipelineSummary. + :type lifecycle_state: str + + :param lifecycle_sub_state: + The value to assign to the lifecycle_sub_state property of this ZeroEtlPipelineSummary. + Allowed values for this property are: "STARTING", "STOPPING", "STOPPED", "MOVING", "RUNNING" + :type lifecycle_sub_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this ZeroEtlPipelineSummary. + :type lifecycle_details: str + + :param time_created: + The value to assign to the time_created property of this ZeroEtlPipelineSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ZeroEtlPipelineSummary. + :type time_updated: datetime + + :param process_options: + The value to assign to the process_options property of this ZeroEtlPipelineSummary. + :type process_options: oci.golden_gate.models.ProcessOptions + + :param time_last_recorded: + The value to assign to the time_last_recorded property of this ZeroEtlPipelineSummary. + :type time_last_recorded: datetime + + """ + self.swagger_types = { + 'recipe_type': 'str', + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'compartment_id': 'str', + 'source_connection_details': 'SourcePipelineConnectionDetails', + 'target_connection_details': 'TargetPipelineConnectionDetails', + 'freeform_tags': 'dict(str, str)', + 'license_model': 'str', + 'cpu_core_count': 'int', + 'is_auto_scaling_enabled': 'bool', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))', + 'locks': 'list[ResourceLock]', + 'lifecycle_state': 'str', + 'lifecycle_sub_state': 'str', + 'lifecycle_details': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'process_options': 'ProcessOptions', + 'time_last_recorded': 'datetime' + } + + self.attribute_map = { + 'recipe_type': 'recipeType', + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'compartment_id': 'compartmentId', + 'source_connection_details': 'sourceConnectionDetails', + 'target_connection_details': 'targetConnectionDetails', + 'freeform_tags': 'freeformTags', + 'license_model': 'licenseModel', + 'cpu_core_count': 'cpuCoreCount', + 'is_auto_scaling_enabled': 'isAutoScalingEnabled', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags', + 'locks': 'locks', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_sub_state': 'lifecycleSubState', + 'lifecycle_details': 'lifecycleDetails', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'process_options': 'processOptions', + 'time_last_recorded': 'timeLastRecorded' + } + + self._recipe_type = None + self._id = None + self._display_name = None + self._description = None + self._compartment_id = None + self._source_connection_details = None + self._target_connection_details = None + self._freeform_tags = None + self._license_model = None + self._cpu_core_count = None + self._is_auto_scaling_enabled = None + self._defined_tags = None + self._system_tags = None + self._locks = None + self._lifecycle_state = None + self._lifecycle_sub_state = None + self._lifecycle_details = None + self._time_created = None + self._time_updated = None + self._process_options = None + self._time_last_recorded = None + self._recipe_type = 'ZERO_ETL' + + @property + def process_options(self): + """ + **[Required]** Gets the process_options of this ZeroEtlPipelineSummary. + + :return: The process_options of this ZeroEtlPipelineSummary. + :rtype: oci.golden_gate.models.ProcessOptions + """ + return self._process_options + + @process_options.setter + def process_options(self, process_options): + """ + Sets the process_options of this ZeroEtlPipelineSummary. + + :param process_options: The process_options of this ZeroEtlPipelineSummary. + :type: oci.golden_gate.models.ProcessOptions + """ + self._process_options = process_options + + @property + def time_last_recorded(self): + """ + Gets the time_last_recorded of this ZeroEtlPipelineSummary. + When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by + `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_last_recorded of this ZeroEtlPipelineSummary. + :rtype: datetime + """ + return self._time_last_recorded + + @time_last_recorded.setter + def time_last_recorded(self, time_last_recorded): + """ + Sets the time_last_recorded of this ZeroEtlPipelineSummary. + When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by + `RFC3339`__, such as `2024-07-25T21:10:29.600Z`. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_last_recorded: The time_last_recorded of this ZeroEtlPipelineSummary. + :type: datetime + """ + self._time_last_recorded = time_last_recorded + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/retry/__init__.py b/src/oci/retry/__init__.py index eebb224862..03b9fd3bfd 100644 --- a/src/oci/retry/__init__.py +++ b/src/oci/retry/__init__.py @@ -22,7 +22,6 @@ # * Retries on the following exception types:- # # - timeouts and connection errors -# - HTTP 409/IncorrectState, 429s (throttles) # - Any HTTP 5xx except 501 DEFAULT_FEDERATION_CLIENT_RETRY_STRATEGY = RetryStrategyBuilder() \ .add_max_attempts(max_attempts=3) \ diff --git a/src/oci/stack_monitoring/models/__init__.py b/src/oci/stack_monitoring/models/__init__.py index 653aa2b8f9..88f4595ab1 100644 --- a/src/oci/stack_monitoring/models/__init__.py +++ b/src/oci/stack_monitoring/models/__init__.py @@ -58,6 +58,9 @@ from .encrypted_credentials import EncryptedCredentials from .evaluate_baselineable_metric_details import EvaluateBaselineableMetricDetails from .evaluate_baselineable_metric_result import EvaluateBaselineableMetricResult +from .http_query_properties import HttpQueryProperties +from .http_script_file_details import HttpScriptFileDetails +from .http_update_query_properties import HttpUpdateQueryProperties from .import_oci_telemetry_resources_task_details import ImportOciTelemetryResourcesTaskDetails from .jmx_query_properties import JmxQueryProperties from .jmx_update_query_properties import JmxUpdateQueryProperties @@ -130,6 +133,7 @@ from .update_auto_promote_config_details import UpdateAutoPromoteConfigDetails from .update_baselineable_metric_details import UpdateBaselineableMetricDetails from .update_config_details import UpdateConfigDetails +from .update_http_script_file_details import UpdateHttpScriptFileDetails from .update_license_auto_assign_config_details import UpdateLicenseAutoAssignConfigDetails from .update_license_enterprise_extensibility_config_details import UpdateLicenseEnterpriseExtensibilityConfigDetails from .update_maintenance_window_details import UpdateMaintenanceWindowDetails @@ -201,6 +205,9 @@ "EncryptedCredentials": EncryptedCredentials, "EvaluateBaselineableMetricDetails": EvaluateBaselineableMetricDetails, "EvaluateBaselineableMetricResult": EvaluateBaselineableMetricResult, + "HttpQueryProperties": HttpQueryProperties, + "HttpScriptFileDetails": HttpScriptFileDetails, + "HttpUpdateQueryProperties": HttpUpdateQueryProperties, "ImportOciTelemetryResourcesTaskDetails": ImportOciTelemetryResourcesTaskDetails, "JmxQueryProperties": JmxQueryProperties, "JmxUpdateQueryProperties": JmxUpdateQueryProperties, @@ -273,6 +280,7 @@ "UpdateAutoPromoteConfigDetails": UpdateAutoPromoteConfigDetails, "UpdateBaselineableMetricDetails": UpdateBaselineableMetricDetails, "UpdateConfigDetails": UpdateConfigDetails, + "UpdateHttpScriptFileDetails": UpdateHttpScriptFileDetails, "UpdateLicenseAutoAssignConfigDetails": UpdateLicenseAutoAssignConfigDetails, "UpdateLicenseEnterpriseExtensibilityConfigDetails": UpdateLicenseEnterpriseExtensibilityConfigDetails, "UpdateMaintenanceWindowDetails": UpdateMaintenanceWindowDetails, diff --git a/src/oci/stack_monitoring/models/http_query_properties.py b/src/oci/stack_monitoring/models/http_query_properties.py new file mode 100644 index 0000000000..b3e6054709 --- /dev/null +++ b/src/oci/stack_monitoring/models/http_query_properties.py @@ -0,0 +1,212 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .metric_extension_query_properties import MetricExtensionQueryProperties +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HttpQueryProperties(MetricExtensionQueryProperties): + """ + Query properties applicable to HTTP type of collection method + """ + + #: A constant which can be used with the response_content_type property of a HttpQueryProperties. + #: This constant has a value of "TEXT_PLAIN" + RESPONSE_CONTENT_TYPE_TEXT_PLAIN = "TEXT_PLAIN" + + #: A constant which can be used with the response_content_type property of a HttpQueryProperties. + #: This constant has a value of "TEXT_HTML" + RESPONSE_CONTENT_TYPE_TEXT_HTML = "TEXT_HTML" + + #: A constant which can be used with the response_content_type property of a HttpQueryProperties. + #: This constant has a value of "APPLICATION_JSON" + RESPONSE_CONTENT_TYPE_APPLICATION_JSON = "APPLICATION_JSON" + + #: A constant which can be used with the response_content_type property of a HttpQueryProperties. + #: This constant has a value of "APPLICATION_XML" + RESPONSE_CONTENT_TYPE_APPLICATION_XML = "APPLICATION_XML" + + #: A constant which can be used with the protocol_type property of a HttpQueryProperties. + #: This constant has a value of "HTTP" + PROTOCOL_TYPE_HTTP = "HTTP" + + #: A constant which can be used with the protocol_type property of a HttpQueryProperties. + #: This constant has a value of "HTTPS" + PROTOCOL_TYPE_HTTPS = "HTTPS" + + def __init__(self, **kwargs): + """ + Initializes a new HttpQueryProperties object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.HttpQueryProperties.collection_method` attribute + of this class is ``HTTP`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param collection_method: + The value to assign to the collection_method property of this HttpQueryProperties. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type collection_method: str + + :param url: + The value to assign to the url property of this HttpQueryProperties. + :type url: str + + :param response_content_type: + The value to assign to the response_content_type property of this HttpQueryProperties. + Allowed values for this property are: "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type response_content_type: str + + :param protocol_type: + The value to assign to the protocol_type property of this HttpQueryProperties. + Allowed values for this property are: "HTTP", "HTTPS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type protocol_type: str + + :param script_details: + The value to assign to the script_details property of this HttpQueryProperties. + :type script_details: oci.stack_monitoring.models.HttpScriptFileDetails + + """ + self.swagger_types = { + 'collection_method': 'str', + 'url': 'str', + 'response_content_type': 'str', + 'protocol_type': 'str', + 'script_details': 'HttpScriptFileDetails' + } + + self.attribute_map = { + 'collection_method': 'collectionMethod', + 'url': 'url', + 'response_content_type': 'responseContentType', + 'protocol_type': 'protocolType', + 'script_details': 'scriptDetails' + } + + self._collection_method = None + self._url = None + self._response_content_type = None + self._protocol_type = None + self._script_details = None + self._collection_method = 'HTTP' + + @property + def url(self): + """ + **[Required]** Gets the url of this HttpQueryProperties. + Http(s) end point URL + + + :return: The url of this HttpQueryProperties. + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """ + Sets the url of this HttpQueryProperties. + Http(s) end point URL + + + :param url: The url of this HttpQueryProperties. + :type: str + """ + self._url = url + + @property + def response_content_type(self): + """ + **[Required]** Gets the response_content_type of this HttpQueryProperties. + Type of content response given by the http(s) URL + + Allowed values for this property are: "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The response_content_type of this HttpQueryProperties. + :rtype: str + """ + return self._response_content_type + + @response_content_type.setter + def response_content_type(self, response_content_type): + """ + Sets the response_content_type of this HttpQueryProperties. + Type of content response given by the http(s) URL + + + :param response_content_type: The response_content_type of this HttpQueryProperties. + :type: str + """ + allowed_values = ["TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML"] + if not value_allowed_none_or_none_sentinel(response_content_type, allowed_values): + response_content_type = 'UNKNOWN_ENUM_VALUE' + self._response_content_type = response_content_type + + @property + def protocol_type(self): + """ + Gets the protocol_type of this HttpQueryProperties. + Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL + + Allowed values for this property are: "HTTP", "HTTPS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The protocol_type of this HttpQueryProperties. + :rtype: str + """ + return self._protocol_type + + @protocol_type.setter + def protocol_type(self, protocol_type): + """ + Sets the protocol_type of this HttpQueryProperties. + Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL + + + :param protocol_type: The protocol_type of this HttpQueryProperties. + :type: str + """ + allowed_values = ["HTTP", "HTTPS"] + if not value_allowed_none_or_none_sentinel(protocol_type, allowed_values): + protocol_type = 'UNKNOWN_ENUM_VALUE' + self._protocol_type = protocol_type + + @property + def script_details(self): + """ + **[Required]** Gets the script_details of this HttpQueryProperties. + + :return: The script_details of this HttpQueryProperties. + :rtype: oci.stack_monitoring.models.HttpScriptFileDetails + """ + return self._script_details + + @script_details.setter + def script_details(self, script_details): + """ + Sets the script_details of this HttpQueryProperties. + + :param script_details: The script_details of this HttpQueryProperties. + :type: oci.stack_monitoring.models.HttpScriptFileDetails + """ + self._script_details = script_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/stack_monitoring/models/http_script_file_details.py b/src/oci/stack_monitoring/models/http_script_file_details.py new file mode 100644 index 0000000000..828d5d3e96 --- /dev/null +++ b/src/oci/stack_monitoring/models/http_script_file_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HttpScriptFileDetails(object): + """ + JavaScript file details which is used to convert http(s) response into metric data + """ + + def __init__(self, **kwargs): + """ + Initializes a new HttpScriptFileDetails 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 HttpScriptFileDetails. + :type name: str + + :param content: + The value to assign to the content property of this HttpScriptFileDetails. + :type content: str + + """ + self.swagger_types = { + 'name': 'str', + 'content': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'content': 'content' + } + + self._name = None + self._content = None + + @property + def name(self): + """ + **[Required]** Gets the name of this HttpScriptFileDetails. + Name of the script file + + + :return: The name of this HttpScriptFileDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HttpScriptFileDetails. + Name of the script file + + + :param name: The name of this HttpScriptFileDetails. + :type: str + """ + self._name = name + + @property + def content(self): + """ + **[Required]** Gets the content of this HttpScriptFileDetails. + Content of the JavaScript file as base64 encoded string + + + :return: The content of this HttpScriptFileDetails. + :rtype: str + """ + return self._content + + @content.setter + def content(self, content): + """ + Sets the content of this HttpScriptFileDetails. + Content of the JavaScript file as base64 encoded string + + + :param content: The content of this HttpScriptFileDetails. + :type: str + """ + self._content = content + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/models/http_update_query_properties.py b/src/oci/stack_monitoring/models/http_update_query_properties.py new file mode 100644 index 0000000000..f621c318b9 --- /dev/null +++ b/src/oci/stack_monitoring/models/http_update_query_properties.py @@ -0,0 +1,211 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + +from .metric_extension_update_query_properties import MetricExtensionUpdateQueryProperties +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HttpUpdateQueryProperties(MetricExtensionUpdateQueryProperties): + """ + Query properties applicable to HTTP type of collection method + """ + + #: A constant which can be used with the response_content_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "TEXT_PLAIN" + RESPONSE_CONTENT_TYPE_TEXT_PLAIN = "TEXT_PLAIN" + + #: A constant which can be used with the response_content_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "TEXT_HTML" + RESPONSE_CONTENT_TYPE_TEXT_HTML = "TEXT_HTML" + + #: A constant which can be used with the response_content_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "APPLICATION_JSON" + RESPONSE_CONTENT_TYPE_APPLICATION_JSON = "APPLICATION_JSON" + + #: A constant which can be used with the response_content_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "APPLICATION_XML" + RESPONSE_CONTENT_TYPE_APPLICATION_XML = "APPLICATION_XML" + + #: A constant which can be used with the protocol_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "HTTP" + PROTOCOL_TYPE_HTTP = "HTTP" + + #: A constant which can be used with the protocol_type property of a HttpUpdateQueryProperties. + #: This constant has a value of "HTTPS" + PROTOCOL_TYPE_HTTPS = "HTTPS" + + def __init__(self, **kwargs): + """ + Initializes a new HttpUpdateQueryProperties object with values from keyword arguments. The default value of the :py:attr:`~oci.stack_monitoring.models.HttpUpdateQueryProperties.collection_method` attribute + of this class is ``HTTP`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param collection_method: + The value to assign to the collection_method property of this HttpUpdateQueryProperties. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" + :type collection_method: str + + :param url: + The value to assign to the url property of this HttpUpdateQueryProperties. + :type url: str + + :param response_content_type: + The value to assign to the response_content_type property of this HttpUpdateQueryProperties. + Allowed values for this property are: "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML" + :type response_content_type: str + + :param protocol_type: + The value to assign to the protocol_type property of this HttpUpdateQueryProperties. + Allowed values for this property are: "HTTP", "HTTPS" + :type protocol_type: str + + :param script_details: + The value to assign to the script_details property of this HttpUpdateQueryProperties. + :type script_details: oci.stack_monitoring.models.UpdateHttpScriptFileDetails + + """ + self.swagger_types = { + 'collection_method': 'str', + 'url': 'str', + 'response_content_type': 'str', + 'protocol_type': 'str', + 'script_details': 'UpdateHttpScriptFileDetails' + } + + self.attribute_map = { + 'collection_method': 'collectionMethod', + 'url': 'url', + 'response_content_type': 'responseContentType', + 'protocol_type': 'protocolType', + 'script_details': 'scriptDetails' + } + + self._collection_method = None + self._url = None + self._response_content_type = None + self._protocol_type = None + self._script_details = None + self._collection_method = 'HTTP' + + @property + def url(self): + """ + Gets the url of this HttpUpdateQueryProperties. + Http(s) end point URL + + + :return: The url of this HttpUpdateQueryProperties. + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """ + Sets the url of this HttpUpdateQueryProperties. + Http(s) end point URL + + + :param url: The url of this HttpUpdateQueryProperties. + :type: str + """ + self._url = url + + @property + def response_content_type(self): + """ + Gets the response_content_type of this HttpUpdateQueryProperties. + Type of content response given by the http(s) URL + + Allowed values for this property are: "TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML" + + + :return: The response_content_type of this HttpUpdateQueryProperties. + :rtype: str + """ + return self._response_content_type + + @response_content_type.setter + def response_content_type(self, response_content_type): + """ + Sets the response_content_type of this HttpUpdateQueryProperties. + Type of content response given by the http(s) URL + + + :param response_content_type: The response_content_type of this HttpUpdateQueryProperties. + :type: str + """ + allowed_values = ["TEXT_PLAIN", "TEXT_HTML", "APPLICATION_JSON", "APPLICATION_XML"] + if not value_allowed_none_or_none_sentinel(response_content_type, allowed_values): + raise ValueError( + f"Invalid value for `response_content_type`, must be None or one of {allowed_values}" + ) + self._response_content_type = response_content_type + + @property + def protocol_type(self): + """ + Gets the protocol_type of this HttpUpdateQueryProperties. + Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL + + Allowed values for this property are: "HTTP", "HTTPS" + + + :return: The protocol_type of this HttpUpdateQueryProperties. + :rtype: str + """ + return self._protocol_type + + @protocol_type.setter + def protocol_type(self, protocol_type): + """ + Sets the protocol_type of this HttpUpdateQueryProperties. + Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL + + + :param protocol_type: The protocol_type of this HttpUpdateQueryProperties. + :type: str + """ + allowed_values = ["HTTP", "HTTPS"] + if not value_allowed_none_or_none_sentinel(protocol_type, allowed_values): + raise ValueError( + f"Invalid value for `protocol_type`, must be None or one of {allowed_values}" + ) + self._protocol_type = protocol_type + + @property + def script_details(self): + """ + Gets the script_details of this HttpUpdateQueryProperties. + + :return: The script_details of this HttpUpdateQueryProperties. + :rtype: oci.stack_monitoring.models.UpdateHttpScriptFileDetails + """ + return self._script_details + + @script_details.setter + def script_details(self, script_details): + """ + Sets the script_details of this HttpUpdateQueryProperties. + + :param script_details: The script_details of this HttpUpdateQueryProperties. + :type: oci.stack_monitoring.models.UpdateHttpScriptFileDetails + """ + self._script_details = script_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/stack_monitoring/models/jmx_query_properties.py b/src/oci/stack_monitoring/models/jmx_query_properties.py index 9842b5a333..c4cc7cee49 100644 --- a/src/oci/stack_monitoring/models/jmx_query_properties.py +++ b/src/oci/stack_monitoring/models/jmx_query_properties.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this JmxQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str :param managed_bean_query: diff --git a/src/oci/stack_monitoring/models/jmx_update_query_properties.py b/src/oci/stack_monitoring/models/jmx_update_query_properties.py index c6e653a400..6485161b60 100644 --- a/src/oci/stack_monitoring/models/jmx_update_query_properties.py +++ b/src/oci/stack_monitoring/models/jmx_update_query_properties.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this JmxUpdateQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str :param managed_bean_query: diff --git a/src/oci/stack_monitoring/models/metric_extension_query_properties.py b/src/oci/stack_monitoring/models/metric_extension_query_properties.py index 06d4a10434..4355b4a53c 100644 --- a/src/oci/stack_monitoring/models/metric_extension_query_properties.py +++ b/src/oci/stack_monitoring/models/metric_extension_query_properties.py @@ -27,6 +27,10 @@ class MetricExtensionQueryProperties(object): #: This constant has a value of "JMX" COLLECTION_METHOD_JMX = "JMX" + #: A constant which can be used with the collection_method property of a MetricExtensionQueryProperties. + #: This constant has a value of "HTTP" + COLLECTION_METHOD_HTTP = "HTTP" + def __init__(self, **kwargs): """ Initializes a new MetricExtensionQueryProperties object with values from keyword arguments. This class has the following subclasses and if you are using this class as input @@ -35,12 +39,13 @@ def __init__(self, **kwargs): * :class:`~oci.stack_monitoring.models.OsCommandQueryProperties` * :class:`~oci.stack_monitoring.models.SqlQueryProperties` * :class:`~oci.stack_monitoring.models.JmxQueryProperties` + * :class:`~oci.stack_monitoring.models.HttpQueryProperties` The following keyword arguments are supported (corresponding to the getters/setters of this class): :param collection_method: The value to assign to the collection_method property of this MetricExtensionQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type collection_method: str @@ -71,6 +76,9 @@ def get_subtype(object_dictionary): if type == 'JMX': return 'JmxQueryProperties' + + if type == 'HTTP': + return 'HttpQueryProperties' else: return 'MetricExtensionQueryProperties' @@ -80,7 +88,7 @@ def collection_method(self): **[Required]** Gets the collection_method of this MetricExtensionQueryProperties. Type of possible collection methods. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -99,7 +107,7 @@ def collection_method(self, collection_method): :param collection_method: The collection_method of this MetricExtensionQueryProperties. :type: str """ - allowed_values = ["OS_COMMAND", "SQL", "JMX"] + allowed_values = ["OS_COMMAND", "SQL", "JMX", "HTTP"] if not value_allowed_none_or_none_sentinel(collection_method, allowed_values): collection_method = 'UNKNOWN_ENUM_VALUE' self._collection_method = collection_method diff --git a/src/oci/stack_monitoring/models/metric_extension_summary.py b/src/oci/stack_monitoring/models/metric_extension_summary.py index 8e99a5c6fd..60c45a49de 100644 --- a/src/oci/stack_monitoring/models/metric_extension_summary.py +++ b/src/oci/stack_monitoring/models/metric_extension_summary.py @@ -43,6 +43,10 @@ class MetricExtensionSummary(object): #: This constant has a value of "JMX" COLLECTION_METHOD_JMX = "JMX" + #: A constant which can be used with the collection_method property of a MetricExtensionSummary. + #: This constant has a value of "HTTP" + COLLECTION_METHOD_HTTP = "HTTP" + def __init__(self, **kwargs): """ Initializes a new MetricExtensionSummary object with values from keyword arguments. @@ -94,7 +98,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this MetricExtensionSummary. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type collection_method: str @@ -419,7 +423,7 @@ def collection_method(self): Gets the collection_method of this MetricExtensionSummary. Type of possible collection methods. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -438,7 +442,7 @@ def collection_method(self, collection_method): :param collection_method: The collection_method of this MetricExtensionSummary. :type: str """ - allowed_values = ["OS_COMMAND", "SQL", "JMX"] + allowed_values = ["OS_COMMAND", "SQL", "JMX", "HTTP"] if not value_allowed_none_or_none_sentinel(collection_method, allowed_values): collection_method = 'UNKNOWN_ENUM_VALUE' self._collection_method = collection_method diff --git a/src/oci/stack_monitoring/models/metric_extension_update_query_properties.py b/src/oci/stack_monitoring/models/metric_extension_update_query_properties.py index 6fc1504590..a290ed370b 100644 --- a/src/oci/stack_monitoring/models/metric_extension_update_query_properties.py +++ b/src/oci/stack_monitoring/models/metric_extension_update_query_properties.py @@ -27,6 +27,10 @@ class MetricExtensionUpdateQueryProperties(object): #: This constant has a value of "JMX" COLLECTION_METHOD_JMX = "JMX" + #: A constant which can be used with the collection_method property of a MetricExtensionUpdateQueryProperties. + #: This constant has a value of "HTTP" + COLLECTION_METHOD_HTTP = "HTTP" + def __init__(self, **kwargs): """ Initializes a new MetricExtensionUpdateQueryProperties object with values from keyword arguments. This class has the following subclasses and if you are using this class as input @@ -35,12 +39,13 @@ def __init__(self, **kwargs): * :class:`~oci.stack_monitoring.models.SqlUpdateQueryProperties` * :class:`~oci.stack_monitoring.models.JmxUpdateQueryProperties` * :class:`~oci.stack_monitoring.models.OsCommandUpdateQueryProperties` + * :class:`~oci.stack_monitoring.models.HttpUpdateQueryProperties` The following keyword arguments are supported (corresponding to the getters/setters of this class): :param collection_method: The value to assign to the collection_method property of this MetricExtensionUpdateQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str """ @@ -70,6 +75,9 @@ def get_subtype(object_dictionary): if type == 'OS_COMMAND': return 'OsCommandUpdateQueryProperties' + + if type == 'HTTP': + return 'HttpUpdateQueryProperties' else: return 'MetricExtensionUpdateQueryProperties' @@ -79,7 +87,7 @@ def collection_method(self): **[Required]** Gets the collection_method of this MetricExtensionUpdateQueryProperties. Type of possible collection methods. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :return: The collection_method of this MetricExtensionUpdateQueryProperties. @@ -97,7 +105,7 @@ def collection_method(self, collection_method): :param collection_method: The collection_method of this MetricExtensionUpdateQueryProperties. :type: str """ - allowed_values = ["OS_COMMAND", "SQL", "JMX"] + allowed_values = ["OS_COMMAND", "SQL", "JMX", "HTTP"] if not value_allowed_none_or_none_sentinel(collection_method, allowed_values): raise ValueError( f"Invalid value for `collection_method`, must be None or one of {allowed_values}" diff --git a/src/oci/stack_monitoring/models/os_command_query_properties.py b/src/oci/stack_monitoring/models/os_command_query_properties.py index cc37816748..acae61da26 100644 --- a/src/oci/stack_monitoring/models/os_command_query_properties.py +++ b/src/oci/stack_monitoring/models/os_command_query_properties.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this OsCommandQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str :param command: diff --git a/src/oci/stack_monitoring/models/os_command_update_query_properties.py b/src/oci/stack_monitoring/models/os_command_update_query_properties.py index ea6ab2d603..ceb9ac6d75 100644 --- a/src/oci/stack_monitoring/models/os_command_update_query_properties.py +++ b/src/oci/stack_monitoring/models/os_command_update_query_properties.py @@ -23,7 +23,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this OsCommandUpdateQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str :param command: diff --git a/src/oci/stack_monitoring/models/script_file_details.py b/src/oci/stack_monitoring/models/script_file_details.py index 7101c3588f..9d723f4afb 100644 --- a/src/oci/stack_monitoring/models/script_file_details.py +++ b/src/oci/stack_monitoring/models/script_file_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ScriptFileDetails(object): """ - Script details applicable to any OS Command based Metric Extension which needs to run a script to collect data + Script details applicable to any OS Command based Metric Extension which needs to run a script to collect data. For removing it during update, set its \"content\" property to an empty string. In that case, \"name\" property value is ignored. """ def __init__(self, **kwargs): diff --git a/src/oci/stack_monitoring/models/sql_out_param_details.py b/src/oci/stack_monitoring/models/sql_out_param_details.py index 433376cf8e..5b4846d272 100644 --- a/src/oci/stack_monitoring/models/sql_out_param_details.py +++ b/src/oci/stack_monitoring/models/sql_out_param_details.py @@ -23,6 +23,10 @@ class SqlOutParamDetails(object): #: This constant has a value of "ARRAY" OUT_PARAM_TYPE_ARRAY = "ARRAY" + #: A constant which can be used with the out_param_type property of a SqlOutParamDetails. + #: This constant has a value of "NO_OUT_PARAM" + OUT_PARAM_TYPE_NO_OUT_PARAM = "NO_OUT_PARAM" + def __init__(self, **kwargs): """ Initializes a new SqlOutParamDetails object with values from keyword arguments. @@ -34,29 +38,36 @@ def __init__(self, **kwargs): :param out_param_type: The value to assign to the out_param_type property of this SqlOutParamDetails. - Allowed values for this property are: "SQL_CURSOR", "ARRAY", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "SQL_CURSOR", "ARRAY", "NO_OUT_PARAM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type out_param_type: str + :param out_param_name: + The value to assign to the out_param_name property of this SqlOutParamDetails. + :type out_param_name: str + """ self.swagger_types = { 'out_param_position': 'int', - 'out_param_type': 'str' + 'out_param_type': 'str', + 'out_param_name': 'str' } self.attribute_map = { 'out_param_position': 'outParamPosition', - 'out_param_type': 'outParamType' + 'out_param_type': 'outParamType', + 'out_param_name': 'outParamName' } self._out_param_position = None self._out_param_type = None + self._out_param_name = None @property def out_param_position(self): """ **[Required]** Gets the out_param_position of this SqlOutParamDetails. - Position of PL/SQL procedure OUT parameter + Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if \"outParamType\" is set to NO_OUT_PARAM value. :return: The out_param_position of this SqlOutParamDetails. @@ -68,7 +79,7 @@ def out_param_position(self): def out_param_position(self, out_param_position): """ Sets the out_param_position of this SqlOutParamDetails. - Position of PL/SQL procedure OUT parameter + Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if \"outParamType\" is set to NO_OUT_PARAM value. :param out_param_position: The out_param_position of this SqlOutParamDetails. @@ -80,9 +91,9 @@ def out_param_position(self, out_param_position): def out_param_type(self): """ **[Required]** Gets the out_param_type of this SqlOutParamDetails. - SQL Type of PL/SQL procedure OUT parameter + SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of \"outParamPosition\" will be ignored. - Allowed values for this property are: "SQL_CURSOR", "ARRAY", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "SQL_CURSOR", "ARRAY", "NO_OUT_PARAM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -95,17 +106,41 @@ def out_param_type(self): def out_param_type(self, out_param_type): """ Sets the out_param_type of this SqlOutParamDetails. - SQL Type of PL/SQL procedure OUT parameter + SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of \"outParamPosition\" will be ignored. :param out_param_type: The out_param_type of this SqlOutParamDetails. :type: str """ - allowed_values = ["SQL_CURSOR", "ARRAY"] + allowed_values = ["SQL_CURSOR", "ARRAY", "NO_OUT_PARAM"] if not value_allowed_none_or_none_sentinel(out_param_type, allowed_values): out_param_type = 'UNKNOWN_ENUM_VALUE' self._out_param_type = out_param_type + @property + def out_param_name(self): + """ + Gets the out_param_name of this SqlOutParamDetails. + Name of the Out Parameter + + + :return: The out_param_name of this SqlOutParamDetails. + :rtype: str + """ + return self._out_param_name + + @out_param_name.setter + def out_param_name(self, out_param_name): + """ + Sets the out_param_name of this SqlOutParamDetails. + Name of the Out Parameter + + + :param out_param_name: The out_param_name of this SqlOutParamDetails. + :type: str + """ + self._out_param_name = out_param_name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/stack_monitoring/models/sql_query_properties.py b/src/oci/stack_monitoring/models/sql_query_properties.py index d924500062..1e6468d2b2 100644 --- a/src/oci/stack_monitoring/models/sql_query_properties.py +++ b/src/oci/stack_monitoring/models/sql_query_properties.py @@ -31,7 +31,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this SqlQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type collection_method: str diff --git a/src/oci/stack_monitoring/models/sql_update_query_properties.py b/src/oci/stack_monitoring/models/sql_update_query_properties.py index 59be85b4b1..b2a73b4fec 100644 --- a/src/oci/stack_monitoring/models/sql_update_query_properties.py +++ b/src/oci/stack_monitoring/models/sql_update_query_properties.py @@ -31,7 +31,7 @@ def __init__(self, **kwargs): :param collection_method: The value to assign to the collection_method property of this SqlUpdateQueryProperties. - Allowed values for this property are: "OS_COMMAND", "SQL", "JMX" + Allowed values for this property are: "OS_COMMAND", "SQL", "JMX", "HTTP" :type collection_method: str :param sql_type: diff --git a/src/oci/stack_monitoring/models/update_http_script_file_details.py b/src/oci/stack_monitoring/models/update_http_script_file_details.py new file mode 100644 index 0000000000..38b853bb79 --- /dev/null +++ b/src/oci/stack_monitoring/models/update_http_script_file_details.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210330 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateHttpScriptFileDetails(object): + """ + JavaScript file details which is used to convert http(s) response into metric data + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateHttpScriptFileDetails 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 UpdateHttpScriptFileDetails. + :type name: str + + :param content: + The value to assign to the content property of this UpdateHttpScriptFileDetails. + :type content: str + + """ + self.swagger_types = { + 'name': 'str', + 'content': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'content': 'content' + } + + self._name = None + self._content = None + + @property + def name(self): + """ + Gets the name of this UpdateHttpScriptFileDetails. + Name of the script file + + + :return: The name of this UpdateHttpScriptFileDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateHttpScriptFileDetails. + Name of the script file + + + :param name: The name of this UpdateHttpScriptFileDetails. + :type: str + """ + self._name = name + + @property + def content(self): + """ + Gets the content of this UpdateHttpScriptFileDetails. + Content of the JavaScript file as base64 encoded string + + + :return: The content of this UpdateHttpScriptFileDetails. + :rtype: str + """ + return self._content + + @content.setter + def content(self, content): + """ + Sets the content of this UpdateHttpScriptFileDetails. + Content of the JavaScript file as base64 encoded string + + + :param content: The content of this UpdateHttpScriptFileDetails. + :type: str + """ + self._content = content + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/stack_monitoring/stack_monitoring_client.py b/src/oci/stack_monitoring/stack_monitoring_client.py index 66b443928e..daf5a16f00 100644 --- a/src/oci/stack_monitoring/stack_monitoring_client.py +++ b/src/oci/stack_monitoring/stack_monitoring_client.py @@ -5159,14 +5159,11 @@ def list_maintenance_windows(self, compartment_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_metric_extensions(self, compartment_id, **kwargs): + def list_metric_extensions(self, **kwargs): """ Returns a list of metric extensions - :param str compartment_id: (required) - The ID of the compartment in which data is listed. - :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 @@ -5185,13 +5182,16 @@ def list_metric_extensions(self, compartment_id, **kwargs): The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending. - Allowed values are: "NAME", "TIME_CREATED" + Allowed values are: "NAME", "TIME_CREATED", "ENABLED_ON_RESOURCE_COUNT" :param str sort_order: (optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: "ASC", "DESC" + :param str compartment_id: (optional) + The ID of the compartment in which data is listed. + :param str resource_type: (optional) A filter to return resources based on resource type. @@ -5211,6 +5211,9 @@ def list_metric_extensions(self, compartment_id, **kwargs): :param str enabled_on_resource_id: (optional) A filter to return metric extensions based on input resource Id on which metric extension is enabled + :param str metric_extension_id: (optional) + Identifier for the metric extension + :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. @@ -5234,7 +5237,7 @@ def list_metric_extensions(self, compartment_id, **kwargs): Click `here `__ to see an example of how to use list_metric_extensions API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['compartmentId'] + required_arguments = [] resource_path = "/metricExtensions" method = "GET" operation_name = "list_metric_extensions" @@ -5248,11 +5251,13 @@ def list_metric_extensions(self, compartment_id, **kwargs): "page", "sort_by", "sort_order", + "compartment_id", "resource_type", "name", "status", "lifecycle_state", "enabled_on_resource_id", + "metric_extension_id", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -5261,7 +5266,7 @@ def list_metric_extensions(self, compartment_id, **kwargs): f"list_metric_extensions got unknown kwargs: {extra_kwargs!r}") if 'sort_by' in kwargs: - sort_by_allowed_values = ["NAME", "TIME_CREATED"] + sort_by_allowed_values = ["NAME", "TIME_CREATED", "ENABLED_ON_RESOURCE_COUNT"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }" @@ -5293,12 +5298,13 @@ def list_metric_extensions(self, compartment_id, **kwargs): "page": kwargs.get("page", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), - "compartmentId": compartment_id, + "compartmentId": kwargs.get("compartment_id", missing), "resourceType": kwargs.get("resource_type", missing), "name": kwargs.get("name", missing), "status": kwargs.get("status", missing), "lifecycleState": kwargs.get("lifecycle_state", missing), - "enabledOnResourceId": kwargs.get("enabled_on_resource_id", missing) + "enabledOnResourceId": kwargs.get("enabled_on_resource_id", missing), + "metricExtensionId": kwargs.get("metric_extension_id", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} diff --git a/src/oci/version.py b/src/oci/version.py index b44fc3fa92..1084349b42 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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.140.0" +__version__ = "2.141.0"