diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 54ebd706d8..1428180bd9 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,24 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.58.0 - 2022-02-22 +==================== + +Added +----- +* Support for the Data Connectivity Management service +* Support for the AI Speech service +* Support for disabling crash recovery in the MySQL Database service +* Support for detector recipes of type "threat", new detector rule of type "rogue user", and sightings operations in the Cloud Guard service +* Support for more VM shape configurations when listing shapes in the Compute service +* Support for customer-managed encryption keys in the Analytics Cloud service +* Support for FastConnect device information in the Networking service + +Breaking +-------- +* Support for retries enabled by default on all operations in the Application Performance Monitoring control plane service + ==================== 2.57.0 - 2022-02-15 ==================== diff --git a/docs/api/ai_speech.rst b/docs/api/ai_speech.rst new file mode 100644 index 0000000000..923b7b0652 --- /dev/null +++ b/docs/api/ai_speech.rst @@ -0,0 +1,39 @@ +Ai Speech +========= + +.. autosummary:: + :toctree: ai_speech/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.ai_speech.AIServiceSpeechClient + oci.ai_speech.AIServiceSpeechClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: ai_speech/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.ai_speech.models.AudioFormatDetails + oci.ai_speech.models.ChangeTranscriptionJobCompartmentDetails + oci.ai_speech.models.CreateTranscriptionJobDetails + oci.ai_speech.models.InputLocation + oci.ai_speech.models.ObjectListFileInputLocation + oci.ai_speech.models.ObjectListInlineInputLocation + oci.ai_speech.models.ObjectLocation + oci.ai_speech.models.OutputLocation + oci.ai_speech.models.ProfanityTranscriptionFilter + oci.ai_speech.models.TranscriptionFilter + oci.ai_speech.models.TranscriptionJob + oci.ai_speech.models.TranscriptionJobCollection + oci.ai_speech.models.TranscriptionJobSummary + oci.ai_speech.models.TranscriptionModelDetails + oci.ai_speech.models.TranscriptionNormalization + oci.ai_speech.models.TranscriptionTask + oci.ai_speech.models.TranscriptionTaskCollection + oci.ai_speech.models.TranscriptionTaskSummary + oci.ai_speech.models.UpdateTranscriptionJobDetails diff --git a/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClient.rst b/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClient.rst new file mode 100644 index 0000000000..6074d0f0d5 --- /dev/null +++ b/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClient.rst @@ -0,0 +1,8 @@ +AIServiceSpeechClient +===================== + +.. currentmodule:: oci.ai_speech + +.. autoclass:: AIServiceSpeechClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClientCompositeOperations.rst b/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClientCompositeOperations.rst new file mode 100644 index 0000000000..c300484d43 --- /dev/null +++ b/docs/api/ai_speech/client/oci.ai_speech.AIServiceSpeechClientCompositeOperations.rst @@ -0,0 +1,8 @@ +AIServiceSpeechClientCompositeOperations +======================================== + +.. currentmodule:: oci.ai_speech + +.. autoclass:: AIServiceSpeechClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.AudioFormatDetails.rst b/docs/api/ai_speech/models/oci.ai_speech.models.AudioFormatDetails.rst new file mode 100644 index 0000000000..328a5edd2b --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.AudioFormatDetails.rst @@ -0,0 +1,11 @@ +AudioFormatDetails +================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: AudioFormatDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.ChangeTranscriptionJobCompartmentDetails.rst b/docs/api/ai_speech/models/oci.ai_speech.models.ChangeTranscriptionJobCompartmentDetails.rst new file mode 100644 index 0000000000..63e4bafc71 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.ChangeTranscriptionJobCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeTranscriptionJobCompartmentDetails +======================================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: ChangeTranscriptionJobCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.CreateTranscriptionJobDetails.rst b/docs/api/ai_speech/models/oci.ai_speech.models.CreateTranscriptionJobDetails.rst new file mode 100644 index 0000000000..143c1297b9 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.CreateTranscriptionJobDetails.rst @@ -0,0 +1,11 @@ +CreateTranscriptionJobDetails +============================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: CreateTranscriptionJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.InputLocation.rst b/docs/api/ai_speech/models/oci.ai_speech.models.InputLocation.rst new file mode 100644 index 0000000000..9967c761fd --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.InputLocation.rst @@ -0,0 +1,11 @@ +InputLocation +============= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: InputLocation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListFileInputLocation.rst b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListFileInputLocation.rst new file mode 100644 index 0000000000..ab7475c396 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListFileInputLocation.rst @@ -0,0 +1,11 @@ +ObjectListFileInputLocation +=========================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: ObjectListFileInputLocation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListInlineInputLocation.rst b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListInlineInputLocation.rst new file mode 100644 index 0000000000..2b0837b9ff --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectListInlineInputLocation.rst @@ -0,0 +1,11 @@ +ObjectListInlineInputLocation +============================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: ObjectListInlineInputLocation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.ObjectLocation.rst b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectLocation.rst new file mode 100644 index 0000000000..3473e32cb2 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.ObjectLocation.rst @@ -0,0 +1,11 @@ +ObjectLocation +============== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: ObjectLocation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.OutputLocation.rst b/docs/api/ai_speech/models/oci.ai_speech.models.OutputLocation.rst new file mode 100644 index 0000000000..e26471f73e --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.OutputLocation.rst @@ -0,0 +1,11 @@ +OutputLocation +============== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: OutputLocation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.ProfanityTranscriptionFilter.rst b/docs/api/ai_speech/models/oci.ai_speech.models.ProfanityTranscriptionFilter.rst new file mode 100644 index 0000000000..282ff79dcc --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.ProfanityTranscriptionFilter.rst @@ -0,0 +1,11 @@ +ProfanityTranscriptionFilter +============================ + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: ProfanityTranscriptionFilter + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionFilter.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionFilter.rst new file mode 100644 index 0000000000..3ab567bacd --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionFilter.rst @@ -0,0 +1,11 @@ +TranscriptionFilter +=================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionFilter + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJob.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJob.rst new file mode 100644 index 0000000000..f8ee511d13 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJob.rst @@ -0,0 +1,11 @@ +TranscriptionJob +================ + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionJob + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobCollection.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobCollection.rst new file mode 100644 index 0000000000..5f3654fc23 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobCollection.rst @@ -0,0 +1,11 @@ +TranscriptionJobCollection +========================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionJobCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobSummary.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobSummary.rst new file mode 100644 index 0000000000..024c6c631d --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionJobSummary.rst @@ -0,0 +1,11 @@ +TranscriptionJobSummary +======================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionJobSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionModelDetails.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionModelDetails.rst new file mode 100644 index 0000000000..8a5621b7c1 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionModelDetails.rst @@ -0,0 +1,11 @@ +TranscriptionModelDetails +========================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionModelDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionNormalization.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionNormalization.rst new file mode 100644 index 0000000000..08e65eaf56 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionNormalization.rst @@ -0,0 +1,11 @@ +TranscriptionNormalization +========================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionNormalization + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTask.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTask.rst new file mode 100644 index 0000000000..a8b2221028 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTask.rst @@ -0,0 +1,11 @@ +TranscriptionTask +================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionTask + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskCollection.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskCollection.rst new file mode 100644 index 0000000000..79cf603003 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskCollection.rst @@ -0,0 +1,11 @@ +TranscriptionTaskCollection +=========================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionTaskCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskSummary.rst b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskSummary.rst new file mode 100644 index 0000000000..06a8f24ddc --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.TranscriptionTaskSummary.rst @@ -0,0 +1,11 @@ +TranscriptionTaskSummary +======================== + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: TranscriptionTaskSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/ai_speech/models/oci.ai_speech.models.UpdateTranscriptionJobDetails.rst b/docs/api/ai_speech/models/oci.ai_speech.models.UpdateTranscriptionJobDetails.rst new file mode 100644 index 0000000000..45726a1bd7 --- /dev/null +++ b/docs/api/ai_speech/models/oci.ai_speech.models.UpdateTranscriptionJobDetails.rst @@ -0,0 +1,11 @@ +UpdateTranscriptionJobDetails +============================= + +.. currentmodule:: oci.ai_speech.models + +.. autoclass:: UpdateTranscriptionJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/analytics.rst b/docs/api/analytics.rst index b14420d666..153535fb9e 100644 --- a/docs/api/analytics.rst +++ b/docs/api/analytics.rst @@ -32,6 +32,7 @@ Analytics oci.analytics.models.PrivateSourceDnsZone oci.analytics.models.PublicEndpointDetails oci.analytics.models.ScaleAnalyticsInstanceDetails + oci.analytics.models.SetKmsKeyDetails oci.analytics.models.UpdateAnalyticsInstanceDetails oci.analytics.models.UpdatePrivateAccessChannelDetails oci.analytics.models.UpdateVanityUrlDetails diff --git a/docs/api/analytics/models/oci.analytics.models.SetKmsKeyDetails.rst b/docs/api/analytics/models/oci.analytics.models.SetKmsKeyDetails.rst new file mode 100644 index 0000000000..b8d1045d52 --- /dev/null +++ b/docs/api/analytics/models/oci.analytics.models.SetKmsKeyDetails.rst @@ -0,0 +1,11 @@ +SetKmsKeyDetails +================ + +.. currentmodule:: oci.analytics.models + +.. autoclass:: SetKmsKeyDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard.rst b/docs/api/cloud_guard.rst index 1d7b22c246..4abbdb309b 100644 --- a/docs/api/cloud_guard.rst +++ b/docs/api/cloud_guard.rst @@ -77,6 +77,8 @@ Cloud Guard oci.cloud_guard.models.ProblemAggregation oci.cloud_guard.models.ProblemAggregationCollection oci.cloud_guard.models.ProblemCollection + oci.cloud_guard.models.ProblemEndpointCollection + oci.cloud_guard.models.ProblemEndpointSummary oci.cloud_guard.models.ProblemHistoryCollection oci.cloud_guard.models.ProblemHistorySummary oci.cloud_guard.models.ProblemSummary @@ -84,6 +86,18 @@ Cloud Guard oci.cloud_guard.models.ProblemTrendAggregationCollection oci.cloud_guard.models.RecommendationSummary oci.cloud_guard.models.RecommendationSummaryCollection + oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails + oci.cloud_guard.models.ResourceProfile + oci.cloud_guard.models.ResourceProfileCollection + oci.cloud_guard.models.ResourceProfileEndpointCollection + oci.cloud_guard.models.ResourceProfileEndpointSummary + oci.cloud_guard.models.ResourceProfileImpactedResourceCollection + oci.cloud_guard.models.ResourceProfileImpactedResourceSummary + oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary + oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummaryCollection + oci.cloud_guard.models.ResourceProfileSummary + oci.cloud_guard.models.ResourceRiskScoreAggregation + oci.cloud_guard.models.ResourceRiskScoreAggregationCollection oci.cloud_guard.models.ResourceTypeCollection oci.cloud_guard.models.ResourceTypeSummary oci.cloud_guard.models.ResponderActivityCollection @@ -115,8 +129,18 @@ Cloud Guard oci.cloud_guard.models.SecurityScoreTrendAggregation oci.cloud_guard.models.SecurityScoreTrendAggregationCollection oci.cloud_guard.models.ServiceTypeSummary + oci.cloud_guard.models.Sighting + oci.cloud_guard.models.SightingCollection + oci.cloud_guard.models.SightingEndpointCollection + oci.cloud_guard.models.SightingEndpointSummary + oci.cloud_guard.models.SightingImpactedResourceCollection + oci.cloud_guard.models.SightingImpactedResourceSummary + oci.cloud_guard.models.SightingSummary + oci.cloud_guard.models.SightingType oci.cloud_guard.models.SimpleCondition oci.cloud_guard.models.SkipBulkResponderExecutionDetails + oci.cloud_guard.models.TacticCollection + oci.cloud_guard.models.TacticSummary oci.cloud_guard.models.Target oci.cloud_guard.models.TargetCollection oci.cloud_guard.models.TargetDetectorDetails @@ -136,6 +160,8 @@ Cloud Guard oci.cloud_guard.models.TargetResponderRecipeSummary oci.cloud_guard.models.TargetSelected oci.cloud_guard.models.TargetSummary + oci.cloud_guard.models.TechniqueCollection + oci.cloud_guard.models.TechniqueSummary oci.cloud_guard.models.TriggerResponderDetails oci.cloud_guard.models.UpdateBulkProblemStatusDetails oci.cloud_guard.models.UpdateConfigurationDetails diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointCollection.rst new file mode 100644 index 0000000000..149f3885c1 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointCollection.rst @@ -0,0 +1,11 @@ +ProblemEndpointCollection +========================= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ProblemEndpointCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointSummary.rst new file mode 100644 index 0000000000..c3c53cc4a7 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ProblemEndpointSummary.rst @@ -0,0 +1,11 @@ +ProblemEndpointSummary +====================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ProblemEndpointSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails.rst new file mode 100644 index 0000000000..92be2709aa --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails.rst @@ -0,0 +1,11 @@ +RequestSummarizedTrendResourceRiskScoresDetails +=============================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: RequestSummarizedTrendResourceRiskScoresDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfile.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfile.rst new file mode 100644 index 0000000000..97b71c97e5 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfile.rst @@ -0,0 +1,11 @@ +ResourceProfile +=============== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileCollection.rst new file mode 100644 index 0000000000..275fb15491 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileCollection.rst @@ -0,0 +1,11 @@ +ResourceProfileCollection +========================= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointCollection.rst new file mode 100644 index 0000000000..6761ddcfc3 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointCollection.rst @@ -0,0 +1,11 @@ +ResourceProfileEndpointCollection +================================= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileEndpointCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointSummary.rst new file mode 100644 index 0000000000..6adb733342 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileEndpointSummary.rst @@ -0,0 +1,11 @@ +ResourceProfileEndpointSummary +============================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileEndpointSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceCollection.rst new file mode 100644 index 0000000000..b46eb29023 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceCollection.rst @@ -0,0 +1,11 @@ +ResourceProfileImpactedResourceCollection +========================================= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileImpactedResourceCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceSummary.rst new file mode 100644 index 0000000000..32f5593919 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileImpactedResourceSummary.rst @@ -0,0 +1,11 @@ +ResourceProfileImpactedResourceSummary +====================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileImpactedResourceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary.rst new file mode 100644 index 0000000000..a8c9b228c0 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary.rst @@ -0,0 +1,11 @@ +ResourceProfileRiskScoreAggregationSummary +========================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileRiskScoreAggregationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummaryCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummaryCollection.rst new file mode 100644 index 0000000000..bd804e9758 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummaryCollection.rst @@ -0,0 +1,11 @@ +ResourceProfileRiskScoreAggregationSummaryCollection +==================================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileRiskScoreAggregationSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileSummary.rst new file mode 100644 index 0000000000..af33f47e37 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceProfileSummary.rst @@ -0,0 +1,11 @@ +ResourceProfileSummary +====================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceProfileSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregation.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregation.rst new file mode 100644 index 0000000000..bf991582e2 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregation.rst @@ -0,0 +1,11 @@ +ResourceRiskScoreAggregation +============================ + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceRiskScoreAggregation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregationCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregationCollection.rst new file mode 100644 index 0000000000..a316938ff2 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.ResourceRiskScoreAggregationCollection.rst @@ -0,0 +1,11 @@ +ResourceRiskScoreAggregationCollection +====================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: ResourceRiskScoreAggregationCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.Sighting.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.Sighting.rst new file mode 100644 index 0000000000..ab20c41f3e --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.Sighting.rst @@ -0,0 +1,11 @@ +Sighting +======== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: Sighting + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingCollection.rst new file mode 100644 index 0000000000..4718efc52a --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingCollection.rst @@ -0,0 +1,11 @@ +SightingCollection +================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointCollection.rst new file mode 100644 index 0000000000..fbc6fcdee3 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointCollection.rst @@ -0,0 +1,11 @@ +SightingEndpointCollection +========================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingEndpointCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointSummary.rst new file mode 100644 index 0000000000..f8cf354bc6 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingEndpointSummary.rst @@ -0,0 +1,11 @@ +SightingEndpointSummary +======================= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingEndpointSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceCollection.rst new file mode 100644 index 0000000000..1e4869cd3a --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceCollection.rst @@ -0,0 +1,11 @@ +SightingImpactedResourceCollection +================================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingImpactedResourceCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceSummary.rst new file mode 100644 index 0000000000..91a0070376 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingImpactedResourceSummary.rst @@ -0,0 +1,11 @@ +SightingImpactedResourceSummary +=============================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingImpactedResourceSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingSummary.rst new file mode 100644 index 0000000000..bcb65b0b46 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingSummary.rst @@ -0,0 +1,11 @@ +SightingSummary +=============== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingType.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingType.rst new file mode 100644 index 0000000000..88da34be44 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.SightingType.rst @@ -0,0 +1,11 @@ +SightingType +============ + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: SightingType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticCollection.rst new file mode 100644 index 0000000000..7216131256 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticCollection.rst @@ -0,0 +1,11 @@ +TacticCollection +================ + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: TacticCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticSummary.rst new file mode 100644 index 0000000000..bafaec5e57 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.TacticSummary.rst @@ -0,0 +1,11 @@ +TacticSummary +============= + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: TacticSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueCollection.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueCollection.rst new file mode 100644 index 0000000000..7fd7361e88 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueCollection.rst @@ -0,0 +1,11 @@ +TechniqueCollection +=================== + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: TechniqueCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueSummary.rst b/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueSummary.rst new file mode 100644 index 0000000000..9b3d9d4df3 --- /dev/null +++ b/docs/api/cloud_guard/models/oci.cloud_guard.models.TechniqueSummary.rst @@ -0,0 +1,11 @@ +TechniqueSummary +================ + +.. currentmodule:: oci.cloud_guard.models + +.. autoclass:: TechniqueSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/core.rst b/docs/api/core.rst index 579abde0ed..c76a432a55 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -374,6 +374,7 @@ Core Services oci.core.models.ServiceIdRequestDetails oci.core.models.ServiceIdResponseDetails oci.core.models.Shape + oci.core.models.ShapeAlternativeObject oci.core.models.ShapeMaxVnicAttachmentOptions oci.core.models.ShapeMeasuredBootOptions oci.core.models.ShapeMemoryOptions diff --git a/docs/api/core/models/oci.core.models.ShapeAlternativeObject.rst b/docs/api/core/models/oci.core.models.ShapeAlternativeObject.rst new file mode 100644 index 0000000000..0af36bdd5b --- /dev/null +++ b/docs/api/core/models/oci.core.models.ShapeAlternativeObject.rst @@ -0,0 +1,11 @@ +ShapeAlternativeObject +====================== + +.. currentmodule:: oci.core.models + +.. autoclass:: ShapeAlternativeObject + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity.rst b/docs/api/data_connectivity.rst new file mode 100644 index 0000000000..1b08911ece --- /dev/null +++ b/docs/api/data_connectivity.rst @@ -0,0 +1,231 @@ +Data Connectivity +================= + +.. autosummary:: + :toctree: data_connectivity/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.data_connectivity.DataConnectivityManagementClient + oci.data_connectivity.NetworkValidationClient + oci.data_connectivity.DataConnectivityManagementClientCompositeOperations + oci.data_connectivity.NetworkValidationClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: data_connectivity/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.data_connectivity.models.AbstractCallAttribute + oci.data_connectivity.models.AbstractDataOperationConfig + oci.data_connectivity.models.AbstractFormatAttribute + oci.data_connectivity.models.AbstractReadAttribute + oci.data_connectivity.models.AbstractWriteAttribute + oci.data_connectivity.models.AggregatorSummary + oci.data_connectivity.models.AttachDataAssetInfo + oci.data_connectivity.models.Attribute + oci.data_connectivity.models.AttributeProfileResult + oci.data_connectivity.models.AvroFormatAttribute + oci.data_connectivity.models.BaseType + oci.data_connectivity.models.BiccReadAttributes + oci.data_connectivity.models.BipCallAttribute + oci.data_connectivity.models.CallOperationConfig + oci.data_connectivity.models.ChangeEndpointCompartmentDetails + oci.data_connectivity.models.ChangeRegistryCompartmentDetails + oci.data_connectivity.models.Column + oci.data_connectivity.models.CompositeType + oci.data_connectivity.models.Compression + oci.data_connectivity.models.ConfigDefinition + oci.data_connectivity.models.ConfigParameterDefinition + oci.data_connectivity.models.ConfigParameterValue + oci.data_connectivity.models.ConfigValues + oci.data_connectivity.models.ConfiguredType + oci.data_connectivity.models.Connection + oci.data_connectivity.models.ConnectionProperty + oci.data_connectivity.models.ConnectionSummary + oci.data_connectivity.models.ConnectionSummaryCollection + oci.data_connectivity.models.ConnectionValidation + oci.data_connectivity.models.ConnectionValidationSummary + oci.data_connectivity.models.ConnectionValidationSummaryCollection + oci.data_connectivity.models.ConnectivityValidation + oci.data_connectivity.models.ConnectorAttribute + oci.data_connectivity.models.CreateAttachDataAssetDetails + oci.data_connectivity.models.CreateConnectionDetails + oci.data_connectivity.models.CreateConnectionValidationDetails + oci.data_connectivity.models.CreateConnectivityValidationDetails + oci.data_connectivity.models.CreateDataAssetDetails + oci.data_connectivity.models.CreateDataPreviewDetails + oci.data_connectivity.models.CreateDataProfileDetails + oci.data_connectivity.models.CreateDeReferenceArtifactDetails + oci.data_connectivity.models.CreateDetachDataAssetDetails + oci.data_connectivity.models.CreateDpEndpointDetails + oci.data_connectivity.models.CreateDpEndpointFromPrivate + oci.data_connectivity.models.CreateDpEndpointFromPublic + oci.data_connectivity.models.CreateEndpointDetails + oci.data_connectivity.models.CreateEntityShapeDetails + oci.data_connectivity.models.CreateEntityShapeFromDataStore + oci.data_connectivity.models.CreateEntityShapeFromFile + oci.data_connectivity.models.CreateEntityShapeFromSQL + oci.data_connectivity.models.CreateEntityShapeFromTable + oci.data_connectivity.models.CreateEntityShapeFromView + oci.data_connectivity.models.CreateExecuteOperationJobDetails + oci.data_connectivity.models.CreateFolderDetails + oci.data_connectivity.models.CreateFullPushDownTaskDetails + oci.data_connectivity.models.CreateReferenceArtifactDetails + oci.data_connectivity.models.CreateRegistryDetails + oci.data_connectivity.models.CreateTestNetworkConnectivityDetails + oci.data_connectivity.models.CsvFormatAttribute + oci.data_connectivity.models.DataAsset + oci.data_connectivity.models.DataAssetSummary + oci.data_connectivity.models.DataAssetSummaryCollection + oci.data_connectivity.models.DataEntity + oci.data_connectivity.models.DataEntityDetails + oci.data_connectivity.models.DataEntityFromDataStore + oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails + oci.data_connectivity.models.DataEntityFromFile + oci.data_connectivity.models.DataEntityFromFileEntityDetails + oci.data_connectivity.models.DataEntityFromSql + oci.data_connectivity.models.DataEntityFromSqlEntityDetails + oci.data_connectivity.models.DataEntityFromTable + oci.data_connectivity.models.DataEntityFromTableEntityDetails + oci.data_connectivity.models.DataEntityFromView + oci.data_connectivity.models.DataEntityFromViewEntityDetails + oci.data_connectivity.models.DataEntitySummary + oci.data_connectivity.models.DataEntitySummaryCollection + oci.data_connectivity.models.DataEntitySummaryFromDataStore + oci.data_connectivity.models.DataEntitySummaryFromFile + oci.data_connectivity.models.DataEntitySummaryFromSql + oci.data_connectivity.models.DataEntitySummaryFromTable + oci.data_connectivity.models.DataEntitySummaryFromView + oci.data_connectivity.models.DataFormat + oci.data_connectivity.models.DataPreview + oci.data_connectivity.models.DataProfile + oci.data_connectivity.models.DataType + oci.data_connectivity.models.DataTypeStat + oci.data_connectivity.models.DateAttribute + oci.data_connectivity.models.DeReferenceInfo + oci.data_connectivity.models.DerivedType + oci.data_connectivity.models.DetachDataAssetInfo + oci.data_connectivity.models.DpEndpoint + oci.data_connectivity.models.DpEndpointDetails + oci.data_connectivity.models.DpEndpointFromPrivate + oci.data_connectivity.models.DpEndpointFromPrivateDetails + oci.data_connectivity.models.DpEndpointFromPublic + oci.data_connectivity.models.DpEndpointFromPublicDetails + oci.data_connectivity.models.DpEndpointSummary + oci.data_connectivity.models.DpEndpointSummaryFromPrivate + oci.data_connectivity.models.DpEndpointSummaryFromPublic + oci.data_connectivity.models.Endpoint + oci.data_connectivity.models.EndpointSummary + oci.data_connectivity.models.EndpointSummaryCollection + oci.data_connectivity.models.EntityProfileResult + oci.data_connectivity.models.EntityShape + oci.data_connectivity.models.EntityShapeFromDataStore + oci.data_connectivity.models.EntityShapeFromFile + oci.data_connectivity.models.EntityShapeFromSQL + oci.data_connectivity.models.EntityShapeFromTable + oci.data_connectivity.models.EntityShapeFromView + oci.data_connectivity.models.ErrorDetails + oci.data_connectivity.models.ExecuteOperationJob + oci.data_connectivity.models.ExecuteOperationJobDetails + oci.data_connectivity.models.ExternalStorage + oci.data_connectivity.models.FilterPush + oci.data_connectivity.models.Folder + oci.data_connectivity.models.FolderSummary + oci.data_connectivity.models.FolderSummaryCollection + oci.data_connectivity.models.ForeignKey + oci.data_connectivity.models.FullPushDownTaskResponse + oci.data_connectivity.models.HdfsWriteAttributes + oci.data_connectivity.models.Histogram + oci.data_connectivity.models.InputPort + oci.data_connectivity.models.Join + oci.data_connectivity.models.JsonFormatAttribute + oci.data_connectivity.models.Key + oci.data_connectivity.models.KeyAttribute + oci.data_connectivity.models.KeyRange + oci.data_connectivity.models.KeyRangePartitionConfig + oci.data_connectivity.models.Message + oci.data_connectivity.models.NativeShapeField + oci.data_connectivity.models.NetworkConnectivityStatus + oci.data_connectivity.models.NetworkConnectivityStatusCollection + oci.data_connectivity.models.NumericAttribute + oci.data_connectivity.models.ObjectFreqStat + oci.data_connectivity.models.ObjectMetadata + oci.data_connectivity.models.ObjectStorageWriteAttributes + oci.data_connectivity.models.Operation + oci.data_connectivity.models.OperationExecResult + oci.data_connectivity.models.OperationFromProcedure + oci.data_connectivity.models.OperationInputRecord + oci.data_connectivity.models.OperationSummary + oci.data_connectivity.models.OperationSummaryCollection + oci.data_connectivity.models.OperationSummaryFromProcedure + oci.data_connectivity.models.OracleAdwcWriteAttributes + oci.data_connectivity.models.OracleAtpWriteAttributes + oci.data_connectivity.models.OracleReadAttribute + oci.data_connectivity.models.OracleReadAttributes + oci.data_connectivity.models.OracleWriteAttributes + oci.data_connectivity.models.Outlier + oci.data_connectivity.models.OutputPort + oci.data_connectivity.models.Parameter + oci.data_connectivity.models.ParentReference + oci.data_connectivity.models.ParquetFormatAttribute + oci.data_connectivity.models.PartitionConfig + oci.data_connectivity.models.PrimaryKey + oci.data_connectivity.models.ProfileConfig + oci.data_connectivity.models.ProfileStat + oci.data_connectivity.models.PushDownOperation + oci.data_connectivity.models.Query + oci.data_connectivity.models.ReadOperationConfig + oci.data_connectivity.models.ReferenceArtifactSummary + oci.data_connectivity.models.ReferenceArtifactSummaryCollection + oci.data_connectivity.models.ReferenceInfo + oci.data_connectivity.models.Registry + oci.data_connectivity.models.RegistryMetadata + oci.data_connectivity.models.RegistrySummary + oci.data_connectivity.models.RegistrySummaryCollection + oci.data_connectivity.models.Row + oci.data_connectivity.models.Schema + oci.data_connectivity.models.SchemaDriftConfig + oci.data_connectivity.models.SchemaSummary + oci.data_connectivity.models.SchemaSummaryCollection + oci.data_connectivity.models.Select + oci.data_connectivity.models.Shape + oci.data_connectivity.models.ShapeField + oci.data_connectivity.models.Sort + oci.data_connectivity.models.SortClause + oci.data_connectivity.models.Source + oci.data_connectivity.models.StringAttribute + oci.data_connectivity.models.StructuredType + oci.data_connectivity.models.Target + oci.data_connectivity.models.TestNetworkConnectivity + oci.data_connectivity.models.Type + oci.data_connectivity.models.TypeLibrary + oci.data_connectivity.models.TypeSummary + oci.data_connectivity.models.TypeSystem + oci.data_connectivity.models.TypedObject + oci.data_connectivity.models.TypesSummaryCollection + oci.data_connectivity.models.UniqueKey + oci.data_connectivity.models.UpdateConnectionDetails + oci.data_connectivity.models.UpdateDataAssetDetails + oci.data_connectivity.models.UpdateDpEndpointDetails + oci.data_connectivity.models.UpdateDpEndpointFromPrivate + oci.data_connectivity.models.UpdateDpEndpointFromPublic + oci.data_connectivity.models.UpdateEndpointDetails + oci.data_connectivity.models.UpdateFolderDetails + oci.data_connectivity.models.UpdateRegistryDetails + oci.data_connectivity.models.ValidationMessage + oci.data_connectivity.models.ValidationResult + oci.data_connectivity.models.WorkRequest + oci.data_connectivity.models.WorkRequestError + oci.data_connectivity.models.WorkRequestErrorCollection + oci.data_connectivity.models.WorkRequestErrorSummary + oci.data_connectivity.models.WorkRequestLog + oci.data_connectivity.models.WorkRequestLogCollection + oci.data_connectivity.models.WorkRequestResource + oci.data_connectivity.models.WorkRequestSummary + oci.data_connectivity.models.WorkRequestSummaryCollection + oci.data_connectivity.models.WriteOperationConfig diff --git a/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClient.rst b/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClient.rst new file mode 100644 index 0000000000..f958be12b1 --- /dev/null +++ b/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClient.rst @@ -0,0 +1,8 @@ +DataConnectivityManagementClient +================================ + +.. currentmodule:: oci.data_connectivity + +.. autoclass:: DataConnectivityManagementClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClientCompositeOperations.rst b/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClientCompositeOperations.rst new file mode 100644 index 0000000000..3d42d7fd96 --- /dev/null +++ b/docs/api/data_connectivity/client/oci.data_connectivity.DataConnectivityManagementClientCompositeOperations.rst @@ -0,0 +1,8 @@ +DataConnectivityManagementClientCompositeOperations +=================================================== + +.. currentmodule:: oci.data_connectivity + +.. autoclass:: DataConnectivityManagementClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClient.rst b/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClient.rst new file mode 100644 index 0000000000..f3e14eed42 --- /dev/null +++ b/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClient.rst @@ -0,0 +1,8 @@ +NetworkValidationClient +======================= + +.. currentmodule:: oci.data_connectivity + +.. autoclass:: NetworkValidationClient + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClientCompositeOperations.rst b/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClientCompositeOperations.rst new file mode 100644 index 0000000000..61937361df --- /dev/null +++ b/docs/api/data_connectivity/client/oci.data_connectivity.NetworkValidationClientCompositeOperations.rst @@ -0,0 +1,8 @@ +NetworkValidationClientCompositeOperations +========================================== + +.. currentmodule:: oci.data_connectivity + +.. autoclass:: NetworkValidationClientCompositeOperations + :special-members: __init__ + :members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractCallAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractCallAttribute.rst new file mode 100644 index 0000000000..d303c6666c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractCallAttribute.rst @@ -0,0 +1,11 @@ +AbstractCallAttribute +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AbstractCallAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractDataOperationConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractDataOperationConfig.rst new file mode 100644 index 0000000000..d079264a18 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractDataOperationConfig.rst @@ -0,0 +1,11 @@ +AbstractDataOperationConfig +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AbstractDataOperationConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractFormatAttribute.rst new file mode 100644 index 0000000000..b3b960f27c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractFormatAttribute.rst @@ -0,0 +1,11 @@ +AbstractFormatAttribute +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AbstractFormatAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractReadAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractReadAttribute.rst new file mode 100644 index 0000000000..97604e2b0b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractReadAttribute.rst @@ -0,0 +1,11 @@ +AbstractReadAttribute +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AbstractReadAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractWriteAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractWriteAttribute.rst new file mode 100644 index 0000000000..add3399bfa --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractWriteAttribute.rst @@ -0,0 +1,11 @@ +AbstractWriteAttribute +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AbstractWriteAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AggregatorSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AggregatorSummary.rst new file mode 100644 index 0000000000..9a09ddb1ca --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AggregatorSummary.rst @@ -0,0 +1,11 @@ +AggregatorSummary +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AggregatorSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AttachDataAssetInfo.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AttachDataAssetInfo.rst new file mode 100644 index 0000000000..8201853da5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AttachDataAssetInfo.rst @@ -0,0 +1,11 @@ +AttachDataAssetInfo +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AttachDataAssetInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Attribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Attribute.rst new file mode 100644 index 0000000000..31a6ecc903 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Attribute.rst @@ -0,0 +1,11 @@ +Attribute +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Attribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AttributeProfileResult.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AttributeProfileResult.rst new file mode 100644 index 0000000000..ab2d5efa97 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AttributeProfileResult.rst @@ -0,0 +1,11 @@ +AttributeProfileResult +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AttributeProfileResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.AvroFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AvroFormatAttribute.rst new file mode 100644 index 0000000000..06345682a0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AvroFormatAttribute.rst @@ -0,0 +1,11 @@ +AvroFormatAttribute +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: AvroFormatAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.BaseType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.BaseType.rst new file mode 100644 index 0000000000..5cdc111fd3 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.BaseType.rst @@ -0,0 +1,11 @@ +BaseType +======== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: BaseType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.BiccReadAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.BiccReadAttributes.rst new file mode 100644 index 0000000000..fc57762cbf --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.BiccReadAttributes.rst @@ -0,0 +1,11 @@ +BiccReadAttributes +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: BiccReadAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.BipCallAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.BipCallAttribute.rst new file mode 100644 index 0000000000..d7b25c2799 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.BipCallAttribute.rst @@ -0,0 +1,11 @@ +BipCallAttribute +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: BipCallAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CallOperationConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CallOperationConfig.rst new file mode 100644 index 0000000000..654980eafe --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CallOperationConfig.rst @@ -0,0 +1,11 @@ +CallOperationConfig +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CallOperationConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeEndpointCompartmentDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeEndpointCompartmentDetails.rst new file mode 100644 index 0000000000..04eaacffee --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeEndpointCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeEndpointCompartmentDetails +================================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ChangeEndpointCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeRegistryCompartmentDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeRegistryCompartmentDetails.rst new file mode 100644 index 0000000000..1542e60ca0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ChangeRegistryCompartmentDetails.rst @@ -0,0 +1,11 @@ +ChangeRegistryCompartmentDetails +================================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ChangeRegistryCompartmentDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Column.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Column.rst new file mode 100644 index 0000000000..0b381cdab9 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Column.rst @@ -0,0 +1,11 @@ +Column +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Column + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CompositeType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CompositeType.rst new file mode 100644 index 0000000000..f2165f98e7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CompositeType.rst @@ -0,0 +1,11 @@ +CompositeType +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CompositeType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Compression.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Compression.rst new file mode 100644 index 0000000000..4aa8564029 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Compression.rst @@ -0,0 +1,11 @@ +Compression +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Compression + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDefinition.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDefinition.rst new file mode 100644 index 0000000000..5db16743c0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDefinition.rst @@ -0,0 +1,11 @@ +ConfigDefinition +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfigDefinition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterDefinition.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterDefinition.rst new file mode 100644 index 0000000000..49efb81723 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterDefinition.rst @@ -0,0 +1,11 @@ +ConfigParameterDefinition +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfigParameterDefinition + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterValue.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterValue.rst new file mode 100644 index 0000000000..4edbfe5560 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigParameterValue.rst @@ -0,0 +1,11 @@ +ConfigParameterValue +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfigParameterValue + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigValues.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigValues.rst new file mode 100644 index 0000000000..6fedb5e7d5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigValues.rst @@ -0,0 +1,11 @@ +ConfigValues +============ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfigValues + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfiguredType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfiguredType.rst new file mode 100644 index 0000000000..aa12064f20 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfiguredType.rst @@ -0,0 +1,11 @@ +ConfiguredType +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfiguredType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Connection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Connection.rst new file mode 100644 index 0000000000..13eee8a827 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Connection.rst @@ -0,0 +1,11 @@ +Connection +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Connection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionProperty.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionProperty.rst new file mode 100644 index 0000000000..c059cd0333 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionProperty.rst @@ -0,0 +1,11 @@ +ConnectionProperty +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionProperty + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummary.rst new file mode 100644 index 0000000000..a5ff73b558 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummary.rst @@ -0,0 +1,11 @@ +ConnectionSummary +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummaryCollection.rst new file mode 100644 index 0000000000..322e225b95 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionSummaryCollection.rst @@ -0,0 +1,11 @@ +ConnectionSummaryCollection +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidation.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidation.rst new file mode 100644 index 0000000000..9fd6d91323 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidation.rst @@ -0,0 +1,11 @@ +ConnectionValidation +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionValidation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummary.rst new file mode 100644 index 0000000000..c19ff89599 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummary.rst @@ -0,0 +1,11 @@ +ConnectionValidationSummary +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionValidationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst new file mode 100644 index 0000000000..5cdbd37dab --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst @@ -0,0 +1,11 @@ +ConnectionValidationSummaryCollection +===================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectionValidationSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityValidation.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityValidation.rst new file mode 100644 index 0000000000..a678125de0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityValidation.rst @@ -0,0 +1,11 @@ +ConnectivityValidation +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectivityValidation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectorAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectorAttribute.rst new file mode 100644 index 0000000000..b699bac29d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectorAttribute.rst @@ -0,0 +1,11 @@ +ConnectorAttribute +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectorAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateAttachDataAssetDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateAttachDataAssetDetails.rst new file mode 100644 index 0000000000..4e30d12ba4 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateAttachDataAssetDetails.rst @@ -0,0 +1,11 @@ +CreateAttachDataAssetDetails +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateAttachDataAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionDetails.rst new file mode 100644 index 0000000000..1b2c10a1ab --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionDetails.rst @@ -0,0 +1,11 @@ +CreateConnectionDetails +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionValidationDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionValidationDetails.rst new file mode 100644 index 0000000000..b8bad8d159 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectionValidationDetails.rst @@ -0,0 +1,11 @@ +CreateConnectionValidationDetails +================================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateConnectionValidationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectivityValidationDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectivityValidationDetails.rst new file mode 100644 index 0000000000..d736c64976 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateConnectivityValidationDetails.rst @@ -0,0 +1,11 @@ +CreateConnectivityValidationDetails +=================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateConnectivityValidationDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataAssetDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataAssetDetails.rst new file mode 100644 index 0000000000..1c40f131fd --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataAssetDetails.rst @@ -0,0 +1,11 @@ +CreateDataAssetDetails +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDataAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataPreviewDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataPreviewDetails.rst new file mode 100644 index 0000000000..94b0380b9d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataPreviewDetails.rst @@ -0,0 +1,11 @@ +CreateDataPreviewDetails +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDataPreviewDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataProfileDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataProfileDetails.rst new file mode 100644 index 0000000000..f66d379f53 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDataProfileDetails.rst @@ -0,0 +1,11 @@ +CreateDataProfileDetails +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDataProfileDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDeReferenceArtifactDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDeReferenceArtifactDetails.rst new file mode 100644 index 0000000000..12e604751e --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDeReferenceArtifactDetails.rst @@ -0,0 +1,11 @@ +CreateDeReferenceArtifactDetails +================================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDeReferenceArtifactDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDetachDataAssetDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDetachDataAssetDetails.rst new file mode 100644 index 0000000000..e4f2df464d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDetachDataAssetDetails.rst @@ -0,0 +1,11 @@ +CreateDetachDataAssetDetails +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDetachDataAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointDetails.rst new file mode 100644 index 0000000000..d9a3b0760d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointDetails.rst @@ -0,0 +1,11 @@ +CreateDpEndpointDetails +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDpEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPrivate.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPrivate.rst new file mode 100644 index 0000000000..0d40517186 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPrivate.rst @@ -0,0 +1,11 @@ +CreateDpEndpointFromPrivate +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDpEndpointFromPrivate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPublic.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPublic.rst new file mode 100644 index 0000000000..f896443d8d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateDpEndpointFromPublic.rst @@ -0,0 +1,11 @@ +CreateDpEndpointFromPublic +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateDpEndpointFromPublic + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEndpointDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEndpointDetails.rst new file mode 100644 index 0000000000..26b093d0a5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEndpointDetails.rst @@ -0,0 +1,11 @@ +CreateEndpointDetails +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeDetails.rst new file mode 100644 index 0000000000..c37b9068f1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeDetails.rst @@ -0,0 +1,11 @@ +CreateEntityShapeDetails +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromDataStore.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromDataStore.rst new file mode 100644 index 0000000000..3056a3ee4f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromDataStore.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromDataStore +============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromDataStore + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromFile.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromFile.rst new file mode 100644 index 0000000000..be05b38f32 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromFile.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromFile +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromFile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromSQL.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromSQL.rst new file mode 100644 index 0000000000..db8c4743b8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromSQL.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromSQL +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromSQL + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromTable.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromTable.rst new file mode 100644 index 0000000000..f6f4ea5263 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromTable.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromTable +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromTable + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromView.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromView.rst new file mode 100644 index 0000000000..a44c95e9b5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromView.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromView +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromView + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateExecuteOperationJobDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateExecuteOperationJobDetails.rst new file mode 100644 index 0000000000..1114950c1f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateExecuteOperationJobDetails.rst @@ -0,0 +1,11 @@ +CreateExecuteOperationJobDetails +================================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateExecuteOperationJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFolderDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFolderDetails.rst new file mode 100644 index 0000000000..d77b1170f0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFolderDetails.rst @@ -0,0 +1,11 @@ +CreateFolderDetails +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateFolderDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFullPushDownTaskDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFullPushDownTaskDetails.rst new file mode 100644 index 0000000000..c4a8c5de8e --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateFullPushDownTaskDetails.rst @@ -0,0 +1,11 @@ +CreateFullPushDownTaskDetails +============================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateFullPushDownTaskDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateReferenceArtifactDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateReferenceArtifactDetails.rst new file mode 100644 index 0000000000..c4d9f107e2 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateReferenceArtifactDetails.rst @@ -0,0 +1,11 @@ +CreateReferenceArtifactDetails +============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateReferenceArtifactDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateRegistryDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateRegistryDetails.rst new file mode 100644 index 0000000000..4affd1b6b4 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateRegistryDetails.rst @@ -0,0 +1,11 @@ +CreateRegistryDetails +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateTestNetworkConnectivityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateTestNetworkConnectivityDetails.rst new file mode 100644 index 0000000000..aff5e1a632 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateTestNetworkConnectivityDetails.rst @@ -0,0 +1,11 @@ +CreateTestNetworkConnectivityDetails +==================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateTestNetworkConnectivityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.CsvFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CsvFormatAttribute.rst new file mode 100644 index 0000000000..22a774d4b5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CsvFormatAttribute.rst @@ -0,0 +1,11 @@ +CsvFormatAttribute +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CsvFormatAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAsset.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAsset.rst new file mode 100644 index 0000000000..393cc243c0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAsset.rst @@ -0,0 +1,11 @@ +DataAsset +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataAsset + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummary.rst new file mode 100644 index 0000000000..a3369aea13 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummary.rst @@ -0,0 +1,11 @@ +DataAssetSummary +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataAssetSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummaryCollection.rst new file mode 100644 index 0000000000..8e27591ce5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataAssetSummaryCollection.rst @@ -0,0 +1,11 @@ +DataAssetSummaryCollection +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataAssetSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntity.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntity.rst new file mode 100644 index 0000000000..149e149a70 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntity.rst @@ -0,0 +1,11 @@ +DataEntity +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityDetails.rst new file mode 100644 index 0000000000..ca786e5e2a --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityDetails +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStore.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStore.rst new file mode 100644 index 0000000000..8cc4df3b7d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStore.rst @@ -0,0 +1,11 @@ +DataEntityFromDataStore +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromDataStore + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails.rst new file mode 100644 index 0000000000..97889ecb3c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromDataStoreEntityDetails +==================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromDataStoreEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFile.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFile.rst new file mode 100644 index 0000000000..7f99e1e909 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFile.rst @@ -0,0 +1,11 @@ +DataEntityFromFile +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromFile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFileEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFileEntityDetails.rst new file mode 100644 index 0000000000..dd20467182 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromFileEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromFileEntityDetails +=============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromFileEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSql.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSql.rst new file mode 100644 index 0000000000..67c8f12fd5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSql.rst @@ -0,0 +1,11 @@ +DataEntityFromSql +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromSql + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSqlEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSqlEntityDetails.rst new file mode 100644 index 0000000000..65428396a0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromSqlEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromSqlEntityDetails +============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromSqlEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTable.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTable.rst new file mode 100644 index 0000000000..1d7597807d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTable.rst @@ -0,0 +1,11 @@ +DataEntityFromTable +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromTable + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTableEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTableEntityDetails.rst new file mode 100644 index 0000000000..dec7a2b852 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromTableEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromTableEntityDetails +================================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromTableEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromView.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromView.rst new file mode 100644 index 0000000000..f9d75f28a4 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromView.rst @@ -0,0 +1,11 @@ +DataEntityFromView +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromView + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromViewEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromViewEntityDetails.rst new file mode 100644 index 0000000000..d2f9779e7e --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromViewEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromViewEntityDetails +=============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromViewEntityDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummary.rst new file mode 100644 index 0000000000..6dc0b7601b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummary.rst @@ -0,0 +1,11 @@ +DataEntitySummary +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryCollection.rst new file mode 100644 index 0000000000..6f3e8c0cf9 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryCollection.rst @@ -0,0 +1,11 @@ +DataEntitySummaryCollection +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromDataStore.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromDataStore.rst new file mode 100644 index 0000000000..836d277496 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromDataStore.rst @@ -0,0 +1,11 @@ +DataEntitySummaryFromDataStore +============================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryFromDataStore + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromFile.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromFile.rst new file mode 100644 index 0000000000..80f2f49025 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromFile.rst @@ -0,0 +1,11 @@ +DataEntitySummaryFromFile +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryFromFile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromSql.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromSql.rst new file mode 100644 index 0000000000..e0773fe2a1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromSql.rst @@ -0,0 +1,11 @@ +DataEntitySummaryFromSql +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryFromSql + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromTable.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromTable.rst new file mode 100644 index 0000000000..215f87e6da --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromTable.rst @@ -0,0 +1,11 @@ +DataEntitySummaryFromTable +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryFromTable + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromView.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromView.rst new file mode 100644 index 0000000000..887f21f356 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntitySummaryFromView.rst @@ -0,0 +1,11 @@ +DataEntitySummaryFromView +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntitySummaryFromView + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataFormat.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataFormat.rst new file mode 100644 index 0000000000..539e2f564d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataFormat.rst @@ -0,0 +1,11 @@ +DataFormat +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataFormat + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataPreview.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataPreview.rst new file mode 100644 index 0000000000..6321813212 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataPreview.rst @@ -0,0 +1,11 @@ +DataPreview +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataPreview + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataProfile.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataProfile.rst new file mode 100644 index 0000000000..220e84aad5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataProfile.rst @@ -0,0 +1,11 @@ +DataProfile +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataProfile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataType.rst new file mode 100644 index 0000000000..c6c09f937c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataType.rst @@ -0,0 +1,11 @@ +DataType +======== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DataTypeStat.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataTypeStat.rst new file mode 100644 index 0000000000..6e8ba6cb22 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataTypeStat.rst @@ -0,0 +1,11 @@ +DataTypeStat +============ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataTypeStat + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DateAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DateAttribute.rst new file mode 100644 index 0000000000..462faf2115 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DateAttribute.rst @@ -0,0 +1,11 @@ +DateAttribute +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DateAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DeReferenceInfo.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeReferenceInfo.rst new file mode 100644 index 0000000000..26aae2caf1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeReferenceInfo.rst @@ -0,0 +1,11 @@ +DeReferenceInfo +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DeReferenceInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DerivedType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DerivedType.rst new file mode 100644 index 0000000000..cae718a3c8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DerivedType.rst @@ -0,0 +1,11 @@ +DerivedType +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DerivedType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DetachDataAssetInfo.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DetachDataAssetInfo.rst new file mode 100644 index 0000000000..5c9e047e66 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DetachDataAssetInfo.rst @@ -0,0 +1,11 @@ +DetachDataAssetInfo +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DetachDataAssetInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpoint.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpoint.rst new file mode 100644 index 0000000000..5eacf315b0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpoint.rst @@ -0,0 +1,11 @@ +DpEndpoint +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpoint + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointDetails.rst new file mode 100644 index 0000000000..964902f1fb --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointDetails.rst @@ -0,0 +1,11 @@ +DpEndpointDetails +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivate.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivate.rst new file mode 100644 index 0000000000..cabfc29f90 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivate.rst @@ -0,0 +1,11 @@ +DpEndpointFromPrivate +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointFromPrivate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivateDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivateDetails.rst new file mode 100644 index 0000000000..fbce755c95 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPrivateDetails.rst @@ -0,0 +1,11 @@ +DpEndpointFromPrivateDetails +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointFromPrivateDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublic.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublic.rst new file mode 100644 index 0000000000..5a0aac7bb6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublic.rst @@ -0,0 +1,11 @@ +DpEndpointFromPublic +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointFromPublic + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublicDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublicDetails.rst new file mode 100644 index 0000000000..e89b19d2a1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointFromPublicDetails.rst @@ -0,0 +1,11 @@ +DpEndpointFromPublicDetails +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointFromPublicDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummary.rst new file mode 100644 index 0000000000..1c66bdac79 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummary.rst @@ -0,0 +1,11 @@ +DpEndpointSummary +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPrivate.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPrivate.rst new file mode 100644 index 0000000000..d4782012f3 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPrivate.rst @@ -0,0 +1,11 @@ +DpEndpointSummaryFromPrivate +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointSummaryFromPrivate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPublic.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPublic.rst new file mode 100644 index 0000000000..1d0d123739 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DpEndpointSummaryFromPublic.rst @@ -0,0 +1,11 @@ +DpEndpointSummaryFromPublic +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DpEndpointSummaryFromPublic + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Endpoint.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Endpoint.rst new file mode 100644 index 0000000000..72bd49bb43 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Endpoint.rst @@ -0,0 +1,11 @@ +Endpoint +======== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Endpoint + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummary.rst new file mode 100644 index 0000000000..34ec316ce1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummary.rst @@ -0,0 +1,11 @@ +EndpointSummary +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EndpointSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummaryCollection.rst new file mode 100644 index 0000000000..21f1e7398b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EndpointSummaryCollection.rst @@ -0,0 +1,11 @@ +EndpointSummaryCollection +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EndpointSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityProfileResult.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityProfileResult.rst new file mode 100644 index 0000000000..94e0373ee6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityProfileResult.rst @@ -0,0 +1,11 @@ +EntityProfileResult +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityProfileResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShape.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShape.rst new file mode 100644 index 0000000000..e56d41af21 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShape.rst @@ -0,0 +1,11 @@ +EntityShape +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShape + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromDataStore.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromDataStore.rst new file mode 100644 index 0000000000..f564f3ec58 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromDataStore.rst @@ -0,0 +1,11 @@ +EntityShapeFromDataStore +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromDataStore + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromFile.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromFile.rst new file mode 100644 index 0000000000..4085375dfb --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromFile.rst @@ -0,0 +1,11 @@ +EntityShapeFromFile +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromFile + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromSQL.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromSQL.rst new file mode 100644 index 0000000000..367fd31e11 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromSQL.rst @@ -0,0 +1,11 @@ +EntityShapeFromSQL +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromSQL + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromTable.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromTable.rst new file mode 100644 index 0000000000..a6ccd4234e --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromTable.rst @@ -0,0 +1,11 @@ +EntityShapeFromTable +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromTable + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromView.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromView.rst new file mode 100644 index 0000000000..4149ade2b7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromView.rst @@ -0,0 +1,11 @@ +EntityShapeFromView +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromView + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ErrorDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ErrorDetails.rst new file mode 100644 index 0000000000..4427f399f9 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ErrorDetails.rst @@ -0,0 +1,11 @@ +ErrorDetails +============ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ErrorDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJob.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJob.rst new file mode 100644 index 0000000000..b9f58092f0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJob.rst @@ -0,0 +1,11 @@ +ExecuteOperationJob +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ExecuteOperationJob + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJobDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJobDetails.rst new file mode 100644 index 0000000000..a9e99f6760 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExecuteOperationJobDetails.rst @@ -0,0 +1,11 @@ +ExecuteOperationJobDetails +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ExecuteOperationJobDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ExternalStorage.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExternalStorage.rst new file mode 100644 index 0000000000..c0f60364ab --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExternalStorage.rst @@ -0,0 +1,11 @@ +ExternalStorage +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ExternalStorage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.FilterPush.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.FilterPush.rst new file mode 100644 index 0000000000..bbbb8c9764 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.FilterPush.rst @@ -0,0 +1,11 @@ +FilterPush +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: FilterPush + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Folder.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Folder.rst new file mode 100644 index 0000000000..2c41737e32 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Folder.rst @@ -0,0 +1,11 @@ +Folder +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Folder + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummary.rst new file mode 100644 index 0000000000..29fc56f843 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummary.rst @@ -0,0 +1,11 @@ +FolderSummary +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: FolderSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummaryCollection.rst new file mode 100644 index 0000000000..35b3c45cf4 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.FolderSummaryCollection.rst @@ -0,0 +1,11 @@ +FolderSummaryCollection +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: FolderSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ForeignKey.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ForeignKey.rst new file mode 100644 index 0000000000..ee9ba1d67b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ForeignKey.rst @@ -0,0 +1,11 @@ +ForeignKey +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ForeignKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.FullPushDownTaskResponse.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.FullPushDownTaskResponse.rst new file mode 100644 index 0000000000..cd58e91f28 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.FullPushDownTaskResponse.rst @@ -0,0 +1,11 @@ +FullPushDownTaskResponse +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: FullPushDownTaskResponse + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.HdfsWriteAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.HdfsWriteAttributes.rst new file mode 100644 index 0000000000..96b3050ac1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.HdfsWriteAttributes.rst @@ -0,0 +1,11 @@ +HdfsWriteAttributes +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: HdfsWriteAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Histogram.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Histogram.rst new file mode 100644 index 0000000000..61563d7fcb --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Histogram.rst @@ -0,0 +1,11 @@ +Histogram +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Histogram + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.InputPort.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.InputPort.rst new file mode 100644 index 0000000000..dbb2e3e529 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.InputPort.rst @@ -0,0 +1,11 @@ +InputPort +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: InputPort + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Join.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Join.rst new file mode 100644 index 0000000000..0c08ed7422 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Join.rst @@ -0,0 +1,11 @@ +Join +==== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Join + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.JsonFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.JsonFormatAttribute.rst new file mode 100644 index 0000000000..aae3e78acb --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.JsonFormatAttribute.rst @@ -0,0 +1,11 @@ +JsonFormatAttribute +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: JsonFormatAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Key.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Key.rst new file mode 100644 index 0000000000..55d4758c53 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Key.rst @@ -0,0 +1,11 @@ +Key +=== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Key + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyAttribute.rst new file mode 100644 index 0000000000..3c4e2dd9f7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyAttribute.rst @@ -0,0 +1,11 @@ +KeyAttribute +============ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: KeyAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRange.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRange.rst new file mode 100644 index 0000000000..544e899344 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRange.rst @@ -0,0 +1,11 @@ +KeyRange +======== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: KeyRange + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRangePartitionConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRangePartitionConfig.rst new file mode 100644 index 0000000000..058285ea6c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.KeyRangePartitionConfig.rst @@ -0,0 +1,11 @@ +KeyRangePartitionConfig +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: KeyRangePartitionConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Message.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Message.rst new file mode 100644 index 0000000000..05280fb99c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Message.rst @@ -0,0 +1,11 @@ +Message +======= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Message + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.NativeShapeField.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.NativeShapeField.rst new file mode 100644 index 0000000000..be00cc71d6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.NativeShapeField.rst @@ -0,0 +1,11 @@ +NativeShapeField +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: NativeShapeField + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatus.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatus.rst new file mode 100644 index 0000000000..f94da8e49f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatus.rst @@ -0,0 +1,11 @@ +NetworkConnectivityStatus +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: NetworkConnectivityStatus + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatusCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatusCollection.rst new file mode 100644 index 0000000000..c73b723a37 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.NetworkConnectivityStatusCollection.rst @@ -0,0 +1,11 @@ +NetworkConnectivityStatusCollection +=================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: NetworkConnectivityStatusCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.NumericAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.NumericAttribute.rst new file mode 100644 index 0000000000..8ffd17247c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.NumericAttribute.rst @@ -0,0 +1,11 @@ +NumericAttribute +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: NumericAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectFreqStat.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectFreqStat.rst new file mode 100644 index 0000000000..c42cc0b63b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectFreqStat.rst @@ -0,0 +1,11 @@ +ObjectFreqStat +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ObjectFreqStat + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectMetadata.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectMetadata.rst new file mode 100644 index 0000000000..9a88e106b5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectMetadata.rst @@ -0,0 +1,11 @@ +ObjectMetadata +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ObjectMetadata + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectStorageWriteAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectStorageWriteAttributes.rst new file mode 100644 index 0000000000..7326bf1319 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ObjectStorageWriteAttributes.rst @@ -0,0 +1,11 @@ +ObjectStorageWriteAttributes +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ObjectStorageWriteAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Operation.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Operation.rst new file mode 100644 index 0000000000..52d149490d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Operation.rst @@ -0,0 +1,11 @@ +Operation +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Operation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationExecResult.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationExecResult.rst new file mode 100644 index 0000000000..e41cf87683 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationExecResult.rst @@ -0,0 +1,11 @@ +OperationExecResult +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationExecResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationFromProcedure.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationFromProcedure.rst new file mode 100644 index 0000000000..6fb86a9a2a --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationFromProcedure.rst @@ -0,0 +1,11 @@ +OperationFromProcedure +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationFromProcedure + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationInputRecord.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationInputRecord.rst new file mode 100644 index 0000000000..81a8caec17 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationInputRecord.rst @@ -0,0 +1,11 @@ +OperationInputRecord +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationInputRecord + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummary.rst new file mode 100644 index 0000000000..f2ea752690 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummary.rst @@ -0,0 +1,11 @@ +OperationSummary +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryCollection.rst new file mode 100644 index 0000000000..7e8330453d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryCollection.rst @@ -0,0 +1,11 @@ +OperationSummaryCollection +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryFromProcedure.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryFromProcedure.rst new file mode 100644 index 0000000000..78cd7a4cd1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryFromProcedure.rst @@ -0,0 +1,11 @@ +OperationSummaryFromProcedure +============================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationSummaryFromProcedure + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAdwcWriteAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAdwcWriteAttributes.rst new file mode 100644 index 0000000000..329d6b3f40 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAdwcWriteAttributes.rst @@ -0,0 +1,11 @@ +OracleAdwcWriteAttributes +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OracleAdwcWriteAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAtpWriteAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAtpWriteAttributes.rst new file mode 100644 index 0000000000..ffb60a9d97 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleAtpWriteAttributes.rst @@ -0,0 +1,11 @@ +OracleAtpWriteAttributes +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OracleAtpWriteAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttribute.rst new file mode 100644 index 0000000000..36eaca269c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttribute.rst @@ -0,0 +1,11 @@ +OracleReadAttribute +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OracleReadAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttributes.rst new file mode 100644 index 0000000000..f679809bb5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleReadAttributes.rst @@ -0,0 +1,11 @@ +OracleReadAttributes +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OracleReadAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleWriteAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleWriteAttributes.rst new file mode 100644 index 0000000000..8790f30f49 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OracleWriteAttributes.rst @@ -0,0 +1,11 @@ +OracleWriteAttributes +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OracleWriteAttributes + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Outlier.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Outlier.rst new file mode 100644 index 0000000000..56c59cc1f2 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Outlier.rst @@ -0,0 +1,11 @@ +Outlier +======= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Outlier + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.OutputPort.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OutputPort.rst new file mode 100644 index 0000000000..296624f6a0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OutputPort.rst @@ -0,0 +1,11 @@ +OutputPort +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OutputPort + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Parameter.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Parameter.rst new file mode 100644 index 0000000000..f529ec1901 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Parameter.rst @@ -0,0 +1,11 @@ +Parameter +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Parameter + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ParentReference.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ParentReference.rst new file mode 100644 index 0000000000..804d9abbd0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ParentReference.rst @@ -0,0 +1,11 @@ +ParentReference +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ParentReference + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ParquetFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ParquetFormatAttribute.rst new file mode 100644 index 0000000000..fb652ab3b6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ParquetFormatAttribute.rst @@ -0,0 +1,11 @@ +ParquetFormatAttribute +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ParquetFormatAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.PartitionConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.PartitionConfig.rst new file mode 100644 index 0000000000..af35280604 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.PartitionConfig.rst @@ -0,0 +1,11 @@ +PartitionConfig +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: PartitionConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.PrimaryKey.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.PrimaryKey.rst new file mode 100644 index 0000000000..3edd78d9ae --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.PrimaryKey.rst @@ -0,0 +1,11 @@ +PrimaryKey +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: PrimaryKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileConfig.rst new file mode 100644 index 0000000000..0f07659ddf --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileConfig.rst @@ -0,0 +1,11 @@ +ProfileConfig +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ProfileConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileStat.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileStat.rst new file mode 100644 index 0000000000..18f27b06e8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ProfileStat.rst @@ -0,0 +1,11 @@ +ProfileStat +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ProfileStat + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.PushDownOperation.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.PushDownOperation.rst new file mode 100644 index 0000000000..7971870c83 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.PushDownOperation.rst @@ -0,0 +1,11 @@ +PushDownOperation +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: PushDownOperation + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Query.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Query.rst new file mode 100644 index 0000000000..5cac357273 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Query.rst @@ -0,0 +1,11 @@ +Query +===== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Query + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ReadOperationConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReadOperationConfig.rst new file mode 100644 index 0000000000..9295752da7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReadOperationConfig.rst @@ -0,0 +1,11 @@ +ReadOperationConfig +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReadOperationConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummary.rst new file mode 100644 index 0000000000..f72ac54ef8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummary.rst @@ -0,0 +1,11 @@ +ReferenceArtifactSummary +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferenceArtifactSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummaryCollection.rst new file mode 100644 index 0000000000..14111c950a --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceArtifactSummaryCollection.rst @@ -0,0 +1,11 @@ +ReferenceArtifactSummaryCollection +================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferenceArtifactSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceInfo.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceInfo.rst new file mode 100644 index 0000000000..0ea22fc847 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferenceInfo.rst @@ -0,0 +1,11 @@ +ReferenceInfo +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferenceInfo + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Registry.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Registry.rst new file mode 100644 index 0000000000..9f27870e5d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Registry.rst @@ -0,0 +1,11 @@ +Registry +======== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Registry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistryMetadata.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistryMetadata.rst new file mode 100644 index 0000000000..270373c85c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistryMetadata.rst @@ -0,0 +1,11 @@ +RegistryMetadata +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: RegistryMetadata + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummary.rst new file mode 100644 index 0000000000..e00054468f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummary.rst @@ -0,0 +1,11 @@ +RegistrySummary +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: RegistrySummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummaryCollection.rst new file mode 100644 index 0000000000..3a3dd4d2a8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.RegistrySummaryCollection.rst @@ -0,0 +1,11 @@ +RegistrySummaryCollection +========================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: RegistrySummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Row.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Row.rst new file mode 100644 index 0000000000..3b31774942 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Row.rst @@ -0,0 +1,11 @@ +Row +=== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Row + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Schema.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Schema.rst new file mode 100644 index 0000000000..f9b164a1b2 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Schema.rst @@ -0,0 +1,11 @@ +Schema +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Schema + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaDriftConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaDriftConfig.rst new file mode 100644 index 0000000000..fb2838d45e --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaDriftConfig.rst @@ -0,0 +1,11 @@ +SchemaDriftConfig +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: SchemaDriftConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummary.rst new file mode 100644 index 0000000000..7dc1fbea82 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummary.rst @@ -0,0 +1,11 @@ +SchemaSummary +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: SchemaSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummaryCollection.rst new file mode 100644 index 0000000000..7d2584e889 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.SchemaSummaryCollection.rst @@ -0,0 +1,11 @@ +SchemaSummaryCollection +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: SchemaSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Select.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Select.rst new file mode 100644 index 0000000000..423a7e010f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Select.rst @@ -0,0 +1,11 @@ +Select +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Select + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Shape.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Shape.rst new file mode 100644 index 0000000000..8c8349e22b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Shape.rst @@ -0,0 +1,11 @@ +Shape +===== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Shape + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ShapeField.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ShapeField.rst new file mode 100644 index 0000000000..db1ad22993 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ShapeField.rst @@ -0,0 +1,11 @@ +ShapeField +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ShapeField + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Sort.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Sort.rst new file mode 100644 index 0000000000..81636962e3 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Sort.rst @@ -0,0 +1,11 @@ +Sort +==== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Sort + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.SortClause.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.SortClause.rst new file mode 100644 index 0000000000..2b9d407c98 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.SortClause.rst @@ -0,0 +1,11 @@ +SortClause +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: SortClause + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Source.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Source.rst new file mode 100644 index 0000000000..1dfcf8b355 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Source.rst @@ -0,0 +1,11 @@ +Source +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Source + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.StringAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.StringAttribute.rst new file mode 100644 index 0000000000..3394d3df25 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.StringAttribute.rst @@ -0,0 +1,11 @@ +StringAttribute +=============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: StringAttribute + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.StructuredType.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.StructuredType.rst new file mode 100644 index 0000000000..37b56da356 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.StructuredType.rst @@ -0,0 +1,11 @@ +StructuredType +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: StructuredType + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Target.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Target.rst new file mode 100644 index 0000000000..0ad820eb43 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Target.rst @@ -0,0 +1,11 @@ +Target +====== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Target + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TestNetworkConnectivity.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TestNetworkConnectivity.rst new file mode 100644 index 0000000000..ee7c65d686 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TestNetworkConnectivity.rst @@ -0,0 +1,11 @@ +TestNetworkConnectivity +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TestNetworkConnectivity + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.Type.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.Type.rst new file mode 100644 index 0000000000..c319d0359b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.Type.rst @@ -0,0 +1,11 @@ +Type +==== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: Type + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeLibrary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeLibrary.rst new file mode 100644 index 0000000000..163ca052ad --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeLibrary.rst @@ -0,0 +1,11 @@ +TypeLibrary +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TypeLibrary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSummary.rst new file mode 100644 index 0000000000..cc17d14d0c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSummary.rst @@ -0,0 +1,11 @@ +TypeSummary +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TypeSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSystem.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSystem.rst new file mode 100644 index 0000000000..61cb8d558b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypeSystem.rst @@ -0,0 +1,11 @@ +TypeSystem +========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TypeSystem + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TypedObject.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypedObject.rst new file mode 100644 index 0000000000..922741e7bd --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypedObject.rst @@ -0,0 +1,11 @@ +TypedObject +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TypedObject + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.TypesSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypesSummaryCollection.rst new file mode 100644 index 0000000000..4402073766 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.TypesSummaryCollection.rst @@ -0,0 +1,11 @@ +TypesSummaryCollection +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: TypesSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UniqueKey.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UniqueKey.rst new file mode 100644 index 0000000000..ed9a052d92 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UniqueKey.rst @@ -0,0 +1,11 @@ +UniqueKey +========= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UniqueKey + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateConnectionDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateConnectionDetails.rst new file mode 100644 index 0000000000..11c3989ef6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateConnectionDetails.rst @@ -0,0 +1,11 @@ +UpdateConnectionDetails +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateConnectionDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDataAssetDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDataAssetDetails.rst new file mode 100644 index 0000000000..9f3b90d9e7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDataAssetDetails.rst @@ -0,0 +1,11 @@ +UpdateDataAssetDetails +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateDataAssetDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointDetails.rst new file mode 100644 index 0000000000..14e9b210c6 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointDetails.rst @@ -0,0 +1,11 @@ +UpdateDpEndpointDetails +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateDpEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPrivate.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPrivate.rst new file mode 100644 index 0000000000..d28c5246c3 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPrivate.rst @@ -0,0 +1,11 @@ +UpdateDpEndpointFromPrivate +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateDpEndpointFromPrivate + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPublic.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPublic.rst new file mode 100644 index 0000000000..a482f94713 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateDpEndpointFromPublic.rst @@ -0,0 +1,11 @@ +UpdateDpEndpointFromPublic +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateDpEndpointFromPublic + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateEndpointDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateEndpointDetails.rst new file mode 100644 index 0000000000..811de7328c --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateEndpointDetails.rst @@ -0,0 +1,11 @@ +UpdateEndpointDetails +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateEndpointDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateFolderDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateFolderDetails.rst new file mode 100644 index 0000000000..35c8a3b762 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateFolderDetails.rst @@ -0,0 +1,11 @@ +UpdateFolderDetails +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateFolderDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateRegistryDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateRegistryDetails.rst new file mode 100644 index 0000000000..ffe4169c4b --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.UpdateRegistryDetails.rst @@ -0,0 +1,11 @@ +UpdateRegistryDetails +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: UpdateRegistryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationMessage.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationMessage.rst new file mode 100644 index 0000000000..a6db3a4637 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationMessage.rst @@ -0,0 +1,11 @@ +ValidationMessage +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ValidationMessage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationResult.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationResult.rst new file mode 100644 index 0000000000..d2d9117a1f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ValidationResult.rst @@ -0,0 +1,11 @@ +ValidationResult +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ValidationResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequest.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequest.rst new file mode 100644 index 0000000000..2b0f9888d7 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequest.rst @@ -0,0 +1,11 @@ +WorkRequest +=========== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequest + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestError.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestError.rst new file mode 100644 index 0000000000..d8eb53b953 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestError.rst @@ -0,0 +1,11 @@ +WorkRequestError +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestError + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorCollection.rst new file mode 100644 index 0000000000..794ab8ac29 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorCollection.rst @@ -0,0 +1,11 @@ +WorkRequestErrorCollection +========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestErrorCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorSummary.rst new file mode 100644 index 0000000000..881f5dbfba --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestErrorSummary.rst @@ -0,0 +1,11 @@ +WorkRequestErrorSummary +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestErrorSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLog.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLog.rst new file mode 100644 index 0000000000..67a60898c5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLog.rst @@ -0,0 +1,11 @@ +WorkRequestLog +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestLog + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLogCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLogCollection.rst new file mode 100644 index 0000000000..219d004cf0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestLogCollection.rst @@ -0,0 +1,11 @@ +WorkRequestLogCollection +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestLogCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestResource.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestResource.rst new file mode 100644 index 0000000000..72a4cdf11f --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestResource.rst @@ -0,0 +1,11 @@ +WorkRequestResource +=================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestResource + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummary.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummary.rst new file mode 100644 index 0000000000..9f50472014 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummary.rst @@ -0,0 +1,11 @@ +WorkRequestSummary +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummaryCollection.rst new file mode 100644 index 0000000000..bb43594230 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WorkRequestSummaryCollection.rst @@ -0,0 +1,11 @@ +WorkRequestSummaryCollection +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WorkRequestSummaryCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.WriteOperationConfig.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.WriteOperationConfig.rst new file mode 100644 index 0000000000..1050bba507 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.WriteOperationConfig.rst @@ -0,0 +1,11 @@ +WriteOperationConfig +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: WriteOperationConfig + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst index 145ea17baf..321179cdc7 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -5,6 +5,7 @@ API Reference * :doc:`Anomaly Detection ` * :doc:`Ai Service Language ` +* :doc:`Ai Service Speech ` * :doc:`Ai Service Vision ` * :doc:`Analytics ` * :doc:`Announcement ` @@ -44,6 +45,8 @@ API Reference * :doc:`Dashboard ` * :doc:`Dashboard Group ` * :doc:`Data Catalog ` +* :doc:`Data Connectivity Management ` +* :doc:`Network Validation ` * :doc:`Data Flow ` * :doc:`Data Integration ` * :doc:`Data Labeling Management ` @@ -173,6 +176,7 @@ API Reference ai_anomaly_detection ai_language + ai_speech ai_vision analytics announcements_service @@ -199,6 +203,7 @@ API Reference core dashboard_service data_catalog + data_connectivity data_flow data_integration data_labeling_service diff --git a/src/oci/__init__.py b/src/oci/__init__.py index e7c1632133..bd75b09a5c 100644 --- a/src/oci/__init__.py +++ b/src/oci/__init__.py @@ -16,9 +16,9 @@ if os.getenv("OCI_PYTHON_SDK_NO_SERVICE_IMPORTS", "").lower() in ["true", "1"]: pass else: - from . import ai_anomaly_detection, ai_language, ai_vision, analytics, announcements_service, apigateway, apm_config, apm_control_plane, apm_synthetics, apm_traces, application_migration, appmgmt_control, artifacts, audit, autoscaling, bastion, bds, blockchain, budget, certificates, certificates_management, cims, cloud_guard, compute_instance_agent, container_engine, core, dashboard_service, data_catalog, data_flow, data_integration, data_labeling_service, data_labeling_service_dataplane, data_safe, data_science, database, database_management, database_migration, database_tools, devops, dns, dts, email, events, file_storage, functions, generic_artifacts_content, golden_gate, healthchecks, identity, identity_data_plane, integration, jms, key_management, limits, load_balancer, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, monitoring, mysql, network_load_balancer, nosql, object_storage, oce, ocvp, oda, ons, operator_access_control, opsi, optimizer, os_management, osp_gateway, osub_billing_schedule, osub_organization_subscription, osub_subscription, osub_usage, resource_manager, resource_search, rover, sch, secrets, service_catalog, service_manager_proxy, streaming, tenant_manager_control_plane, threat_intelligence, usage, usage_api, vault, visual_builder, vulnerability_scanning, waas, waf, work_requests + from . import ai_anomaly_detection, ai_language, ai_speech, ai_vision, analytics, announcements_service, apigateway, apm_config, apm_control_plane, apm_synthetics, apm_traces, application_migration, appmgmt_control, artifacts, audit, autoscaling, bastion, bds, blockchain, budget, certificates, certificates_management, cims, cloud_guard, compute_instance_agent, container_engine, core, dashboard_service, data_catalog, data_connectivity, data_flow, data_integration, data_labeling_service, data_labeling_service_dataplane, data_safe, data_science, database, database_management, database_migration, database_tools, devops, dns, dts, email, events, file_storage, functions, generic_artifacts_content, golden_gate, healthchecks, identity, identity_data_plane, integration, jms, key_management, limits, load_balancer, log_analytics, logging, loggingingestion, loggingsearch, management_agent, management_dashboard, marketplace, monitoring, mysql, network_load_balancer, nosql, object_storage, oce, ocvp, oda, ons, operator_access_control, opsi, optimizer, os_management, osp_gateway, osub_billing_schedule, osub_organization_subscription, osub_subscription, osub_usage, resource_manager, resource_search, rover, sch, secrets, service_catalog, service_manager_proxy, streaming, tenant_manager_control_plane, threat_intelligence, usage, usage_api, vault, visual_builder, vulnerability_scanning, waas, waf, work_requests __all__ = [ "BaseClient", "Error", "Request", "Response", "Signer", "config", "constants", "decorators", "exceptions", "regions", "wait_until", "pagination", "auth", "retry", "fips", "circuit_breaker", - "ai_anomaly_detection", "ai_language", "ai_vision", "analytics", "announcements_service", "apigateway", "apm_config", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "appmgmt_control", "artifacts", "audit", "autoscaling", "bastion", "bds", "blockchain", "budget", "certificates", "certificates_management", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "dashboard_service", "data_catalog", "data_flow", "data_integration", "data_labeling_service", "data_labeling_service_dataplane", "data_safe", "data_science", "database", "database_management", "database_migration", "database_tools", "devops", "dns", "dts", "email", "events", "file_storage", "functions", "generic_artifacts_content", "golden_gate", "healthchecks", "identity", "identity_data_plane", "integration", "jms", "key_management", "limits", "load_balancer", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "monitoring", "mysql", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "ons", "operator_access_control", "opsi", "optimizer", "os_management", "osp_gateway", "osub_billing_schedule", "osub_organization_subscription", "osub_subscription", "osub_usage", "resource_manager", "resource_search", "rover", "sch", "secrets", "service_catalog", "service_manager_proxy", "streaming", "tenant_manager_control_plane", "threat_intelligence", "usage", "usage_api", "vault", "visual_builder", "vulnerability_scanning", "waas", "waf", "work_requests" + "ai_anomaly_detection", "ai_language", "ai_speech", "ai_vision", "analytics", "announcements_service", "apigateway", "apm_config", "apm_control_plane", "apm_synthetics", "apm_traces", "application_migration", "appmgmt_control", "artifacts", "audit", "autoscaling", "bastion", "bds", "blockchain", "budget", "certificates", "certificates_management", "cims", "cloud_guard", "compute_instance_agent", "container_engine", "core", "dashboard_service", "data_catalog", "data_connectivity", "data_flow", "data_integration", "data_labeling_service", "data_labeling_service_dataplane", "data_safe", "data_science", "database", "database_management", "database_migration", "database_tools", "devops", "dns", "dts", "email", "events", "file_storage", "functions", "generic_artifacts_content", "golden_gate", "healthchecks", "identity", "identity_data_plane", "integration", "jms", "key_management", "limits", "load_balancer", "log_analytics", "logging", "loggingingestion", "loggingsearch", "management_agent", "management_dashboard", "marketplace", "monitoring", "mysql", "network_load_balancer", "nosql", "object_storage", "oce", "ocvp", "oda", "ons", "operator_access_control", "opsi", "optimizer", "os_management", "osp_gateway", "osub_billing_schedule", "osub_organization_subscription", "osub_subscription", "osub_usage", "resource_manager", "resource_search", "rover", "sch", "secrets", "service_catalog", "service_manager_proxy", "streaming", "tenant_manager_control_plane", "threat_intelligence", "usage", "usage_api", "vault", "visual_builder", "vulnerability_scanning", "waas", "waf", "work_requests" ] diff --git a/src/oci/ai_speech/__init__.py b/src/oci/ai_speech/__init__.py new file mode 100644 index 0000000000..d901be5f6a --- /dev/null +++ b/src/oci/ai_speech/__init__.py @@ -0,0 +1,12 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .ai_service_speech_client import AIServiceSpeechClient +from .ai_service_speech_client_composite_operations import AIServiceSpeechClientCompositeOperations +from . import models + +__all__ = ["AIServiceSpeechClient", "AIServiceSpeechClientCompositeOperations", "models"] diff --git a/src/oci/ai_speech/ai_service_speech_client.py b/src/oci/ai_speech/ai_service_speech_client.py new file mode 100644 index 0000000000..a4066a4801 --- /dev/null +++ b/src/oci/ai_speech/ai_service_speech_client.py @@ -0,0 +1,1065 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import ai_speech_type_mapping +missing = Sentinel("Missing") + + +class AIServiceSpeechClient(object): + """ + The OCI Speech Service harnesses the power of spoken language by allowing developers to easily convert file-based data containing human speech into highly accurate text transcriptions. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20220101', + 'service_endpoint_template': 'https://speech.aiservice.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("ai_service_speech", config, signer, ai_speech_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def cancel_transcription_job(self, transcription_job_id, **kwargs): + """ + Canceling the job cancels all the tasks under it. + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use cancel_transcription_job API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}/actions/cancel" + method = "POST" + + # 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( + "cancel_transcription_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "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) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def cancel_transcription_task(self, transcription_job_id, transcription_task_id, **kwargs): + """ + Cancel Transcription Task + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param str transcription_task_id: (required) + Unique Transcription Task identifier. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use cancel_transcription_task API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}/transcriptionTasks/{transcriptionTaskId}/actions/cancel" + method = "POST" + + # 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( + "cancel_transcription_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id, + "transcriptionTaskId": transcription_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def change_transcription_job_compartment(self, transcription_job_id, change_transcription_job_compartment_details, **kwargs): + """ + Moves a transcription Job resource into a different compartment. + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param oci.ai_speech.models.ChangeTranscriptionJobCompartmentDetails change_transcription_job_compartment_details: (required) + Details for changing the compartment of a transcription Job. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_transcription_job_compartment API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}/actions/changeCompartment" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_transcription_job_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_transcription_job_compartment_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_transcription_job_compartment_details) + + def create_transcription_job(self, create_transcription_job_details, **kwargs): + """ + Creates a new Transcription Job. + + + :param oci.ai_speech.models.CreateTranscriptionJobDetails create_transcription_job_details: (required) + Details for the new Transcription Job. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_speech.models.TranscriptionJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_transcription_job API. + """ + resource_path = "/transcriptionJobs" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_transcription_job got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_transcription_job_details, + response_type="TranscriptionJob") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_transcription_job_details, + response_type="TranscriptionJob") + + def get_transcription_job(self, transcription_job_id, **kwargs): + """ + Gets a Transcription Job by identifier + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_speech.models.TranscriptionJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_transcription_job API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_transcription_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="TranscriptionJob") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="TranscriptionJob") + + def get_transcription_task(self, transcription_job_id, transcription_task_id, **kwargs): + """ + Gets a Transcription Task by identifier + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param str transcription_task_id: (required) + Unique Transcription Task identifier. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_speech.models.TranscriptionTask` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_transcription_task API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}/transcriptionTasks/{transcriptionTaskId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_transcription_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id, + "transcriptionTaskId": transcription_task_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + 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="TranscriptionTask") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="TranscriptionTask") + + def list_transcription_jobs(self, **kwargs): + """ + Returns a list of Transcription Jobs. + + + :param str compartment_id: (optional) + The ID of the compartment in which to list resources. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELING", "CANCELED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str id: (optional) + Unique identifier(OCID). + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_speech.models.TranscriptionJobCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_transcription_jobs API. + """ + resource_path = "/transcriptionJobs" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id", + "lifecycle_state", + "display_name", + "id", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_transcription_jobs got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELING", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": kwargs.get("compartment_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "id": kwargs.get("id", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TranscriptionJobCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TranscriptionJobCollection") + + def list_transcription_tasks(self, transcription_job_id, **kwargs): + """ + Returns a list of Transcription Tasks. + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param str lifecycle_state: (optional) + A filter to return only resources whose lifecycleState matches the given lifecycleState. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED" + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str id: (optional) + Unique identifier(OCID). + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.ai_speech.models.TranscriptionTaskCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_transcription_tasks API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}/transcriptionTasks" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "lifecycle_state", + "display_name", + "id", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_transcription_tasks got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "lifecycleState": kwargs.get("lifecycle_state", missing), + "displayName": kwargs.get("display_name", missing), + "id": kwargs.get("id", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="TranscriptionTaskCollection") + 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="TranscriptionTaskCollection") + + def update_transcription_job(self, transcription_job_id, update_transcription_job_details, **kwargs): + """ + Updates the Transcription Job + + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param oci.ai_speech.models.UpdateTranscriptionJobDetails update_transcription_job_details: (required) + The information to be updated. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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_speech.models.TranscriptionJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_transcription_job API. + """ + resource_path = "/transcriptionJobs/{transcriptionJobId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_transcription_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "transcriptionJobId": transcription_job_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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_transcription_job_details, + response_type="TranscriptionJob") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_transcription_job_details, + response_type="TranscriptionJob") diff --git a/src/oci/ai_speech/ai_service_speech_client_composite_operations.py b/src/oci/ai_speech/ai_service_speech_client_composite_operations.py new file mode 100644 index 0000000000..1f84613446 --- /dev/null +++ b/src/oci/ai_speech/ai_service_speech_client_composite_operations.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class AIServiceSpeechClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.ai_speech.AIServiceSpeechClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new AIServiceSpeechClientCompositeOperations object + + :param AIServiceSpeechClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def create_transcription_job_and_wait_for_state(self, create_transcription_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.ai_speech.AIServiceSpeechClient.create_transcription_job` and waits for the :py:class:`~oci.ai_speech.models.TranscriptionJob` acted upon + to enter the given state(s). + + :param oci.ai_speech.models.CreateTranscriptionJobDetails create_transcription_job_details: (required) + Details for the new Transcription Job. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.ai_speech.models.TranscriptionJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.ai_speech.AIServiceSpeechClient.create_transcription_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_transcription_job(create_transcription_job_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_transcription_job(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_transcription_job_and_wait_for_state(self, transcription_job_id, update_transcription_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.ai_speech.AIServiceSpeechClient.update_transcription_job` and waits for the :py:class:`~oci.ai_speech.models.TranscriptionJob` acted upon + to enter the given state(s). + + :param str transcription_job_id: (required) + Unique Transcription Job identifier. + + :param oci.ai_speech.models.UpdateTranscriptionJobDetails update_transcription_job_details: (required) + The information to be updated. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.ai_speech.models.TranscriptionJob.lifecycle_state` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.ai_speech.AIServiceSpeechClient.update_transcription_job` + + :param dict waiter_kwargs: + A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds`` + as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait + """ + operation_result = self.client.update_transcription_job(transcription_job_id, update_transcription_job_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.data.id + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_transcription_job(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/ai_speech/models/__init__.py b/src/oci/ai_speech/models/__init__.py new file mode 100644 index 0000000000..57528a4d34 --- /dev/null +++ b/src/oci/ai_speech/models/__init__.py @@ -0,0 +1,48 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .audio_format_details import AudioFormatDetails +from .change_transcription_job_compartment_details import ChangeTranscriptionJobCompartmentDetails +from .create_transcription_job_details import CreateTranscriptionJobDetails +from .input_location import InputLocation +from .object_list_file_input_location import ObjectListFileInputLocation +from .object_list_inline_input_location import ObjectListInlineInputLocation +from .object_location import ObjectLocation +from .output_location import OutputLocation +from .profanity_transcription_filter import ProfanityTranscriptionFilter +from .transcription_filter import TranscriptionFilter +from .transcription_job import TranscriptionJob +from .transcription_job_collection import TranscriptionJobCollection +from .transcription_job_summary import TranscriptionJobSummary +from .transcription_model_details import TranscriptionModelDetails +from .transcription_normalization import TranscriptionNormalization +from .transcription_task import TranscriptionTask +from .transcription_task_collection import TranscriptionTaskCollection +from .transcription_task_summary import TranscriptionTaskSummary +from .update_transcription_job_details import UpdateTranscriptionJobDetails + +# Maps type names to classes for ai_speech services. +ai_speech_type_mapping = { + "AudioFormatDetails": AudioFormatDetails, + "ChangeTranscriptionJobCompartmentDetails": ChangeTranscriptionJobCompartmentDetails, + "CreateTranscriptionJobDetails": CreateTranscriptionJobDetails, + "InputLocation": InputLocation, + "ObjectListFileInputLocation": ObjectListFileInputLocation, + "ObjectListInlineInputLocation": ObjectListInlineInputLocation, + "ObjectLocation": ObjectLocation, + "OutputLocation": OutputLocation, + "ProfanityTranscriptionFilter": ProfanityTranscriptionFilter, + "TranscriptionFilter": TranscriptionFilter, + "TranscriptionJob": TranscriptionJob, + "TranscriptionJobCollection": TranscriptionJobCollection, + "TranscriptionJobSummary": TranscriptionJobSummary, + "TranscriptionModelDetails": TranscriptionModelDetails, + "TranscriptionNormalization": TranscriptionNormalization, + "TranscriptionTask": TranscriptionTask, + "TranscriptionTaskCollection": TranscriptionTaskCollection, + "TranscriptionTaskSummary": TranscriptionTaskSummary, + "UpdateTranscriptionJobDetails": UpdateTranscriptionJobDetails +} diff --git a/src/oci/ai_speech/models/audio_format_details.py b/src/oci/ai_speech/models/audio_format_details.py new file mode 100644 index 0000000000..12f2db28c6 --- /dev/null +++ b/src/oci/ai_speech/models/audio_format_details.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AudioFormatDetails(object): + """ + Audio format details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AudioFormatDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param format: + The value to assign to the format property of this AudioFormatDetails. + :type format: str + + :param number_of_channels: + The value to assign to the number_of_channels property of this AudioFormatDetails. + :type number_of_channels: int + + :param encoding: + The value to assign to the encoding property of this AudioFormatDetails. + :type encoding: str + + :param sample_rate_in_hz: + The value to assign to the sample_rate_in_hz property of this AudioFormatDetails. + :type sample_rate_in_hz: int + + """ + self.swagger_types = { + 'format': 'str', + 'number_of_channels': 'int', + 'encoding': 'str', + 'sample_rate_in_hz': 'int' + } + + self.attribute_map = { + 'format': 'format', + 'number_of_channels': 'numberOfChannels', + 'encoding': 'encoding', + 'sample_rate_in_hz': 'sampleRateInHz' + } + + self._format = None + self._number_of_channels = None + self._encoding = None + self._sample_rate_in_hz = None + + @property + def format(self): + """ + Gets the format of this AudioFormatDetails. + Input file format. Example - WAV. + + + :return: The format of this AudioFormatDetails. + :rtype: str + """ + return self._format + + @format.setter + def format(self, format): + """ + Sets the format of this AudioFormatDetails. + Input file format. Example - WAV. + + + :param format: The format of this AudioFormatDetails. + :type: str + """ + self._format = format + + @property + def number_of_channels(self): + """ + Gets the number_of_channels of this AudioFormatDetails. + Input file number of channels. + + + :return: The number_of_channels of this AudioFormatDetails. + :rtype: int + """ + return self._number_of_channels + + @number_of_channels.setter + def number_of_channels(self, number_of_channels): + """ + Sets the number_of_channels of this AudioFormatDetails. + Input file number of channels. + + + :param number_of_channels: The number_of_channels of this AudioFormatDetails. + :type: int + """ + self._number_of_channels = number_of_channels + + @property + def encoding(self): + """ + Gets the encoding of this AudioFormatDetails. + Input file encoding. Example - PCM. + + + :return: The encoding of this AudioFormatDetails. + :rtype: str + """ + return self._encoding + + @encoding.setter + def encoding(self, encoding): + """ + Sets the encoding of this AudioFormatDetails. + Input file encoding. Example - PCM. + + + :param encoding: The encoding of this AudioFormatDetails. + :type: str + """ + self._encoding = encoding + + @property + def sample_rate_in_hz(self): + """ + Gets the sample_rate_in_hz of this AudioFormatDetails. + Input file sampleRate. Example - 16000 + + + :return: The sample_rate_in_hz of this AudioFormatDetails. + :rtype: int + """ + return self._sample_rate_in_hz + + @sample_rate_in_hz.setter + def sample_rate_in_hz(self, sample_rate_in_hz): + """ + Sets the sample_rate_in_hz of this AudioFormatDetails. + Input file sampleRate. Example - 16000 + + + :param sample_rate_in_hz: The sample_rate_in_hz of this AudioFormatDetails. + :type: int + """ + self._sample_rate_in_hz = sample_rate_in_hz + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/change_transcription_job_compartment_details.py b/src/oci/ai_speech/models/change_transcription_job_compartment_details.py new file mode 100644 index 0000000000..29f036b139 --- /dev/null +++ b/src/oci/ai_speech/models/change_transcription_job_compartment_details.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeTranscriptionJobCompartmentDetails(object): + """ + Details for changing the compartment of a transcription job. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeTranscriptionJobCompartmentDetails 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 ChangeTranscriptionJobCompartmentDetails. + :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 ChangeTranscriptionJobCompartmentDetails. + The `OCID`__ of the compartment + where the resource should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The compartment_id of this ChangeTranscriptionJobCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeTranscriptionJobCompartmentDetails. + The `OCID`__ of the compartment + where the resource should be moved. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param compartment_id: The compartment_id of this ChangeTranscriptionJobCompartmentDetails. + :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/ai_speech/models/create_transcription_job_details.py b/src/oci/ai_speech/models/create_transcription_job_details.py new file mode 100644 index 0000000000..d531d2666a --- /dev/null +++ b/src/oci/ai_speech/models/create_transcription_job_details.py @@ -0,0 +1,306 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateTranscriptionJobDetails(object): + """ + The information about new Transcription Job. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateTranscriptionJobDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this CreateTranscriptionJobDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateTranscriptionJobDetails. + :type compartment_id: str + + :param description: + The value to assign to the description property of this CreateTranscriptionJobDetails. + :type description: str + + :param model_details: + The value to assign to the model_details property of this CreateTranscriptionJobDetails. + :type model_details: oci.ai_speech.models.TranscriptionModelDetails + + :param normalization: + The value to assign to the normalization property of this CreateTranscriptionJobDetails. + :type normalization: oci.ai_speech.models.TranscriptionNormalization + + :param input_location: + The value to assign to the input_location property of this CreateTranscriptionJobDetails. + :type input_location: oci.ai_speech.models.InputLocation + + :param output_location: + The value to assign to the output_location property of this CreateTranscriptionJobDetails. + :type output_location: oci.ai_speech.models.OutputLocation + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateTranscriptionJobDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateTranscriptionJobDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'compartment_id': 'str', + 'description': 'str', + 'model_details': 'TranscriptionModelDetails', + 'normalization': 'TranscriptionNormalization', + 'input_location': 'InputLocation', + 'output_location': 'OutputLocation', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'description': 'description', + 'model_details': 'modelDetails', + 'normalization': 'normalization', + 'input_location': 'inputLocation', + 'output_location': 'outputLocation', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._compartment_id = None + self._description = None + self._model_details = None + self._normalization = None + self._input_location = None + self._output_location = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this CreateTranscriptionJobDetails. + Transcription job name. + + + :return: The display_name of this CreateTranscriptionJobDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateTranscriptionJobDetails. + Transcription job name. + + + :param display_name: The display_name of this CreateTranscriptionJobDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this CreateTranscriptionJobDetails. + The OCID of the compartment that contains the transcriptionJob. + + + :return: The compartment_id of this CreateTranscriptionJobDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateTranscriptionJobDetails. + The OCID of the compartment that contains the transcriptionJob. + + + :param compartment_id: The compartment_id of this CreateTranscriptionJobDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def description(self): + """ + Gets the description of this CreateTranscriptionJobDetails. + Transcription job description. + + + :return: The description of this CreateTranscriptionJobDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateTranscriptionJobDetails. + Transcription job description. + + + :param description: The description of this CreateTranscriptionJobDetails. + :type: str + """ + self._description = description + + @property + def model_details(self): + """ + Gets the model_details of this CreateTranscriptionJobDetails. + + :return: The model_details of this CreateTranscriptionJobDetails. + :rtype: oci.ai_speech.models.TranscriptionModelDetails + """ + return self._model_details + + @model_details.setter + def model_details(self, model_details): + """ + Sets the model_details of this CreateTranscriptionJobDetails. + + :param model_details: The model_details of this CreateTranscriptionJobDetails. + :type: oci.ai_speech.models.TranscriptionModelDetails + """ + self._model_details = model_details + + @property + def normalization(self): + """ + Gets the normalization of this CreateTranscriptionJobDetails. + + :return: The normalization of this CreateTranscriptionJobDetails. + :rtype: oci.ai_speech.models.TranscriptionNormalization + """ + return self._normalization + + @normalization.setter + def normalization(self, normalization): + """ + Sets the normalization of this CreateTranscriptionJobDetails. + + :param normalization: The normalization of this CreateTranscriptionJobDetails. + :type: oci.ai_speech.models.TranscriptionNormalization + """ + self._normalization = normalization + + @property + def input_location(self): + """ + **[Required]** Gets the input_location of this CreateTranscriptionJobDetails. + + :return: The input_location of this CreateTranscriptionJobDetails. + :rtype: oci.ai_speech.models.InputLocation + """ + return self._input_location + + @input_location.setter + def input_location(self, input_location): + """ + Sets the input_location of this CreateTranscriptionJobDetails. + + :param input_location: The input_location of this CreateTranscriptionJobDetails. + :type: oci.ai_speech.models.InputLocation + """ + self._input_location = input_location + + @property + def output_location(self): + """ + **[Required]** Gets the output_location of this CreateTranscriptionJobDetails. + + :return: The output_location of this CreateTranscriptionJobDetails. + :rtype: oci.ai_speech.models.OutputLocation + """ + return self._output_location + + @output_location.setter + def output_location(self, output_location): + """ + Sets the output_location of this CreateTranscriptionJobDetails. + + :param output_location: The output_location of this CreateTranscriptionJobDetails. + :type: oci.ai_speech.models.OutputLocation + """ + self._output_location = output_location + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateTranscriptionJobDetails. + 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 CreateTranscriptionJobDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateTranscriptionJobDetails. + 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 CreateTranscriptionJobDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateTranscriptionJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateTranscriptionJobDetails. + :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 CreateTranscriptionJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateTranscriptionJobDetails. + :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_speech/models/input_location.py b/src/oci/ai_speech/models/input_location.py new file mode 100644 index 0000000000..96d37f4436 --- /dev/null +++ b/src/oci/ai_speech/models/input_location.py @@ -0,0 +1,113 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class InputLocation(object): + """ + The location of the input(s). + """ + + #: A constant which can be used with the location_type property of a InputLocation. + #: This constant has a value of "OBJECT_LIST_INLINE_INPUT_LOCATION" + LOCATION_TYPE_OBJECT_LIST_INLINE_INPUT_LOCATION = "OBJECT_LIST_INLINE_INPUT_LOCATION" + + #: A constant which can be used with the location_type property of a InputLocation. + #: This constant has a value of "OBJECT_LIST_FILE_INPUT_LOCATION" + LOCATION_TYPE_OBJECT_LIST_FILE_INPUT_LOCATION = "OBJECT_LIST_FILE_INPUT_LOCATION" + + def __init__(self, **kwargs): + """ + Initializes a new InputLocation 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_speech.models.ObjectListFileInputLocation` + * :class:`~oci.ai_speech.models.ObjectListInlineInputLocation` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param location_type: + The value to assign to the location_type property of this InputLocation. + Allowed values for this property are: "OBJECT_LIST_INLINE_INPUT_LOCATION", "OBJECT_LIST_FILE_INPUT_LOCATION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type location_type: str + + """ + self.swagger_types = { + 'location_type': 'str' + } + + self.attribute_map = { + 'location_type': 'locationType' + } + + self._location_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['locationType'] + + if type == 'OBJECT_LIST_FILE_INPUT_LOCATION': + return 'ObjectListFileInputLocation' + + if type == 'OBJECT_LIST_INLINE_INPUT_LOCATION': + return 'ObjectListInlineInputLocation' + else: + return 'InputLocation' + + @property + def location_type(self): + """ + **[Required]** Gets the location_type of this InputLocation. + The type of input location. + Allowed values are: + - `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object Storage. + - `OBJECT_LIST_FILE_INPUT_LOCATION`: An object in Object Storage that contains a list of input files. + + Allowed values for this property are: "OBJECT_LIST_INLINE_INPUT_LOCATION", "OBJECT_LIST_FILE_INPUT_LOCATION", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The location_type of this InputLocation. + :rtype: str + """ + return self._location_type + + @location_type.setter + def location_type(self, location_type): + """ + Sets the location_type of this InputLocation. + The type of input location. + Allowed values are: + - `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object Storage. + - `OBJECT_LIST_FILE_INPUT_LOCATION`: An object in Object Storage that contains a list of input files. + + + :param location_type: The location_type of this InputLocation. + :type: str + """ + allowed_values = ["OBJECT_LIST_INLINE_INPUT_LOCATION", "OBJECT_LIST_FILE_INPUT_LOCATION"] + if not value_allowed_none_or_none_sentinel(location_type, allowed_values): + location_type = 'UNKNOWN_ENUM_VALUE' + self._location_type = location_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_speech/models/object_list_file_input_location.py b/src/oci/ai_speech/models/object_list_file_input_location.py new file mode 100644 index 0000000000..3a2d03f283 --- /dev/null +++ b/src/oci/ai_speech/models/object_list_file_input_location.py @@ -0,0 +1,76 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .input_location import InputLocation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectListFileInputLocation(InputLocation): + """ + An object in Object Storage that contains a list of input files. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectListFileInputLocation object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.ObjectListFileInputLocation.location_type` attribute + of this class is ``OBJECT_LIST_FILE_INPUT_LOCATION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param location_type: + The value to assign to the location_type property of this ObjectListFileInputLocation. + Allowed values for this property are: "OBJECT_LIST_INLINE_INPUT_LOCATION", "OBJECT_LIST_FILE_INPUT_LOCATION" + :type location_type: str + + :param object_location: + The value to assign to the object_location property of this ObjectListFileInputLocation. + :type object_location: oci.ai_speech.models.ObjectLocation + + """ + self.swagger_types = { + 'location_type': 'str', + 'object_location': 'ObjectLocation' + } + + self.attribute_map = { + 'location_type': 'locationType', + 'object_location': 'objectLocation' + } + + self._location_type = None + self._object_location = None + self._location_type = 'OBJECT_LIST_FILE_INPUT_LOCATION' + + @property + def object_location(self): + """ + **[Required]** Gets the object_location of this ObjectListFileInputLocation. + + :return: The object_location of this ObjectListFileInputLocation. + :rtype: oci.ai_speech.models.ObjectLocation + """ + return self._object_location + + @object_location.setter + def object_location(self, object_location): + """ + Sets the object_location of this ObjectListFileInputLocation. + + :param object_location: The object_location of this ObjectListFileInputLocation. + :type: oci.ai_speech.models.ObjectLocation + """ + self._object_location = object_location + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/object_list_inline_input_location.py b/src/oci/ai_speech/models/object_list_inline_input_location.py new file mode 100644 index 0000000000..dceba57754 --- /dev/null +++ b/src/oci/ai_speech/models/object_list_inline_input_location.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .input_location import InputLocation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectListInlineInputLocation(InputLocation): + """ + A list of object locations in Object Storage. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectListInlineInputLocation object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.ObjectListInlineInputLocation.location_type` attribute + of this class is ``OBJECT_LIST_INLINE_INPUT_LOCATION`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param location_type: + The value to assign to the location_type property of this ObjectListInlineInputLocation. + Allowed values for this property are: "OBJECT_LIST_INLINE_INPUT_LOCATION", "OBJECT_LIST_FILE_INPUT_LOCATION" + :type location_type: str + + :param object_locations: + The value to assign to the object_locations property of this ObjectListInlineInputLocation. + :type object_locations: list[oci.ai_speech.models.ObjectLocation] + + """ + self.swagger_types = { + 'location_type': 'str', + 'object_locations': 'list[ObjectLocation]' + } + + self.attribute_map = { + 'location_type': 'locationType', + 'object_locations': 'objectLocations' + } + + self._location_type = None + self._object_locations = None + self._location_type = 'OBJECT_LIST_INLINE_INPUT_LOCATION' + + @property + def object_locations(self): + """ + **[Required]** Gets the object_locations of this ObjectListInlineInputLocation. + A list of ObjectLocations. + + + :return: The object_locations of this ObjectListInlineInputLocation. + :rtype: list[oci.ai_speech.models.ObjectLocation] + """ + return self._object_locations + + @object_locations.setter + def object_locations(self, object_locations): + """ + Sets the object_locations of this ObjectListInlineInputLocation. + A list of ObjectLocations. + + + :param object_locations: The object_locations of this ObjectListInlineInputLocation. + :type: list[oci.ai_speech.models.ObjectLocation] + """ + self._object_locations = object_locations + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/object_location.py b/src/oci/ai_speech/models/object_location.py new file mode 100644 index 0000000000..f5e7fca740 --- /dev/null +++ b/src/oci/ai_speech/models/object_location.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectLocation(object): + """ + A location in Object Storage that is uniquely identified by namespace name, bucket name and object name. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectLocation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param namespace_name: + The value to assign to the namespace_name property of this ObjectLocation. + :type namespace_name: str + + :param bucket_name: + The value to assign to the bucket_name property of this ObjectLocation. + :type bucket_name: str + + :param object_names: + The value to assign to the object_names property of this ObjectLocation. + :type object_names: list[str] + + """ + self.swagger_types = { + 'namespace_name': 'str', + 'bucket_name': 'str', + 'object_names': 'list[str]' + } + + self.attribute_map = { + 'namespace_name': 'namespaceName', + 'bucket_name': 'bucketName', + 'object_names': 'objectNames' + } + + self._namespace_name = None + self._bucket_name = None + self._object_names = None + + @property + def namespace_name(self): + """ + **[Required]** Gets the namespace_name of this ObjectLocation. + Object Storage namespace name. + + + :return: The namespace_name of this ObjectLocation. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this ObjectLocation. + Object Storage namespace name. + + + :param namespace_name: The namespace_name of this ObjectLocation. + :type: str + """ + self._namespace_name = namespace_name + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this ObjectLocation. + Object Storage bucket name. + + + :return: The bucket_name of this ObjectLocation. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ObjectLocation. + Object Storage bucket name. + + + :param bucket_name: The bucket_name of this ObjectLocation. + :type: str + """ + self._bucket_name = bucket_name + + @property + def object_names(self): + """ + **[Required]** Gets the object_names of this ObjectLocation. + Object Storage object names. + + + :return: The object_names of this ObjectLocation. + :rtype: list[str] + """ + return self._object_names + + @object_names.setter + def object_names(self, object_names): + """ + Sets the object_names of this ObjectLocation. + Object Storage object names. + + + :param object_names: The object_names of this ObjectLocation. + :type: list[str] + """ + self._object_names = object_names + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/output_location.py b/src/oci/ai_speech/models/output_location.py new file mode 100644 index 0000000000..aadfd10771 --- /dev/null +++ b/src/oci/ai_speech/models/output_location.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OutputLocation(object): + """ + OCI Object Storage Location. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OutputLocation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param namespace_name: + The value to assign to the namespace_name property of this OutputLocation. + :type namespace_name: str + + :param bucket_name: + The value to assign to the bucket_name property of this OutputLocation. + :type bucket_name: str + + :param prefix: + The value to assign to the prefix property of this OutputLocation. + :type prefix: str + + """ + self.swagger_types = { + 'namespace_name': 'str', + 'bucket_name': 'str', + 'prefix': 'str' + } + + self.attribute_map = { + 'namespace_name': 'namespaceName', + 'bucket_name': 'bucketName', + 'prefix': 'prefix' + } + + self._namespace_name = None + self._bucket_name = None + self._prefix = None + + @property + def namespace_name(self): + """ + **[Required]** Gets the namespace_name of this OutputLocation. + Object Storage namespace. + + + :return: The namespace_name of this OutputLocation. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this OutputLocation. + Object Storage namespace. + + + :param namespace_name: The namespace_name of this OutputLocation. + :type: str + """ + self._namespace_name = namespace_name + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this OutputLocation. + Object Storage bucket name. + + + :return: The bucket_name of this OutputLocation. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this OutputLocation. + Object Storage bucket name. + + + :param bucket_name: The bucket_name of this OutputLocation. + :type: str + """ + self._bucket_name = bucket_name + + @property + def prefix(self): + """ + **[Required]** Gets the prefix of this OutputLocation. + Object Storage folder name. + + + :return: The prefix of this OutputLocation. + :rtype: str + """ + return self._prefix + + @prefix.setter + def prefix(self, prefix): + """ + Sets the prefix of this OutputLocation. + Object Storage folder name. + + + :param prefix: The prefix of this OutputLocation. + :type: str + """ + self._prefix = prefix + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/profanity_transcription_filter.py b/src/oci/ai_speech/models/profanity_transcription_filter.py new file mode 100644 index 0000000000..8e20c47658 --- /dev/null +++ b/src/oci/ai_speech/models/profanity_transcription_filter.py @@ -0,0 +1,109 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .transcription_filter import TranscriptionFilter +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProfanityTranscriptionFilter(TranscriptionFilter): + """ + Profanity transcription filter. + """ + + #: A constant which can be used with the mode property of a ProfanityTranscriptionFilter. + #: This constant has a value of "MASK" + MODE_MASK = "MASK" + + #: A constant which can be used with the mode property of a ProfanityTranscriptionFilter. + #: This constant has a value of "REMOVE" + MODE_REMOVE = "REMOVE" + + #: A constant which can be used with the mode property of a ProfanityTranscriptionFilter. + #: This constant has a value of "TAG" + MODE_TAG = "TAG" + + def __init__(self, **kwargs): + """ + Initializes a new ProfanityTranscriptionFilter object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.ProfanityTranscriptionFilter.type` attribute + of this class is ``PROFANITY`` 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 ProfanityTranscriptionFilter. + Allowed values for this property are: "PROFANITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param mode: + The value to assign to the mode property of this ProfanityTranscriptionFilter. + Allowed values for this property are: "MASK", "REMOVE", "TAG", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type mode: str + + """ + self.swagger_types = { + 'type': 'str', + 'mode': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'mode': 'mode' + } + + self._type = None + self._mode = None + self._type = 'PROFANITY' + + @property + def mode(self): + """ + **[Required]** Gets the mode of this ProfanityTranscriptionFilter. + The mode of filters. + Allowed values are: + - `MASK`: Will mask detected profanity in transcription. + - `REMOVE`: Will replace profane word with * in transcription. + - `TAG`: Will tag profane word as profanity but will show actual word. + + Allowed values for this property are: "MASK", "REMOVE", "TAG", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The mode of this ProfanityTranscriptionFilter. + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """ + Sets the mode of this ProfanityTranscriptionFilter. + The mode of filters. + Allowed values are: + - `MASK`: Will mask detected profanity in transcription. + - `REMOVE`: Will replace profane word with * in transcription. + - `TAG`: Will tag profane word as profanity but will show actual word. + + + :param mode: The mode of this ProfanityTranscriptionFilter. + :type: str + """ + allowed_values = ["MASK", "REMOVE", "TAG"] + if not value_allowed_none_or_none_sentinel(mode, allowed_values): + mode = 'UNKNOWN_ENUM_VALUE' + self._mode = mode + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/transcription_filter.py b/src/oci/ai_speech/models/transcription_filter.py new file mode 100644 index 0000000000..0d0a27bf5f --- /dev/null +++ b/src/oci/ai_speech/models/transcription_filter.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionFilter(object): + """ + Transcription Filter. + """ + + #: A constant which can be used with the type property of a TranscriptionFilter. + #: This constant has a value of "PROFANITY" + TYPE_PROFANITY = "PROFANITY" + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionFilter 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_speech.models.ProfanityTranscriptionFilter` + + 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 TranscriptionFilter. + Allowed values for this property are: "PROFANITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + """ + self.swagger_types = { + 'type': 'str' + } + + self.attribute_map = { + 'type': 'type' + } + + self._type = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['type'] + + if type == 'PROFANITY': + return 'ProfanityTranscriptionFilter' + else: + return 'TranscriptionFilter' + + @property + def type(self): + """ + **[Required]** Gets the type of this TranscriptionFilter. + The type of filters. + Allowed values are: + - `PROFANITY` + + Allowed values for this property are: "PROFANITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this TranscriptionFilter. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this TranscriptionFilter. + The type of filters. + Allowed values are: + - `PROFANITY` + + + :param type: The type of this TranscriptionFilter. + :type: str + """ + allowed_values = ["PROFANITY"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_speech/models/transcription_job.py b/src/oci/ai_speech/models/transcription_job.py new file mode 100644 index 0000000000..630572729c --- /dev/null +++ b/src/oci/ai_speech/models/transcription_job.py @@ -0,0 +1,743 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionJob(object): + """ + Description of Transcription Job. + """ + + #: A constant which can be used with the lifecycle_state property of a TranscriptionJob. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionJob. + #: 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 TranscriptionJob. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionJob. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionJob. + #: This constant has a value of "CANCELING" + LIFECYCLE_STATE_CANCELING = "CANCELING" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionJob. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionJob 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 TranscriptionJob. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TranscriptionJob. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this TranscriptionJob. + :type compartment_id: str + + :param description: + The value to assign to the description property of this TranscriptionJob. + :type description: str + + :param model_details: + The value to assign to the model_details property of this TranscriptionJob. + :type model_details: oci.ai_speech.models.TranscriptionModelDetails + + :param normalization: + The value to assign to the normalization property of this TranscriptionJob. + :type normalization: oci.ai_speech.models.TranscriptionNormalization + + :param time_accepted: + The value to assign to the time_accepted property of this TranscriptionJob. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this TranscriptionJob. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this TranscriptionJob. + :type time_finished: datetime + + :param total_tasks: + The value to assign to the total_tasks property of this TranscriptionJob. + :type total_tasks: int + + :param outstanding_tasks: + The value to assign to the outstanding_tasks property of this TranscriptionJob. + :type outstanding_tasks: int + + :param successful_tasks: + The value to assign to the successful_tasks property of this TranscriptionJob. + :type successful_tasks: int + + :param ttl_in_days: + The value to assign to the ttl_in_days property of this TranscriptionJob. + :type ttl_in_days: int + + :param percent_complete: + The value to assign to the percent_complete property of this TranscriptionJob. + :type percent_complete: int + + :param input_location: + The value to assign to the input_location property of this TranscriptionJob. + :type input_location: oci.ai_speech.models.InputLocation + + :param output_location: + The value to assign to the output_location property of this TranscriptionJob. + :type output_location: oci.ai_speech.models.OutputLocation + + :param created_by: + The value to assign to the created_by property of this TranscriptionJob. + :type created_by: str + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TranscriptionJob. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this TranscriptionJob. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this TranscriptionJob. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this TranscriptionJob. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this TranscriptionJob. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'description': 'str', + 'model_details': 'TranscriptionModelDetails', + 'normalization': 'TranscriptionNormalization', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'total_tasks': 'int', + 'outstanding_tasks': 'int', + 'successful_tasks': 'int', + 'ttl_in_days': 'int', + 'percent_complete': 'int', + 'input_location': 'InputLocation', + 'output_location': 'OutputLocation', + 'created_by': 'str', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'description': 'description', + 'model_details': 'modelDetails', + 'normalization': 'normalization', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'total_tasks': 'totalTasks', + 'outstanding_tasks': 'outstandingTasks', + 'successful_tasks': 'successfulTasks', + 'ttl_in_days': 'ttlInDays', + 'percent_complete': 'percentComplete', + 'input_location': 'inputLocation', + 'output_location': 'outputLocation', + 'created_by': 'createdBy', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._description = None + self._model_details = None + self._normalization = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + self._total_tasks = None + self._outstanding_tasks = None + self._successful_tasks = None + self._ttl_in_days = None + self._percent_complete = None + self._input_location = None + self._output_location = None + self._created_by = 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 TranscriptionJob. + Unique identifier that is immutable on creation. + + + :return: The id of this TranscriptionJob. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TranscriptionJob. + Unique identifier that is immutable on creation. + + + :param id: The id of this TranscriptionJob. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this TranscriptionJob. + Job name. + + + :return: The display_name of this TranscriptionJob. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TranscriptionJob. + Job name. + + + :param display_name: The display_name of this TranscriptionJob. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this TranscriptionJob. + The OCID of the compartment that contains the transcriptionJob. + + + :return: The compartment_id of this TranscriptionJob. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this TranscriptionJob. + The OCID of the compartment that contains the transcriptionJob. + + + :param compartment_id: The compartment_id of this TranscriptionJob. + :type: str + """ + self._compartment_id = compartment_id + + @property + def description(self): + """ + Gets the description of this TranscriptionJob. + Job description. + + + :return: The description of this TranscriptionJob. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this TranscriptionJob. + Job description. + + + :param description: The description of this TranscriptionJob. + :type: str + """ + self._description = description + + @property + def model_details(self): + """ + **[Required]** Gets the model_details of this TranscriptionJob. + + :return: The model_details of this TranscriptionJob. + :rtype: oci.ai_speech.models.TranscriptionModelDetails + """ + return self._model_details + + @model_details.setter + def model_details(self, model_details): + """ + Sets the model_details of this TranscriptionJob. + + :param model_details: The model_details of this TranscriptionJob. + :type: oci.ai_speech.models.TranscriptionModelDetails + """ + self._model_details = model_details + + @property + def normalization(self): + """ + Gets the normalization of this TranscriptionJob. + + :return: The normalization of this TranscriptionJob. + :rtype: oci.ai_speech.models.TranscriptionNormalization + """ + return self._normalization + + @normalization.setter + def normalization(self, normalization): + """ + Sets the normalization of this TranscriptionJob. + + :param normalization: The normalization of this TranscriptionJob. + :type: oci.ai_speech.models.TranscriptionNormalization + """ + self._normalization = normalization + + @property + def time_accepted(self): + """ + Gets the time_accepted of this TranscriptionJob. + Job accepted time. + + + :return: The time_accepted of this TranscriptionJob. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this TranscriptionJob. + Job accepted time. + + + :param time_accepted: The time_accepted of this TranscriptionJob. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this TranscriptionJob. + Job started time. + + + :return: The time_started of this TranscriptionJob. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this TranscriptionJob. + Job started time. + + + :param time_started: The time_started of this TranscriptionJob. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this TranscriptionJob. + Job finished time. + + + :return: The time_finished of this TranscriptionJob. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this TranscriptionJob. + Job finished time. + + + :param time_finished: The time_finished of this TranscriptionJob. + :type: datetime + """ + self._time_finished = time_finished + + @property + def total_tasks(self): + """ + Gets the total_tasks of this TranscriptionJob. + Total tasks in a job. + + + :return: The total_tasks of this TranscriptionJob. + :rtype: int + """ + return self._total_tasks + + @total_tasks.setter + def total_tasks(self, total_tasks): + """ + Sets the total_tasks of this TranscriptionJob. + Total tasks in a job. + + + :param total_tasks: The total_tasks of this TranscriptionJob. + :type: int + """ + self._total_tasks = total_tasks + + @property + def outstanding_tasks(self): + """ + Gets the outstanding_tasks of this TranscriptionJob. + Total outstanding tasks in a job. + + + :return: The outstanding_tasks of this TranscriptionJob. + :rtype: int + """ + return self._outstanding_tasks + + @outstanding_tasks.setter + def outstanding_tasks(self, outstanding_tasks): + """ + Sets the outstanding_tasks of this TranscriptionJob. + Total outstanding tasks in a job. + + + :param outstanding_tasks: The outstanding_tasks of this TranscriptionJob. + :type: int + """ + self._outstanding_tasks = outstanding_tasks + + @property + def successful_tasks(self): + """ + Gets the successful_tasks of this TranscriptionJob. + Total successful tasks in a job. + + + :return: The successful_tasks of this TranscriptionJob. + :rtype: int + """ + return self._successful_tasks + + @successful_tasks.setter + def successful_tasks(self, successful_tasks): + """ + Sets the successful_tasks of this TranscriptionJob. + Total successful tasks in a job. + + + :param successful_tasks: The successful_tasks of this TranscriptionJob. + :type: int + """ + self._successful_tasks = successful_tasks + + @property + def ttl_in_days(self): + """ + Gets the ttl_in_days of this TranscriptionJob. + Time to live duration in days for Job. Job will be available till max 90 days. + + + :return: The ttl_in_days of this TranscriptionJob. + :rtype: int + """ + return self._ttl_in_days + + @ttl_in_days.setter + def ttl_in_days(self, ttl_in_days): + """ + Sets the ttl_in_days of this TranscriptionJob. + Time to live duration in days for Job. Job will be available till max 90 days. + + + :param ttl_in_days: The ttl_in_days of this TranscriptionJob. + :type: int + """ + self._ttl_in_days = ttl_in_days + + @property + def percent_complete(self): + """ + Gets the percent_complete of this TranscriptionJob. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :return: The percent_complete of this TranscriptionJob. + :rtype: int + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this TranscriptionJob. + 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 TranscriptionJob. + :type: int + """ + self._percent_complete = percent_complete + + @property + def input_location(self): + """ + **[Required]** Gets the input_location of this TranscriptionJob. + + :return: The input_location of this TranscriptionJob. + :rtype: oci.ai_speech.models.InputLocation + """ + return self._input_location + + @input_location.setter + def input_location(self, input_location): + """ + Sets the input_location of this TranscriptionJob. + + :param input_location: The input_location of this TranscriptionJob. + :type: oci.ai_speech.models.InputLocation + """ + self._input_location = input_location + + @property + def output_location(self): + """ + **[Required]** Gets the output_location of this TranscriptionJob. + + :return: The output_location of this TranscriptionJob. + :rtype: oci.ai_speech.models.OutputLocation + """ + return self._output_location + + @output_location.setter + def output_location(self, output_location): + """ + Sets the output_location of this TranscriptionJob. + + :param output_location: The output_location of this TranscriptionJob. + :type: oci.ai_speech.models.OutputLocation + """ + self._output_location = output_location + + @property + def created_by(self): + """ + Gets the created_by of this TranscriptionJob. + OCID of the user who created the transcriptionJob. + + + :return: The created_by of this TranscriptionJob. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this TranscriptionJob. + OCID of the user who created the transcriptionJob. + + + :param created_by: The created_by of this TranscriptionJob. + :type: str + """ + self._created_by = created_by + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TranscriptionJob. + The current state of the Job. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this TranscriptionJob. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TranscriptionJob. + The current state of the Job. + + + :param lifecycle_state: The lifecycle_state of this TranscriptionJob. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this TranscriptionJob. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this TranscriptionJob. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this TranscriptionJob. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this TranscriptionJob. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this TranscriptionJob. + 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 TranscriptionJob. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this TranscriptionJob. + 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 TranscriptionJob. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this TranscriptionJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this TranscriptionJob. + :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 TranscriptionJob. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this TranscriptionJob. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this TranscriptionJob. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this TranscriptionJob. + :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 TranscriptionJob. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this TranscriptionJob. + :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_speech/models/transcription_job_collection.py b/src/oci/ai_speech/models/transcription_job_collection.py new file mode 100644 index 0000000000..45dba6aab1 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_job_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionJobCollection(object): + """ + Results of a Transcription Job search. Contains both TranscriptionJobSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionJobCollection 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 TranscriptionJobCollection. + :type items: list[oci.ai_speech.models.TranscriptionJobSummary] + + """ + self.swagger_types = { + 'items': 'list[TranscriptionJobSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TranscriptionJobCollection. + List of transcription jobs. + + + :return: The items of this TranscriptionJobCollection. + :rtype: list[oci.ai_speech.models.TranscriptionJobSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TranscriptionJobCollection. + List of transcription jobs. + + + :param items: The items of this TranscriptionJobCollection. + :type: list[oci.ai_speech.models.TranscriptionJobSummary] + """ + 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/ai_speech/models/transcription_job_summary.py b/src/oci/ai_speech/models/transcription_job_summary.py new file mode 100644 index 0000000000..54e1d49f27 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_job_summary.py @@ -0,0 +1,541 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionJobSummary(object): + """ + Summary of the Transcription Job. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionJobSummary 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 TranscriptionJobSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TranscriptionJobSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this TranscriptionJobSummary. + :type compartment_id: str + + :param created_by: + The value to assign to the created_by property of this TranscriptionJobSummary. + :type created_by: str + + :param percent_complete: + The value to assign to the percent_complete property of this TranscriptionJobSummary. + :type percent_complete: int + + :param time_accepted: + The value to assign to the time_accepted property of this TranscriptionJobSummary. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this TranscriptionJobSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this TranscriptionJobSummary. + :type time_finished: datetime + + :param total_tasks: + The value to assign to the total_tasks property of this TranscriptionJobSummary. + :type total_tasks: int + + :param outstanding_tasks: + The value to assign to the outstanding_tasks property of this TranscriptionJobSummary. + :type outstanding_tasks: int + + :param successful_tasks: + The value to assign to the successful_tasks property of this TranscriptionJobSummary. + :type successful_tasks: int + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TranscriptionJobSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this TranscriptionJobSummary. + :type lifecycle_details: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this TranscriptionJobSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this TranscriptionJobSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param system_tags: + The value to assign to the system_tags property of this TranscriptionJobSummary. + :type system_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'created_by': 'str', + 'percent_complete': 'int', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'total_tasks': 'int', + 'outstanding_tasks': 'int', + 'successful_tasks': 'int', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'system_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'created_by': 'createdBy', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'total_tasks': 'totalTasks', + 'outstanding_tasks': 'outstandingTasks', + 'successful_tasks': 'successfulTasks', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'system_tags': 'systemTags' + } + + self._id = None + self._display_name = None + self._compartment_id = None + self._created_by = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + self._total_tasks = None + self._outstanding_tasks = None + self._successful_tasks = 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 TranscriptionJobSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this TranscriptionJobSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TranscriptionJobSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this TranscriptionJobSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this TranscriptionJobSummary. + Transcription Job name, can be renamed. + + + :return: The display_name of this TranscriptionJobSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TranscriptionJobSummary. + Transcription Job name, can be renamed. + + + :param display_name: The display_name of this TranscriptionJobSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this TranscriptionJobSummary. + The OCID of the compartment that contains the transcriptionJob. + + + :return: The compartment_id of this TranscriptionJobSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this TranscriptionJobSummary. + The OCID of the compartment that contains the transcriptionJob. + + + :param compartment_id: The compartment_id of this TranscriptionJobSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def created_by(self): + """ + Gets the created_by of this TranscriptionJobSummary. + OCID of the user who created the transcriptionJob. + + + :return: The created_by of this TranscriptionJobSummary. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this TranscriptionJobSummary. + OCID of the user who created the transcriptionJob. + + + :param created_by: The created_by of this TranscriptionJobSummary. + :type: str + """ + self._created_by = created_by + + @property + def percent_complete(self): + """ + Gets the percent_complete of this TranscriptionJobSummary. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :return: The percent_complete of this TranscriptionJobSummary. + :rtype: int + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this TranscriptionJobSummary. + 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 TranscriptionJobSummary. + :type: int + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + Gets the time_accepted of this TranscriptionJobSummary. + Job accepted time. + + + :return: The time_accepted of this TranscriptionJobSummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this TranscriptionJobSummary. + Job accepted time. + + + :param time_accepted: The time_accepted of this TranscriptionJobSummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this TranscriptionJobSummary. + Job started time. + + + :return: The time_started of this TranscriptionJobSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this TranscriptionJobSummary. + Job started time. + + + :param time_started: The time_started of this TranscriptionJobSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this TranscriptionJobSummary. + Job finished time. + + + :return: The time_finished of this TranscriptionJobSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this TranscriptionJobSummary. + Job finished time. + + + :param time_finished: The time_finished of this TranscriptionJobSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def total_tasks(self): + """ + Gets the total_tasks of this TranscriptionJobSummary. + Total number of tasks in a job. + + + :return: The total_tasks of this TranscriptionJobSummary. + :rtype: int + """ + return self._total_tasks + + @total_tasks.setter + def total_tasks(self, total_tasks): + """ + Sets the total_tasks of this TranscriptionJobSummary. + Total number of tasks in a job. + + + :param total_tasks: The total_tasks of this TranscriptionJobSummary. + :type: int + """ + self._total_tasks = total_tasks + + @property + def outstanding_tasks(self): + """ + Gets the outstanding_tasks of this TranscriptionJobSummary. + Total outstanding tasks in a job. + + + :return: The outstanding_tasks of this TranscriptionJobSummary. + :rtype: int + """ + return self._outstanding_tasks + + @outstanding_tasks.setter + def outstanding_tasks(self, outstanding_tasks): + """ + Sets the outstanding_tasks of this TranscriptionJobSummary. + Total outstanding tasks in a job. + + + :param outstanding_tasks: The outstanding_tasks of this TranscriptionJobSummary. + :type: int + """ + self._outstanding_tasks = outstanding_tasks + + @property + def successful_tasks(self): + """ + Gets the successful_tasks of this TranscriptionJobSummary. + Total successful tasks in a job. + + + :return: The successful_tasks of this TranscriptionJobSummary. + :rtype: int + """ + return self._successful_tasks + + @successful_tasks.setter + def successful_tasks(self, successful_tasks): + """ + Sets the successful_tasks of this TranscriptionJobSummary. + Total successful tasks in a job. + + + :param successful_tasks: The successful_tasks of this TranscriptionJobSummary. + :type: int + """ + self._successful_tasks = successful_tasks + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TranscriptionJobSummary. + The current state of the Speech Job. + + + :return: The lifecycle_state of this TranscriptionJobSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TranscriptionJobSummary. + The current state of the Speech Job. + + + :param lifecycle_state: The lifecycle_state of this TranscriptionJobSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this TranscriptionJobSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this TranscriptionJobSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this TranscriptionJobSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this TranscriptionJobSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this TranscriptionJobSummary. + 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 TranscriptionJobSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this TranscriptionJobSummary. + 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 TranscriptionJobSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this TranscriptionJobSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this TranscriptionJobSummary. + :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 TranscriptionJobSummary. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this TranscriptionJobSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def system_tags(self): + """ + Gets the system_tags of this TranscriptionJobSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :return: The system_tags of this TranscriptionJobSummary. + :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 TranscriptionJobSummary. + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` + + + :param system_tags: The system_tags of this TranscriptionJobSummary. + :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_speech/models/transcription_model_details.py b/src/oci/ai_speech/models/transcription_model_details.py new file mode 100644 index 0000000000..d926e66872 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_model_details.py @@ -0,0 +1,133 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionModelDetails(object): + """ + Model details. + """ + + #: A constant which can be used with the domain property of a TranscriptionModelDetails. + #: This constant has a value of "GENERIC" + DOMAIN_GENERIC = "GENERIC" + + #: A constant which can be used with the language_code property of a TranscriptionModelDetails. + #: This constant has a value of "en-US" + LANGUAGE_CODE_EN_US = "en-US" + + #: A constant which can be used with the language_code property of a TranscriptionModelDetails. + #: This constant has a value of "es-ES" + LANGUAGE_CODE_ES_ES = "es-ES" + + #: A constant which can be used with the language_code property of a TranscriptionModelDetails. + #: This constant has a value of "pt-BR" + LANGUAGE_CODE_PT_BR = "pt-BR" + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionModelDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param domain: + The value to assign to the domain property of this TranscriptionModelDetails. + Allowed values for this property are: "GENERIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type domain: str + + :param language_code: + The value to assign to the language_code property of this TranscriptionModelDetails. + Allowed values for this property are: "en-US", "es-ES", "pt-BR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type language_code: str + + """ + self.swagger_types = { + 'domain': 'str', + 'language_code': 'str' + } + + self.attribute_map = { + 'domain': 'domain', + 'language_code': 'languageCode' + } + + self._domain = None + self._language_code = None + + @property + def domain(self): + """ + Gets the domain of this TranscriptionModelDetails. + Domain for input files. + + Allowed values for this property are: "GENERIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The domain of this TranscriptionModelDetails. + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """ + Sets the domain of this TranscriptionModelDetails. + Domain for input files. + + + :param domain: The domain of this TranscriptionModelDetails. + :type: str + """ + allowed_values = ["GENERIC"] + if not value_allowed_none_or_none_sentinel(domain, allowed_values): + domain = 'UNKNOWN_ENUM_VALUE' + self._domain = domain + + @property + def language_code(self): + """ + Gets the language_code of this TranscriptionModelDetails. + Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646]. + + Allowed values for this property are: "en-US", "es-ES", "pt-BR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The language_code of this TranscriptionModelDetails. + :rtype: str + """ + return self._language_code + + @language_code.setter + def language_code(self, language_code): + """ + Sets the language_code of this TranscriptionModelDetails. + Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646]. + + + :param language_code: The language_code of this TranscriptionModelDetails. + :type: str + """ + allowed_values = ["en-US", "es-ES", "pt-BR"] + if not value_allowed_none_or_none_sentinel(language_code, allowed_values): + language_code = 'UNKNOWN_ENUM_VALUE' + self._language_code = language_code + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/transcription_normalization.py b/src/oci/ai_speech/models/transcription_normalization.py new file mode 100644 index 0000000000..83916e50b4 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_normalization.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionNormalization(object): + """ + Information to Normalize generated transcript. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionNormalization object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param filters: + The value to assign to the filters property of this TranscriptionNormalization. + :type filters: list[oci.ai_speech.models.TranscriptionFilter] + + """ + self.swagger_types = { + 'filters': 'list[TranscriptionFilter]' + } + + self.attribute_map = { + 'filters': 'filters' + } + + self._filters = None + + @property + def filters(self): + """ + Gets the filters of this TranscriptionNormalization. + List of filters. + + + :return: The filters of this TranscriptionNormalization. + :rtype: list[oci.ai_speech.models.TranscriptionFilter] + """ + return self._filters + + @filters.setter + def filters(self, filters): + """ + Sets the filters of this TranscriptionNormalization. + List of filters. + + + :param filters: The filters of this TranscriptionNormalization. + :type: list[oci.ai_speech.models.TranscriptionFilter] + """ + self._filters = filters + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_speech/models/transcription_task.py b/src/oci/ai_speech/models/transcription_task.py new file mode 100644 index 0000000000..d5542fe743 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_task.py @@ -0,0 +1,485 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionTask(object): + """ + Description of Transcription Task. + """ + + #: A constant which can be used with the lifecycle_state property of a TranscriptionTask. + #: This constant has a value of "ACCEPTED" + LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionTask. + #: 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 TranscriptionTask. + #: This constant has a value of "SUCCEEDED" + LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionTask. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + #: A constant which can be used with the lifecycle_state property of a TranscriptionTask. + #: This constant has a value of "CANCELED" + LIFECYCLE_STATE_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionTask 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 TranscriptionTask. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TranscriptionTask. + :type display_name: str + + :param time_started: + The value to assign to the time_started property of this TranscriptionTask. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this TranscriptionTask. + :type time_finished: datetime + + :param percent_complete: + The value to assign to the percent_complete property of this TranscriptionTask. + :type percent_complete: int + + :param ttl_in_days: + The value to assign to the ttl_in_days property of this TranscriptionTask. + :type ttl_in_days: int + + :param model_details: + The value to assign to the model_details property of this TranscriptionTask. + :type model_details: oci.ai_speech.models.TranscriptionModelDetails + + :param audio_format_details: + The value to assign to the audio_format_details property of this TranscriptionTask. + :type audio_format_details: oci.ai_speech.models.AudioFormatDetails + + :param file_size_in_bytes: + The value to assign to the file_size_in_bytes property of this TranscriptionTask. + :type file_size_in_bytes: int + + :param file_duration_in_seconds: + The value to assign to the file_duration_in_seconds property of this TranscriptionTask. + :type file_duration_in_seconds: int + + :param input_location: + The value to assign to the input_location property of this TranscriptionTask. + :type input_location: oci.ai_speech.models.ObjectLocation + + :param output_location: + The value to assign to the output_location property of this TranscriptionTask. + :type output_location: oci.ai_speech.models.ObjectLocation + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TranscriptionTask. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this TranscriptionTask. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'percent_complete': 'int', + 'ttl_in_days': 'int', + 'model_details': 'TranscriptionModelDetails', + 'audio_format_details': 'AudioFormatDetails', + 'file_size_in_bytes': 'int', + 'file_duration_in_seconds': 'int', + 'input_location': 'ObjectLocation', + 'output_location': 'ObjectLocation', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'percent_complete': 'percentComplete', + 'ttl_in_days': 'ttlInDays', + 'model_details': 'modelDetails', + 'audio_format_details': 'audioFormatDetails', + 'file_size_in_bytes': 'fileSizeInBytes', + 'file_duration_in_seconds': 'fileDurationInSeconds', + 'input_location': 'inputLocation', + 'output_location': 'outputLocation', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails' + } + + self._id = None + self._display_name = None + self._time_started = None + self._time_finished = None + self._percent_complete = None + self._ttl_in_days = None + self._model_details = None + self._audio_format_details = None + self._file_size_in_bytes = None + self._file_duration_in_seconds = None + self._input_location = None + self._output_location = None + self._lifecycle_state = None + self._lifecycle_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this TranscriptionTask. + Unique identifier that is immutable on creation + + + :return: The id of this TranscriptionTask. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TranscriptionTask. + Unique identifier that is immutable on creation + + + :param id: The id of this TranscriptionTask. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this TranscriptionTask. + Task name. + + + :return: The display_name of this TranscriptionTask. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TranscriptionTask. + Task name. + + + :param display_name: The display_name of this TranscriptionTask. + :type: str + """ + self._display_name = display_name + + @property + def time_started(self): + """ + Gets the time_started of this TranscriptionTask. + Task started time. + + + :return: The time_started of this TranscriptionTask. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this TranscriptionTask. + Task started time. + + + :param time_started: The time_started of this TranscriptionTask. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this TranscriptionTask. + Task finished time. + + + :return: The time_finished of this TranscriptionTask. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this TranscriptionTask. + Task finished time. + + + :param time_finished: The time_finished of this TranscriptionTask. + :type: datetime + """ + self._time_finished = time_finished + + @property + def percent_complete(self): + """ + Gets the percent_complete of this TranscriptionTask. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :return: The percent_complete of this TranscriptionTask. + :rtype: int + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this TranscriptionTask. + 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 TranscriptionTask. + :type: int + """ + self._percent_complete = percent_complete + + @property + def ttl_in_days(self): + """ + Gets the ttl_in_days of this TranscriptionTask. + Time to live duration in days for tasks. Task will be available till max 90 days. + + + :return: The ttl_in_days of this TranscriptionTask. + :rtype: int + """ + return self._ttl_in_days + + @ttl_in_days.setter + def ttl_in_days(self, ttl_in_days): + """ + Sets the ttl_in_days of this TranscriptionTask. + Time to live duration in days for tasks. Task will be available till max 90 days. + + + :param ttl_in_days: The ttl_in_days of this TranscriptionTask. + :type: int + """ + self._ttl_in_days = ttl_in_days + + @property + def model_details(self): + """ + Gets the model_details of this TranscriptionTask. + + :return: The model_details of this TranscriptionTask. + :rtype: oci.ai_speech.models.TranscriptionModelDetails + """ + return self._model_details + + @model_details.setter + def model_details(self, model_details): + """ + Sets the model_details of this TranscriptionTask. + + :param model_details: The model_details of this TranscriptionTask. + :type: oci.ai_speech.models.TranscriptionModelDetails + """ + self._model_details = model_details + + @property + def audio_format_details(self): + """ + Gets the audio_format_details of this TranscriptionTask. + + :return: The audio_format_details of this TranscriptionTask. + :rtype: oci.ai_speech.models.AudioFormatDetails + """ + return self._audio_format_details + + @audio_format_details.setter + def audio_format_details(self, audio_format_details): + """ + Sets the audio_format_details of this TranscriptionTask. + + :param audio_format_details: The audio_format_details of this TranscriptionTask. + :type: oci.ai_speech.models.AudioFormatDetails + """ + self._audio_format_details = audio_format_details + + @property + def file_size_in_bytes(self): + """ + Gets the file_size_in_bytes of this TranscriptionTask. + Size of input file in Bytes. + + + :return: The file_size_in_bytes of this TranscriptionTask. + :rtype: int + """ + return self._file_size_in_bytes + + @file_size_in_bytes.setter + def file_size_in_bytes(self, file_size_in_bytes): + """ + Sets the file_size_in_bytes of this TranscriptionTask. + Size of input file in Bytes. + + + :param file_size_in_bytes: The file_size_in_bytes of this TranscriptionTask. + :type: int + """ + self._file_size_in_bytes = file_size_in_bytes + + @property + def file_duration_in_seconds(self): + """ + Gets the file_duration_in_seconds of this TranscriptionTask. + Duration of input file in Seconds. + + + :return: The file_duration_in_seconds of this TranscriptionTask. + :rtype: int + """ + return self._file_duration_in_seconds + + @file_duration_in_seconds.setter + def file_duration_in_seconds(self, file_duration_in_seconds): + """ + Sets the file_duration_in_seconds of this TranscriptionTask. + Duration of input file in Seconds. + + + :param file_duration_in_seconds: The file_duration_in_seconds of this TranscriptionTask. + :type: int + """ + self._file_duration_in_seconds = file_duration_in_seconds + + @property + def input_location(self): + """ + Gets the input_location of this TranscriptionTask. + + :return: The input_location of this TranscriptionTask. + :rtype: oci.ai_speech.models.ObjectLocation + """ + return self._input_location + + @input_location.setter + def input_location(self, input_location): + """ + Sets the input_location of this TranscriptionTask. + + :param input_location: The input_location of this TranscriptionTask. + :type: oci.ai_speech.models.ObjectLocation + """ + self._input_location = input_location + + @property + def output_location(self): + """ + Gets the output_location of this TranscriptionTask. + + :return: The output_location of this TranscriptionTask. + :rtype: oci.ai_speech.models.ObjectLocation + """ + return self._output_location + + @output_location.setter + def output_location(self, output_location): + """ + Sets the output_location of this TranscriptionTask. + + :param output_location: The output_location of this TranscriptionTask. + :type: oci.ai_speech.models.ObjectLocation + """ + self._output_location = output_location + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TranscriptionTask. + The current state of the Task. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this TranscriptionTask. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TranscriptionTask. + The current state of the Task. + + + :param lifecycle_state: The lifecycle_state of this TranscriptionTask. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this TranscriptionTask. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this TranscriptionTask. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this TranscriptionTask. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this TranscriptionTask. + :type: str + """ + self._lifecycle_details = lifecycle_details + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_speech/models/transcription_task_collection.py b/src/oci/ai_speech/models/transcription_task_collection.py new file mode 100644 index 0000000000..0b81f31e3e --- /dev/null +++ b/src/oci/ai_speech/models/transcription_task_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionTaskCollection(object): + """ + Results of a Transcription Task search. Contains both TranscriptionTaskSummary items and other information, such as metadata. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionTaskCollection 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 TranscriptionTaskCollection. + :type items: list[oci.ai_speech.models.TranscriptionTaskSummary] + + """ + self.swagger_types = { + 'items': 'list[TranscriptionTaskSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TranscriptionTaskCollection. + List of Transcription Task. + + + :return: The items of this TranscriptionTaskCollection. + :rtype: list[oci.ai_speech.models.TranscriptionTaskSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TranscriptionTaskCollection. + List of Transcription Task. + + + :param items: The items of this TranscriptionTaskCollection. + :type: list[oci.ai_speech.models.TranscriptionTaskSummary] + """ + 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/ai_speech/models/transcription_task_summary.py b/src/oci/ai_speech/models/transcription_task_summary.py new file mode 100644 index 0000000000..1fd81549f5 --- /dev/null +++ b/src/oci/ai_speech/models/transcription_task_summary.py @@ -0,0 +1,318 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TranscriptionTaskSummary(object): + """ + Summary of the Transcription Task. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TranscriptionTaskSummary 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 TranscriptionTaskSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TranscriptionTaskSummary. + :type display_name: str + + :param percent_complete: + The value to assign to the percent_complete property of this TranscriptionTaskSummary. + :type percent_complete: int + + :param file_size_in_bytes: + The value to assign to the file_size_in_bytes property of this TranscriptionTaskSummary. + :type file_size_in_bytes: int + + :param file_duration_in_seconds: + The value to assign to the file_duration_in_seconds property of this TranscriptionTaskSummary. + :type file_duration_in_seconds: int + + :param time_started: + The value to assign to the time_started property of this TranscriptionTaskSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this TranscriptionTaskSummary. + :type time_finished: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this TranscriptionTaskSummary. + :type lifecycle_state: str + + :param lifecycle_details: + The value to assign to the lifecycle_details property of this TranscriptionTaskSummary. + :type lifecycle_details: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'percent_complete': 'int', + 'file_size_in_bytes': 'int', + 'file_duration_in_seconds': 'int', + 'time_started': 'datetime', + 'time_finished': 'datetime', + 'lifecycle_state': 'str', + 'lifecycle_details': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'percent_complete': 'percentComplete', + 'file_size_in_bytes': 'fileSizeInBytes', + 'file_duration_in_seconds': 'fileDurationInSeconds', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished', + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails' + } + + self._id = None + self._display_name = None + self._percent_complete = None + self._file_size_in_bytes = None + self._file_duration_in_seconds = None + self._time_started = None + self._time_finished = None + self._lifecycle_state = None + self._lifecycle_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this TranscriptionTaskSummary. + Unique identifier that is immutable on creation. + + + :return: The id of this TranscriptionTaskSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TranscriptionTaskSummary. + Unique identifier that is immutable on creation. + + + :param id: The id of this TranscriptionTaskSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this TranscriptionTaskSummary. + Transcription task name. + + + :return: The display_name of this TranscriptionTaskSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TranscriptionTaskSummary. + Transcription task name. + + + :param display_name: The display_name of this TranscriptionTaskSummary. + :type: str + """ + self._display_name = display_name + + @property + def percent_complete(self): + """ + Gets the percent_complete of this TranscriptionTaskSummary. + How much progress the operation has made, vs the total amount of work that must be performed. + + + :return: The percent_complete of this TranscriptionTaskSummary. + :rtype: int + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this TranscriptionTaskSummary. + 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 TranscriptionTaskSummary. + :type: int + """ + self._percent_complete = percent_complete + + @property + def file_size_in_bytes(self): + """ + Gets the file_size_in_bytes of this TranscriptionTaskSummary. + Size of input file in Bytes. + + + :return: The file_size_in_bytes of this TranscriptionTaskSummary. + :rtype: int + """ + return self._file_size_in_bytes + + @file_size_in_bytes.setter + def file_size_in_bytes(self, file_size_in_bytes): + """ + Sets the file_size_in_bytes of this TranscriptionTaskSummary. + Size of input file in Bytes. + + + :param file_size_in_bytes: The file_size_in_bytes of this TranscriptionTaskSummary. + :type: int + """ + self._file_size_in_bytes = file_size_in_bytes + + @property + def file_duration_in_seconds(self): + """ + Gets the file_duration_in_seconds of this TranscriptionTaskSummary. + Duration of input file in Seconds. + + + :return: The file_duration_in_seconds of this TranscriptionTaskSummary. + :rtype: int + """ + return self._file_duration_in_seconds + + @file_duration_in_seconds.setter + def file_duration_in_seconds(self, file_duration_in_seconds): + """ + Sets the file_duration_in_seconds of this TranscriptionTaskSummary. + Duration of input file in Seconds. + + + :param file_duration_in_seconds: The file_duration_in_seconds of this TranscriptionTaskSummary. + :type: int + """ + self._file_duration_in_seconds = file_duration_in_seconds + + @property + def time_started(self): + """ + Gets the time_started of this TranscriptionTaskSummary. + Task started time + + + :return: The time_started of this TranscriptionTaskSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this TranscriptionTaskSummary. + Task started time + + + :param time_started: The time_started of this TranscriptionTaskSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this TranscriptionTaskSummary. + Job finished time + + + :return: The time_finished of this TranscriptionTaskSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this TranscriptionTaskSummary. + Job finished time + + + :param time_finished: The time_finished of this TranscriptionTaskSummary. + :type: datetime + """ + self._time_finished = time_finished + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this TranscriptionTaskSummary. + The current state of the Speech Job. + + + :return: The lifecycle_state of this TranscriptionTaskSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this TranscriptionTaskSummary. + The current state of the Speech Job. + + + :param lifecycle_state: The lifecycle_state of this TranscriptionTaskSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this TranscriptionTaskSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The lifecycle_details of this TranscriptionTaskSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this TranscriptionTaskSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param lifecycle_details: The lifecycle_details of this TranscriptionTaskSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/ai_speech/models/update_transcription_job_details.py b/src/oci/ai_speech/models/update_transcription_job_details.py new file mode 100644 index 0000000000..bd5c6b0d5b --- /dev/null +++ b/src/oci/ai_speech/models/update_transcription_job_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateTranscriptionJobDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateTranscriptionJobDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param display_name: + The value to assign to the display_name property of this UpdateTranscriptionJobDetails. + :type display_name: str + + :param description: + The value to assign to the description property of this UpdateTranscriptionJobDetails. + :type description: str + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateTranscriptionJobDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateTranscriptionJobDetails. + :type defined_tags: dict(str, dict(str, object)) + + """ + self.swagger_types = { + 'display_name': 'str', + 'description': 'str', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))' + } + + self.attribute_map = { + 'display_name': 'displayName', + 'description': 'description', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags' + } + + self._display_name = None + self._description = None + self._freeform_tags = None + self._defined_tags = None + + @property + def display_name(self): + """ + Gets the display_name of this UpdateTranscriptionJobDetails. + Transcription job name. + + + :return: The display_name of this UpdateTranscriptionJobDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateTranscriptionJobDetails. + Transcription job name. + + + :param display_name: The display_name of this UpdateTranscriptionJobDetails. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this UpdateTranscriptionJobDetails. + Transcription job description. + + + :return: The description of this UpdateTranscriptionJobDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateTranscriptionJobDetails. + Transcription job description. + + + :param description: The description of this UpdateTranscriptionJobDetails. + :type: str + """ + self._description = description + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateTranscriptionJobDetails. + 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 UpdateTranscriptionJobDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateTranscriptionJobDetails. + 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 UpdateTranscriptionJobDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateTranscriptionJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateTranscriptionJobDetails. + :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 UpdateTranscriptionJobDetails. + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateTranscriptionJobDetails. + :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/analytics/analytics_client.py b/src/oci/analytics/analytics_client.py index 0a6112ee82..639703c417 100644 --- a/src/oci/analytics/analytics_client.py +++ b/src/oci/analytics/analytics_client.py @@ -1927,6 +1927,111 @@ def scale_analytics_instance(self, analytics_instance_id, scale_analytics_instan header_params=header_params, body=scale_analytics_instance_details) + def set_kms_key(self, analytics_instance_id, set_kms_key_details, **kwargs): + """ + Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key. + + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.SetKmsKeyDetails set_kms_key_details: (required) + Input payload to reset the OCI Vault encryption key. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` + parameter to the value of the etag from a previous GET or POST response for that resource. The resource + will be updated or deleted only if the etag you provide matches the resource's current etag value. + + :param str opc_request_id: (optional) + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may 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 set_kms_key API. + """ + resource_path = "/analyticsInstances/{analyticsInstanceId}/actions/setKmsKey" + method = "POST" + + # 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( + "set_kms_key got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "analyticsInstanceId": analytics_instance_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "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=set_kms_key_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=set_kms_key_details) + def start_analytics_instance(self, analytics_instance_id, **kwargs): """ Starts the specified Analytics instance. The operation is long-running diff --git a/src/oci/analytics/analytics_client_composite_operations.py b/src/oci/analytics/analytics_client_composite_operations.py index e12e2e4014..89ac1ea050 100644 --- a/src/oci/analytics/analytics_client_composite_operations.py +++ b/src/oci/analytics/analytics_client_composite_operations.py @@ -410,6 +410,47 @@ def scale_analytics_instance_and_wait_for_state(self, analytics_instance_id, sca except Exception as e: raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def set_kms_key_and_wait_for_state(self, analytics_instance_id, set_kms_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.analytics.AnalyticsClient.set_kms_key` and waits for the :py:class:`~oci.analytics.models.WorkRequest` + to enter the given state(s). + + :param str analytics_instance_id: (required) + The OCID of the AnalyticsInstance. + + :param oci.analytics.models.SetKmsKeyDetails set_kms_key_details: (required) + Input payload to reset the OCI Vault encryption key. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.analytics.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.analytics.AnalyticsClient.set_kms_key` + + :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.set_kms_key(analytics_instance_id, set_kms_key_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + def start_analytics_instance_and_wait_for_state(self, analytics_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): """ Calls :py:func:`~oci.analytics.AnalyticsClient.start_analytics_instance` and waits for the :py:class:`~oci.analytics.models.WorkRequest` diff --git a/src/oci/analytics/models/__init__.py b/src/oci/analytics/models/__init__.py index aa29c1a471..a3a14e488b 100644 --- a/src/oci/analytics/models/__init__.py +++ b/src/oci/analytics/models/__init__.py @@ -18,6 +18,7 @@ from .private_source_dns_zone import PrivateSourceDnsZone from .public_endpoint_details import PublicEndpointDetails from .scale_analytics_instance_details import ScaleAnalyticsInstanceDetails +from .set_kms_key_details import SetKmsKeyDetails from .update_analytics_instance_details import UpdateAnalyticsInstanceDetails from .update_private_access_channel_details import UpdatePrivateAccessChannelDetails from .update_vanity_url_details import UpdateVanityUrlDetails @@ -45,6 +46,7 @@ "PrivateSourceDnsZone": PrivateSourceDnsZone, "PublicEndpointDetails": PublicEndpointDetails, "ScaleAnalyticsInstanceDetails": ScaleAnalyticsInstanceDetails, + "SetKmsKeyDetails": SetKmsKeyDetails, "UpdateAnalyticsInstanceDetails": UpdateAnalyticsInstanceDetails, "UpdatePrivateAccessChannelDetails": UpdatePrivateAccessChannelDetails, "UpdateVanityUrlDetails": UpdateVanityUrlDetails, diff --git a/src/oci/analytics/models/analytics_instance.py b/src/oci/analytics/models/analytics_instance.py index 402db4eb98..42cfa61b89 100644 --- a/src/oci/analytics/models/analytics_instance.py +++ b/src/oci/analytics/models/analytics_instance.py @@ -128,6 +128,10 @@ def __init__(self, **kwargs): The value to assign to the freeform_tags property of this AnalyticsInstance. :type freeform_tags: dict(str, str) + :param kms_key_id: + The value to assign to the kms_key_id property of this AnalyticsInstance. + :type kms_key_id: str + :param time_created: The value to assign to the time_created property of this AnalyticsInstance. :type time_created: datetime @@ -153,6 +157,7 @@ def __init__(self, **kwargs): 'service_url': 'str', 'defined_tags': 'dict(str, dict(str, object))', 'freeform_tags': 'dict(str, str)', + 'kms_key_id': 'str', 'time_created': 'datetime', 'time_updated': 'datetime' } @@ -173,6 +178,7 @@ def __init__(self, **kwargs): 'service_url': 'serviceUrl', 'defined_tags': 'definedTags', 'freeform_tags': 'freeformTags', + 'kms_key_id': 'kmsKeyId', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated' } @@ -192,6 +198,7 @@ def __init__(self, **kwargs): self._service_url = None self._defined_tags = None self._freeform_tags = None + self._kms_key_id = None self._time_created = None self._time_updated = None @@ -585,6 +592,34 @@ def freeform_tags(self, freeform_tags): """ self._freeform_tags = freeform_tags + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this AnalyticsInstance. + The `OCID`__ of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The kms_key_id of this AnalyticsInstance. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this AnalyticsInstance. + The `OCID`__ of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param kms_key_id: The kms_key_id of this AnalyticsInstance. + :type: str + """ + self._kms_key_id = kms_key_id + @property def time_created(self): """ diff --git a/src/oci/analytics/models/create_analytics_instance_details.py b/src/oci/analytics/models/create_analytics_instance_details.py index f126602464..656b03d868 100644 --- a/src/oci/analytics/models/create_analytics_instance_details.py +++ b/src/oci/analytics/models/create_analytics_instance_details.py @@ -80,6 +80,10 @@ def __init__(self, **kwargs): The value to assign to the freeform_tags property of this CreateAnalyticsInstanceDetails. :type freeform_tags: dict(str, str) + :param kms_key_id: + The value to assign to the kms_key_id property of this CreateAnalyticsInstanceDetails. + :type kms_key_id: str + """ self.swagger_types = { 'name': 'str', @@ -92,7 +96,8 @@ def __init__(self, **kwargs): 'network_endpoint_details': 'NetworkEndpointDetails', 'idcs_access_token': 'str', 'defined_tags': 'dict(str, dict(str, object))', - 'freeform_tags': 'dict(str, str)' + 'freeform_tags': 'dict(str, str)', + 'kms_key_id': 'str' } self.attribute_map = { @@ -106,7 +111,8 @@ def __init__(self, **kwargs): 'network_endpoint_details': 'networkEndpointDetails', 'idcs_access_token': 'idcsAccessToken', 'defined_tags': 'definedTags', - 'freeform_tags': 'freeformTags' + 'freeform_tags': 'freeformTags', + 'kms_key_id': 'kmsKeyId' } self._name = None @@ -120,6 +126,7 @@ def __init__(self, **kwargs): self._idcs_access_token = None self._defined_tags = None self._freeform_tags = None + self._kms_key_id = None @property def name(self): @@ -413,6 +420,34 @@ def freeform_tags(self, freeform_tags): """ self._freeform_tags = freeform_tags + @property + def kms_key_id(self): + """ + Gets the kms_key_id of this CreateAnalyticsInstanceDetails. + The `OCID`__ of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The kms_key_id of this CreateAnalyticsInstanceDetails. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this CreateAnalyticsInstanceDetails. + The `OCID`__ of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param kms_key_id: The kms_key_id of this CreateAnalyticsInstanceDetails. + :type: str + """ + self._kms_key_id = kms_key_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/analytics/models/set_kms_key_details.py b/src/oci/analytics/models/set_kms_key_details.py new file mode 100644 index 0000000000..9e8d6d623f --- /dev/null +++ b/src/oci/analytics/models/set_kms_key_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SetKmsKeyDetails(object): + """ + Input payload to reset the OCI Vault encryption key. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SetKmsKeyDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param kms_key_id: + The value to assign to the kms_key_id property of this SetKmsKeyDetails. + :type kms_key_id: str + + """ + self.swagger_types = { + 'kms_key_id': 'str' + } + + self.attribute_map = { + 'kms_key_id': 'kmsKeyId' + } + + self._kms_key_id = None + + @property + def kms_key_id(self): + """ + **[Required]** Gets the kms_key_id of this SetKmsKeyDetails. + OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API). + + + :return: The kms_key_id of this SetKmsKeyDetails. + :rtype: str + """ + return self._kms_key_id + + @kms_key_id.setter + def kms_key_id(self, kms_key_id): + """ + Sets the kms_key_id of this SetKmsKeyDetails. + OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API). + + + :param kms_key_id: The kms_key_id of this SetKmsKeyDetails. + :type: str + """ + self._kms_key_id = kms_key_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/analytics/models/work_request.py b/src/oci/analytics/models/work_request.py index 4b3de4b31a..597dc28395 100644 --- a/src/oci/analytics/models/work_request.py +++ b/src/oci/analytics/models/work_request.py @@ -65,6 +65,10 @@ class WorkRequest(object): #: This constant has a value of "DELETE_PRIVATE_ACCESS_CHANNEL" OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL = "DELETE_PRIVATE_ACCESS_CHANNEL" + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE_INSTANCE_ENCRYPTION_KEY" + OPERATION_TYPE_UPDATE_INSTANCE_ENCRYPTION_KEY = "UPDATE_INSTANCE_ENCRYPTION_KEY" + #: A constant which can be used with the status property of a WorkRequest. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -100,7 +104,7 @@ def __init__(self, **kwargs): :param operation_type: The value to assign to the operation_type property of this WorkRequest. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -199,7 +203,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequest. The operation performed by the work request. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -218,7 +222,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequest. :type: str """ - allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL"] + allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY"] 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/analytics/models/work_request_summary.py b/src/oci/analytics/models/work_request_summary.py index b5836e935f..dc36f749c4 100644 --- a/src/oci/analytics/models/work_request_summary.py +++ b/src/oci/analytics/models/work_request_summary.py @@ -65,6 +65,10 @@ class WorkRequestSummary(object): #: This constant has a value of "DELETE_PRIVATE_ACCESS_CHANNEL" OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL = "DELETE_PRIVATE_ACCESS_CHANNEL" + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE_INSTANCE_ENCRYPTION_KEY" + OPERATION_TYPE_UPDATE_INSTANCE_ENCRYPTION_KEY = "UPDATE_INSTANCE_ENCRYPTION_KEY" + #: A constant which can be used with the status property of a WorkRequestSummary. #: This constant has a value of "ACCEPTED" STATUS_ACCEPTED = "ACCEPTED" @@ -100,7 +104,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_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type operation_type: str @@ -192,7 +196,7 @@ def operation_type(self): **[Required]** Gets the operation_type of this WorkRequestSummary. The operation performed by the work request. - Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -211,7 +215,7 @@ def operation_type(self, operation_type): :param operation_type: The operation_type of this WorkRequestSummary. :type: str """ - allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL"] + allowed_values = ["CREATE_ANALYTICS_INSTANCE", "DELETE_ANALYTICS_INSTANCE", "START_ANALYTICS_INSTANCE", "STOP_ANALYTICS_INSTANCE", "SCALE_ANALYTICS_INSTANCE", "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT", "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT", "CREATE_VANITY_URL", "UPDATE_VANITY_URL", "DELETE_VANITY_URL", "CREATE_PRIVATE_ACCESS_CHANNEL", "UPDATE_PRIVATE_ACCESS_CHANNEL", "DELETE_PRIVATE_ACCESS_CHANNEL", "UPDATE_INSTANCE_ENCRYPTION_KEY"] 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/apm_control_plane/apm_domain_client.py b/src/oci/apm_control_plane/apm_domain_client.py index ebf92f52fb..a0579cf5d0 100644 --- a/src/oci/apm_control_plane/apm_domain_client.py +++ b/src/oci/apm_control_plane/apm_domain_client.py @@ -19,7 +19,7 @@ class ApmDomainClient(object): """ Use the Application Performance Monitoring Control Plane API to perform operations such as creating, updating, - deleting and listing APM domains and monitoring the progress of these operations using the work request APIs. + deleting and listing APM domains and monitoring the progress of these operations using the work request APIs. For more information, see [Application Performance Monitoring](/iaas/application-performance-monitoring/index.html). """ def __init__(self, config, **kwargs): @@ -111,7 +111,7 @@ def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compart :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param oci.apm_control_plane.models.ChangeApmDomainCompartmentDetails change_apm_domain_compartment_details: (required) The information to be used in changing compartment. @@ -126,7 +126,7 @@ def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compart 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 + A token that uniquely identifies a request therefore 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 @@ -135,7 +135,7 @@ def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compart :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -189,6 +189,8 @@ def change_apm_domain_compartment(self, apm_domain_id, change_apm_domain_compart 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): @@ -219,7 +221,7 @@ def create_apm_domain(self, create_apm_domain_details, **kwargs): Details for the new APM domain. :param str opc_retry_token: (optional) - A token that uniquely identifies a request so it can be retried in case of a timeout or + A token that uniquely identifies a request therefore 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 @@ -231,7 +233,7 @@ def create_apm_domain(self, create_apm_domain_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -273,6 +275,8 @@ def create_apm_domain(self, create_apm_domain_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -300,7 +304,7 @@ def delete_apm_domain(self, apm_domain_id, **kwargs): :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param str if_match: (optional) For optimistic concurrency control. Set the `if-match` parameter @@ -314,7 +318,7 @@ def delete_apm_domain(self, apm_domain_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -366,6 +370,8 @@ def delete_apm_domain(self, apm_domain_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -394,7 +400,7 @@ def generate_data_keys(self, generate_data_keys_list_details, apm_domain_id, **k List of new Data Keys to be generated. :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param str if_match: (optional) For optimistic concurrency control. Set the `if-match` parameter @@ -408,7 +414,7 @@ def generate_data_keys(self, generate_data_keys_list_details, apm_domain_id, **k :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -460,6 +466,8 @@ def generate_data_keys(self, generate_data_keys_list_details, apm_domain_id, **k 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): @@ -486,7 +494,7 @@ def get_apm_domain(self, apm_domain_id, **kwargs): :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param str opc_request_id: (optional) The client request ID for tracing. @@ -494,7 +502,7 @@ def get_apm_domain(self, apm_domain_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -544,6 +552,8 @@ def get_apm_domain(self, apm_domain_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -578,7 +588,7 @@ def get_work_request(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -628,6 +638,8 @@ def get_work_request(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -654,7 +666,7 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param str opc_request_id: (optional) The client request ID for tracing. @@ -668,7 +680,7 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -726,6 +738,8 @@ def list_apm_domain_work_requests(self, apm_domain_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -776,7 +790,7 @@ def list_apm_domains(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, timeCreated is default. Allowed values are: "timeCreated", "displayName" @@ -786,7 +800,7 @@ def list_apm_domains(self, compartment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -864,6 +878,8 @@ def list_apm_domains(self, compartment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -891,7 +907,7 @@ def list_data_keys(self, apm_domain_id, **kwargs): :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param str data_key_type: (optional) Data key type. @@ -904,7 +920,7 @@ def list_data_keys(self, apm_domain_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -967,6 +983,8 @@ def list_data_keys(self, apm_domain_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1009,7 +1027,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1067,6 +1085,8 @@ def list_work_request_errors(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1109,7 +1129,7 @@ def list_work_request_logs(self, work_request_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1167,6 +1187,8 @@ def list_work_request_logs(self, work_request_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1209,7 +1231,7 @@ def list_work_requests(self, compartment_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1258,6 +1280,8 @@ def list_work_requests(self, compartment_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1285,7 +1309,7 @@ def remove_data_keys(self, apm_domain_id, remove_data_keys_list_details, **kwarg :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param oci.apm_control_plane.models.list[RemoveDataKeyDetails] remove_data_keys_list_details: (required) List of Data Keys to be removed. @@ -1302,7 +1326,7 @@ def remove_data_keys(self, apm_domain_id, remove_data_keys_list_details, **kwarg :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1354,6 +1378,8 @@ def remove_data_keys(self, apm_domain_id, remove_data_keys_list_details, **kwarg operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -1380,7 +1406,7 @@ def update_apm_domain(self, apm_domain_id, update_apm_domain_details, **kwargs): :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param oci.apm_control_plane.models.UpdateApmDomainDetails update_apm_domain_details: (required) The information to be updated for the APM domain. @@ -1397,7 +1423,7 @@ def update_apm_domain(self, apm_domain_id, update_apm_domain_details, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -1449,6 +1475,8 @@ def update_apm_domain(self, apm_domain_id, update_apm_domain_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): diff --git a/src/oci/apm_control_plane/apm_domain_client_composite_operations.py b/src/oci/apm_control_plane/apm_domain_client_composite_operations.py index 76d7412f8b..bfcf524e02 100644 --- a/src/oci/apm_control_plane/apm_domain_client_composite_operations.py +++ b/src/oci/apm_control_plane/apm_domain_client_composite_operations.py @@ -29,7 +29,7 @@ def change_apm_domain_compartment_and_wait_for_state(self, apm_domain_id, change to enter the given state(s). :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param oci.apm_control_plane.models.ChangeApmDomainCompartmentDetails change_apm_domain_compartment_details: (required) The information to be used in changing compartment. @@ -108,7 +108,7 @@ def delete_apm_domain_and_wait_for_state(self, apm_domain_id, wait_for_states=[] to enter the given state(s). :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` @@ -157,7 +157,7 @@ def generate_data_keys_and_wait_for_state(self, generate_data_keys_list_details, List of new Data Keys to be generated. :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.apm_control_plane.models.WorkRequest.status` @@ -195,7 +195,7 @@ def remove_data_keys_and_wait_for_state(self, apm_domain_id, remove_data_keys_li to enter the given state(s). :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param list[RemoveDataKeyDetails] remove_data_keys_list_details: (required) List of Data Keys to be removed. @@ -236,7 +236,7 @@ def update_apm_domain_and_wait_for_state(self, apm_domain_id, update_apm_domain_ to enter the given state(s). :param str apm_domain_id: (required) - The OCID of the APM domain + The OCID of the APM domain. :param oci.apm_control_plane.models.UpdateApmDomainDetails update_apm_domain_details: (required) The information to be updated for the APM domain. diff --git a/src/oci/apm_control_plane/models/work_request_error.py b/src/oci/apm_control_plane/models/work_request_error.py index 0251faceea..da648ede8f 100644 --- a/src/oci/apm_control_plane/models/work_request_error.py +++ b/src/oci/apm_control_plane/models/work_request_error.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def code(self): """ **[Required]** Gets the code of this WorkRequestError. - A machine-usable code for the error that occured. Error codes are listed at + A machine-usable code for the error that occurred. Error codes are listed at `API Errors`__ __ https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm @@ -66,7 +66,7 @@ def code(self): def code(self, code): """ Sets the code of this WorkRequestError. - A machine-usable code for the error that occured. Error codes are listed at + A machine-usable code for the error that occurred. Error codes are listed at `API Errors`__ __ https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm diff --git a/src/oci/cloud_guard/cloud_guard_client.py b/src/oci/cloud_guard/cloud_guard_client.py index 07b61d026a..3f6a396c9e 100644 --- a/src/oci/cloud_guard/cloud_guard_client.py +++ b/src/oci/cloud_guard/cloud_guard_client.py @@ -18,7 +18,9 @@ class CloudGuardClient(object): """ - A description of the Cloud Guard APIs + Use the Cloud Guard API to automate processes that you would otherwise perform through the Cloud Guard Console. + + **Note:** You can perform Create, Update, and Delete operations only from the reporting region of your Cloud Guard tenancy. You can perform Read operations from any region. """ def __init__(self, config, **kwargs): @@ -1830,7 +1832,7 @@ def get_condition_metadata_type(self, condition_metadata_type_id, **kwargs): :param str condition_metadata_type_id: (required) The type of the condition meta data. - Allowed values are: "ActivityCondition", "SecurityCondition", "CloudGuardCondition" + Allowed values are: "ActivityCondition", "SecurityCondition", "CloudGuardCondition", "ThreatCondition" :param str opc_request_id: (optional) The client request ID for tracing. @@ -2599,6 +2601,90 @@ def get_problem(self, problem_id, **kwargs): header_params=header_params, response_type="Problem") + def get_resource_profile(self, resource_profile_id, **kwargs): + """ + Returns resource profile details + + + :param str resource_profile_id: (required) + OCID of the resource profile. + + :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.cloud_guard.models.ResourceProfile` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_resource_profile API. + """ + resource_path = "/resourceProfiles/{resourceProfileId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_resource_profile got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "resourceProfileId": resource_profile_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ResourceProfile") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="ResourceProfile") + def get_responder_execution(self, responder_execution_id, **kwargs): """ Returns a Responder Execution identified by responderExecutionId @@ -2939,6 +3025,90 @@ def get_responder_rule(self, responder_rule_id, **kwargs): header_params=header_params, response_type="ResponderRule") + def get_sighting(self, sighting_id, **kwargs): + """ + Returns Sighting details + + + :param str sighting_id: (required) + OCID of the sighting. + + :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.cloud_guard.models.Sighting` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_sighting API. + """ + resource_path = "/sightings/{sightingId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_sighting got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "sightingId": sighting_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Sighting") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Sighting") + def get_target(self, target_id, **kwargs): """ Returns a Target identified by targetId @@ -4885,13 +5055,10 @@ def list_policies(self, compartment_id, **kwargs): header_params=header_params, response_type="PolicyCollection") - def list_problem_histories(self, compartment_id, problem_id, **kwargs): + def list_problem_endpoints(self, problem_id, **kwargs): """ - Returns a list of Actions done on CloudGuard Problem - + Returns a list of endpoints associated with a cloud guard problem - :param str compartment_id: (required) - The ID of the compartment in which to list resources. :param str problem_id: (required) OCId of the problem. @@ -4927,13 +5094,13 @@ def list_problem_histories(self, compartment_id, problem_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.cloud_guard.models.ProblemHistoryCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ProblemEndpointCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_problem_histories API. + Click `here `__ to see an example of how to use list_problem_endpoints API. """ - resource_path = "/problems/{problemId}/histories" + resource_path = "/problems/{problemId}/endpoints" method = "GET" # Don't accept unknown kwargs @@ -4949,7 +5116,7 @@ def list_problem_histories(self, compartment_id, problem_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_problem_histories got unknown kwargs: {!r}".format(extra_kwargs)) + "list_problem_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "problemId": problem_id @@ -4976,7 +5143,6 @@ def list_problem_histories(self, compartment_id, problem_id, **kwargs): ) query_params = { - "compartmentId": compartment_id, "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -5007,7 +5173,7 @@ def list_problem_histories(self, compartment_id, problem_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ProblemHistoryCollection") + response_type="ProblemEndpointCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -5015,101 +5181,18 @@ def list_problem_histories(self, compartment_id, problem_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ProblemHistoryCollection") + response_type="ProblemEndpointCollection") - def list_problems(self, compartment_id, **kwargs): + def list_problem_histories(self, compartment_id, problem_id, **kwargs): """ - Returns a list of all Problems identified by the Cloud Guard - - The ListProblems operation returns only the problems in `compartmentId` passed. - The list does not include any subcompartments of the compartmentId passed. - - The parameter `accessLevel` specifies whether to return only those compartments for which the - requestor has INSPECT permissions on at least one resource directly - or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if - Principal doesn't have access to even one of the child compartments. This is valid only when - `compartmentIdInSubtree` is set to `true`. - - The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the - `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. - To get a full list of all compartments and subcompartments in the tenancy (root compartment), - set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. + Returns a list of Actions done on CloudGuard Problem :param str compartment_id: (required) The ID of the compartment in which to list resources. - :param datetime time_last_detected_greater_than_or_equal_to: (optional) - Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. - - :param datetime time_last_detected_less_than_or_equal_to: (optional) - End time for a filter. If end time is not specified, end time will be set to current time. - - :param datetime time_first_detected_greater_than_or_equal_to: (optional) - Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. - - :param datetime time_first_detected_less_than_or_equal_to: (optional) - End time for a filter. If end time is not specified, end time will be set to current time. - - :param str lifecycle_detail: (optional) - The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - - Allowed values are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" - - :param str lifecycle_state: (optional) - The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - - Allowed values are: "ACTIVE", "INACTIVE" - - :param str region: (optional) - OCI Monitoring region. - - :param str risk_level: (optional) - Risk level of the Problem. - - :param str resource_type: (optional) - Resource Type associated with the resource. - - :param str city: (optional) - City of the problem. - - :param str state: (optional) - State of the problem. - - :param str country: (optional) - Country of the problem. - - :param str label: (optional) - Label associated with the Problem. - - :param list[str] detector_rule_id_list: (optional) - Comma seperated list of detector rule ids to be passed in to match against Problems. - - :param str detector_type: (optional) - The field to list the Problems by Detector Type. Valid values are IAAS_ACTIVITY_DETECTOR and IAAS_CONFIGURATION_DETECTOR - - Allowed values are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR" - - :param str target_id: (optional) - The ID of the target in which to list resources. - - :param bool compartment_id_in_subtree: (optional) - Default is false. - When set to true, the hierarchy of compartments is traversed - and all compartments and subcompartments in the tenancy are - returned depending on the the setting of `accessLevel`. - - :param str access_level: (optional) - Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. - Setting this to `ACCESSIBLE` returns only those compartments for which the - user has INSPECT permissions directly or indirectly (permissions can be on a - resource in a subcompartment). - When set to `RESTRICTED` permissions are checked and no partial results are displayed. - - Allowed values are: "RESTRICTED", "ACCESSIBLE" - - :param str resource_id: (optional) - The ID of the resource associated with the problem. + :param str problem_id: (required) + OCId of the problem. :param int limit: (optional) The maximum number of items to return. @@ -5123,9 +5206,9 @@ def list_problems(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. - Allowed values are: "riskLevel", "timeLastDetected", "resourceName" + Allowed values are: "timeCreated" :param str opc_request_id: (optional) The client request ID for tracing. @@ -5142,11 +5225,226 @@ def list_problems(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ProblemCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ProblemHistoryCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_problems API. + Click `here `__ to see an example of how to use list_problem_histories API. + """ + resource_path = "/problems/{problemId}/histories" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_problem_histories got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "problemId": problem_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ProblemHistoryCollection") + 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="ProblemHistoryCollection") + + def list_problems(self, compartment_id, **kwargs): + """ + Returns a list of all Problems identified by the Cloud Guard + + The ListProblems operation returns only the problems in `compartmentId` passed. + The list does not include any subcompartments of the compartmentId passed. + + The parameter `accessLevel` specifies whether to return only those compartments for which the + requestor has INSPECT permissions on at least one resource directly + or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if + Principal doesn't have access to even one of the child compartments. This is valid only when + `compartmentIdInSubtree` is set to `true`. + + The parameter `compartmentIdInSubtree` applies when you perform ListProblems on the + `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. + To get a full list of all compartments and subcompartments in the tenancy (root compartment), + set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param datetime time_last_detected_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. + + :param datetime time_last_detected_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to current time. + + :param datetime time_first_detected_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. + + :param datetime time_first_detected_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to current time. + + :param str lifecycle_detail: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "OPEN", "RESOLVED", "DISMISSED", "DELETED" + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "ACTIVE", "INACTIVE" + + :param str region: (optional) + OCI Monitoring region. + + :param str risk_level: (optional) + Risk level of the Problem. + + :param str resource_type: (optional) + Resource Type associated with the resource. + + :param str city: (optional) + City of the problem. + + :param str state: (optional) + State of the problem. + + :param str country: (optional) + Country of the problem. + + :param str label: (optional) + Label associated with the Problem. + + :param list[str] detector_rule_id_list: (optional) + Comma seperated list of detector rule ids to be passed in to match against Problems. + + :param str detector_type: (optional) + The field to list the Problems by Detector Type. Valid values are IAAS_ACTIVITY_DETECTOR and IAAS_CONFIGURATION_DETECTOR + + Allowed values are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR" + + :param str target_id: (optional) + The ID of the target in which to list resources. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + + :param str access_level: (optional) + Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). + When set to `RESTRICTED` permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param str resource_id: (optional) + The ID of the resource associated with the problem. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default. + + Allowed values are: "riskLevel", "timeLastDetected", "resourceName" + + :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.cloud_guard.models.ProblemCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_problems API. """ resource_path = "/problems" method = "GET" @@ -5200,7 +5498,7 @@ def list_problems(self, compartment_id, **kwargs): ) if 'detector_type' in kwargs: - detector_type_allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + detector_type_allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if kwargs['detector_type'] not in detector_type_allowed_values: raise ValueError( "Invalid value for `detector_type`, must be one of {0}".format(detector_type_allowed_values) @@ -5462,18 +5760,13 @@ def list_recommendations(self, compartment_id, **kwargs): header_params=header_params, response_type="RecommendationSummaryCollection") - def list_resource_types(self, compartment_id, **kwargs): + def list_resource_profile_endpoints(self, resource_profile_id, **kwargs): """ - Returns a list of resource types. - - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. + Returns a list of endpoints for Cloud Guard resource profile - :param str lifecycle_state: (optional) - The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + :param str resource_profile_id: (required) + OCID of the resource profile. :param int limit: (optional) The maximum number of items to return. @@ -5487,9 +5780,9 @@ def list_resource_types(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. - Allowed values are: "displayName", "riskLevel" + Allowed values are: "timeCreated" :param str opc_request_id: (optional) The client request ID for tracing. @@ -5506,20 +5799,19 @@ def list_resource_types(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResourceTypeCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResourceProfileEndpointCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_resource_types API. + Click `here `__ to see an example of how to use list_resource_profile_endpoints API. """ - resource_path = "/resourceTypes" + resource_path = "/resourceProfiles/{resourceProfileId}/endpoints" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "lifecycle_state", "limit", "page", "sort_order", @@ -5529,14 +5821,17 @@ def list_resource_types(self, compartment_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_resource_types got unknown kwargs: {!r}".format(extra_kwargs)) + "list_resource_profile_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) - ) + path_params = { + "resourceProfileId": resource_profile_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] @@ -5546,15 +5841,13 @@ def list_resource_types(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["displayName", "riskLevel"] + sort_by_allowed_values = ["timeCreated"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) query_params = { - "compartmentId": compartment_id, - "lifecycleState": kwargs.get("lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -5582,24 +5875,26 @@ def list_resource_types(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="ResourceTypeCollection") + response_type="ResourceProfileEndpointCollection") 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="ResourceTypeCollection") + response_type="ResourceProfileEndpointCollection") - def list_responder_activities(self, problem_id, **kwargs): + def list_resource_profile_impacted_resources(self, resource_profile_id, **kwargs): """ - Returns a list of Responder activities done on CloudGuard Problem + Returns a list of impacted resources for Cloud Guard resource profile - :param str problem_id: (required) - OCId of the problem. + :param str resource_profile_id: (required) + OCID of the resource profile. :param int limit: (optional) The maximum number of items to return. @@ -5613,9 +5908,9 @@ def list_responder_activities(self, problem_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName is ascending. If no value is specified timeCreated is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. - Allowed values are: "timeCreated", "responderRuleName" + Allowed values are: "timeCreated" :param str opc_request_id: (optional) The client request ID for tracing. @@ -5632,13 +5927,13 @@ def list_responder_activities(self, problem_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.cloud_guard.models.ResponderActivityCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResourceProfileImpactedResourceCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_responder_activities API. + Click `here `__ to see an example of how to use list_resource_profile_impacted_resources API. """ - resource_path = "/problems/{problemId}/responderActivities" + resource_path = "/resourceProfiles/{resourceProfileId}/impactedResources" method = "GET" # Don't accept unknown kwargs @@ -5654,10 +5949,10 @@ def list_responder_activities(self, problem_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_responder_activities got unknown kwargs: {!r}".format(extra_kwargs)) + "list_resource_profile_impacted_resources got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "problemId": problem_id + "resourceProfileId": resource_profile_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -5674,7 +5969,7 @@ def list_responder_activities(self, problem_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "responderRuleName"] + sort_by_allowed_values = ["timeCreated"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -5711,7 +6006,7 @@ def list_responder_activities(self, problem_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ResponderActivityCollection") + response_type="ResourceProfileImpactedResourceCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -5719,16 +6014,41 @@ def list_responder_activities(self, problem_id, **kwargs): path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ResponderActivityCollection") + response_type="ResourceProfileImpactedResourceCollection") - def list_responder_executions(self, compartment_id, **kwargs): + def list_resource_profiles(self, compartment_id, **kwargs): """ - Returns a list of Responder Executions. A Responder Execution is an entity that tracks the collective execution of multiple Responder Rule Executions for a given Problem. + Returns a list of all resource profiles identified by the Cloud Guard + The ListResourceProfiles operation returns only resource profiles that match the passed filters. + + The ListResourceProfiles operation returns only the resource profiles in `compartmentId` passed. + The parameter `accessLevel` specifies whether to return only those compartments for which the + requestor has INSPECT permissions on at least one resource directly + or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if + Principal doesn't have access to even one of the child compartments. This is valid only when + `compartmentIdInSubtree` is set to `true`. + + The parameter `compartmentIdInSubtree` applies when you perform ListResourceProfiles on the + `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. + To get a full list of all compartments and subcompartments in the tenancy (root compartment), + set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. :param str compartment_id: (required) The ID of the compartment in which to list resources. + :param datetime time_last_detected_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. + + :param datetime time_last_detected_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to current time. + + :param datetime time_first_detected_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. + + :param datetime time_first_detected_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to current time. + :param bool compartment_id_in_subtree: (optional) Default is false. When set to true, the hierarchy of compartments is traversed @@ -5744,41 +6064,20 @@ def list_responder_executions(self, compartment_id, **kwargs): Allowed values are: "RESTRICTED", "ACCESSIBLE" - :param list[str] responder_rule_ids: (optional) - Responder Rule Ids filter for the Responder Executions. - - :param datetime time_created_greater_than_or_equal_to: (optional) - Creation Start time for filtering - - :param datetime time_created_less_than_or_equal_to: (optional) - Creation End time for filtering - - :param datetime time_completed_greater_than_or_equal_to: (optional) - Completion End Time - - :param datetime time_completed_less_than_or_equal_to: (optional) - Completion Start Time - - :param str target_id: (optional) - The ID of the target in which to list resources. - - :param str resource_type: (optional) - Resource Type associated with the resource. - - :param str responder_type: (optional) - The field to list the Responder Executions by Responder Type. Valid values are REMEDIATION and NOTIFICATION - - Allowed values are: "REMEDIATION", "NOTIFICATION" + :param list[str] resource_types: (optional) + A filter to return only resources that match the list of resource types given - :param str responder_execution_status: (optional) - The status of the responder execution in which to list responders. + :param float risk_score_greater_than_or_equal_to: (optional) + risk score filter - Allowed values are: "STARTED", "AWAITING_CONFIRMATION", "AWAITING_INPUT", "SUCCEEDED", "FAILED", "SKIPPED", "ALL" + :param float risk_score_less_than_or_equal_to: (optional) + risk score filter - :param str responder_execution_mode: (optional) - The mode of the responder execution in which to list responders. + :param list[str] techniques: (optional) + A filter to return only resources that match the list of techniques given - Allowed values are: "MANUAL", "AUTOMATED", "ALL" + :param list[str] tactics: (optional) + A filter to return only resources that match the list of tactics given. :param int limit: (optional) The maximum number of items to return. @@ -5792,9 +6091,9 @@ def list_responder_executions(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default. + The field to sort resource profiles. Only one sort order may be provided. Default order for timeLastDetected is descending. If no value is specified timeLastDetected is default. - Allowed values are: "timeCreated", "responderRuleName", "resourceName", "timeCompleted" + Allowed values are: "riskScore", "riskScoreGrowth", "timeFirstDetected", "timeLastDetected", "sightingsCount", "displayName", "type" :param str opc_request_id: (optional) The client request ID for tracing. @@ -5811,31 +6110,30 @@ def list_responder_executions(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResponderExecutionCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResourceProfileCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_responder_executions API. + Click `here `__ to see an example of how to use list_resource_profiles API. """ - resource_path = "/responderExecutions" + resource_path = "/resourceProfiles" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", + "time_last_detected_greater_than_or_equal_to", + "time_last_detected_less_than_or_equal_to", + "time_first_detected_greater_than_or_equal_to", + "time_first_detected_less_than_or_equal_to", "compartment_id_in_subtree", "access_level", - "responder_rule_ids", - "time_created_greater_than_or_equal_to", - "time_created_less_than_or_equal_to", - "time_completed_greater_than_or_equal_to", - "time_completed_less_than_or_equal_to", - "target_id", - "resource_type", - "responder_type", - "responder_execution_status", - "responder_execution_mode", + "resource_types", + "risk_score_greater_than_or_equal_to", + "risk_score_less_than_or_equal_to", + "techniques", + "tactics", "limit", "page", "sort_order", @@ -5845,7 +6143,7 @@ def list_responder_executions(self, compartment_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_responder_executions got unknown kwargs: {!r}".format(extra_kwargs)) + "list_resource_profiles got unknown kwargs: {!r}".format(extra_kwargs)) if 'access_level' in kwargs: access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] @@ -5854,25 +6152,158 @@ def list_responder_executions(self, compartment_id, **kwargs): "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) ) - if 'responder_type' in kwargs: - responder_type_allowed_values = ["REMEDIATION", "NOTIFICATION"] - if kwargs['responder_type'] not in responder_type_allowed_values: + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: raise ValueError( - "Invalid value for `responder_type`, must be one of {0}".format(responder_type_allowed_values) + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) ) - if 'responder_execution_status' in kwargs: - responder_execution_status_allowed_values = ["STARTED", "AWAITING_CONFIRMATION", "AWAITING_INPUT", "SUCCEEDED", "FAILED", "SKIPPED", "ALL"] - if kwargs['responder_execution_status'] not in responder_execution_status_allowed_values: + if 'sort_by' in kwargs: + sort_by_allowed_values = ["riskScore", "riskScoreGrowth", "timeFirstDetected", "timeLastDetected", "sightingsCount", "displayName", "type"] + if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( - "Invalid value for `responder_execution_status`, must be one of {0}".format(responder_execution_status_allowed_values) + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) - if 'responder_execution_mode' in kwargs: - responder_execution_mode_allowed_values = ["MANUAL", "AUTOMATED", "ALL"] - if kwargs['responder_execution_mode'] not in responder_execution_mode_allowed_values: + query_params = { + "compartmentId": compartment_id, + "timeLastDetectedGreaterThanOrEqualTo": kwargs.get("time_last_detected_greater_than_or_equal_to", missing), + "timeLastDetectedLessThanOrEqualTo": kwargs.get("time_last_detected_less_than_or_equal_to", missing), + "timeFirstDetectedGreaterThanOrEqualTo": kwargs.get("time_first_detected_greater_than_or_equal_to", missing), + "timeFirstDetectedLessThanOrEqualTo": kwargs.get("time_first_detected_less_than_or_equal_to", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "resourceTypes": self.base_client.generate_collection_format_param(kwargs.get("resource_types", missing), 'multi'), + "riskScoreGreaterThanOrEqualTo": kwargs.get("risk_score_greater_than_or_equal_to", missing), + "riskScoreLessThanOrEqualTo": kwargs.get("risk_score_less_than_or_equal_to", missing), + "techniques": self.base_client.generate_collection_format_param(kwargs.get("techniques", missing), 'multi'), + "tactics": self.base_client.generate_collection_format_param(kwargs.get("tactics", missing), 'multi'), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ResourceProfileCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResourceProfileCollection") + + def list_resource_types(self, compartment_id, **kwargs): + """ + Returns a list of resource types. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str detector_id: (optional) + Detector type + + Allowed values are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR" + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. + + Allowed values are: "displayName", "riskLevel" + + :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.cloud_guard.models.ResourceTypeCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_resource_types API. + """ + resource_path = "/resourceTypes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "detector_id", + "lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_resource_types got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'detector_id' in kwargs: + detector_id_allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] + if kwargs['detector_id'] not in detector_id_allowed_values: raise ValueError( - "Invalid value for `responder_execution_mode`, must be one of {0}".format(responder_execution_mode_allowed_values) + "Invalid value for `detector_id`, must be one of {0}".format(detector_id_allowed_values) + ) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) ) if 'sort_order' in kwargs: @@ -5883,7 +6314,7 @@ def list_responder_executions(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "responderRuleName", "resourceName", "timeCompleted"] + sort_by_allowed_values = ["displayName", "riskLevel"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -5891,18 +6322,8 @@ def list_responder_executions(self, compartment_id, **kwargs): query_params = { "compartmentId": compartment_id, - "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), - "accessLevel": kwargs.get("access_level", missing), - "responderRuleIds": self.base_client.generate_collection_format_param(kwargs.get("responder_rule_ids", missing), 'multi'), - "timeCreatedGreaterThanOrEqualTo": kwargs.get("time_created_greater_than_or_equal_to", missing), - "timeCreatedLessThanOrEqualTo": kwargs.get("time_created_less_than_or_equal_to", missing), - "timeCompletedGreaterThanOrEqualTo": kwargs.get("time_completed_greater_than_or_equal_to", missing), - "timeCompletedLessThanOrEqualTo": kwargs.get("time_completed_less_than_or_equal_to", missing), - "targetId": kwargs.get("target_id", missing), - "resourceType": kwargs.get("resource_type", missing), - "responderType": kwargs.get("responder_type", missing), - "responderExecutionStatus": kwargs.get("responder_execution_status", missing), - "responderExecutionMode": kwargs.get("responder_execution_mode", missing), + "detectorId": kwargs.get("detector_id", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -5932,33 +6353,967 @@ def list_responder_executions(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="ResponderExecutionCollection") + response_type="ResourceTypeCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="ResponderExecutionCollection") + response_type="ResourceTypeCollection") + + def list_responder_activities(self, problem_id, **kwargs): + """ + Returns a list of Responder activities done on CloudGuard Problem + + + :param str problem_id: (required) + OCId of the problem. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "responderRuleName" + + :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.cloud_guard.models.ResponderActivityCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_responder_activities API. + """ + resource_path = "/problems/{problemId}/responderActivities" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_responder_activities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "problemId": problem_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "responderRuleName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ResponderActivityCollection") + 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="ResponderActivityCollection") + + def list_responder_executions(self, compartment_id, **kwargs): + """ + Returns a list of Responder Executions. A Responder Execution is an entity that tracks the collective execution of multiple Responder Rule Executions for a given Problem. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + + :param str access_level: (optional) + Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). + When set to `RESTRICTED` permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param list[str] responder_rule_ids: (optional) + Responder Rule Ids filter for the Responder Executions. + + :param datetime time_created_greater_than_or_equal_to: (optional) + Creation Start time for filtering + + :param datetime time_created_less_than_or_equal_to: (optional) + Creation End time for filtering + + :param datetime time_completed_greater_than_or_equal_to: (optional) + Completion End Time + + :param datetime time_completed_less_than_or_equal_to: (optional) + Completion Start Time + + :param str target_id: (optional) + The ID of the target in which to list resources. + + :param str resource_type: (optional) + Resource Type associated with the resource. + + :param str responder_type: (optional) + The field to list the Responder Executions by Responder Type. Valid values are REMEDIATION and NOTIFICATION + + Allowed values are: "REMEDIATION", "NOTIFICATION" + + :param str responder_execution_status: (optional) + The status of the responder execution in which to list responders. + + Allowed values are: "STARTED", "AWAITING_CONFIRMATION", "AWAITING_INPUT", "SUCCEEDED", "FAILED", "SKIPPED", "ALL" + + :param str responder_execution_mode: (optional) + The mode of the responder execution in which to list responders. + + Allowed values are: "MANUAL", "AUTOMATED", "ALL" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "responderRuleName", "resourceName", "timeCompleted" + + :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.cloud_guard.models.ResponderExecutionCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_responder_executions API. + """ + resource_path = "/responderExecutions" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "compartment_id_in_subtree", + "access_level", + "responder_rule_ids", + "time_created_greater_than_or_equal_to", + "time_created_less_than_or_equal_to", + "time_completed_greater_than_or_equal_to", + "time_completed_less_than_or_equal_to", + "target_id", + "resource_type", + "responder_type", + "responder_execution_status", + "responder_execution_mode", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_responder_executions got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + ) + + if 'responder_type' in kwargs: + responder_type_allowed_values = ["REMEDIATION", "NOTIFICATION"] + if kwargs['responder_type'] not in responder_type_allowed_values: + raise ValueError( + "Invalid value for `responder_type`, must be one of {0}".format(responder_type_allowed_values) + ) + + if 'responder_execution_status' in kwargs: + responder_execution_status_allowed_values = ["STARTED", "AWAITING_CONFIRMATION", "AWAITING_INPUT", "SUCCEEDED", "FAILED", "SKIPPED", "ALL"] + if kwargs['responder_execution_status'] not in responder_execution_status_allowed_values: + raise ValueError( + "Invalid value for `responder_execution_status`, must be one of {0}".format(responder_execution_status_allowed_values) + ) + + if 'responder_execution_mode' in kwargs: + responder_execution_mode_allowed_values = ["MANUAL", "AUTOMATED", "ALL"] + if kwargs['responder_execution_mode'] not in responder_execution_mode_allowed_values: + raise ValueError( + "Invalid value for `responder_execution_mode`, must be one of {0}".format(responder_execution_mode_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "responderRuleName", "resourceName", "timeCompleted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "responderRuleIds": self.base_client.generate_collection_format_param(kwargs.get("responder_rule_ids", missing), 'multi'), + "timeCreatedGreaterThanOrEqualTo": kwargs.get("time_created_greater_than_or_equal_to", missing), + "timeCreatedLessThanOrEqualTo": kwargs.get("time_created_less_than_or_equal_to", missing), + "timeCompletedGreaterThanOrEqualTo": kwargs.get("time_completed_greater_than_or_equal_to", missing), + "timeCompletedLessThanOrEqualTo": kwargs.get("time_completed_less_than_or_equal_to", missing), + "targetId": kwargs.get("target_id", missing), + "resourceType": kwargs.get("resource_type", missing), + "responderType": kwargs.get("responder_type", missing), + "responderExecutionStatus": kwargs.get("responder_execution_status", missing), + "responderExecutionMode": kwargs.get("responder_execution_mode", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderExecutionCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderExecutionCollection") + + def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment_id, **kwargs): + """ + Returns a list of ResponderRule associated with ResponderRecipe. + + + :param str responder_recipe_id: (required) + OCID of ResponderRecipe + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. + + Allowed values are: "displayName", "riskLevel" + + :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.cloud_guard.models.ResponderRecipeResponderRuleCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_responder_recipe_responder_rules API. + """ + resource_path = "/responderRecipes/{responderRecipeId}/responderRules" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_responder_recipe_responder_rules got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "responderRecipeId": responder_recipe_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["displayName", "riskLevel"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ResponderRecipeResponderRuleCollection") + 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="ResponderRecipeResponderRuleCollection") + + def list_responder_recipes(self, compartment_id, **kwargs): + """ + Returns a list of all ResponderRecipes in a compartment + The ListResponderRecipe operation returns only the targets in `compartmentId` passed. + The list does not include any subcompartments of the compartmentId passed. + + The parameter `accessLevel` specifies whether to return only those compartments for which the + requestor has INSPECT permissions on at least one resource directly + or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if + Principal doesn't have access to even one of the child compartments. This is valid only when + `compartmentIdInSubtree` is set to `true`. + + The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the + `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. + To get a full list of all compartments and subcompartments in the tenancy (root compartment), + set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param bool resource_metadata_only: (optional) + Default is false. + When set to true, the list of all Oracle Managed Resources + Metadata supported by Cloud Guard are returned. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + + :param str access_level: (optional) + Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). + When set to `RESTRICTED` permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResponderRecipeCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_responder_recipes API. + """ + resource_path = "/responderRecipes" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "resource_metadata_only", + "display_name", + "lifecycle_state", + "limit", + "page", + "compartment_id_in_subtree", + "access_level", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_responder_recipes got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "resourceMetadataOnly": kwargs.get("resource_metadata_only", missing), + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderRecipeCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderRecipeCollection") + + def list_responder_rules(self, compartment_id, **kwargs): + """ + Returns a list of ResponderRule. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param str display_name: (optional) + A filter to return only resources that match the entire display name given. + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated", "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResponderRuleCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_responder_rules API. + """ + resource_path = "/responderRules" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "display_name", + "lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_responder_rules got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "displayName": kwargs.get("display_name", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderRuleCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResponderRuleCollection") + + def list_sighting_endpoints(self, sighting_id, **kwargs): + """ + Returns Sighting endpoints details + + + :param str sighting_id: (required) + OCID of the sighting. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. + + Allowed values are: "timeCreated" + + :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.cloud_guard.models.SightingEndpointCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_sighting_endpoints API. + """ + resource_path = "/sightings/{sightingId}/endpoints" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_sighting_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "sightingId": sighting_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="SightingEndpointCollection") + 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="SightingEndpointCollection") - def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment_id, **kwargs): + def list_sighting_impacted_resources(self, sighting_id, **kwargs): """ - Returns a list of ResponderRule associated with ResponderRecipe. - - - :param str responder_recipe_id: (required) - OCID of ResponderRecipe - - :param str compartment_id: (required) - The ID of the compartment in which to list resources. - - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. + Return a list of Impacted Resources for a CloudGuard Sighting - :param str lifecycle_state: (optional) - The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + :param str sighting_id: (required) + OCID of the sighting. :param int limit: (optional) The maximum number of items to return. @@ -5972,9 +7327,9 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. - Allowed values are: "displayName", "riskLevel" + Allowed values are: "timeCreated" :param str opc_request_id: (optional) The client request ID for tracing. @@ -5991,21 +7346,19 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment 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.cloud_guard.models.ResponderRecipeResponderRuleCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.SightingImpactedResourceCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_responder_recipe_responder_rules API. + Click `here `__ to see an example of how to use list_sighting_impacted_resources API. """ - resource_path = "/responderRecipes/{responderRecipeId}/responderRules" + resource_path = "/sightings/{sightingId}/impactedResources" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "display_name", - "lifecycle_state", "limit", "page", "sort_order", @@ -6015,10 +7368,10 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_responder_recipe_responder_rules got unknown kwargs: {!r}".format(extra_kwargs)) + "list_sighting_impacted_resources got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "responderRecipeId": responder_recipe_id + "sightingId": sighting_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -6027,13 +7380,6 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) - ) - if 'sort_order' in kwargs: sort_order_allowed_values = ["ASC", "DESC"] if kwargs['sort_order'] not in sort_order_allowed_values: @@ -6042,16 +7388,13 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["displayName", "riskLevel"] + sort_by_allowed_values = ["timeCreated"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) query_params = { - "compartmentId": compartment_id, - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -6082,7 +7425,7 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ResponderRecipeResponderRuleCollection") + response_type="SightingImpactedResourceCollection") else: return self.base_client.call_api( resource_path=resource_path, @@ -6090,13 +7433,12 @@ def list_responder_recipe_responder_rules(self, responder_recipe_id, compartment path_params=path_params, query_params=query_params, header_params=header_params, - response_type="ResponderRecipeResponderRuleCollection") + response_type="SightingImpactedResourceCollection") - def list_responder_recipes(self, compartment_id, **kwargs): + def list_sightings(self, compartment_id, **kwargs): """ - Returns a list of all ResponderRecipes in a compartment - The ListResponderRecipe operation returns only the targets in `compartmentId` passed. - The list does not include any subcompartments of the compartmentId passed. + Returns a list of all Sightings identified by the Cloud Guard + The ListSightings operation returns only sightings that match the passed filters. The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly @@ -6104,7 +7446,7 @@ def list_responder_recipes(self, compartment_id, **kwargs): Principal doesn't have access to even one of the child compartments. This is valid only when `compartmentIdInSubtree` is set to `true`. - The parameter `compartmentIdInSubtree` applies when you perform ListResponderRecipe on the + The parameter `compartmentIdInSubtree` applies when you perform ListSightings on the `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE. @@ -6113,24 +7455,11 @@ def list_responder_recipes(self, compartment_id, **kwargs): :param str compartment_id: (required) The ID of the compartment in which to list resources. - :param bool resource_metadata_only: (optional) - Default is false. - When set to true, the list of all Oracle Managed Resources - Metadata supported by Cloud Guard are returned. - - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. - - :param str lifecycle_state: (optional) - The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. - - Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" - - :param int limit: (optional) - The maximum number of items to return. + :param str problem_id: (optional) + OCID of the problem. - :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 resource_profile_id: (optional) + OCID of the resource profile. :param bool compartment_id_in_subtree: (optional) Default is false. @@ -6147,15 +7476,27 @@ def list_responder_recipes(self, compartment_id, **kwargs): Allowed values are: "RESTRICTED", "ACCESSIBLE" + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default. - Allowed values are: "timeCreated", "displayName" + Allowed values are: "timeCreated" + + :param datetime time_last_detected_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to current time - 30 days. + + :param datetime time_last_detected_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to current time. :param str opc_request_id: (optional) The client request ID for tracing. @@ -6172,41 +7513,35 @@ def list_responder_recipes(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResponderRecipeCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.SightingCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_responder_recipes API. + Click `here `__ to see an example of how to use list_sightings API. """ - resource_path = "/responderRecipes" + resource_path = "/sightings" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "resource_metadata_only", - "display_name", - "lifecycle_state", - "limit", - "page", + "problem_id", + "resource_profile_id", "compartment_id_in_subtree", "access_level", + "limit", + "page", "sort_order", "sort_by", + "time_last_detected_greater_than_or_equal_to", + "time_last_detected_less_than_or_equal_to", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_responder_recipes got unknown kwargs: {!r}".format(extra_kwargs)) - - if 'lifecycle_state' in kwargs: - lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] - if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: - raise ValueError( - "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) - ) + "list_sightings got unknown kwargs: {!r}".format(extra_kwargs)) if 'access_level' in kwargs: access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] @@ -6223,23 +7558,24 @@ def list_responder_recipes(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] + sort_by_allowed_values = ["timeCreated"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) query_params = { + "problemId": kwargs.get("problem_id", missing), + "resourceProfileId": kwargs.get("resource_profile_id", missing), "compartmentId": compartment_id, - "resourceMetadataOnly": kwargs.get("resource_metadata_only", missing), - "displayName": kwargs.get("display_name", missing), - "lifecycleState": kwargs.get("lifecycle_state", missing), - "limit": kwargs.get("limit", missing), - "page": kwargs.get("page", missing), "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), "accessLevel": kwargs.get("access_level", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), - "sortBy": kwargs.get("sort_by", missing) + "sortBy": kwargs.get("sort_by", missing), + "timeLastDetectedGreaterThanOrEqualTo": kwargs.get("time_last_detected_greater_than_or_equal_to", missing), + "timeLastDetectedLessThanOrEqualTo": kwargs.get("time_last_detected_less_than_or_equal_to", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6265,26 +7601,23 @@ def list_responder_recipes(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="ResponderRecipeCollection") + response_type="SightingCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="ResponderRecipeCollection") + response_type="SightingCollection") - def list_responder_rules(self, compartment_id, **kwargs): + def list_tactics(self, compartment_id, **kwargs): """ - Returns a list of ResponderRule. + Returns a list of tactics associated with detector rules. :param str compartment_id: (required) The ID of the compartment in which to list resources. - :param str display_name: (optional) - A filter to return only resources that match the entire display name given. - :param str lifecycle_state: (optional) The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. @@ -6302,9 +7635,9 @@ def list_responder_rules(self, compartment_id, **kwargs): Allowed values are: "ASC", "DESC" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. + The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. - Allowed values are: "timeCreated", "displayName" + Allowed values are: "displayName" :param str opc_request_id: (optional) The client request ID for tracing. @@ -6321,20 +7654,19 @@ def list_responder_rules(self, compartment_id, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.ResponderRuleCollection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.TacticCollection` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use list_responder_rules API. + Click `here `__ to see an example of how to use list_tactics API. """ - resource_path = "/responderRules" + resource_path = "/tactics" method = "GET" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "display_name", "lifecycle_state", "limit", "page", @@ -6345,7 +7677,7 @@ def list_responder_rules(self, compartment_id, **kwargs): extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "list_responder_rules got unknown kwargs: {!r}".format(extra_kwargs)) + "list_tactics got unknown kwargs: {!r}".format(extra_kwargs)) if 'lifecycle_state' in kwargs: lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] @@ -6362,7 +7694,7 @@ def list_responder_rules(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] + sort_by_allowed_values = ["displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) @@ -6370,7 +7702,6 @@ def list_responder_rules(self, compartment_id, **kwargs): query_params = { "compartmentId": compartment_id, - "displayName": kwargs.get("display_name", missing), "lifecycleState": kwargs.get("lifecycle_state", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), @@ -6401,14 +7732,14 @@ def list_responder_rules(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="ResponderRuleCollection") + response_type="TacticCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="ResponderRuleCollection") + response_type="TacticCollection") def list_target_detector_recipe_detector_rules(self, target_id, target_detector_recipe_id, compartment_id, **kwargs): """ @@ -7136,7 +8467,145 @@ def list_targets(self, compartment_id, **kwargs): access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] if kwargs['access_level'] not in access_level_allowed_values: raise ValueError( - "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "displayName": kwargs.get("display_name", missing), + "compartmentId": compartment_id, + "lifecycleState": kwargs.get("lifecycle_state", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TargetCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="TargetCollection") + + def list_techniques(self, compartment_id, **kwargs): + """ + Returns a list of techniques associated with detector rules. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param list[str] tactics: (optional) + A filter to return only resources that match the list of tactics given. + + :param str lifecycle_state: (optional) + The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. + + Allowed values are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str sort_order: (optional) + The sort order to use, either 'asc' or 'desc'. + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default. + + Allowed values are: "displayName" + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.cloud_guard.models.TechniqueCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_techniques API. + """ + resource_path = "/techniques" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "tactics", + "lifecycle_state", + "limit", + "page", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_techniques got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'lifecycle_state' in kwargs: + lifecycle_state_allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"] + if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values: + raise ValueError( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) ) if 'sort_order' in kwargs: @@ -7147,18 +8616,16 @@ def list_targets(self, compartment_id, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["timeCreated", "displayName"] + sort_by_allowed_values = ["displayName"] if kwargs['sort_by'] not in sort_by_allowed_values: raise ValueError( "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) ) query_params = { - "displayName": kwargs.get("display_name", missing), "compartmentId": compartment_id, + "tactics": self.base_client.generate_collection_format_param(kwargs.get("tactics", missing), 'multi'), "lifecycleState": kwargs.get("lifecycle_state", missing), - "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), - "accessLevel": kwargs.get("access_level", missing), "limit": kwargs.get("limit", missing), "page": kwargs.get("page", missing), "sortOrder": kwargs.get("sort_order", missing), @@ -7188,14 +8655,14 @@ def list_targets(self, compartment_id, **kwargs): method=method, query_params=query_params, header_params=header_params, - response_type="TargetCollection") + response_type="TechniqueCollection") else: return self.base_client.call_api( resource_path=resource_path, method=method, query_params=query_params, header_params=header_params, - response_type="TargetCollection") + response_type="TechniqueCollection") def request_risk_scores(self, compartment_id, **kwargs): """ @@ -8099,6 +9566,150 @@ def request_summarized_security_scores(self, compartment_id, **kwargs): header_params=header_params, response_type="SecurityScoreAggregationCollection") + def request_summarized_top_trend_resource_profile_risk_scores(self, compartment_id, **kwargs): + """ + Summarizes the resource profile risk score top trends for the given time range based on the search filters. + + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param datetime time_score_computed_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days. + + :param datetime time_score_computed_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to today's current time. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + + :param str sort_by: (optional) + The field to sort trendlines for resource profiles. Only one sort order may be provided. If no value is specified riskScore is default. + + Allowed values are: "riskScore", "riskScoreGrowth", "timeFirstDetected", "timeLastDetected" + + :param int count: (optional) + Number of resource profile risk score trend-lines to be displayed. Default value is 10. + + :param str access_level: (optional) + Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). + When set to `RESTRICTED` permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param 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 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.cloud_guard.models.ResourceProfileRiskScoreAggregationSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use request_summarized_top_trend_resource_profile_risk_scores API. + """ + resource_path = "/resourceProfileRiskScores/actions/summarizeTopTrends" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "time_score_computed_greater_than_or_equal_to", + "time_score_computed_less_than_or_equal_to", + "compartment_id_in_subtree", + "sort_by", + "count", + "access_level", + "limit", + "page", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "request_summarized_top_trend_resource_profile_risk_scores got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["riskScore", "riskScoreGrowth", "timeFirstDetected", "timeLastDetected"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "timeScoreComputedGreaterThanOrEqualTo": kwargs.get("time_score_computed_greater_than_or_equal_to", missing), + "timeScoreComputedLessThanOrEqualTo": kwargs.get("time_score_computed_less_than_or_equal_to", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "sortBy": kwargs.get("sort_by", missing), + "count": kwargs.get("count", missing), + "accessLevel": kwargs.get("access_level", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResourceProfileRiskScoreAggregationSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="ResourceProfileRiskScoreAggregationSummaryCollection") + def request_summarized_trend_problems(self, compartment_id, **kwargs): """ Returns the number of problems identified by cloud guard, for a given time period. @@ -8235,6 +9846,136 @@ def request_summarized_trend_problems(self, compartment_id, **kwargs): header_params=header_params, response_type="ProblemTrendAggregationCollection") + def request_summarized_trend_resource_risk_scores(self, request_summarized_trend_resource_risk_scores_details, compartment_id, **kwargs): + """ + Summarizes the resource risk score trend for the given time range based on the search filters. + + + :param oci.cloud_guard.models.RequestSummarizedTrendResourceRiskScoresDetails request_summarized_trend_resource_risk_scores_details: (required) + The filter to fetch risk score trend. + + :param str compartment_id: (required) + The ID of the compartment in which to list resources. + + :param datetime time_score_computed_greater_than_or_equal_to: (optional) + Start time for a filter. If start time is not specified, start time will be set to today's current time - 30 days. + + :param datetime time_score_computed_less_than_or_equal_to: (optional) + End time for a filter. If end time is not specified, end time will be set to today's current time. + + :param bool compartment_id_in_subtree: (optional) + Default is false. + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + + :param str access_level: (optional) + Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). + When set to `RESTRICTED` permissions are checked and no partial results are displayed. + + Allowed values are: "RESTRICTED", "ACCESSIBLE" + + :param 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 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.cloud_guard.models.ResourceRiskScoreAggregationCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use request_summarized_trend_resource_risk_scores API. + """ + resource_path = "/resourceRiskScores/actions/summarizeTrend" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "time_score_computed_greater_than_or_equal_to", + "time_score_computed_less_than_or_equal_to", + "compartment_id_in_subtree", + "access_level", + "limit", + "page", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "request_summarized_trend_resource_risk_scores got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'access_level' in kwargs: + access_level_allowed_values = ["RESTRICTED", "ACCESSIBLE"] + if kwargs['access_level'] not in access_level_allowed_values: + raise ValueError( + "Invalid value for `access_level`, must be one of {0}".format(access_level_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "timeScoreComputedGreaterThanOrEqualTo": kwargs.get("time_score_computed_greater_than_or_equal_to", missing), + "timeScoreComputedLessThanOrEqualTo": kwargs.get("time_score_computed_less_than_or_equal_to", missing), + "compartmentIdInSubtree": kwargs.get("compartment_id_in_subtree", missing), + "accessLevel": kwargs.get("access_level", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + body=request_summarized_trend_resource_risk_scores_details, + response_type="ResourceRiskScoreAggregationCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + body=request_summarized_trend_resource_risk_scores_details, + response_type="ResourceRiskScoreAggregationCollection") + def request_summarized_trend_responder_executions(self, compartment_id, **kwargs): """ Returns the number of remediations performed by Responders, for a given time period. diff --git a/src/oci/cloud_guard/models/__init__.py b/src/oci/cloud_guard/models/__init__.py index 97278c096b..a0cc534569 100644 --- a/src/oci/cloud_guard/models/__init__.py +++ b/src/oci/cloud_guard/models/__init__.py @@ -63,6 +63,8 @@ from .problem_aggregation import ProblemAggregation from .problem_aggregation_collection import ProblemAggregationCollection from .problem_collection import ProblemCollection +from .problem_endpoint_collection import ProblemEndpointCollection +from .problem_endpoint_summary import ProblemEndpointSummary from .problem_history_collection import ProblemHistoryCollection from .problem_history_summary import ProblemHistorySummary from .problem_summary import ProblemSummary @@ -70,6 +72,18 @@ from .problem_trend_aggregation_collection import ProblemTrendAggregationCollection from .recommendation_summary import RecommendationSummary from .recommendation_summary_collection import RecommendationSummaryCollection +from .request_summarized_trend_resource_risk_scores_details import RequestSummarizedTrendResourceRiskScoresDetails +from .resource_profile import ResourceProfile +from .resource_profile_collection import ResourceProfileCollection +from .resource_profile_endpoint_collection import ResourceProfileEndpointCollection +from .resource_profile_endpoint_summary import ResourceProfileEndpointSummary +from .resource_profile_impacted_resource_collection import ResourceProfileImpactedResourceCollection +from .resource_profile_impacted_resource_summary import ResourceProfileImpactedResourceSummary +from .resource_profile_risk_score_aggregation_summary import ResourceProfileRiskScoreAggregationSummary +from .resource_profile_risk_score_aggregation_summary_collection import ResourceProfileRiskScoreAggregationSummaryCollection +from .resource_profile_summary import ResourceProfileSummary +from .resource_risk_score_aggregation import ResourceRiskScoreAggregation +from .resource_risk_score_aggregation_collection import ResourceRiskScoreAggregationCollection from .resource_type_collection import ResourceTypeCollection from .resource_type_summary import ResourceTypeSummary from .responder_activity_collection import ResponderActivityCollection @@ -101,8 +115,18 @@ from .security_score_trend_aggregation import SecurityScoreTrendAggregation from .security_score_trend_aggregation_collection import SecurityScoreTrendAggregationCollection from .service_type_summary import ServiceTypeSummary +from .sighting import Sighting +from .sighting_collection import SightingCollection +from .sighting_endpoint_collection import SightingEndpointCollection +from .sighting_endpoint_summary import SightingEndpointSummary +from .sighting_impacted_resource_collection import SightingImpactedResourceCollection +from .sighting_impacted_resource_summary import SightingImpactedResourceSummary +from .sighting_summary import SightingSummary +from .sighting_type import SightingType from .simple_condition import SimpleCondition from .skip_bulk_responder_execution_details import SkipBulkResponderExecutionDetails +from .tactic_collection import TacticCollection +from .tactic_summary import TacticSummary from .target import Target from .target_collection import TargetCollection from .target_detector_details import TargetDetectorDetails @@ -122,6 +146,8 @@ from .target_responder_recipe_summary import TargetResponderRecipeSummary from .target_selected import TargetSelected from .target_summary import TargetSummary +from .technique_collection import TechniqueCollection +from .technique_summary import TechniqueSummary from .trigger_responder_details import TriggerResponderDetails from .update_bulk_problem_status_details import UpdateBulkProblemStatusDetails from .update_configuration_details import UpdateConfigurationDetails @@ -209,6 +235,8 @@ "ProblemAggregation": ProblemAggregation, "ProblemAggregationCollection": ProblemAggregationCollection, "ProblemCollection": ProblemCollection, + "ProblemEndpointCollection": ProblemEndpointCollection, + "ProblemEndpointSummary": ProblemEndpointSummary, "ProblemHistoryCollection": ProblemHistoryCollection, "ProblemHistorySummary": ProblemHistorySummary, "ProblemSummary": ProblemSummary, @@ -216,6 +244,18 @@ "ProblemTrendAggregationCollection": ProblemTrendAggregationCollection, "RecommendationSummary": RecommendationSummary, "RecommendationSummaryCollection": RecommendationSummaryCollection, + "RequestSummarizedTrendResourceRiskScoresDetails": RequestSummarizedTrendResourceRiskScoresDetails, + "ResourceProfile": ResourceProfile, + "ResourceProfileCollection": ResourceProfileCollection, + "ResourceProfileEndpointCollection": ResourceProfileEndpointCollection, + "ResourceProfileEndpointSummary": ResourceProfileEndpointSummary, + "ResourceProfileImpactedResourceCollection": ResourceProfileImpactedResourceCollection, + "ResourceProfileImpactedResourceSummary": ResourceProfileImpactedResourceSummary, + "ResourceProfileRiskScoreAggregationSummary": ResourceProfileRiskScoreAggregationSummary, + "ResourceProfileRiskScoreAggregationSummaryCollection": ResourceProfileRiskScoreAggregationSummaryCollection, + "ResourceProfileSummary": ResourceProfileSummary, + "ResourceRiskScoreAggregation": ResourceRiskScoreAggregation, + "ResourceRiskScoreAggregationCollection": ResourceRiskScoreAggregationCollection, "ResourceTypeCollection": ResourceTypeCollection, "ResourceTypeSummary": ResourceTypeSummary, "ResponderActivityCollection": ResponderActivityCollection, @@ -247,8 +287,18 @@ "SecurityScoreTrendAggregation": SecurityScoreTrendAggregation, "SecurityScoreTrendAggregationCollection": SecurityScoreTrendAggregationCollection, "ServiceTypeSummary": ServiceTypeSummary, + "Sighting": Sighting, + "SightingCollection": SightingCollection, + "SightingEndpointCollection": SightingEndpointCollection, + "SightingEndpointSummary": SightingEndpointSummary, + "SightingImpactedResourceCollection": SightingImpactedResourceCollection, + "SightingImpactedResourceSummary": SightingImpactedResourceSummary, + "SightingSummary": SightingSummary, + "SightingType": SightingType, "SimpleCondition": SimpleCondition, "SkipBulkResponderExecutionDetails": SkipBulkResponderExecutionDetails, + "TacticCollection": TacticCollection, + "TacticSummary": TacticSummary, "Target": Target, "TargetCollection": TargetCollection, "TargetDetectorDetails": TargetDetectorDetails, @@ -268,6 +318,8 @@ "TargetResponderRecipeSummary": TargetResponderRecipeSummary, "TargetSelected": TargetSelected, "TargetSummary": TargetSummary, + "TechniqueCollection": TechniqueCollection, + "TechniqueSummary": TechniqueSummary, "TriggerResponderDetails": TriggerResponderDetails, "UpdateBulkProblemStatusDetails": UpdateBulkProblemStatusDetails, "UpdateConfigurationDetails": UpdateConfigurationDetails, diff --git a/src/oci/cloud_guard/models/create_data_mask_rule_details.py b/src/oci/cloud_guard/models/create_data_mask_rule_details.py index af735fb62c..d5dfcbc926 100644 --- a/src/oci/cloud_guard/models/create_data_mask_rule_details.py +++ b/src/oci/cloud_guard/models/create_data_mask_rule_details.py @@ -163,7 +163,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateDataMaskRuleDetails. - Data Mask Rule name + Data mask rule name. + + Avoid entering confidential information. :return: The display_name of this CreateDataMaskRuleDetails. @@ -175,7 +177,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateDataMaskRuleDetails. - Data Mask Rule name + Data mask rule name. + + Avoid entering confidential information. :param display_name: The display_name of this CreateDataMaskRuleDetails. @@ -211,7 +215,8 @@ def compartment_id(self, compartment_id): def description(self): """ Gets the description of this CreateDataMaskRuleDetails. - The Data Mask Rule description. + The data mask rule description. + Avoid entering confidential information. :return: The description of this CreateDataMaskRuleDetails. @@ -223,7 +228,8 @@ def description(self): def description(self, description): """ Sets the description of this CreateDataMaskRuleDetails. - The Data Mask Rule description. + The data mask rule description. + Avoid entering confidential information. :param description: The description of this CreateDataMaskRuleDetails. @@ -381,6 +387,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this CreateDataMaskRuleDetails. :rtype: dict(str, str) @@ -394,6 +402,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this CreateDataMaskRuleDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/create_detector_recipe_details.py b/src/oci/cloud_guard/models/create_detector_recipe_details.py index 1c511719f8..b008f1ca36 100644 --- a/src/oci/cloud_guard/models/create_detector_recipe_details.py +++ b/src/oci/cloud_guard/models/create_detector_recipe_details.py @@ -79,7 +79,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateDetectorRecipeDetails. - DetectorRecipe Display Name + Detector recipe display name. + + Avoid entering confidential information. :return: The display_name of this CreateDetectorRecipeDetails. @@ -91,7 +93,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateDetectorRecipeDetails. - DetectorRecipe Display Name + Detector recipe display name. + + Avoid entering confidential information. :param display_name: The display_name of this CreateDetectorRecipeDetails. @@ -103,7 +107,9 @@ def display_name(self, display_name): def description(self): """ Gets the description of this CreateDetectorRecipeDetails. - DetectorRecipe Description + Detector recipe description. + + Avoid entering confidential information. :return: The description of this CreateDetectorRecipeDetails. @@ -115,7 +121,9 @@ def description(self): def description(self, description): """ Sets the description of this CreateDetectorRecipeDetails. - DetectorRecipe Description + Detector recipe description. + + Avoid entering confidential information. :param description: The description of this CreateDetectorRecipeDetails. @@ -202,6 +210,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this CreateDetectorRecipeDetails. :rtype: dict(str, str) @@ -215,6 +225,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this CreateDetectorRecipeDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/create_managed_list_details.py b/src/oci/cloud_guard/models/create_managed_list_details.py index 09c7e133d8..51884f899a 100644 --- a/src/oci/cloud_guard/models/create_managed_list_details.py +++ b/src/oci/cloud_guard/models/create_managed_list_details.py @@ -135,7 +135,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateManagedListDetails. - ManagedList display name + Managed list display name. + + Avoid entering confidential information. :return: The display_name of this CreateManagedListDetails. @@ -147,7 +149,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateManagedListDetails. - ManagedList display name + Managed list display name. + + Avoid entering confidential information. :param display_name: The display_name of this CreateManagedListDetails. @@ -207,7 +211,9 @@ def source_managed_list_id(self, source_managed_list_id): def description(self): """ Gets the description of this CreateManagedListDetails. - ManagedList description + Managed list description. + + Avoid entering confidential information. :return: The description of this CreateManagedListDetails. @@ -219,7 +225,9 @@ def description(self): def description(self, description): """ Sets the description of this CreateManagedListDetails. - ManagedList description + Managed list description. + + Avoid entering confidential information. :param description: The description of this CreateManagedListDetails. @@ -290,6 +298,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this CreateManagedListDetails. :rtype: dict(str, str) @@ -303,6 +313,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this CreateManagedListDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/create_responder_recipe_details.py b/src/oci/cloud_guard/models/create_responder_recipe_details.py index b9feff07ca..93610d5c0d 100644 --- a/src/oci/cloud_guard/models/create_responder_recipe_details.py +++ b/src/oci/cloud_guard/models/create_responder_recipe_details.py @@ -79,7 +79,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateResponderRecipeDetails. - ResponderRecipe Display Name + Responder recipe display name. + + Avoid entering confidential information. :return: The display_name of this CreateResponderRecipeDetails. @@ -91,7 +93,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateResponderRecipeDetails. - ResponderRecipe Display Name + Responder recipe display name. + + Avoid entering confidential information. :param display_name: The display_name of this CreateResponderRecipeDetails. @@ -103,7 +107,9 @@ def display_name(self, display_name): def description(self): """ Gets the description of this CreateResponderRecipeDetails. - ResponderRecipe Description + Responder recipe description. + + Avoid entering confidential information. :return: The description of this CreateResponderRecipeDetails. @@ -115,7 +121,9 @@ def description(self): def description(self, description): """ Sets the description of this CreateResponderRecipeDetails. - ResponderRecipe Description + Responder recipe description. + + Avoid entering confidential information. :param description: The description of this CreateResponderRecipeDetails. @@ -202,6 +210,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this CreateResponderRecipeDetails. :rtype: dict(str, str) @@ -215,6 +225,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this CreateResponderRecipeDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/create_target_details.py b/src/oci/cloud_guard/models/create_target_details.py index 796a2d3b12..c902aa2b3b 100644 --- a/src/oci/cloud_guard/models/create_target_details.py +++ b/src/oci/cloud_guard/models/create_target_details.py @@ -142,7 +142,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateTargetDetails. - DetectorTemplate Identifier + DetectorTemplate identifier. + + Avoid entering confidential information. :return: The display_name of this CreateTargetDetails. @@ -154,7 +156,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateTargetDetails. - DetectorTemplate Identifier + DetectorTemplate identifier. + + Avoid entering confidential information. :param display_name: The display_name of this CreateTargetDetails. @@ -192,6 +196,8 @@ def description(self): Gets the description of this CreateTargetDetails. The target description. + Avoid entering confidential information. + :return: The description of this CreateTargetDetails. :rtype: str @@ -204,6 +210,8 @@ def description(self, description): Sets the description of this CreateTargetDetails. The target description. + Avoid entering confidential information. + :param description: The description of this CreateTargetDetails. :type: str @@ -353,6 +361,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this CreateTargetDetails. :rtype: dict(str, str) @@ -366,6 +376,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this CreateTargetDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/data_mask_rule.py b/src/oci/cloud_guard/models/data_mask_rule.py index c3b25a0d65..7be9909096 100644 --- a/src/oci/cloud_guard/models/data_mask_rule.py +++ b/src/oci/cloud_guard/models/data_mask_rule.py @@ -225,7 +225,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this DataMaskRule. - Data Mask Rule Identifier, can be renamed + Data Mask Rule Identifier, can be renamed. :return: The display_name of this DataMaskRule. @@ -237,7 +237,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DataMaskRule. - Data Mask Rule Identifier, can be renamed + Data Mask Rule Identifier, can be renamed. :param display_name: The display_name of this DataMaskRule. @@ -249,7 +249,7 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this DataMaskRule. - Compartment Identifier where the resource is created + Compartment Identifier where the resource is created. :return: The compartment_id of this DataMaskRule. @@ -261,7 +261,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DataMaskRule. - Compartment Identifier where the resource is created + Compartment Identifier where the resource is created. :param compartment_id: The compartment_id of this DataMaskRule. @@ -506,6 +506,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this DataMaskRule. :rtype: dict(str, str) @@ -519,6 +521,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this DataMaskRule. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/data_mask_rule_summary.py b/src/oci/cloud_guard/models/data_mask_rule_summary.py index 9b8d36e126..74ee0515d2 100644 --- a/src/oci/cloud_guard/models/data_mask_rule_summary.py +++ b/src/oci/cloud_guard/models/data_mask_rule_summary.py @@ -506,6 +506,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this DataMaskRuleSummary. :rtype: dict(str, str) @@ -519,6 +521,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this DataMaskRuleSummary. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/detector_details.py b/src/oci/cloud_guard/models/detector_details.py index bacbb65645..cb08872c22 100644 --- a/src/oci/cloud_guard/models/detector_details.py +++ b/src/oci/cloud_guard/models/detector_details.py @@ -64,6 +64,18 @@ def __init__(self, **kwargs): The value to assign to the is_configuration_allowed property of this DetectorDetails. :type is_configuration_allowed: bool + :param problem_threshold: + The value to assign to the problem_threshold property of this DetectorDetails. + :type problem_threshold: int + + :param target_types: + The value to assign to the target_types property of this DetectorDetails. + :type target_types: list[str] + + :param sighting_types: + The value to assign to the sighting_types property of this DetectorDetails. + :type sighting_types: list[oci.cloud_guard.models.SightingType] + """ self.swagger_types = { 'is_enabled': 'bool', @@ -71,7 +83,10 @@ def __init__(self, **kwargs): 'configurations': 'list[DetectorConfiguration]', 'condition': 'Condition', 'labels': 'list[str]', - 'is_configuration_allowed': 'bool' + 'is_configuration_allowed': 'bool', + 'problem_threshold': 'int', + 'target_types': 'list[str]', + 'sighting_types': 'list[SightingType]' } self.attribute_map = { @@ -80,7 +95,10 @@ def __init__(self, **kwargs): 'configurations': 'configurations', 'condition': 'condition', 'labels': 'labels', - 'is_configuration_allowed': 'isConfigurationAllowed' + 'is_configuration_allowed': 'isConfigurationAllowed', + 'problem_threshold': 'problemThreshold', + 'target_types': 'targetTypes', + 'sighting_types': 'sightingTypes' } self._is_enabled = None @@ -89,6 +107,9 @@ def __init__(self, **kwargs): self._condition = None self._labels = None self._is_configuration_allowed = None + self._problem_threshold = None + self._target_types = None + self._sighting_types = None @property def is_enabled(self): @@ -117,7 +138,7 @@ def is_enabled(self, is_enabled): @property def risk_level(self): """ - **[Required]** Gets the risk_level of this DetectorDetails. + Gets the risk_level of this DetectorDetails. The Risk Level Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. @@ -236,6 +257,78 @@ def is_configuration_allowed(self, is_configuration_allowed): """ self._is_configuration_allowed = is_configuration_allowed + @property + def problem_threshold(self): + """ + Gets the problem_threshold of this DetectorDetails. + Cutover point for an elevated resource Risk Score to create a Problem + + + :return: The problem_threshold of this DetectorDetails. + :rtype: int + """ + return self._problem_threshold + + @problem_threshold.setter + def problem_threshold(self, problem_threshold): + """ + Sets the problem_threshold of this DetectorDetails. + Cutover point for an elevated resource Risk Score to create a Problem + + + :param problem_threshold: The problem_threshold of this DetectorDetails. + :type: int + """ + self._problem_threshold = problem_threshold + + @property + def target_types(self): + """ + Gets the target_types of this DetectorDetails. + List of target types for which the detector rule is applicable + + + :return: The target_types of this DetectorDetails. + :rtype: list[str] + """ + return self._target_types + + @target_types.setter + def target_types(self, target_types): + """ + Sets the target_types of this DetectorDetails. + List of target types for which the detector rule is applicable + + + :param target_types: The target_types of this DetectorDetails. + :type: list[str] + """ + self._target_types = target_types + + @property + def sighting_types(self): + """ + Gets the sighting_types of this DetectorDetails. + List of sighting types + + + :return: The sighting_types of this DetectorDetails. + :rtype: list[oci.cloud_guard.models.SightingType] + """ + return self._sighting_types + + @sighting_types.setter + def sighting_types(self, sighting_types): + """ + Sets the sighting_types of this DetectorDetails. + List of sighting types + + + :param sighting_types: The sighting_types of this DetectorDetails. + :type: list[oci.cloud_guard.models.SightingType] + """ + self._sighting_types = sighting_types + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cloud_guard/models/detector_recipe.py b/src/oci/cloud_guard/models/detector_recipe.py index 8bf644ebe3..645dead9f2 100644 --- a/src/oci/cloud_guard/models/detector_recipe.py +++ b/src/oci/cloud_guard/models/detector_recipe.py @@ -29,6 +29,10 @@ class DetectorRecipe(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRecipe. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the lifecycle_state property of a DetectorRecipe. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -90,7 +94,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRecipe. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -116,6 +120,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param source_data_retention: + The value to assign to the source_data_retention property of this DetectorRecipe. + :type source_data_retention: int + :param freeform_tags: The value to assign to the freeform_tags property of this DetectorRecipe. :type freeform_tags: dict(str, str) @@ -142,6 +150,7 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'lifecycle_state': 'str', + 'source_data_retention': 'int', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))' @@ -160,6 +169,7 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', + 'source_data_retention': 'sourceDataRetention', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags' @@ -177,6 +187,7 @@ def __init__(self, **kwargs): self._time_created = None self._time_updated = None self._lifecycle_state = None + self._source_data_retention = None self._freeform_tags = None self._defined_tags = None self._system_tags = None @@ -209,7 +220,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this DetectorRecipe. - DisplayName of detector recipe + DisplayName of detector recipe. :return: The display_name of this DetectorRecipe. @@ -221,7 +232,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DetectorRecipe. - DisplayName of detector recipe + DisplayName of detector recipe. :param display_name: The display_name of this DetectorRecipe. @@ -233,7 +244,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this DetectorRecipe. - Detector recipe description + Detector recipe description. :return: The description of this DetectorRecipe. @@ -245,7 +256,7 @@ def description(self): def description(self, description): """ Sets the description of this DetectorRecipe. - Detector recipe description + Detector recipe description. :param description: The description of this DetectorRecipe. @@ -337,7 +348,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRecipe. Type of detector - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -356,7 +367,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRecipe. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector @@ -487,6 +498,30 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def source_data_retention(self): + """ + Gets the source_data_retention of this DetectorRecipe. + The number of days for which source data is retained + + + :return: The source_data_retention of this DetectorRecipe. + :rtype: int + """ + return self._source_data_retention + + @source_data_retention.setter + def source_data_retention(self, source_data_retention): + """ + Sets the source_data_retention of this DetectorRecipe. + The number of days for which source data is retained + + + :param source_data_retention: The source_data_retention of this DetectorRecipe. + :type: int + """ + self._source_data_retention = source_data_retention + @property def freeform_tags(self): """ @@ -494,6 +529,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this DetectorRecipe. :rtype: dict(str, str) @@ -507,6 +544,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this DetectorRecipe. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/detector_recipe_detector_rule.py b/src/oci/cloud_guard/models/detector_recipe_detector_rule.py index e674bace80..5aa644307b 100644 --- a/src/oci/cloud_guard/models/detector_recipe_detector_rule.py +++ b/src/oci/cloud_guard/models/detector_recipe_detector_rule.py @@ -21,6 +21,10 @@ class DetectorRecipeDetectorRule(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRecipeDetectorRule. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a DetectorRecipeDetectorRule. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRecipeDetectorRule. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -218,7 +222,7 @@ def __init__(self, **kwargs): def detector_rule_id(self): """ **[Required]** Gets the detector_rule_id of this DetectorRecipeDetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :return: The detector_rule_id of this DetectorRecipeDetectorRule. @@ -230,7 +234,7 @@ def detector_rule_id(self): def detector_rule_id(self, detector_rule_id): """ Sets the detector_rule_id of this DetectorRecipeDetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :param detector_rule_id: The detector_rule_id of this DetectorRecipeDetectorRule. @@ -242,7 +246,7 @@ def detector_rule_id(self, detector_rule_id): def display_name(self): """ Gets the display_name of this DetectorRecipeDetectorRule. - displayName + Display name for DetectorRecipeDetectorRule. :return: The display_name of this DetectorRecipeDetectorRule. @@ -254,7 +258,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DetectorRecipeDetectorRule. - displayName + Display name for DetectorRecipeDetectorRule. :param display_name: The display_name of this DetectorRecipeDetectorRule. @@ -266,7 +270,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this DetectorRecipeDetectorRule. - Description for DetectorRecipeDetectorRule + Description for DetectorRecipeDetectorRule. :return: The description of this DetectorRecipeDetectorRule. @@ -278,7 +282,7 @@ def description(self): def description(self, description): """ Sets the description of this DetectorRecipeDetectorRule. - Description for DetectorRecipeDetectorRule + Description for DetectorRecipeDetectorRule. :param description: The description of this DetectorRecipeDetectorRule. @@ -316,7 +320,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRecipeDetectorRule. detector for the rule - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +339,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRecipeDetectorRule. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/detector_recipe_detector_rule_summary.py b/src/oci/cloud_guard/models/detector_recipe_detector_rule_summary.py index 9935dc91fb..c8a9d61b79 100644 --- a/src/oci/cloud_guard/models/detector_recipe_detector_rule_summary.py +++ b/src/oci/cloud_guard/models/detector_recipe_detector_rule_summary.py @@ -21,6 +21,10 @@ class DetectorRecipeDetectorRuleSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRecipeDetectorRuleSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a DetectorRecipeDetectorRuleSummary. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRecipeDetectorRuleSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -316,7 +320,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRecipeDetectorRuleSummary. possible type of detectors - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +339,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRecipeDetectorRuleSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/detector_recipe_summary.py b/src/oci/cloud_guard/models/detector_recipe_summary.py index fe03ab2c43..a96bb4e70c 100644 --- a/src/oci/cloud_guard/models/detector_recipe_summary.py +++ b/src/oci/cloud_guard/models/detector_recipe_summary.py @@ -29,6 +29,10 @@ class DetectorRecipeSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRecipeSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the lifecycle_state property of a DetectorRecipeSummary. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -90,7 +94,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRecipeSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -112,6 +116,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param source_data_retention: + The value to assign to the source_data_retention property of this DetectorRecipeSummary. + :type source_data_retention: int + :param freeform_tags: The value to assign to the freeform_tags property of this DetectorRecipeSummary. :type freeform_tags: dict(str, str) @@ -137,6 +145,7 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'lifecycle_state': 'str', + 'source_data_retention': 'int', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))' @@ -154,6 +163,7 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', + 'source_data_retention': 'sourceDataRetention', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags' @@ -170,6 +180,7 @@ def __init__(self, **kwargs): self._time_created = None self._time_updated = None self._lifecycle_state = None + self._source_data_retention = None self._freeform_tags = None self._defined_tags = None self._system_tags = None @@ -330,7 +341,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRecipeSummary. Type of detector - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -349,7 +360,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRecipeSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector @@ -456,6 +467,30 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def source_data_retention(self): + """ + Gets the source_data_retention of this DetectorRecipeSummary. + The number of days for which source data is retained + + + :return: The source_data_retention of this DetectorRecipeSummary. + :rtype: int + """ + return self._source_data_retention + + @source_data_retention.setter + def source_data_retention(self, source_data_retention): + """ + Sets the source_data_retention of this DetectorRecipeSummary. + The number of days for which source data is retained + + + :param source_data_retention: The source_data_retention of this DetectorRecipeSummary. + :type: int + """ + self._source_data_retention = source_data_retention + @property def freeform_tags(self): """ @@ -463,6 +498,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this DetectorRecipeSummary. :rtype: dict(str, str) @@ -476,6 +513,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this DetectorRecipeSummary. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/detector_rule.py b/src/oci/cloud_guard/models/detector_rule.py index a12ab3e427..7f5291f190 100644 --- a/src/oci/cloud_guard/models/detector_rule.py +++ b/src/oci/cloud_guard/models/detector_rule.py @@ -21,6 +21,10 @@ class DetectorRule(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRule. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a DetectorRule. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRule. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -218,7 +222,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this DetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :return: The id of this DetectorRule. @@ -230,7 +234,7 @@ def id(self): def id(self, id): """ Sets the id of this DetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :param id: The id of this DetectorRule. @@ -242,7 +246,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this DetectorRule. - displayName + Display name for DetectorRule. :return: The display_name of this DetectorRule. @@ -254,7 +258,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this DetectorRule. - displayName + Display name for DetectorRule. :param display_name: The display_name of this DetectorRule. @@ -266,7 +270,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this DetectorRule. - description for DetectorRule + Description for DetectorRule. :return: The description of this DetectorRule. @@ -278,7 +282,7 @@ def description(self): def description(self, description): """ Sets the description of this DetectorRule. - description for DetectorRule + Description for DetectorRule. :param description: The description of this DetectorRule. @@ -316,7 +320,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRule. detector for the rule - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +339,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRule. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/detector_rule_summary.py b/src/oci/cloud_guard/models/detector_rule_summary.py index ab3c8978cf..4cea940d4f 100644 --- a/src/oci/cloud_guard/models/detector_rule_summary.py +++ b/src/oci/cloud_guard/models/detector_rule_summary.py @@ -21,6 +21,10 @@ class DetectorRuleSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a DetectorRuleSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a DetectorRuleSummary. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this DetectorRuleSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -316,7 +320,7 @@ def detector(self): **[Required]** Gets the detector of this DetectorRuleSummary. possible type of detectors - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +339,7 @@ def detector(self, detector): :param detector: The detector of this DetectorRuleSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/managed_list.py b/src/oci/cloud_guard/models/managed_list.py index 7125c8f6ab..908899c30a 100644 --- a/src/oci/cloud_guard/models/managed_list.py +++ b/src/oci/cloud_guard/models/managed_list.py @@ -256,7 +256,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this ManagedList. - ManagedList display name + ManagedList display name. :return: The display_name of this ManagedList. @@ -268,7 +268,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ManagedList. - ManagedList display name + ManagedList display name. :param display_name: The display_name of this ManagedList. @@ -280,7 +280,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ManagedList. - ManagedList description + ManagedList description. :return: The description of this ManagedList. @@ -292,7 +292,7 @@ def description(self): def description(self, description): """ Sets the description of this ManagedList. - ManagedList description + ManagedList description. :param description: The description of this ManagedList. @@ -565,6 +565,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this ManagedList. :rtype: dict(str, str) @@ -578,6 +580,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this ManagedList. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/managed_list_summary.py b/src/oci/cloud_guard/models/managed_list_summary.py index b3c3b0f8ad..efd3c4fe71 100644 --- a/src/oci/cloud_guard/models/managed_list_summary.py +++ b/src/oci/cloud_guard/models/managed_list_summary.py @@ -565,6 +565,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this ManagedListSummary. :rtype: dict(str, str) @@ -578,6 +580,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this ManagedListSummary. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/problem.py b/src/oci/cloud_guard/models/problem.py index 3035c0b731..e0ea9459c1 100644 --- a/src/oci/cloud_guard/models/problem.py +++ b/src/oci/cloud_guard/models/problem.py @@ -65,6 +65,10 @@ class Problem(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_ID_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector_id property of a Problem. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_ID_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + def __init__(self, **kwargs): """ Initializes a new Problem object with values from keyword arguments. @@ -96,6 +100,26 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type risk_level: str + :param risk_score: + The value to assign to the risk_score property of this Problem. + :type risk_score: float + + :param peak_risk_score_date: + The value to assign to the peak_risk_score_date property of this Problem. + :type peak_risk_score_date: str + + :param peak_risk_score: + The value to assign to the peak_risk_score property of this Problem. + :type peak_risk_score: float + + :param auto_resolve_date: + The value to assign to the auto_resolve_date property of this Problem. + :type auto_resolve_date: str + + :param peak_risk_score_lookup_period_in_days: + The value to assign to the peak_risk_score_lookup_period_in_days property of this Problem. + :type peak_risk_score_lookup_period_in_days: int + :param resource_id: The value to assign to the resource_id property of this Problem. :type resource_id: str @@ -134,7 +158,7 @@ def __init__(self, **kwargs): :param detector_id: The value to assign to the detector_id property of this Problem. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector_id: str @@ -166,6 +190,11 @@ def __init__(self, **kwargs): 'region': 'str', 'regions': 'list[str]', 'risk_level': 'str', + 'risk_score': 'float', + 'peak_risk_score_date': 'str', + 'peak_risk_score': 'float', + 'auto_resolve_date': 'str', + 'peak_risk_score_lookup_period_in_days': 'int', 'resource_id': 'str', 'resource_name': 'str', 'resource_type': 'str', @@ -189,6 +218,11 @@ def __init__(self, **kwargs): 'region': 'region', 'regions': 'regions', 'risk_level': 'riskLevel', + 'risk_score': 'riskScore', + 'peak_risk_score_date': 'peakRiskScoreDate', + 'peak_risk_score': 'peakRiskScore', + 'auto_resolve_date': 'autoResolveDate', + 'peak_risk_score_lookup_period_in_days': 'peakRiskScoreLookupPeriodInDays', 'resource_id': 'resourceId', 'resource_name': 'resourceName', 'resource_type': 'resourceType', @@ -211,6 +245,11 @@ def __init__(self, **kwargs): self._region = None self._regions = None self._risk_level = None + self._risk_score = None + self._peak_risk_score_date = None + self._peak_risk_score = None + self._auto_resolve_date = None + self._peak_risk_score_lookup_period_in_days = None self._resource_id = None self._resource_name = None self._resource_type = None @@ -376,6 +415,126 @@ def risk_level(self, risk_level): risk_level = 'UNKNOWN_ENUM_VALUE' self._risk_level = risk_level + @property + def risk_score(self): + """ + Gets the risk_score of this Problem. + Risk Score for the problem + + + :return: The risk_score of this Problem. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this Problem. + Risk Score for the problem + + + :param risk_score: The risk_score of this Problem. + :type: float + """ + self._risk_score = risk_score + + @property + def peak_risk_score_date(self): + """ + Gets the peak_risk_score_date of this Problem. + The date and time for the peak risk score that is observed. Format defined by RFC3339. + + + :return: The peak_risk_score_date of this Problem. + :rtype: str + """ + return self._peak_risk_score_date + + @peak_risk_score_date.setter + def peak_risk_score_date(self, peak_risk_score_date): + """ + Sets the peak_risk_score_date of this Problem. + The date and time for the peak risk score that is observed. Format defined by RFC3339. + + + :param peak_risk_score_date: The peak_risk_score_date of this Problem. + :type: str + """ + self._peak_risk_score_date = peak_risk_score_date + + @property + def peak_risk_score(self): + """ + Gets the peak_risk_score of this Problem. + Peak risk score for the problem + + + :return: The peak_risk_score of this Problem. + :rtype: float + """ + return self._peak_risk_score + + @peak_risk_score.setter + def peak_risk_score(self, peak_risk_score): + """ + Sets the peak_risk_score of this Problem. + Peak risk score for the problem + + + :param peak_risk_score: The peak_risk_score of this Problem. + :type: float + """ + self._peak_risk_score = peak_risk_score + + @property + def auto_resolve_date(self): + """ + Gets the auto_resolve_date of this Problem. + The date and time when the problem will be auto resolved. Format defined by RFC3339. + + + :return: The auto_resolve_date of this Problem. + :rtype: str + """ + return self._auto_resolve_date + + @auto_resolve_date.setter + def auto_resolve_date(self, auto_resolve_date): + """ + Sets the auto_resolve_date of this Problem. + The date and time when the problem will be auto resolved. Format defined by RFC3339. + + + :param auto_resolve_date: The auto_resolve_date of this Problem. + :type: str + """ + self._auto_resolve_date = auto_resolve_date + + @property + def peak_risk_score_lookup_period_in_days(self): + """ + Gets the peak_risk_score_lookup_period_in_days of this Problem. + Number of days for which peak score is calculated for the problem + + + :return: The peak_risk_score_lookup_period_in_days of this Problem. + :rtype: int + """ + return self._peak_risk_score_lookup_period_in_days + + @peak_risk_score_lookup_period_in_days.setter + def peak_risk_score_lookup_period_in_days(self, peak_risk_score_lookup_period_in_days): + """ + Sets the peak_risk_score_lookup_period_in_days of this Problem. + Number of days for which peak score is calculated for the problem + + + :param peak_risk_score_lookup_period_in_days: The peak_risk_score_lookup_period_in_days of this Problem. + :type: int + """ + self._peak_risk_score_lookup_period_in_days = peak_risk_score_lookup_period_in_days + @property def resource_id(self): """ @@ -586,7 +745,7 @@ def detector_id(self): Gets the detector_id of this Problem. Id of the detector associated with the Problem. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -605,7 +764,7 @@ def detector_id(self, detector_id): :param detector_id: The detector_id of this Problem. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector_id, allowed_values): detector_id = 'UNKNOWN_ENUM_VALUE' self._detector_id = detector_id diff --git a/src/oci/cloud_guard/models/problem_endpoint_collection.py b/src/oci/cloud_guard/models/problem_endpoint_collection.py new file mode 100644 index 0000000000..aa11154519 --- /dev/null +++ b/src/oci/cloud_guard/models/problem_endpoint_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProblemEndpointCollection(object): + """ + Provides the list of problem endpoints + """ + + def __init__(self, **kwargs): + """ + Initializes a new ProblemEndpointCollection 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 ProblemEndpointCollection. + :type items: list[oci.cloud_guard.models.ProblemEndpointSummary] + + """ + self.swagger_types = { + 'items': 'list[ProblemEndpointSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ProblemEndpointCollection. + List of problem endpoints + + + :return: The items of this ProblemEndpointCollection. + :rtype: list[oci.cloud_guard.models.ProblemEndpointSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ProblemEndpointCollection. + List of problem endpoints + + + :param items: The items of this ProblemEndpointCollection. + :type: list[oci.cloud_guard.models.ProblemEndpointSummary] + """ + 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/cloud_guard/models/problem_endpoint_summary.py b/src/oci/cloud_guard/models/problem_endpoint_summary.py new file mode 100644 index 0000000000..68d909dcf0 --- /dev/null +++ b/src/oci/cloud_guard/models/problem_endpoint_summary.py @@ -0,0 +1,504 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProblemEndpointSummary(object): + """ + Problem endpoints summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ProblemEndpointSummary 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 ProblemEndpointSummary. + :type id: str + + :param sighting_id: + The value to assign to the sighting_id property of this ProblemEndpointSummary. + :type sighting_id: str + + :param problem_id: + The value to assign to the problem_id property of this ProblemEndpointSummary. + :type problem_id: str + + :param sighting_type: + The value to assign to the sighting_type property of this ProblemEndpointSummary. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this ProblemEndpointSummary. + :type sighting_type_display_name: str + + :param ip_address: + The value to assign to the ip_address property of this ProblemEndpointSummary. + :type ip_address: str + + :param ip_address_type: + The value to assign to the ip_address_type property of this ProblemEndpointSummary. + :type ip_address_type: str + + :param ip_classification_type: + The value to assign to the ip_classification_type property of this ProblemEndpointSummary. + :type ip_classification_type: str + + :param country: + The value to assign to the country property of this ProblemEndpointSummary. + :type country: str + + :param latitude: + The value to assign to the latitude property of this ProblemEndpointSummary. + :type latitude: float + + :param longitude: + The value to assign to the longitude property of this ProblemEndpointSummary. + :type longitude: float + + :param asn_number: + The value to assign to the asn_number property of this ProblemEndpointSummary. + :type asn_number: str + + :param regions: + The value to assign to the regions property of this ProblemEndpointSummary. + :type regions: list[str] + + :param services: + The value to assign to the services property of this ProblemEndpointSummary. + :type services: list[str] + + :param time_last_detected: + The value to assign to the time_last_detected property of this ProblemEndpointSummary. + :type time_last_detected: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'sighting_id': 'str', + 'problem_id': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', + 'ip_address': 'str', + 'ip_address_type': 'str', + 'ip_classification_type': 'str', + 'country': 'str', + 'latitude': 'float', + 'longitude': 'float', + 'asn_number': 'str', + 'regions': 'list[str]', + 'services': 'list[str]', + 'time_last_detected': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'sighting_id': 'sightingId', + 'problem_id': 'problemId', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', + 'ip_address': 'ipAddress', + 'ip_address_type': 'ipAddressType', + 'ip_classification_type': 'ipClassificationType', + 'country': 'country', + 'latitude': 'latitude', + 'longitude': 'longitude', + 'asn_number': 'asnNumber', + 'regions': 'regions', + 'services': 'services', + 'time_last_detected': 'timeLastDetected' + } + + self._id = None + self._sighting_id = None + self._problem_id = None + self._sighting_type = None + self._sighting_type_display_name = None + self._ip_address = None + self._ip_address_type = None + self._ip_classification_type = None + self._country = None + self._latitude = None + self._longitude = None + self._asn_number = None + self._regions = None + self._services = None + self._time_last_detected = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ProblemEndpointSummary. + Unique identifier for problem endpoint. + + + :return: The id of this ProblemEndpointSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ProblemEndpointSummary. + Unique identifier for problem endpoint. + + + :param id: The id of this ProblemEndpointSummary. + :type: str + """ + self._id = id + + @property + def sighting_id(self): + """ + **[Required]** Gets the sighting_id of this ProblemEndpointSummary. + Unique id for sighting associated with the endpoint. + + + :return: The sighting_id of this ProblemEndpointSummary. + :rtype: str + """ + return self._sighting_id + + @sighting_id.setter + def sighting_id(self, sighting_id): + """ + Sets the sighting_id of this ProblemEndpointSummary. + Unique id for sighting associated with the endpoint. + + + :param sighting_id: The sighting_id of this ProblemEndpointSummary. + :type: str + """ + self._sighting_id = sighting_id + + @property + def problem_id(self): + """ + **[Required]** Gets the problem_id of this ProblemEndpointSummary. + Unique id for cloudguard problem + + + :return: The problem_id of this ProblemEndpointSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this ProblemEndpointSummary. + Unique id for cloudguard problem + + + :param problem_id: The problem_id of this ProblemEndpointSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def sighting_type(self): + """ + **[Required]** Gets the sighting_type of this ProblemEndpointSummary. + Identifier for the sighting type + + + :return: The sighting_type of this ProblemEndpointSummary. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this ProblemEndpointSummary. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this ProblemEndpointSummary. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + **[Required]** Gets the sighting_type_display_name of this ProblemEndpointSummary. + Display Name of the sighting type + + + :return: The sighting_type_display_name of this ProblemEndpointSummary. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this ProblemEndpointSummary. + Display Name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this ProblemEndpointSummary. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + + @property + def ip_address(self): + """ + **[Required]** Gets the ip_address of this ProblemEndpointSummary. + IP Address of the Endpoint + + + :return: The ip_address of this ProblemEndpointSummary. + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """ + Sets the ip_address of this ProblemEndpointSummary. + IP Address of the Endpoint + + + :param ip_address: The ip_address of this ProblemEndpointSummary. + :type: str + """ + self._ip_address = ip_address + + @property + def ip_address_type(self): + """ + **[Required]** Gets the ip_address_type of this ProblemEndpointSummary. + IP Address type of the Endpoint + + + :return: The ip_address_type of this ProblemEndpointSummary. + :rtype: str + """ + return self._ip_address_type + + @ip_address_type.setter + def ip_address_type(self, ip_address_type): + """ + Sets the ip_address_type of this ProblemEndpointSummary. + IP Address type of the Endpoint + + + :param ip_address_type: The ip_address_type of this ProblemEndpointSummary. + :type: str + """ + self._ip_address_type = ip_address_type + + @property + def ip_classification_type(self): + """ + Gets the ip_classification_type of this ProblemEndpointSummary. + IP Address classification type of the endpoint + + + :return: The ip_classification_type of this ProblemEndpointSummary. + :rtype: str + """ + return self._ip_classification_type + + @ip_classification_type.setter + def ip_classification_type(self, ip_classification_type): + """ + Sets the ip_classification_type of this ProblemEndpointSummary. + IP Address classification type of the endpoint + + + :param ip_classification_type: The ip_classification_type of this ProblemEndpointSummary. + :type: str + """ + self._ip_classification_type = ip_classification_type + + @property + def country(self): + """ + Gets the country of this ProblemEndpointSummary. + Country of the endpoint + + + :return: The country of this ProblemEndpointSummary. + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """ + Sets the country of this ProblemEndpointSummary. + Country of the endpoint + + + :param country: The country of this ProblemEndpointSummary. + :type: str + """ + self._country = country + + @property + def latitude(self): + """ + Gets the latitude of this ProblemEndpointSummary. + Latitude of the endpoint + + + :return: The latitude of this ProblemEndpointSummary. + :rtype: float + """ + return self._latitude + + @latitude.setter + def latitude(self, latitude): + """ + Sets the latitude of this ProblemEndpointSummary. + Latitude of the endpoint + + + :param latitude: The latitude of this ProblemEndpointSummary. + :type: float + """ + self._latitude = latitude + + @property + def longitude(self): + """ + Gets the longitude of this ProblemEndpointSummary. + Longitude of the endpoint + + + :return: The longitude of this ProblemEndpointSummary. + :rtype: float + """ + return self._longitude + + @longitude.setter + def longitude(self, longitude): + """ + Sets the longitude of this ProblemEndpointSummary. + Longitude of the endpoint + + + :param longitude: The longitude of this ProblemEndpointSummary. + :type: float + """ + self._longitude = longitude + + @property + def asn_number(self): + """ + Gets the asn_number of this ProblemEndpointSummary. + ASN number of the endpoint + + + :return: The asn_number of this ProblemEndpointSummary. + :rtype: str + """ + return self._asn_number + + @asn_number.setter + def asn_number(self, asn_number): + """ + Sets the asn_number of this ProblemEndpointSummary. + ASN number of the endpoint + + + :param asn_number: The asn_number of this ProblemEndpointSummary. + :type: str + """ + self._asn_number = asn_number + + @property + def regions(self): + """ + Gets the regions of this ProblemEndpointSummary. + Regions where activities were performed from this IP + + + :return: The regions of this ProblemEndpointSummary. + :rtype: list[str] + """ + return self._regions + + @regions.setter + def regions(self, regions): + """ + Sets the regions of this ProblemEndpointSummary. + Regions where activities were performed from this IP + + + :param regions: The regions of this ProblemEndpointSummary. + :type: list[str] + """ + self._regions = regions + + @property + def services(self): + """ + Gets the services of this ProblemEndpointSummary. + Services where activities were performed from this IP + + + :return: The services of this ProblemEndpointSummary. + :rtype: list[str] + """ + return self._services + + @services.setter + def services(self, services): + """ + Sets the services of this ProblemEndpointSummary. + Services where activities were performed from this IP + + + :param services: The services of this ProblemEndpointSummary. + :type: list[str] + """ + self._services = services + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this ProblemEndpointSummary. + Time when activities were last detected + + + :return: The time_last_detected of this ProblemEndpointSummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this ProblemEndpointSummary. + Time when activities were last detected + + + :param time_last_detected: The time_last_detected of this ProblemEndpointSummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/problem_summary.py b/src/oci/cloud_guard/models/problem_summary.py index b747c0751b..b54fd389f1 100644 --- a/src/oci/cloud_guard/models/problem_summary.py +++ b/src/oci/cloud_guard/models/problem_summary.py @@ -65,6 +65,10 @@ class ProblemSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_ID_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector_id property of a ProblemSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_ID_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + def __init__(self, **kwargs): """ Initializes a new ProblemSummary object with values from keyword arguments. @@ -88,6 +92,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type risk_level: str + :param risk_score: + The value to assign to the risk_score property of this ProblemSummary. + :type risk_score: float + :param resource_id: The value to assign to the resource_id property of this ProblemSummary. :type resource_id: str @@ -126,7 +134,7 @@ def __init__(self, **kwargs): :param detector_id: The value to assign to the detector_id property of this ProblemSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector_id: str @@ -148,6 +156,7 @@ def __init__(self, **kwargs): 'compartment_id': 'str', 'detector_rule_id': 'str', 'risk_level': 'str', + 'risk_score': 'float', 'resource_id': 'str', 'resource_name': 'str', 'resource_type': 'str', @@ -167,6 +176,7 @@ def __init__(self, **kwargs): 'compartment_id': 'compartmentId', 'detector_rule_id': 'detectorRuleId', 'risk_level': 'riskLevel', + 'risk_score': 'riskScore', 'resource_id': 'resourceId', 'resource_name': 'resourceName', 'resource_type': 'resourceType', @@ -185,6 +195,7 @@ def __init__(self, **kwargs): self._compartment_id = None self._detector_rule_id = None self._risk_level = None + self._risk_score = None self._resource_id = None self._resource_name = None self._resource_type = None @@ -300,6 +311,30 @@ def risk_level(self, risk_level): risk_level = 'UNKNOWN_ENUM_VALUE' self._risk_level = risk_level + @property + def risk_score(self): + """ + Gets the risk_score of this ProblemSummary. + Risk Score for the problem + + + :return: The risk_score of this ProblemSummary. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this ProblemSummary. + Risk Score for the problem + + + :param risk_score: The risk_score of this ProblemSummary. + :type: float + """ + self._risk_score = risk_score + @property def resource_id(self): """ @@ -510,7 +545,7 @@ def detector_id(self): Gets the detector_id of this ProblemSummary. Id of detector associated with the Problem. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -529,7 +564,7 @@ def detector_id(self, detector_id): :param detector_id: The detector_id of this ProblemSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector_id, allowed_values): detector_id = 'UNKNOWN_ENUM_VALUE' self._detector_id = detector_id diff --git a/src/oci/cloud_guard/models/request_summarized_trend_resource_risk_scores_details.py b/src/oci/cloud_guard/models/request_summarized_trend_resource_risk_scores_details.py new file mode 100644 index 0000000000..b4f52ca13b --- /dev/null +++ b/src/oci/cloud_guard/models/request_summarized_trend_resource_risk_scores_details.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RequestSummarizedTrendResourceRiskScoresDetails(object): + """ + ResourceRiskScores filter. + """ + + #: A constant which can be used with the filter property of a RequestSummarizedTrendResourceRiskScoresDetails. + #: This constant has a value of "PROBLEM_ID" + FILTER_PROBLEM_ID = "PROBLEM_ID" + + #: A constant which can be used with the filter property of a RequestSummarizedTrendResourceRiskScoresDetails. + #: This constant has a value of "RESOURCE_PROFILE_ID" + FILTER_RESOURCE_PROFILE_ID = "RESOURCE_PROFILE_ID" + + def __init__(self, **kwargs): + """ + Initializes a new RequestSummarizedTrendResourceRiskScoresDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param filter: + The value to assign to the filter property of this RequestSummarizedTrendResourceRiskScoresDetails. + Allowed values for this property are: "PROBLEM_ID", "RESOURCE_PROFILE_ID" + :type filter: str + + :param filter_id: + The value to assign to the filter_id property of this RequestSummarizedTrendResourceRiskScoresDetails. + :type filter_id: str + + """ + self.swagger_types = { + 'filter': 'str', + 'filter_id': 'str' + } + + self.attribute_map = { + 'filter': 'filter', + 'filter_id': 'filterId' + } + + self._filter = None + self._filter_id = None + + @property + def filter(self): + """ + **[Required]** Gets the filter of this RequestSummarizedTrendResourceRiskScoresDetails. + The filter type. + + Allowed values for this property are: "PROBLEM_ID", "RESOURCE_PROFILE_ID" + + + :return: The filter of this RequestSummarizedTrendResourceRiskScoresDetails. + :rtype: str + """ + return self._filter + + @filter.setter + def filter(self, filter): + """ + Sets the filter of this RequestSummarizedTrendResourceRiskScoresDetails. + The filter type. + + + :param filter: The filter of this RequestSummarizedTrendResourceRiskScoresDetails. + :type: str + """ + allowed_values = ["PROBLEM_ID", "RESOURCE_PROFILE_ID"] + if not value_allowed_none_or_none_sentinel(filter, allowed_values): + raise ValueError( + "Invalid value for `filter`, must be None or one of {0}" + .format(allowed_values) + ) + self._filter = filter + + @property + def filter_id(self): + """ + **[Required]** Gets the filter_id of this RequestSummarizedTrendResourceRiskScoresDetails. + Id to be passed in to filter the risk scores. + + + :return: The filter_id of this RequestSummarizedTrendResourceRiskScoresDetails. + :rtype: str + """ + return self._filter_id + + @filter_id.setter + def filter_id(self, filter_id): + """ + Sets the filter_id of this RequestSummarizedTrendResourceRiskScoresDetails. + Id to be passed in to filter the risk scores. + + + :param filter_id: The filter_id of this RequestSummarizedTrendResourceRiskScoresDetails. + :type: str + """ + self._filter_id = filter_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/cloud_guard/models/resource_profile.py b/src/oci/cloud_guard/models/resource_profile.py new file mode 100644 index 0000000000..3b94c47a5e --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile.py @@ -0,0 +1,532 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfile(object): + """ + Resource profile details + """ + + #: A constant which can be used with the risk_level property of a ResourceProfile. + #: This constant has a value of "CRITICAL" + RISK_LEVEL_CRITICAL = "CRITICAL" + + #: A constant which can be used with the risk_level property of a ResourceProfile. + #: This constant has a value of "HIGH" + RISK_LEVEL_HIGH = "HIGH" + + #: A constant which can be used with the risk_level property of a ResourceProfile. + #: This constant has a value of "MEDIUM" + RISK_LEVEL_MEDIUM = "MEDIUM" + + #: A constant which can be used with the risk_level property of a ResourceProfile. + #: This constant has a value of "LOW" + RISK_LEVEL_LOW = "LOW" + + #: A constant which can be used with the risk_level property of a ResourceProfile. + #: This constant has a value of "MINOR" + RISK_LEVEL_MINOR = "MINOR" + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfile object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sightings_count: + The value to assign to the sightings_count property of this ResourceProfile. + :type sightings_count: int + + :param id: + The value to assign to the id property of this ResourceProfile. + :type id: str + + :param resource_id: + The value to assign to the resource_id property of this ResourceProfile. + :type resource_id: str + + :param display_name: + The value to assign to the display_name property of this ResourceProfile. + :type display_name: str + + :param type: + The value to assign to the type property of this ResourceProfile. + :type type: str + + :param problem_ids: + The value to assign to the problem_ids property of this ResourceProfile. + :type problem_ids: list[str] + + :param compartment_id: + The value to assign to the compartment_id property of this ResourceProfile. + :type compartment_id: str + + :param target_id: + The value to assign to the target_id property of this ResourceProfile. + :type target_id: str + + :param risk_score: + The value to assign to the risk_score property of this ResourceProfile. + :type risk_score: float + + :param risk_level: + The value to assign to the risk_level property of this ResourceProfile. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type risk_level: str + + :param peak_risk_score: + The value to assign to the peak_risk_score property of this ResourceProfile. + :type peak_risk_score: float + + :param time_peak_score: + The value to assign to the time_peak_score property of this ResourceProfile. + :type time_peak_score: datetime + + :param time_first_detected: + The value to assign to the time_first_detected property of this ResourceProfile. + :type time_first_detected: datetime + + :param time_last_detected: + The value to assign to the time_last_detected property of this ResourceProfile. + :type time_last_detected: datetime + + :param tactics: + The value to assign to the tactics property of this ResourceProfile. + :type tactics: list[oci.cloud_guard.models.TacticSummary] + + """ + self.swagger_types = { + 'sightings_count': 'int', + 'id': 'str', + 'resource_id': 'str', + 'display_name': 'str', + 'type': 'str', + 'problem_ids': 'list[str]', + 'compartment_id': 'str', + 'target_id': 'str', + 'risk_score': 'float', + 'risk_level': 'str', + 'peak_risk_score': 'float', + 'time_peak_score': 'datetime', + 'time_first_detected': 'datetime', + 'time_last_detected': 'datetime', + 'tactics': 'list[TacticSummary]' + } + + self.attribute_map = { + 'sightings_count': 'sightingsCount', + 'id': 'id', + 'resource_id': 'resourceId', + 'display_name': 'displayName', + 'type': 'type', + 'problem_ids': 'problemIds', + 'compartment_id': 'compartmentId', + 'target_id': 'targetId', + 'risk_score': 'riskScore', + 'risk_level': 'riskLevel', + 'peak_risk_score': 'peakRiskScore', + 'time_peak_score': 'timePeakScore', + 'time_first_detected': 'timeFirstDetected', + 'time_last_detected': 'timeLastDetected', + 'tactics': 'tactics' + } + + self._sightings_count = None + self._id = None + self._resource_id = None + self._display_name = None + self._type = None + self._problem_ids = None + self._compartment_id = None + self._target_id = None + self._risk_score = None + self._risk_level = None + self._peak_risk_score = None + self._time_peak_score = None + self._time_first_detected = None + self._time_last_detected = None + self._tactics = None + + @property + def sightings_count(self): + """ + Gets the sightings_count of this ResourceProfile. + Number of sightings associated with this resource profile + + + :return: The sightings_count of this ResourceProfile. + :rtype: int + """ + return self._sightings_count + + @sightings_count.setter + def sightings_count(self, sightings_count): + """ + Sets the sightings_count of this ResourceProfile. + Number of sightings associated with this resource profile + + + :param sightings_count: The sightings_count of this ResourceProfile. + :type: int + """ + self._sightings_count = sightings_count + + @property + def id(self): + """ + **[Required]** Gets the id of this ResourceProfile. + Unique identifier for resource profile + + + :return: The id of this ResourceProfile. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ResourceProfile. + Unique identifier for resource profile + + + :param id: The id of this ResourceProfile. + :type: str + """ + self._id = id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this ResourceProfile. + Unique identifier for resource profile + + + :return: The resource_id of this ResourceProfile. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this ResourceProfile. + Unique identifier for resource profile + + + :param resource_id: The resource_id of this ResourceProfile. + :type: str + """ + self._resource_id = resource_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ResourceProfile. + Resource name for resource profile + + + :return: The display_name of this ResourceProfile. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ResourceProfile. + Resource name for resource profile + + + :param display_name: The display_name of this ResourceProfile. + :type: str + """ + self._display_name = display_name + + @property + def type(self): + """ + **[Required]** Gets the type of this ResourceProfile. + Resource type for resource profile + + + :return: The type of this ResourceProfile. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ResourceProfile. + Resource type for resource profile + + + :param type: The type of this ResourceProfile. + :type: str + """ + self._type = type + + @property + def problem_ids(self): + """ + Gets the problem_ids of this ResourceProfile. + List of Problems associated with the resource profile. + + + :return: The problem_ids of this ResourceProfile. + :rtype: list[str] + """ + return self._problem_ids + + @problem_ids.setter + def problem_ids(self, problem_ids): + """ + Sets the problem_ids of this ResourceProfile. + List of Problems associated with the resource profile. + + + :param problem_ids: The problem_ids of this ResourceProfile. + :type: list[str] + """ + self._problem_ids = problem_ids + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ResourceProfile. + Compartment Id for resource profile + + + :return: The compartment_id of this ResourceProfile. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ResourceProfile. + Compartment Id for resource profile + + + :param compartment_id: The compartment_id of this ResourceProfile. + :type: str + """ + self._compartment_id = compartment_id + + @property + def target_id(self): + """ + Gets the target_id of this ResourceProfile. + Target Id for resource profile + + + :return: The target_id of this ResourceProfile. + :rtype: str + """ + return self._target_id + + @target_id.setter + def target_id(self, target_id): + """ + Sets the target_id of this ResourceProfile. + Target Id for resource profile + + + :param target_id: The target_id of this ResourceProfile. + :type: str + """ + self._target_id = target_id + + @property + def risk_score(self): + """ + **[Required]** Gets the risk_score of this ResourceProfile. + Risk Score for the resource profile + + + :return: The risk_score of this ResourceProfile. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this ResourceProfile. + Risk Score for the resource profile + + + :param risk_score: The risk_score of this ResourceProfile. + :type: float + """ + self._risk_score = risk_score + + @property + def risk_level(self): + """ + Gets the risk_level of this ResourceProfile. + Risk Level associated with resource profile + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The risk_level of this ResourceProfile. + :rtype: str + """ + return self._risk_level + + @risk_level.setter + def risk_level(self, risk_level): + """ + Sets the risk_level of this ResourceProfile. + Risk Level associated with resource profile + + + :param risk_level: The risk_level of this ResourceProfile. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(risk_level, allowed_values): + risk_level = 'UNKNOWN_ENUM_VALUE' + self._risk_level = risk_level + + @property + def peak_risk_score(self): + """ + Gets the peak_risk_score of this ResourceProfile. + Peak Risk Score for the resource profile + + + :return: The peak_risk_score of this ResourceProfile. + :rtype: float + """ + return self._peak_risk_score + + @peak_risk_score.setter + def peak_risk_score(self, peak_risk_score): + """ + Sets the peak_risk_score of this ResourceProfile. + Peak Risk Score for the resource profile + + + :param peak_risk_score: The peak_risk_score of this ResourceProfile. + :type: float + """ + self._peak_risk_score = peak_risk_score + + @property + def time_peak_score(self): + """ + Gets the time_peak_score of this ResourceProfile. + The date and time for peak risk score. Format defined by RFC3339. + + + :return: The time_peak_score of this ResourceProfile. + :rtype: datetime + """ + return self._time_peak_score + + @time_peak_score.setter + def time_peak_score(self, time_peak_score): + """ + Sets the time_peak_score of this ResourceProfile. + The date and time for peak risk score. Format defined by RFC3339. + + + :param time_peak_score: The time_peak_score of this ResourceProfile. + :type: datetime + """ + self._time_peak_score = time_peak_score + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this ResourceProfile. + The date and time the resource profile was first detected. Format defined by RFC3339. + + + :return: The time_first_detected of this ResourceProfile. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this ResourceProfile. + The date and time the resource profile was first detected. Format defined by RFC3339. + + + :param time_first_detected: The time_first_detected of this ResourceProfile. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this ResourceProfile. + The date and time the resource profile was last detected. Format defined by RFC3339. + + + :return: The time_last_detected of this ResourceProfile. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this ResourceProfile. + The date and time the resource profile was last detected. Format defined by RFC3339. + + + :param time_last_detected: The time_last_detected of this ResourceProfile. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def tactics(self): + """ + **[Required]** Gets the tactics of this ResourceProfile. + List of tactic summary associated with the resource profile. + + + :return: The tactics of this ResourceProfile. + :rtype: list[oci.cloud_guard.models.TacticSummary] + """ + return self._tactics + + @tactics.setter + def tactics(self, tactics): + """ + Sets the tactics of this ResourceProfile. + List of tactic summary associated with the resource profile. + + + :param tactics: The tactics of this ResourceProfile. + :type: list[oci.cloud_guard.models.TacticSummary] + """ + self._tactics = tactics + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/resource_profile_collection.py b/src/oci/cloud_guard/models/resource_profile_collection.py new file mode 100644 index 0000000000..4b6017f697 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileCollection(object): + """ + Collection of resource profile summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileCollection 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 ResourceProfileCollection. + :type items: list[oci.cloud_guard.models.ResourceProfileSummary] + + """ + self.swagger_types = { + 'items': 'list[ResourceProfileSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceProfileCollection. + List of resource profiles + + + :return: The items of this ResourceProfileCollection. + :rtype: list[oci.cloud_guard.models.ResourceProfileSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceProfileCollection. + List of resource profiles + + + :param items: The items of this ResourceProfileCollection. + :type: list[oci.cloud_guard.models.ResourceProfileSummary] + """ + 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/cloud_guard/models/resource_profile_endpoint_collection.py b/src/oci/cloud_guard/models/resource_profile_endpoint_collection.py new file mode 100644 index 0000000000..46caf22452 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_endpoint_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileEndpointCollection(object): + """ + Collection of Resource Profile endpoint summaries + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileEndpointCollection 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 ResourceProfileEndpointCollection. + :type items: list[oci.cloud_guard.models.ResourceProfileEndpointSummary] + + """ + self.swagger_types = { + 'items': 'list[ResourceProfileEndpointSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceProfileEndpointCollection. + List of ResourceProfileEndpointSummary + + + :return: The items of this ResourceProfileEndpointCollection. + :rtype: list[oci.cloud_guard.models.ResourceProfileEndpointSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceProfileEndpointCollection. + List of ResourceProfileEndpointSummary + + + :param items: The items of this ResourceProfileEndpointCollection. + :type: list[oci.cloud_guard.models.ResourceProfileEndpointSummary] + """ + 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/cloud_guard/models/resource_profile_endpoint_summary.py b/src/oci/cloud_guard/models/resource_profile_endpoint_summary.py new file mode 100644 index 0000000000..c4837ce8b9 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_endpoint_summary.py @@ -0,0 +1,504 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileEndpointSummary(object): + """ + Resource Profile Endpoints summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileEndpointSummary 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 ResourceProfileEndpointSummary. + :type id: str + + :param resource_profile_id: + The value to assign to the resource_profile_id property of this ResourceProfileEndpointSummary. + :type resource_profile_id: str + + :param problem_id: + The value to assign to the problem_id property of this ResourceProfileEndpointSummary. + :type problem_id: str + + :param sighting_type: + The value to assign to the sighting_type property of this ResourceProfileEndpointSummary. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this ResourceProfileEndpointSummary. + :type sighting_type_display_name: str + + :param ip_address: + The value to assign to the ip_address property of this ResourceProfileEndpointSummary. + :type ip_address: str + + :param ip_address_type: + The value to assign to the ip_address_type property of this ResourceProfileEndpointSummary. + :type ip_address_type: str + + :param ip_classification_type: + The value to assign to the ip_classification_type property of this ResourceProfileEndpointSummary. + :type ip_classification_type: str + + :param country: + The value to assign to the country property of this ResourceProfileEndpointSummary. + :type country: str + + :param latitude: + The value to assign to the latitude property of this ResourceProfileEndpointSummary. + :type latitude: float + + :param longitude: + The value to assign to the longitude property of this ResourceProfileEndpointSummary. + :type longitude: float + + :param asn_number: + The value to assign to the asn_number property of this ResourceProfileEndpointSummary. + :type asn_number: str + + :param regions: + The value to assign to the regions property of this ResourceProfileEndpointSummary. + :type regions: list[str] + + :param services: + The value to assign to the services property of this ResourceProfileEndpointSummary. + :type services: list[str] + + :param time_last_detected: + The value to assign to the time_last_detected property of this ResourceProfileEndpointSummary. + :type time_last_detected: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'resource_profile_id': 'str', + 'problem_id': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', + 'ip_address': 'str', + 'ip_address_type': 'str', + 'ip_classification_type': 'str', + 'country': 'str', + 'latitude': 'float', + 'longitude': 'float', + 'asn_number': 'str', + 'regions': 'list[str]', + 'services': 'list[str]', + 'time_last_detected': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'resource_profile_id': 'resourceProfileId', + 'problem_id': 'problemId', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', + 'ip_address': 'ipAddress', + 'ip_address_type': 'ipAddressType', + 'ip_classification_type': 'ipClassificationType', + 'country': 'country', + 'latitude': 'latitude', + 'longitude': 'longitude', + 'asn_number': 'asnNumber', + 'regions': 'regions', + 'services': 'services', + 'time_last_detected': 'timeLastDetected' + } + + self._id = None + self._resource_profile_id = None + self._problem_id = None + self._sighting_type = None + self._sighting_type_display_name = None + self._ip_address = None + self._ip_address_type = None + self._ip_classification_type = None + self._country = None + self._latitude = None + self._longitude = None + self._asn_number = None + self._regions = None + self._services = None + self._time_last_detected = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ResourceProfileEndpointSummary. + Unique identifier for sighting endpoints + + + :return: The id of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ResourceProfileEndpointSummary. + Unique identifier for sighting endpoints + + + :param id: The id of this ResourceProfileEndpointSummary. + :type: str + """ + self._id = id + + @property + def resource_profile_id(self): + """ + **[Required]** Gets the resource_profile_id of this ResourceProfileEndpointSummary. + Resource profile Id associated with the imacted resource + + + :return: The resource_profile_id of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._resource_profile_id + + @resource_profile_id.setter + def resource_profile_id(self, resource_profile_id): + """ + Sets the resource_profile_id of this ResourceProfileEndpointSummary. + Resource profile Id associated with the imacted resource + + + :param resource_profile_id: The resource_profile_id of this ResourceProfileEndpointSummary. + :type: str + """ + self._resource_profile_id = resource_profile_id + + @property + def problem_id(self): + """ + Gets the problem_id of this ResourceProfileEndpointSummary. + Problem Id for sighting endpoints + + + :return: The problem_id of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this ResourceProfileEndpointSummary. + Problem Id for sighting endpoints + + + :param problem_id: The problem_id of this ResourceProfileEndpointSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def sighting_type(self): + """ + **[Required]** Gets the sighting_type of this ResourceProfileEndpointSummary. + Identifier for the sighting type + + + :return: The sighting_type of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this ResourceProfileEndpointSummary. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this ResourceProfileEndpointSummary. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + **[Required]** Gets the sighting_type_display_name of this ResourceProfileEndpointSummary. + Name of the sighting type + + + :return: The sighting_type_display_name of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this ResourceProfileEndpointSummary. + Name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this ResourceProfileEndpointSummary. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + + @property + def ip_address(self): + """ + **[Required]** Gets the ip_address of this ResourceProfileEndpointSummary. + IP Address + + + :return: The ip_address of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """ + Sets the ip_address of this ResourceProfileEndpointSummary. + IP Address + + + :param ip_address: The ip_address of this ResourceProfileEndpointSummary. + :type: str + """ + self._ip_address = ip_address + + @property + def ip_address_type(self): + """ + **[Required]** Gets the ip_address_type of this ResourceProfileEndpointSummary. + IP Address type + + + :return: The ip_address_type of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._ip_address_type + + @ip_address_type.setter + def ip_address_type(self, ip_address_type): + """ + Sets the ip_address_type of this ResourceProfileEndpointSummary. + IP Address type + + + :param ip_address_type: The ip_address_type of this ResourceProfileEndpointSummary. + :type: str + """ + self._ip_address_type = ip_address_type + + @property + def ip_classification_type(self): + """ + Gets the ip_classification_type of this ResourceProfileEndpointSummary. + IP Address classification type + + + :return: The ip_classification_type of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._ip_classification_type + + @ip_classification_type.setter + def ip_classification_type(self, ip_classification_type): + """ + Sets the ip_classification_type of this ResourceProfileEndpointSummary. + IP Address classification type + + + :param ip_classification_type: The ip_classification_type of this ResourceProfileEndpointSummary. + :type: str + """ + self._ip_classification_type = ip_classification_type + + @property + def country(self): + """ + Gets the country of this ResourceProfileEndpointSummary. + Country + + + :return: The country of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """ + Sets the country of this ResourceProfileEndpointSummary. + Country + + + :param country: The country of this ResourceProfileEndpointSummary. + :type: str + """ + self._country = country + + @property + def latitude(self): + """ + Gets the latitude of this ResourceProfileEndpointSummary. + Latitude + + + :return: The latitude of this ResourceProfileEndpointSummary. + :rtype: float + """ + return self._latitude + + @latitude.setter + def latitude(self, latitude): + """ + Sets the latitude of this ResourceProfileEndpointSummary. + Latitude + + + :param latitude: The latitude of this ResourceProfileEndpointSummary. + :type: float + """ + self._latitude = latitude + + @property + def longitude(self): + """ + Gets the longitude of this ResourceProfileEndpointSummary. + Longitude + + + :return: The longitude of this ResourceProfileEndpointSummary. + :rtype: float + """ + return self._longitude + + @longitude.setter + def longitude(self, longitude): + """ + Sets the longitude of this ResourceProfileEndpointSummary. + Longitude + + + :param longitude: The longitude of this ResourceProfileEndpointSummary. + :type: float + """ + self._longitude = longitude + + @property + def asn_number(self): + """ + Gets the asn_number of this ResourceProfileEndpointSummary. + ASN number + + + :return: The asn_number of this ResourceProfileEndpointSummary. + :rtype: str + """ + return self._asn_number + + @asn_number.setter + def asn_number(self, asn_number): + """ + Sets the asn_number of this ResourceProfileEndpointSummary. + ASN number + + + :param asn_number: The asn_number of this ResourceProfileEndpointSummary. + :type: str + """ + self._asn_number = asn_number + + @property + def regions(self): + """ + Gets the regions of this ResourceProfileEndpointSummary. + Regions where activities were performed from this IP + + + :return: The regions of this ResourceProfileEndpointSummary. + :rtype: list[str] + """ + return self._regions + + @regions.setter + def regions(self, regions): + """ + Sets the regions of this ResourceProfileEndpointSummary. + Regions where activities were performed from this IP + + + :param regions: The regions of this ResourceProfileEndpointSummary. + :type: list[str] + """ + self._regions = regions + + @property + def services(self): + """ + Gets the services of this ResourceProfileEndpointSummary. + Services where activities were performed from this IP + + + :return: The services of this ResourceProfileEndpointSummary. + :rtype: list[str] + """ + return self._services + + @services.setter + def services(self, services): + """ + Sets the services of this ResourceProfileEndpointSummary. + Services where activities were performed from this IP + + + :param services: The services of this ResourceProfileEndpointSummary. + :type: list[str] + """ + self._services = services + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this ResourceProfileEndpointSummary. + Time when activities were created + + + :return: The time_last_detected of this ResourceProfileEndpointSummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this ResourceProfileEndpointSummary. + Time when activities were created + + + :param time_last_detected: The time_last_detected of this ResourceProfileEndpointSummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/resource_profile_impacted_resource_collection.py b/src/oci/cloud_guard/models/resource_profile_impacted_resource_collection.py new file mode 100644 index 0000000000..e029296b9c --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_impacted_resource_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileImpactedResourceCollection(object): + """ + Collection of resource profile impacted resource summaries + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileImpactedResourceCollection 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 ResourceProfileImpactedResourceCollection. + :type items: list[oci.cloud_guard.models.ResourceProfileImpactedResourceSummary] + + """ + self.swagger_types = { + 'items': 'list[ResourceProfileImpactedResourceSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceProfileImpactedResourceCollection. + List of ResourceProfileImpactedResourceSummary + + + :return: The items of this ResourceProfileImpactedResourceCollection. + :rtype: list[oci.cloud_guard.models.ResourceProfileImpactedResourceSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceProfileImpactedResourceCollection. + List of ResourceProfileImpactedResourceSummary + + + :param items: The items of this ResourceProfileImpactedResourceCollection. + :type: list[oci.cloud_guard.models.ResourceProfileImpactedResourceSummary] + """ + 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/cloud_guard/models/resource_profile_impacted_resource_summary.py b/src/oci/cloud_guard/models/resource_profile_impacted_resource_summary.py new file mode 100644 index 0000000000..f3f4993605 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_impacted_resource_summary.py @@ -0,0 +1,380 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileImpactedResourceSummary(object): + """ + Resource Profile impacted resource summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileImpactedResourceSummary 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 ResourceProfileImpactedResourceSummary. + :type id: str + + :param resource_profile_id: + The value to assign to the resource_profile_id property of this ResourceProfileImpactedResourceSummary. + :type resource_profile_id: str + + :param problem_id: + The value to assign to the problem_id property of this ResourceProfileImpactedResourceSummary. + :type problem_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this ResourceProfileImpactedResourceSummary. + :type compartment_id: str + + :param resource_id: + The value to assign to the resource_id property of this ResourceProfileImpactedResourceSummary. + :type resource_id: str + + :param resource_name: + The value to assign to the resource_name property of this ResourceProfileImpactedResourceSummary. + :type resource_name: str + + :param resource_type: + The value to assign to the resource_type property of this ResourceProfileImpactedResourceSummary. + :type resource_type: str + + :param sighting_type: + The value to assign to the sighting_type property of this ResourceProfileImpactedResourceSummary. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this ResourceProfileImpactedResourceSummary. + :type sighting_type_display_name: str + + :param region: + The value to assign to the region property of this ResourceProfileImpactedResourceSummary. + :type region: str + + :param time_identified: + The value to assign to the time_identified property of this ResourceProfileImpactedResourceSummary. + :type time_identified: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'resource_profile_id': 'str', + 'problem_id': 'str', + 'compartment_id': 'str', + 'resource_id': 'str', + 'resource_name': 'str', + 'resource_type': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', + 'region': 'str', + 'time_identified': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'resource_profile_id': 'resourceProfileId', + 'problem_id': 'problemId', + 'compartment_id': 'compartmentId', + 'resource_id': 'resourceId', + 'resource_name': 'resourceName', + 'resource_type': 'resourceType', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', + 'region': 'region', + 'time_identified': 'timeIdentified' + } + + self._id = None + self._resource_profile_id = None + self._problem_id = None + self._compartment_id = None + self._resource_id = None + self._resource_name = None + self._resource_type = None + self._sighting_type = None + self._sighting_type_display_name = None + self._region = None + self._time_identified = None + + @property + def id(self): + """ + **[Required]** Gets the id of this ResourceProfileImpactedResourceSummary. + Unique identifier for impacted resource + + + :return: The id of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ResourceProfileImpactedResourceSummary. + Unique identifier for impacted resource + + + :param id: The id of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._id = id + + @property + def resource_profile_id(self): + """ + **[Required]** Gets the resource_profile_id of this ResourceProfileImpactedResourceSummary. + Resource profile Id associated with the imacted resource + + + :return: The resource_profile_id of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._resource_profile_id + + @resource_profile_id.setter + def resource_profile_id(self, resource_profile_id): + """ + Sets the resource_profile_id of this ResourceProfileImpactedResourceSummary. + Resource profile Id associated with the imacted resource + + + :param resource_profile_id: The resource_profile_id of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._resource_profile_id = resource_profile_id + + @property + def problem_id(self): + """ + Gets the problem_id of this ResourceProfileImpactedResourceSummary. + Problem Id for impacted resource + + + :return: The problem_id of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this ResourceProfileImpactedResourceSummary. + Problem Id for impacted resource + + + :param problem_id: The problem_id of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this ResourceProfileImpactedResourceSummary. + Compartment Id for impacted resource + + + :return: The compartment_id of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ResourceProfileImpactedResourceSummary. + Compartment Id for impacted resource + + + :param compartment_id: The compartment_id of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this ResourceProfileImpactedResourceSummary. + Impacted resource Id + + + :return: The resource_id of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this ResourceProfileImpactedResourceSummary. + Impacted resource Id + + + :param resource_id: The resource_id of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._resource_id = resource_id + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this ResourceProfileImpactedResourceSummary. + Resource name + + + :return: The resource_name of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this ResourceProfileImpactedResourceSummary. + Resource name + + + :param resource_name: The resource_name of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._resource_name = resource_name + + @property + def resource_type(self): + """ + **[Required]** Gets the resource_type of this ResourceProfileImpactedResourceSummary. + Resource type + + + :return: The resource_type of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._resource_type + + @resource_type.setter + def resource_type(self, resource_type): + """ + Sets the resource_type of this ResourceProfileImpactedResourceSummary. + Resource type + + + :param resource_type: The resource_type of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._resource_type = resource_type + + @property + def sighting_type(self): + """ + **[Required]** Gets the sighting_type of this ResourceProfileImpactedResourceSummary. + Identifier for the sighting type + + + :return: The sighting_type of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this ResourceProfileImpactedResourceSummary. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + **[Required]** Gets the sighting_type_display_name of this ResourceProfileImpactedResourceSummary. + Name of the sighting type + + + :return: The sighting_type_display_name of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this ResourceProfileImpactedResourceSummary. + Name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + + @property + def region(self): + """ + **[Required]** Gets the region of this ResourceProfileImpactedResourceSummary. + Region for impacted resource + + + :return: The region of this ResourceProfileImpactedResourceSummary. + :rtype: str + """ + return self._region + + @region.setter + def region(self, region): + """ + Sets the region of this ResourceProfileImpactedResourceSummary. + Region for impacted resource + + + :param region: The region of this ResourceProfileImpactedResourceSummary. + :type: str + """ + self._region = region + + @property + def time_identified(self): + """ + **[Required]** Gets the time_identified of this ResourceProfileImpactedResourceSummary. + Time when the impacted resource is identified for given resource profile. + + + :return: The time_identified of this ResourceProfileImpactedResourceSummary. + :rtype: datetime + """ + return self._time_identified + + @time_identified.setter + def time_identified(self, time_identified): + """ + Sets the time_identified of this ResourceProfileImpactedResourceSummary. + Time when the impacted resource is identified for given resource profile. + + + :param time_identified: The time_identified of this ResourceProfileImpactedResourceSummary. + :type: datetime + """ + self._time_identified = time_identified + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/resource_profile_risk_score_aggregation_summary.py b/src/oci/cloud_guard/models/resource_profile_risk_score_aggregation_summary.py new file mode 100644 index 0000000000..e625b8b119 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_risk_score_aggregation_summary.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileRiskScoreAggregationSummary(object): + """ + Resource profile risk score trend-line + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileRiskScoreAggregationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param resource_profile_id: + The value to assign to the resource_profile_id property of this ResourceProfileRiskScoreAggregationSummary. + :type resource_profile_id: str + + :param resource_profile_display_name: + The value to assign to the resource_profile_display_name property of this ResourceProfileRiskScoreAggregationSummary. + :type resource_profile_display_name: str + + :param risk_threshold: + The value to assign to the risk_threshold property of this ResourceProfileRiskScoreAggregationSummary. + :type risk_threshold: int + + :param items: + The value to assign to the items property of this ResourceProfileRiskScoreAggregationSummary. + :type items: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + + """ + self.swagger_types = { + 'resource_profile_id': 'str', + 'resource_profile_display_name': 'str', + 'risk_threshold': 'int', + 'items': 'list[ResourceRiskScoreAggregation]' + } + + self.attribute_map = { + 'resource_profile_id': 'resourceProfileId', + 'resource_profile_display_name': 'resourceProfileDisplayName', + 'risk_threshold': 'riskThreshold', + 'items': 'items' + } + + self._resource_profile_id = None + self._resource_profile_display_name = None + self._risk_threshold = None + self._items = None + + @property + def resource_profile_id(self): + """ + **[Required]** Gets the resource_profile_id of this ResourceProfileRiskScoreAggregationSummary. + OCID for the resource profile + + + :return: The resource_profile_id of this ResourceProfileRiskScoreAggregationSummary. + :rtype: str + """ + return self._resource_profile_id + + @resource_profile_id.setter + def resource_profile_id(self, resource_profile_id): + """ + Sets the resource_profile_id of this ResourceProfileRiskScoreAggregationSummary. + OCID for the resource profile + + + :param resource_profile_id: The resource_profile_id of this ResourceProfileRiskScoreAggregationSummary. + :type: str + """ + self._resource_profile_id = resource_profile_id + + @property + def resource_profile_display_name(self): + """ + **[Required]** Gets the resource_profile_display_name of this ResourceProfileRiskScoreAggregationSummary. + Display name for the resource profile + + + :return: The resource_profile_display_name of this ResourceProfileRiskScoreAggregationSummary. + :rtype: str + """ + return self._resource_profile_display_name + + @resource_profile_display_name.setter + def resource_profile_display_name(self, resource_profile_display_name): + """ + Sets the resource_profile_display_name of this ResourceProfileRiskScoreAggregationSummary. + Display name for the resource profile + + + :param resource_profile_display_name: The resource_profile_display_name of this ResourceProfileRiskScoreAggregationSummary. + :type: str + """ + self._resource_profile_display_name = resource_profile_display_name + + @property + def risk_threshold(self): + """ + Gets the risk_threshold of this ResourceProfileRiskScoreAggregationSummary. + Risk threshold + + + :return: The risk_threshold of this ResourceProfileRiskScoreAggregationSummary. + :rtype: int + """ + return self._risk_threshold + + @risk_threshold.setter + def risk_threshold(self, risk_threshold): + """ + Sets the risk_threshold of this ResourceProfileRiskScoreAggregationSummary. + Risk threshold + + + :param risk_threshold: The risk_threshold of this ResourceProfileRiskScoreAggregationSummary. + :type: int + """ + self._risk_threshold = risk_threshold + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceProfileRiskScoreAggregationSummary. + List of ResourceRiskScoreAggregation + + + :return: The items of this ResourceProfileRiskScoreAggregationSummary. + :rtype: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceProfileRiskScoreAggregationSummary. + List of ResourceRiskScoreAggregation + + + :param items: The items of this ResourceProfileRiskScoreAggregationSummary. + :type: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + """ + 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/cloud_guard/models/resource_profile_risk_score_aggregation_summary_collection.py b/src/oci/cloud_guard/models/resource_profile_risk_score_aggregation_summary_collection.py new file mode 100644 index 0000000000..36ad6224b4 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_risk_score_aggregation_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileRiskScoreAggregationSummaryCollection(object): + """ + Collection of resource profile risk score trends. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileRiskScoreAggregationSummaryCollection 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 ResourceProfileRiskScoreAggregationSummaryCollection. + :type items: list[oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary] + + """ + self.swagger_types = { + 'items': 'list[ResourceProfileRiskScoreAggregationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceProfileRiskScoreAggregationSummaryCollection. + List of ResourceProfileRiskScoreAggregationSummary + + + :return: The items of this ResourceProfileRiskScoreAggregationSummaryCollection. + :rtype: list[oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceProfileRiskScoreAggregationSummaryCollection. + List of ResourceProfileRiskScoreAggregationSummary + + + :param items: The items of this ResourceProfileRiskScoreAggregationSummaryCollection. + :type: list[oci.cloud_guard.models.ResourceProfileRiskScoreAggregationSummary] + """ + 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/cloud_guard/models/resource_profile_summary.py b/src/oci/cloud_guard/models/resource_profile_summary.py new file mode 100644 index 0000000000..4d573d197a --- /dev/null +++ b/src/oci/cloud_guard/models/resource_profile_summary.py @@ -0,0 +1,349 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceProfileSummary(object): + """ + Resource profile summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceProfileSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param sightings_count: + The value to assign to the sightings_count property of this ResourceProfileSummary. + :type sightings_count: int + + :param id: + The value to assign to the id property of this ResourceProfileSummary. + :type id: str + + :param resource_id: + The value to assign to the resource_id property of this ResourceProfileSummary. + :type resource_id: str + + :param display_name: + The value to assign to the display_name property of this ResourceProfileSummary. + :type display_name: str + + :param type: + The value to assign to the type property of this ResourceProfileSummary. + :type type: str + + :param risk_score: + The value to assign to the risk_score property of this ResourceProfileSummary. + :type risk_score: float + + :param tactics: + The value to assign to the tactics property of this ResourceProfileSummary. + :type tactics: list[oci.cloud_guard.models.TacticSummary] + + :param time_first_detected: + The value to assign to the time_first_detected property of this ResourceProfileSummary. + :type time_first_detected: datetime + + :param time_last_detected: + The value to assign to the time_last_detected property of this ResourceProfileSummary. + :type time_last_detected: datetime + + :param problems_count: + The value to assign to the problems_count property of this ResourceProfileSummary. + :type problems_count: int + + """ + self.swagger_types = { + 'sightings_count': 'int', + 'id': 'str', + 'resource_id': 'str', + 'display_name': 'str', + 'type': 'str', + 'risk_score': 'float', + 'tactics': 'list[TacticSummary]', + 'time_first_detected': 'datetime', + 'time_last_detected': 'datetime', + 'problems_count': 'int' + } + + self.attribute_map = { + 'sightings_count': 'sightingsCount', + 'id': 'id', + 'resource_id': 'resourceId', + 'display_name': 'displayName', + 'type': 'type', + 'risk_score': 'riskScore', + 'tactics': 'tactics', + 'time_first_detected': 'timeFirstDetected', + 'time_last_detected': 'timeLastDetected', + 'problems_count': 'problemsCount' + } + + self._sightings_count = None + self._id = None + self._resource_id = None + self._display_name = None + self._type = None + self._risk_score = None + self._tactics = None + self._time_first_detected = None + self._time_last_detected = None + self._problems_count = None + + @property + def sightings_count(self): + """ + Gets the sightings_count of this ResourceProfileSummary. + Number of sightings associated with this resource profile + + + :return: The sightings_count of this ResourceProfileSummary. + :rtype: int + """ + return self._sightings_count + + @sightings_count.setter + def sightings_count(self, sightings_count): + """ + Sets the sightings_count of this ResourceProfileSummary. + Number of sightings associated with this resource profile + + + :param sightings_count: The sightings_count of this ResourceProfileSummary. + :type: int + """ + self._sightings_count = sightings_count + + @property + def id(self): + """ + **[Required]** Gets the id of this ResourceProfileSummary. + Unique identifier for resource profile + + + :return: The id of this ResourceProfileSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ResourceProfileSummary. + Unique identifier for resource profile + + + :param id: The id of this ResourceProfileSummary. + :type: str + """ + self._id = id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this ResourceProfileSummary. + Unique identifier for resource profile + + + :return: The resource_id of this ResourceProfileSummary. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this ResourceProfileSummary. + Unique identifier for resource profile + + + :param resource_id: The resource_id of this ResourceProfileSummary. + :type: str + """ + self._resource_id = resource_id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this ResourceProfileSummary. + Resource name for resource profile + + + :return: The display_name of this ResourceProfileSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ResourceProfileSummary. + Resource name for resource profile + + + :param display_name: The display_name of this ResourceProfileSummary. + :type: str + """ + self._display_name = display_name + + @property + def type(self): + """ + **[Required]** Gets the type of this ResourceProfileSummary. + Resource type for resource profile + + + :return: The type of this ResourceProfileSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ResourceProfileSummary. + Resource type for resource profile + + + :param type: The type of this ResourceProfileSummary. + :type: str + """ + self._type = type + + @property + def risk_score(self): + """ + **[Required]** Gets the risk_score of this ResourceProfileSummary. + Risk Score for the resource profile + + + :return: The risk_score of this ResourceProfileSummary. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this ResourceProfileSummary. + Risk Score for the resource profile + + + :param risk_score: The risk_score of this ResourceProfileSummary. + :type: float + """ + self._risk_score = risk_score + + @property + def tactics(self): + """ + **[Required]** Gets the tactics of this ResourceProfileSummary. + List of tactic summary associated with the resource profile. + + + :return: The tactics of this ResourceProfileSummary. + :rtype: list[oci.cloud_guard.models.TacticSummary] + """ + return self._tactics + + @tactics.setter + def tactics(self, tactics): + """ + Sets the tactics of this ResourceProfileSummary. + List of tactic summary associated with the resource profile. + + + :param tactics: The tactics of this ResourceProfileSummary. + :type: list[oci.cloud_guard.models.TacticSummary] + """ + self._tactics = tactics + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this ResourceProfileSummary. + The date and time the resource profile was first detected. Format defined by RFC3339. + + + :return: The time_first_detected of this ResourceProfileSummary. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this ResourceProfileSummary. + The date and time the resource profile was first detected. Format defined by RFC3339. + + + :param time_first_detected: The time_first_detected of this ResourceProfileSummary. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this ResourceProfileSummary. + The date and time the resource profile was last detected. Format defined by RFC3339. + + + :return: The time_last_detected of this ResourceProfileSummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this ResourceProfileSummary. + The date and time the resource profile was last detected. Format defined by RFC3339. + + + :param time_last_detected: The time_last_detected of this ResourceProfileSummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def problems_count(self): + """ + Gets the problems_count of this ResourceProfileSummary. + Number of problems associated with this resource profile + + + :return: The problems_count of this ResourceProfileSummary. + :rtype: int + """ + return self._problems_count + + @problems_count.setter + def problems_count(self, problems_count): + """ + Sets the problems_count of this ResourceProfileSummary. + Number of problems associated with this resource profile + + + :param problems_count: The problems_count of this ResourceProfileSummary. + :type: int + """ + self._problems_count = problems_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/cloud_guard/models/resource_risk_score_aggregation.py b/src/oci/cloud_guard/models/resource_risk_score_aggregation.py new file mode 100644 index 0000000000..7efd5456ae --- /dev/null +++ b/src/oci/cloud_guard/models/resource_risk_score_aggregation.py @@ -0,0 +1,191 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceRiskScoreAggregation(object): + """ + Risk score of a resource. + """ + + #: A constant which can be used with the risk_level property of a ResourceRiskScoreAggregation. + #: This constant has a value of "CRITICAL" + RISK_LEVEL_CRITICAL = "CRITICAL" + + #: A constant which can be used with the risk_level property of a ResourceRiskScoreAggregation. + #: This constant has a value of "HIGH" + RISK_LEVEL_HIGH = "HIGH" + + #: A constant which can be used with the risk_level property of a ResourceRiskScoreAggregation. + #: This constant has a value of "MEDIUM" + RISK_LEVEL_MEDIUM = "MEDIUM" + + #: A constant which can be used with the risk_level property of a ResourceRiskScoreAggregation. + #: This constant has a value of "LOW" + RISK_LEVEL_LOW = "LOW" + + #: A constant which can be used with the risk_level property of a ResourceRiskScoreAggregation. + #: This constant has a value of "MINOR" + RISK_LEVEL_MINOR = "MINOR" + + def __init__(self, **kwargs): + """ + Initializes a new ResourceRiskScoreAggregation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param tactics: + The value to assign to the tactics property of this ResourceRiskScoreAggregation. + :type tactics: list[str] + + :param score_timestamp: + The value to assign to the score_timestamp property of this ResourceRiskScoreAggregation. + :type score_timestamp: float + + :param risk_score: + The value to assign to the risk_score property of this ResourceRiskScoreAggregation. + :type risk_score: float + + :param risk_level: + The value to assign to the risk_level property of this ResourceRiskScoreAggregation. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type risk_level: str + + """ + self.swagger_types = { + 'tactics': 'list[str]', + 'score_timestamp': 'float', + 'risk_score': 'float', + 'risk_level': 'str' + } + + self.attribute_map = { + 'tactics': 'tactics', + 'score_timestamp': 'scoreTimestamp', + 'risk_score': 'riskScore', + 'risk_level': 'riskLevel' + } + + self._tactics = None + self._score_timestamp = None + self._risk_score = None + self._risk_level = None + + @property + def tactics(self): + """ + **[Required]** Gets the tactics of this ResourceRiskScoreAggregation. + Tactics used for evaluating the risk scrore + + + :return: The tactics of this ResourceRiskScoreAggregation. + :rtype: list[str] + """ + return self._tactics + + @tactics.setter + def tactics(self, tactics): + """ + Sets the tactics of this ResourceRiskScoreAggregation. + Tactics used for evaluating the risk scrore + + + :param tactics: The tactics of this ResourceRiskScoreAggregation. + :type: list[str] + """ + self._tactics = tactics + + @property + def score_timestamp(self): + """ + **[Required]** Gets the score_timestamp of this ResourceRiskScoreAggregation. + The date and time for which the score is calculated. Format defined by RFC3339. + + + :return: The score_timestamp of this ResourceRiskScoreAggregation. + :rtype: float + """ + return self._score_timestamp + + @score_timestamp.setter + def score_timestamp(self, score_timestamp): + """ + Sets the score_timestamp of this ResourceRiskScoreAggregation. + The date and time for which the score is calculated. Format defined by RFC3339. + + + :param score_timestamp: The score_timestamp of this ResourceRiskScoreAggregation. + :type: float + """ + self._score_timestamp = score_timestamp + + @property + def risk_score(self): + """ + **[Required]** Gets the risk_score of this ResourceRiskScoreAggregation. + Risk Score + + + :return: The risk_score of this ResourceRiskScoreAggregation. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this ResourceRiskScoreAggregation. + Risk Score + + + :param risk_score: The risk_score of this ResourceRiskScoreAggregation. + :type: float + """ + self._risk_score = risk_score + + @property + def risk_level(self): + """ + **[Required]** Gets the risk_level of this ResourceRiskScoreAggregation. + The Risk Level + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The risk_level of this ResourceRiskScoreAggregation. + :rtype: str + """ + return self._risk_level + + @risk_level.setter + def risk_level(self, risk_level): + """ + Sets the risk_level of this ResourceRiskScoreAggregation. + The Risk Level + + + :param risk_level: The risk_level of this ResourceRiskScoreAggregation. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(risk_level, allowed_values): + risk_level = 'UNKNOWN_ENUM_VALUE' + self._risk_level = risk_level + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/resource_risk_score_aggregation_collection.py b/src/oci/cloud_guard/models/resource_risk_score_aggregation_collection.py new file mode 100644 index 0000000000..64694c77e0 --- /dev/null +++ b/src/oci/cloud_guard/models/resource_risk_score_aggregation_collection.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ResourceRiskScoreAggregationCollection(object): + """ + Collection of Resource risk scores + """ + + def __init__(self, **kwargs): + """ + Initializes a new ResourceRiskScoreAggregationCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param filter_type: + The value to assign to the filter_type property of this ResourceRiskScoreAggregationCollection. + :type filter_type: str + + :param filter_id: + The value to assign to the filter_id property of this ResourceRiskScoreAggregationCollection. + :type filter_id: str + + :param risk_threshold: + The value to assign to the risk_threshold property of this ResourceRiskScoreAggregationCollection. + :type risk_threshold: int + + :param items: + The value to assign to the items property of this ResourceRiskScoreAggregationCollection. + :type items: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + + """ + self.swagger_types = { + 'filter_type': 'str', + 'filter_id': 'str', + 'risk_threshold': 'int', + 'items': 'list[ResourceRiskScoreAggregation]' + } + + self.attribute_map = { + 'filter_type': 'filterType', + 'filter_id': 'filterId', + 'risk_threshold': 'riskThreshold', + 'items': 'items' + } + + self._filter_type = None + self._filter_id = None + self._risk_threshold = None + self._items = None + + @property + def filter_type(self): + """ + **[Required]** Gets the filter_type of this ResourceRiskScoreAggregationCollection. + Type of filter. Valid Values - problem_id and resource_id + + + :return: The filter_type of this ResourceRiskScoreAggregationCollection. + :rtype: str + """ + return self._filter_type + + @filter_type.setter + def filter_type(self, filter_type): + """ + Sets the filter_type of this ResourceRiskScoreAggregationCollection. + Type of filter. Valid Values - problem_id and resource_id + + + :param filter_type: The filter_type of this ResourceRiskScoreAggregationCollection. + :type: str + """ + self._filter_type = filter_type + + @property + def filter_id(self): + """ + **[Required]** Gets the filter_id of this ResourceRiskScoreAggregationCollection. + Id value on which risk scores are filtered + + + :return: The filter_id of this ResourceRiskScoreAggregationCollection. + :rtype: str + """ + return self._filter_id + + @filter_id.setter + def filter_id(self, filter_id): + """ + Sets the filter_id of this ResourceRiskScoreAggregationCollection. + Id value on which risk scores are filtered + + + :param filter_id: The filter_id of this ResourceRiskScoreAggregationCollection. + :type: str + """ + self._filter_id = filter_id + + @property + def risk_threshold(self): + """ + Gets the risk_threshold of this ResourceRiskScoreAggregationCollection. + Risk Score + + + :return: The risk_threshold of this ResourceRiskScoreAggregationCollection. + :rtype: int + """ + return self._risk_threshold + + @risk_threshold.setter + def risk_threshold(self, risk_threshold): + """ + Sets the risk_threshold of this ResourceRiskScoreAggregationCollection. + Risk Score + + + :param risk_threshold: The risk_threshold of this ResourceRiskScoreAggregationCollection. + :type: int + """ + self._risk_threshold = risk_threshold + + @property + def items(self): + """ + **[Required]** Gets the items of this ResourceRiskScoreAggregationCollection. + List of ResourceRiskScoreAggregation + + + :return: The items of this ResourceRiskScoreAggregationCollection. + :rtype: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ResourceRiskScoreAggregationCollection. + List of ResourceRiskScoreAggregation + + + :param items: The items of this ResourceRiskScoreAggregationCollection. + :type: list[oci.cloud_guard.models.ResourceRiskScoreAggregation] + """ + 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/cloud_guard/models/responder_recipe.py b/src/oci/cloud_guard/models/responder_recipe.py index b187f5482a..89fa59e50c 100644 --- a/src/oci/cloud_guard/models/responder_recipe.py +++ b/src/oci/cloud_guard/models/responder_recipe.py @@ -199,7 +199,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this ResponderRecipe. - ResponderRecipe Display Name + ResponderRecipe display name. :return: The display_name of this ResponderRecipe. @@ -211,7 +211,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ResponderRecipe. - ResponderRecipe Display Name + ResponderRecipe display name. :param display_name: The display_name of this ResponderRecipe. @@ -223,7 +223,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ResponderRecipe. - ResponderRecipe Description + ResponderRecipe description. :return: The description of this ResponderRecipe. @@ -235,7 +235,7 @@ def description(self): def description(self, description): """ Sets the description of this ResponderRecipe. - ResponderRecipe Description + ResponderRecipe description. :param description: The description of this ResponderRecipe. @@ -478,6 +478,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this ResponderRecipe. :rtype: dict(str, str) @@ -491,6 +493,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this ResponderRecipe. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/responder_recipe_responder_rule.py b/src/oci/cloud_guard/models/responder_recipe_responder_rule.py index e0c3006cd6..6db554b4ef 100644 --- a/src/oci/cloud_guard/models/responder_recipe_responder_rule.py +++ b/src/oci/cloud_guard/models/responder_recipe_responder_rule.py @@ -188,7 +188,7 @@ def responder_rule_id(self, responder_rule_id): def display_name(self): """ Gets the display_name of this ResponderRecipeResponderRule. - ResponderRule Display Name + ResponderRule display name. :return: The display_name of this ResponderRecipeResponderRule. @@ -200,7 +200,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ResponderRecipeResponderRule. - ResponderRule Display Name + ResponderRule display name. :param display_name: The display_name of this ResponderRecipeResponderRule. @@ -212,7 +212,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ResponderRecipeResponderRule. - ResponderRule Description + ResponderRule description. :return: The description of this ResponderRecipeResponderRule. @@ -224,7 +224,7 @@ def description(self): def description(self, description): """ Sets the description of this ResponderRecipeResponderRule. - ResponderRule Description + ResponderRule description. :param description: The description of this ResponderRecipeResponderRule. diff --git a/src/oci/cloud_guard/models/responder_recipe_summary.py b/src/oci/cloud_guard/models/responder_recipe_summary.py index 3fbf5e5769..9cac748081 100644 --- a/src/oci/cloud_guard/models/responder_recipe_summary.py +++ b/src/oci/cloud_guard/models/responder_recipe_summary.py @@ -192,7 +192,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this ResponderRecipeSummary. - ResponderRecipe Display Name + ResponderRecipe display name. :return: The display_name of this ResponderRecipeSummary. @@ -204,7 +204,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this ResponderRecipeSummary. - ResponderRecipe Display Name + ResponderRecipe display name. :param display_name: The display_name of this ResponderRecipeSummary. @@ -216,7 +216,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this ResponderRecipeSummary. - ResponderRecipe Description + ResponderRecipe description. :return: The description of this ResponderRecipeSummary. @@ -228,7 +228,7 @@ def description(self): def description(self, description): """ Sets the description of this ResponderRecipeSummary. - ResponderRecipe Description + ResponderRecipe description. :param description: The description of this ResponderRecipeSummary. @@ -447,6 +447,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this ResponderRecipeSummary. :rtype: dict(str, str) @@ -460,6 +462,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this ResponderRecipeSummary. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/sighting.py b/src/oci/cloud_guard/models/sighting.py new file mode 100644 index 0000000000..4b4d74a91f --- /dev/null +++ b/src/oci/cloud_guard/models/sighting.py @@ -0,0 +1,743 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Sighting(object): + """ + Sighting details. + """ + + #: A constant which can be used with the classification_status property of a Sighting. + #: This constant has a value of "FALSE_POSITIVE" + CLASSIFICATION_STATUS_FALSE_POSITIVE = "FALSE_POSITIVE" + + #: A constant which can be used with the classification_status property of a Sighting. + #: This constant has a value of "FALSE_NEGATIVE" + CLASSIFICATION_STATUS_FALSE_NEGATIVE = "FALSE_NEGATIVE" + + #: A constant which can be used with the classification_status property of a Sighting. + #: This constant has a value of "TRUE_POSITIVE" + CLASSIFICATION_STATUS_TRUE_POSITIVE = "TRUE_POSITIVE" + + #: A constant which can be used with the classification_status property of a Sighting. + #: This constant has a value of "TRUE_NEGATIVE" + CLASSIFICATION_STATUS_TRUE_NEGATIVE = "TRUE_NEGATIVE" + + #: A constant which can be used with the classification_status property of a Sighting. + #: This constant has a value of "NOT_CLASSIFIED" + CLASSIFICATION_STATUS_NOT_CLASSIFIED = "NOT_CLASSIFIED" + + #: A constant which can be used with the severity property of a Sighting. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the severity property of a Sighting. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a Sighting. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a Sighting. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a Sighting. + #: This constant has a value of "MINOR" + SEVERITY_MINOR = "MINOR" + + #: A constant which can be used with the confidence property of a Sighting. + #: This constant has a value of "CRITICAL" + CONFIDENCE_CRITICAL = "CRITICAL" + + #: A constant which can be used with the confidence property of a Sighting. + #: This constant has a value of "HIGH" + CONFIDENCE_HIGH = "HIGH" + + #: A constant which can be used with the confidence property of a Sighting. + #: This constant has a value of "MEDIUM" + CONFIDENCE_MEDIUM = "MEDIUM" + + #: A constant which can be used with the confidence property of a Sighting. + #: This constant has a value of "LOW" + CONFIDENCE_LOW = "LOW" + + #: A constant which can be used with the confidence property of a Sighting. + #: This constant has a value of "MINOR" + CONFIDENCE_MINOR = "MINOR" + + def __init__(self, **kwargs): + """ + Initializes a new Sighting 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 Sighting. + :type id: str + + :param description: + The value to assign to the description property of this Sighting. + :type description: str + + :param problem_id: + The value to assign to the problem_id property of this Sighting. + :type problem_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this Sighting. + :type compartment_id: str + + :param actor_principal_id: + The value to assign to the actor_principal_id property of this Sighting. + :type actor_principal_id: str + + :param actor_principal_name: + The value to assign to the actor_principal_name property of this Sighting. + :type actor_principal_name: str + + :param actor_principal_type: + The value to assign to the actor_principal_type property of this Sighting. + :type actor_principal_type: str + + :param classification_status: + The value to assign to the classification_status property of this Sighting. + Allowed values for this property are: "FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type classification_status: str + + :param sighting_type: + The value to assign to the sighting_type property of this Sighting. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this Sighting. + :type sighting_type_display_name: str + + :param tactic_name: + The value to assign to the tactic_name property of this Sighting. + :type tactic_name: str + + :param technique_name: + The value to assign to the technique_name property of this Sighting. + :type technique_name: str + + :param sighting_score: + The value to assign to the sighting_score property of this Sighting. + :type sighting_score: int + + :param risk_score: + The value to assign to the risk_score property of this Sighting. + :type risk_score: float + + :param severity: + The value to assign to the severity property of this Sighting. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param confidence: + The value to assign to the confidence property of this Sighting. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type confidence: str + + :param time_first_detected: + The value to assign to the time_first_detected property of this Sighting. + :type time_first_detected: datetime + + :param time_last_detected: + The value to assign to the time_last_detected property of this Sighting. + :type time_last_detected: datetime + + :param regions: + The value to assign to the regions property of this Sighting. + :type regions: list[str] + + :param additional_details: + The value to assign to the additional_details property of this Sighting. + :type additional_details: dict(str, str) + + """ + self.swagger_types = { + 'id': 'str', + 'description': 'str', + 'problem_id': 'str', + 'compartment_id': 'str', + 'actor_principal_id': 'str', + 'actor_principal_name': 'str', + 'actor_principal_type': 'str', + 'classification_status': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', + 'tactic_name': 'str', + 'technique_name': 'str', + 'sighting_score': 'int', + 'risk_score': 'float', + 'severity': 'str', + 'confidence': 'str', + 'time_first_detected': 'datetime', + 'time_last_detected': 'datetime', + 'regions': 'list[str]', + 'additional_details': 'dict(str, str)' + } + + self.attribute_map = { + 'id': 'id', + 'description': 'description', + 'problem_id': 'problemId', + 'compartment_id': 'compartmentId', + 'actor_principal_id': 'actorPrincipalId', + 'actor_principal_name': 'actorPrincipalName', + 'actor_principal_type': 'actorPrincipalType', + 'classification_status': 'classificationStatus', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', + 'tactic_name': 'tacticName', + 'technique_name': 'techniqueName', + 'sighting_score': 'sightingScore', + 'risk_score': 'riskScore', + 'severity': 'severity', + 'confidence': 'confidence', + 'time_first_detected': 'timeFirstDetected', + 'time_last_detected': 'timeLastDetected', + 'regions': 'regions', + 'additional_details': 'additionalDetails' + } + + self._id = None + self._description = None + self._problem_id = None + self._compartment_id = None + self._actor_principal_id = None + self._actor_principal_name = None + self._actor_principal_type = None + self._classification_status = None + self._sighting_type = None + self._sighting_type_display_name = None + self._tactic_name = None + self._technique_name = None + self._sighting_score = None + self._risk_score = None + self._severity = None + self._confidence = None + self._time_first_detected = None + self._time_last_detected = None + self._regions = None + self._additional_details = None + + @property + def id(self): + """ + **[Required]** Gets the id of this Sighting. + Unique identifier for sighting event + + + :return: The id of this Sighting. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Sighting. + Unique identifier for sighting event + + + :param id: The id of this Sighting. + :type: str + """ + self._id = id + + @property + def description(self): + """ + **[Required]** Gets the description of this Sighting. + Description of the sighting event + + + :return: The description of this Sighting. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Sighting. + Description of the sighting event + + + :param description: The description of this Sighting. + :type: str + """ + self._description = description + + @property + def problem_id(self): + """ + Gets the problem_id of this Sighting. + Problem Id to which the Sighting is associated + + + :return: The problem_id of this Sighting. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this Sighting. + Problem Id to which the Sighting is associated + + + :param problem_id: The problem_id of this Sighting. + :type: str + """ + self._problem_id = problem_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this Sighting. + Compartment Id where the resource is created + + + :return: The compartment_id of this Sighting. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Sighting. + Compartment Id where the resource is created + + + :param compartment_id: The compartment_id of this Sighting. + :type: str + """ + self._compartment_id = compartment_id + + @property + def actor_principal_id(self): + """ + Gets the actor_principal_id of this Sighting. + Unique identifier for principal actor + + + :return: The actor_principal_id of this Sighting. + :rtype: str + """ + return self._actor_principal_id + + @actor_principal_id.setter + def actor_principal_id(self, actor_principal_id): + """ + Sets the actor_principal_id of this Sighting. + Unique identifier for principal actor + + + :param actor_principal_id: The actor_principal_id of this Sighting. + :type: str + """ + self._actor_principal_id = actor_principal_id + + @property + def actor_principal_name(self): + """ + Gets the actor_principal_name of this Sighting. + Name of the principal actor + + + :return: The actor_principal_name of this Sighting. + :rtype: str + """ + return self._actor_principal_name + + @actor_principal_name.setter + def actor_principal_name(self, actor_principal_name): + """ + Sets the actor_principal_name of this Sighting. + Name of the principal actor + + + :param actor_principal_name: The actor_principal_name of this Sighting. + :type: str + """ + self._actor_principal_name = actor_principal_name + + @property + def actor_principal_type(self): + """ + Gets the actor_principal_type of this Sighting. + Type of the principal actor + + + :return: The actor_principal_type of this Sighting. + :rtype: str + """ + return self._actor_principal_type + + @actor_principal_type.setter + def actor_principal_type(self, actor_principal_type): + """ + Sets the actor_principal_type of this Sighting. + Type of the principal actor + + + :param actor_principal_type: The actor_principal_type of this Sighting. + :type: str + """ + self._actor_principal_type = actor_principal_type + + @property + def classification_status(self): + """ + **[Required]** Gets the classification_status of this Sighting. + ClassificationStatus of the sighting event + + Allowed values for this property are: "FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The classification_status of this Sighting. + :rtype: str + """ + return self._classification_status + + @classification_status.setter + def classification_status(self, classification_status): + """ + Sets the classification_status of this Sighting. + ClassificationStatus of the sighting event + + + :param classification_status: The classification_status of this Sighting. + :type: str + """ + allowed_values = ["FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED"] + if not value_allowed_none_or_none_sentinel(classification_status, allowed_values): + classification_status = 'UNKNOWN_ENUM_VALUE' + self._classification_status = classification_status + + @property + def sighting_type(self): + """ + **[Required]** Gets the sighting_type of this Sighting. + Identifier for the sighting type + + + :return: The sighting_type of this Sighting. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this Sighting. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this Sighting. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + **[Required]** Gets the sighting_type_display_name of this Sighting. + Display name of the sighting type + + + :return: The sighting_type_display_name of this Sighting. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this Sighting. + Display name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this Sighting. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + + @property + def tactic_name(self): + """ + **[Required]** Gets the tactic_name of this Sighting. + Name of the Mitre att&ck tactic + + + :return: The tactic_name of this Sighting. + :rtype: str + """ + return self._tactic_name + + @tactic_name.setter + def tactic_name(self, tactic_name): + """ + Sets the tactic_name of this Sighting. + Name of the Mitre att&ck tactic + + + :param tactic_name: The tactic_name of this Sighting. + :type: str + """ + self._tactic_name = tactic_name + + @property + def technique_name(self): + """ + **[Required]** Gets the technique_name of this Sighting. + Name of the Mitre att&ck technique + + + :return: The technique_name of this Sighting. + :rtype: str + """ + return self._technique_name + + @technique_name.setter + def technique_name(self, technique_name): + """ + Sets the technique_name of this Sighting. + Name of the Mitre att&ck technique + + + :param technique_name: The technique_name of this Sighting. + :type: str + """ + self._technique_name = technique_name + + @property + def sighting_score(self): + """ + **[Required]** Gets the sighting_score of this Sighting. + Score for the sighting + + + :return: The sighting_score of this Sighting. + :rtype: int + """ + return self._sighting_score + + @sighting_score.setter + def sighting_score(self, sighting_score): + """ + Sets the sighting_score of this Sighting. + Score for the sighting + + + :param sighting_score: The sighting_score of this Sighting. + :type: int + """ + self._sighting_score = sighting_score + + @property + def risk_score(self): + """ + Gets the risk_score of this Sighting. + DEPRECATED + + + :return: The risk_score of this Sighting. + :rtype: float + """ + return self._risk_score + + @risk_score.setter + def risk_score(self, risk_score): + """ + Sets the risk_score of this Sighting. + DEPRECATED + + + :param risk_score: The risk_score of this Sighting. + :type: float + """ + self._risk_score = risk_score + + @property + def severity(self): + """ + **[Required]** Gets the severity of this Sighting. + Severity of the sighting + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this Sighting. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this Sighting. + Severity of the sighting + + + :param severity: The severity of this Sighting. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this Sighting. + Confidence of the sighting + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The confidence of this Sighting. + :rtype: str + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this Sighting. + Confidence of the sighting + + + :param confidence: The confidence of this Sighting. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(confidence, allowed_values): + confidence = 'UNKNOWN_ENUM_VALUE' + self._confidence = confidence + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this Sighting. + The date and time the sighting was first detected. Format defined by RFC3339. + + + :return: The time_first_detected of this Sighting. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this Sighting. + The date and time the sighting was first detected. Format defined by RFC3339. + + + :param time_first_detected: The time_first_detected of this Sighting. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this Sighting. + The date and time the sighting was last detected. Format defined by RFC3339. + + + :return: The time_last_detected of this Sighting. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this Sighting. + The date and time the sighting was last detected. Format defined by RFC3339. + + + :param time_last_detected: The time_last_detected of this Sighting. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def regions(self): + """ + **[Required]** Gets the regions of this Sighting. + regions involved in the sighting + + + :return: The regions of this Sighting. + :rtype: list[str] + """ + return self._regions + + @regions.setter + def regions(self, regions): + """ + Sets the regions of this Sighting. + regions involved in the sighting + + + :param regions: The regions of this Sighting. + :type: list[str] + """ + self._regions = regions + + @property + def additional_details(self): + """ + Gets the additional_details of this Sighting. + The additional details of the Sighting + + + :return: The additional_details of this Sighting. + :rtype: dict(str, str) + """ + return self._additional_details + + @additional_details.setter + def additional_details(self, additional_details): + """ + Sets the additional_details of this Sighting. + The additional details of the Sighting + + + :param additional_details: The additional_details of this Sighting. + :type: dict(str, str) + """ + self._additional_details = additional_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/cloud_guard/models/sighting_collection.py b/src/oci/cloud_guard/models/sighting_collection.py new file mode 100644 index 0000000000..c4ef87b7cd --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingCollection(object): + """ + Provides the summary of sighting + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingCollection 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 SightingCollection. + :type items: list[oci.cloud_guard.models.SightingSummary] + + """ + self.swagger_types = { + 'items': 'list[SightingSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SightingCollection. + List of SightingSummary + + + :return: The items of this SightingCollection. + :rtype: list[oci.cloud_guard.models.SightingSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SightingCollection. + List of SightingSummary + + + :param items: The items of this SightingCollection. + :type: list[oci.cloud_guard.models.SightingSummary] + """ + 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/cloud_guard/models/sighting_endpoint_collection.py b/src/oci/cloud_guard/models/sighting_endpoint_collection.py new file mode 100644 index 0000000000..240df37d0b --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_endpoint_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingEndpointCollection(object): + """ + Provides the summary of sighting endpoints + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingEndpointCollection 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 SightingEndpointCollection. + :type items: list[oci.cloud_guard.models.SightingEndpointSummary] + + """ + self.swagger_types = { + 'items': 'list[SightingEndpointSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SightingEndpointCollection. + List of SightingEndpointSummary + + + :return: The items of this SightingEndpointCollection. + :rtype: list[oci.cloud_guard.models.SightingEndpointSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SightingEndpointCollection. + List of SightingEndpointSummary + + + :param items: The items of this SightingEndpointCollection. + :type: list[oci.cloud_guard.models.SightingEndpointSummary] + """ + 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/cloud_guard/models/sighting_endpoint_summary.py b/src/oci/cloud_guard/models/sighting_endpoint_summary.py new file mode 100644 index 0000000000..132c98d097 --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_endpoint_summary.py @@ -0,0 +1,442 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingEndpointSummary(object): + """ + Sighting Endpoints summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingEndpointSummary 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 SightingEndpointSummary. + :type id: str + + :param sighting_id: + The value to assign to the sighting_id property of this SightingEndpointSummary. + :type sighting_id: str + + :param problem_id: + The value to assign to the problem_id property of this SightingEndpointSummary. + :type problem_id: str + + :param ip_address: + The value to assign to the ip_address property of this SightingEndpointSummary. + :type ip_address: str + + :param ip_address_type: + The value to assign to the ip_address_type property of this SightingEndpointSummary. + :type ip_address_type: str + + :param ip_classification_type: + The value to assign to the ip_classification_type property of this SightingEndpointSummary. + :type ip_classification_type: str + + :param country: + The value to assign to the country property of this SightingEndpointSummary. + :type country: str + + :param latitude: + The value to assign to the latitude property of this SightingEndpointSummary. + :type latitude: float + + :param longitude: + The value to assign to the longitude property of this SightingEndpointSummary. + :type longitude: float + + :param asn_number: + The value to assign to the asn_number property of this SightingEndpointSummary. + :type asn_number: str + + :param regions: + The value to assign to the regions property of this SightingEndpointSummary. + :type regions: list[str] + + :param services: + The value to assign to the services property of this SightingEndpointSummary. + :type services: list[str] + + :param time_last_detected: + The value to assign to the time_last_detected property of this SightingEndpointSummary. + :type time_last_detected: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'sighting_id': 'str', + 'problem_id': 'str', + 'ip_address': 'str', + 'ip_address_type': 'str', + 'ip_classification_type': 'str', + 'country': 'str', + 'latitude': 'float', + 'longitude': 'float', + 'asn_number': 'str', + 'regions': 'list[str]', + 'services': 'list[str]', + 'time_last_detected': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'sighting_id': 'sightingId', + 'problem_id': 'problemId', + 'ip_address': 'ipAddress', + 'ip_address_type': 'ipAddressType', + 'ip_classification_type': 'ipClassificationType', + 'country': 'country', + 'latitude': 'latitude', + 'longitude': 'longitude', + 'asn_number': 'asnNumber', + 'regions': 'regions', + 'services': 'services', + 'time_last_detected': 'timeLastDetected' + } + + self._id = None + self._sighting_id = None + self._problem_id = None + self._ip_address = None + self._ip_address_type = None + self._ip_classification_type = None + self._country = None + self._latitude = None + self._longitude = None + self._asn_number = None + self._regions = None + self._services = None + self._time_last_detected = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SightingEndpointSummary. + Unique identifier for sighting endpoints + + + :return: The id of this SightingEndpointSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SightingEndpointSummary. + Unique identifier for sighting endpoints + + + :param id: The id of this SightingEndpointSummary. + :type: str + """ + self._id = id + + @property + def sighting_id(self): + """ + **[Required]** Gets the sighting_id of this SightingEndpointSummary. + Sighitng Id for sighting endpoints + + + :return: The sighting_id of this SightingEndpointSummary. + :rtype: str + """ + return self._sighting_id + + @sighting_id.setter + def sighting_id(self, sighting_id): + """ + Sets the sighting_id of this SightingEndpointSummary. + Sighitng Id for sighting endpoints + + + :param sighting_id: The sighting_id of this SightingEndpointSummary. + :type: str + """ + self._sighting_id = sighting_id + + @property + def problem_id(self): + """ + Gets the problem_id of this SightingEndpointSummary. + Problem Id for sighting endpoints + + + :return: The problem_id of this SightingEndpointSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this SightingEndpointSummary. + Problem Id for sighting endpoints + + + :param problem_id: The problem_id of this SightingEndpointSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def ip_address(self): + """ + **[Required]** Gets the ip_address of this SightingEndpointSummary. + IP Address + + + :return: The ip_address of this SightingEndpointSummary. + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """ + Sets the ip_address of this SightingEndpointSummary. + IP Address + + + :param ip_address: The ip_address of this SightingEndpointSummary. + :type: str + """ + self._ip_address = ip_address + + @property + def ip_address_type(self): + """ + **[Required]** Gets the ip_address_type of this SightingEndpointSummary. + IP Address type + + + :return: The ip_address_type of this SightingEndpointSummary. + :rtype: str + """ + return self._ip_address_type + + @ip_address_type.setter + def ip_address_type(self, ip_address_type): + """ + Sets the ip_address_type of this SightingEndpointSummary. + IP Address type + + + :param ip_address_type: The ip_address_type of this SightingEndpointSummary. + :type: str + """ + self._ip_address_type = ip_address_type + + @property + def ip_classification_type(self): + """ + Gets the ip_classification_type of this SightingEndpointSummary. + IP Address classification type + + + :return: The ip_classification_type of this SightingEndpointSummary. + :rtype: str + """ + return self._ip_classification_type + + @ip_classification_type.setter + def ip_classification_type(self, ip_classification_type): + """ + Sets the ip_classification_type of this SightingEndpointSummary. + IP Address classification type + + + :param ip_classification_type: The ip_classification_type of this SightingEndpointSummary. + :type: str + """ + self._ip_classification_type = ip_classification_type + + @property + def country(self): + """ + Gets the country of this SightingEndpointSummary. + Country + + + :return: The country of this SightingEndpointSummary. + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """ + Sets the country of this SightingEndpointSummary. + Country + + + :param country: The country of this SightingEndpointSummary. + :type: str + """ + self._country = country + + @property + def latitude(self): + """ + Gets the latitude of this SightingEndpointSummary. + Latitude + + + :return: The latitude of this SightingEndpointSummary. + :rtype: float + """ + return self._latitude + + @latitude.setter + def latitude(self, latitude): + """ + Sets the latitude of this SightingEndpointSummary. + Latitude + + + :param latitude: The latitude of this SightingEndpointSummary. + :type: float + """ + self._latitude = latitude + + @property + def longitude(self): + """ + Gets the longitude of this SightingEndpointSummary. + Longitude + + + :return: The longitude of this SightingEndpointSummary. + :rtype: float + """ + return self._longitude + + @longitude.setter + def longitude(self, longitude): + """ + Sets the longitude of this SightingEndpointSummary. + Longitude + + + :param longitude: The longitude of this SightingEndpointSummary. + :type: float + """ + self._longitude = longitude + + @property + def asn_number(self): + """ + Gets the asn_number of this SightingEndpointSummary. + ASN number + + + :return: The asn_number of this SightingEndpointSummary. + :rtype: str + """ + return self._asn_number + + @asn_number.setter + def asn_number(self, asn_number): + """ + Sets the asn_number of this SightingEndpointSummary. + ASN number + + + :param asn_number: The asn_number of this SightingEndpointSummary. + :type: str + """ + self._asn_number = asn_number + + @property + def regions(self): + """ + Gets the regions of this SightingEndpointSummary. + Regions where activities were performed from this IP + + + :return: The regions of this SightingEndpointSummary. + :rtype: list[str] + """ + return self._regions + + @regions.setter + def regions(self, regions): + """ + Sets the regions of this SightingEndpointSummary. + Regions where activities were performed from this IP + + + :param regions: The regions of this SightingEndpointSummary. + :type: list[str] + """ + self._regions = regions + + @property + def services(self): + """ + Gets the services of this SightingEndpointSummary. + Services where activities were performed from this IP + + + :return: The services of this SightingEndpointSummary. + :rtype: list[str] + """ + return self._services + + @services.setter + def services(self, services): + """ + Sets the services of this SightingEndpointSummary. + Services where activities were performed from this IP + + + :param services: The services of this SightingEndpointSummary. + :type: list[str] + """ + self._services = services + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this SightingEndpointSummary. + Time when activities were created + + + :return: The time_last_detected of this SightingEndpointSummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this SightingEndpointSummary. + Time when activities were created + + + :param time_last_detected: The time_last_detected of this SightingEndpointSummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/sighting_impacted_resource_collection.py b/src/oci/cloud_guard/models/sighting_impacted_resource_collection.py new file mode 100644 index 0000000000..a0de8c0454 --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_impacted_resource_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingImpactedResourceCollection(object): + """ + Provides the summary of sighting impacted resource + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingImpactedResourceCollection 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 SightingImpactedResourceCollection. + :type items: list[oci.cloud_guard.models.SightingImpactedResourceSummary] + + """ + self.swagger_types = { + 'items': 'list[SightingImpactedResourceSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SightingImpactedResourceCollection. + List of SightingImpactedResourceSummary + + + :return: The items of this SightingImpactedResourceCollection. + :rtype: list[oci.cloud_guard.models.SightingImpactedResourceSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SightingImpactedResourceCollection. + List of SightingImpactedResourceSummary + + + :param items: The items of this SightingImpactedResourceCollection. + :type: list[oci.cloud_guard.models.SightingImpactedResourceSummary] + """ + 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/cloud_guard/models/sighting_impacted_resource_summary.py b/src/oci/cloud_guard/models/sighting_impacted_resource_summary.py new file mode 100644 index 0000000000..d0d22da8da --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_impacted_resource_summary.py @@ -0,0 +1,318 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingImpactedResourceSummary(object): + """ + Sighting Impacted Resource summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingImpactedResourceSummary 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 SightingImpactedResourceSummary. + :type id: str + + :param resource_id: + The value to assign to the resource_id property of this SightingImpactedResourceSummary. + :type resource_id: str + + :param sighting_id: + The value to assign to the sighting_id property of this SightingImpactedResourceSummary. + :type sighting_id: str + + :param problem_id: + The value to assign to the problem_id property of this SightingImpactedResourceSummary. + :type problem_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this SightingImpactedResourceSummary. + :type compartment_id: str + + :param resource_name: + The value to assign to the resource_name property of this SightingImpactedResourceSummary. + :type resource_name: str + + :param resource_type: + The value to assign to the resource_type property of this SightingImpactedResourceSummary. + :type resource_type: str + + :param region: + The value to assign to the region property of this SightingImpactedResourceSummary. + :type region: str + + :param time_identified: + The value to assign to the time_identified property of this SightingImpactedResourceSummary. + :type time_identified: datetime + + """ + self.swagger_types = { + 'id': 'str', + 'resource_id': 'str', + 'sighting_id': 'str', + 'problem_id': 'str', + 'compartment_id': 'str', + 'resource_name': 'str', + 'resource_type': 'str', + 'region': 'str', + 'time_identified': 'datetime' + } + + self.attribute_map = { + 'id': 'id', + 'resource_id': 'resourceId', + 'sighting_id': 'sightingId', + 'problem_id': 'problemId', + 'compartment_id': 'compartmentId', + 'resource_name': 'resourceName', + 'resource_type': 'resourceType', + 'region': 'region', + 'time_identified': 'timeIdentified' + } + + self._id = None + self._resource_id = None + self._sighting_id = None + self._problem_id = None + self._compartment_id = None + self._resource_name = None + self._resource_type = None + self._region = None + self._time_identified = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SightingImpactedResourceSummary. + Unique identifier for impacted resource + + + :return: The id of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SightingImpactedResourceSummary. + Unique identifier for impacted resource + + + :param id: The id of this SightingImpactedResourceSummary. + :type: str + """ + self._id = id + + @property + def resource_id(self): + """ + **[Required]** Gets the resource_id of this SightingImpactedResourceSummary. + Impacted resource Id + + + :return: The resource_id of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._resource_id + + @resource_id.setter + def resource_id(self, resource_id): + """ + Sets the resource_id of this SightingImpactedResourceSummary. + Impacted resource Id + + + :param resource_id: The resource_id of this SightingImpactedResourceSummary. + :type: str + """ + self._resource_id = resource_id + + @property + def sighting_id(self): + """ + **[Required]** Gets the sighting_id of this SightingImpactedResourceSummary. + Sighting Id + + + :return: The sighting_id of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._sighting_id + + @sighting_id.setter + def sighting_id(self, sighting_id): + """ + Sets the sighting_id of this SightingImpactedResourceSummary. + Sighting Id + + + :param sighting_id: The sighting_id of this SightingImpactedResourceSummary. + :type: str + """ + self._sighting_id = sighting_id + + @property + def problem_id(self): + """ + Gets the problem_id of this SightingImpactedResourceSummary. + Problem Id for impacted resource + + + :return: The problem_id of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this SightingImpactedResourceSummary. + Problem Id for impacted resource + + + :param problem_id: The problem_id of this SightingImpactedResourceSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this SightingImpactedResourceSummary. + Compartment Id for impacted resource + + + :return: The compartment_id of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this SightingImpactedResourceSummary. + Compartment Id for impacted resource + + + :param compartment_id: The compartment_id of this SightingImpactedResourceSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this SightingImpactedResourceSummary. + Resource name + + + :return: The resource_name of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this SightingImpactedResourceSummary. + Resource name + + + :param resource_name: The resource_name of this SightingImpactedResourceSummary. + :type: str + """ + self._resource_name = resource_name + + @property + def resource_type(self): + """ + **[Required]** Gets the resource_type of this SightingImpactedResourceSummary. + Resource type + + + :return: The resource_type of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._resource_type + + @resource_type.setter + def resource_type(self, resource_type): + """ + Sets the resource_type of this SightingImpactedResourceSummary. + Resource type + + + :param resource_type: The resource_type of this SightingImpactedResourceSummary. + :type: str + """ + self._resource_type = resource_type + + @property + def region(self): + """ + **[Required]** Gets the region of this SightingImpactedResourceSummary. + Region for impacted resource + + + :return: The region of this SightingImpactedResourceSummary. + :rtype: str + """ + return self._region + + @region.setter + def region(self, region): + """ + Sets the region of this SightingImpactedResourceSummary. + Region for impacted resource + + + :param region: The region of this SightingImpactedResourceSummary. + :type: str + """ + self._region = region + + @property + def time_identified(self): + """ + **[Required]** Gets the time_identified of this SightingImpactedResourceSummary. + Time when the impacted resource is identified for given sighting. + + + :return: The time_identified of this SightingImpactedResourceSummary. + :rtype: datetime + """ + return self._time_identified + + @time_identified.setter + def time_identified(self, time_identified): + """ + Sets the time_identified of this SightingImpactedResourceSummary. + Time when the impacted resource is identified for given sighting. + + + :param time_identified: The time_identified of this SightingImpactedResourceSummary. + :type: datetime + """ + self._time_identified = time_identified + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/sighting_summary.py b/src/oci/cloud_guard/models/sighting_summary.py new file mode 100644 index 0000000000..d4296aea91 --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_summary.py @@ -0,0 +1,681 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingSummary(object): + """ + Sighting summary Definition. + """ + + #: A constant which can be used with the classification_status property of a SightingSummary. + #: This constant has a value of "FALSE_POSITIVE" + CLASSIFICATION_STATUS_FALSE_POSITIVE = "FALSE_POSITIVE" + + #: A constant which can be used with the classification_status property of a SightingSummary. + #: This constant has a value of "FALSE_NEGATIVE" + CLASSIFICATION_STATUS_FALSE_NEGATIVE = "FALSE_NEGATIVE" + + #: A constant which can be used with the classification_status property of a SightingSummary. + #: This constant has a value of "TRUE_POSITIVE" + CLASSIFICATION_STATUS_TRUE_POSITIVE = "TRUE_POSITIVE" + + #: A constant which can be used with the classification_status property of a SightingSummary. + #: This constant has a value of "TRUE_NEGATIVE" + CLASSIFICATION_STATUS_TRUE_NEGATIVE = "TRUE_NEGATIVE" + + #: A constant which can be used with the classification_status property of a SightingSummary. + #: This constant has a value of "NOT_CLASSIFIED" + CLASSIFICATION_STATUS_NOT_CLASSIFIED = "NOT_CLASSIFIED" + + #: A constant which can be used with the severity property of a SightingSummary. + #: This constant has a value of "CRITICAL" + SEVERITY_CRITICAL = "CRITICAL" + + #: A constant which can be used with the severity property of a SightingSummary. + #: This constant has a value of "HIGH" + SEVERITY_HIGH = "HIGH" + + #: A constant which can be used with the severity property of a SightingSummary. + #: This constant has a value of "MEDIUM" + SEVERITY_MEDIUM = "MEDIUM" + + #: A constant which can be used with the severity property of a SightingSummary. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + + #: A constant which can be used with the severity property of a SightingSummary. + #: This constant has a value of "MINOR" + SEVERITY_MINOR = "MINOR" + + #: A constant which can be used with the confidence property of a SightingSummary. + #: This constant has a value of "CRITICAL" + CONFIDENCE_CRITICAL = "CRITICAL" + + #: A constant which can be used with the confidence property of a SightingSummary. + #: This constant has a value of "HIGH" + CONFIDENCE_HIGH = "HIGH" + + #: A constant which can be used with the confidence property of a SightingSummary. + #: This constant has a value of "MEDIUM" + CONFIDENCE_MEDIUM = "MEDIUM" + + #: A constant which can be used with the confidence property of a SightingSummary. + #: This constant has a value of "LOW" + CONFIDENCE_LOW = "LOW" + + #: A constant which can be used with the confidence property of a SightingSummary. + #: This constant has a value of "MINOR" + CONFIDENCE_MINOR = "MINOR" + + def __init__(self, **kwargs): + """ + Initializes a new SightingSummary 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 SightingSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this SightingSummary. + :type compartment_id: str + + :param problem_id: + The value to assign to the problem_id property of this SightingSummary. + :type problem_id: str + + :param actor_principal_id: + The value to assign to the actor_principal_id property of this SightingSummary. + :type actor_principal_id: str + + :param actor_principal_name: + The value to assign to the actor_principal_name property of this SightingSummary. + :type actor_principal_name: str + + :param actor_principal_type: + The value to assign to the actor_principal_type property of this SightingSummary. + :type actor_principal_type: str + + :param detector_rule_id: + The value to assign to the detector_rule_id property of this SightingSummary. + :type detector_rule_id: str + + :param classification_status: + The value to assign to the classification_status property of this SightingSummary. + Allowed values for this property are: "FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type classification_status: str + + :param sighting_type: + The value to assign to the sighting_type property of this SightingSummary. + :type sighting_type: str + + :param sighting_type_display_name: + The value to assign to the sighting_type_display_name property of this SightingSummary. + :type sighting_type_display_name: str + + :param tactic_name: + The value to assign to the tactic_name property of this SightingSummary. + :type tactic_name: str + + :param technique_name: + The value to assign to the technique_name property of this SightingSummary. + :type technique_name: str + + :param sighting_score: + The value to assign to the sighting_score property of this SightingSummary. + :type sighting_score: int + + :param severity: + The value to assign to the severity property of this SightingSummary. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type severity: str + + :param confidence: + The value to assign to the confidence property of this SightingSummary. + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type confidence: str + + :param time_first_detected: + The value to assign to the time_first_detected property of this SightingSummary. + :type time_first_detected: datetime + + :param time_last_detected: + The value to assign to the time_last_detected property of this SightingSummary. + :type time_last_detected: datetime + + :param regions: + The value to assign to the regions property of this SightingSummary. + :type regions: list[str] + + """ + self.swagger_types = { + 'id': 'str', + 'compartment_id': 'str', + 'problem_id': 'str', + 'actor_principal_id': 'str', + 'actor_principal_name': 'str', + 'actor_principal_type': 'str', + 'detector_rule_id': 'str', + 'classification_status': 'str', + 'sighting_type': 'str', + 'sighting_type_display_name': 'str', + 'tactic_name': 'str', + 'technique_name': 'str', + 'sighting_score': 'int', + 'severity': 'str', + 'confidence': 'str', + 'time_first_detected': 'datetime', + 'time_last_detected': 'datetime', + 'regions': 'list[str]' + } + + self.attribute_map = { + 'id': 'id', + 'compartment_id': 'compartmentId', + 'problem_id': 'problemId', + 'actor_principal_id': 'actorPrincipalId', + 'actor_principal_name': 'actorPrincipalName', + 'actor_principal_type': 'actorPrincipalType', + 'detector_rule_id': 'detectorRuleId', + 'classification_status': 'classificationStatus', + 'sighting_type': 'sightingType', + 'sighting_type_display_name': 'sightingTypeDisplayName', + 'tactic_name': 'tacticName', + 'technique_name': 'techniqueName', + 'sighting_score': 'sightingScore', + 'severity': 'severity', + 'confidence': 'confidence', + 'time_first_detected': 'timeFirstDetected', + 'time_last_detected': 'timeLastDetected', + 'regions': 'regions' + } + + self._id = None + self._compartment_id = None + self._problem_id = None + self._actor_principal_id = None + self._actor_principal_name = None + self._actor_principal_type = None + self._detector_rule_id = None + self._classification_status = None + self._sighting_type = None + self._sighting_type_display_name = None + self._tactic_name = None + self._technique_name = None + self._sighting_score = None + self._severity = None + self._confidence = None + self._time_first_detected = None + self._time_last_detected = None + self._regions = None + + @property + def id(self): + """ + **[Required]** Gets the id of this SightingSummary. + Unique identifier for finding event + + + :return: The id of this SightingSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SightingSummary. + Unique identifier for finding event + + + :param id: The id of this SightingSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this SightingSummary. + Compartment Id where the resource is created + + + :return: The compartment_id of this SightingSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this SightingSummary. + Compartment Id where the resource is created + + + :param compartment_id: The compartment_id of this SightingSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def problem_id(self): + """ + Gets the problem_id of this SightingSummary. + Problem Id to which the Sighting is associated + + + :return: The problem_id of this SightingSummary. + :rtype: str + """ + return self._problem_id + + @problem_id.setter + def problem_id(self, problem_id): + """ + Sets the problem_id of this SightingSummary. + Problem Id to which the Sighting is associated + + + :param problem_id: The problem_id of this SightingSummary. + :type: str + """ + self._problem_id = problem_id + + @property + def actor_principal_id(self): + """ + Gets the actor_principal_id of this SightingSummary. + Unique identifier for principal actor + + + :return: The actor_principal_id of this SightingSummary. + :rtype: str + """ + return self._actor_principal_id + + @actor_principal_id.setter + def actor_principal_id(self, actor_principal_id): + """ + Sets the actor_principal_id of this SightingSummary. + Unique identifier for principal actor + + + :param actor_principal_id: The actor_principal_id of this SightingSummary. + :type: str + """ + self._actor_principal_id = actor_principal_id + + @property + def actor_principal_name(self): + """ + Gets the actor_principal_name of this SightingSummary. + Name of the principal actor + + + :return: The actor_principal_name of this SightingSummary. + :rtype: str + """ + return self._actor_principal_name + + @actor_principal_name.setter + def actor_principal_name(self, actor_principal_name): + """ + Sets the actor_principal_name of this SightingSummary. + Name of the principal actor + + + :param actor_principal_name: The actor_principal_name of this SightingSummary. + :type: str + """ + self._actor_principal_name = actor_principal_name + + @property + def actor_principal_type(self): + """ + Gets the actor_principal_type of this SightingSummary. + Type of the principal actor + + + :return: The actor_principal_type of this SightingSummary. + :rtype: str + """ + return self._actor_principal_type + + @actor_principal_type.setter + def actor_principal_type(self, actor_principal_type): + """ + Sets the actor_principal_type of this SightingSummary. + Type of the principal actor + + + :param actor_principal_type: The actor_principal_type of this SightingSummary. + :type: str + """ + self._actor_principal_type = actor_principal_type + + @property + def detector_rule_id(self): + """ + **[Required]** Gets the detector_rule_id of this SightingSummary. + Unique identifier of the rule + + + :return: The detector_rule_id of this SightingSummary. + :rtype: str + """ + return self._detector_rule_id + + @detector_rule_id.setter + def detector_rule_id(self, detector_rule_id): + """ + Sets the detector_rule_id of this SightingSummary. + Unique identifier of the rule + + + :param detector_rule_id: The detector_rule_id of this SightingSummary. + :type: str + """ + self._detector_rule_id = detector_rule_id + + @property + def classification_status(self): + """ + **[Required]** Gets the classification_status of this SightingSummary. + ClassificationStatus of the sighting event + + Allowed values for this property are: "FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The classification_status of this SightingSummary. + :rtype: str + """ + return self._classification_status + + @classification_status.setter + def classification_status(self, classification_status): + """ + Sets the classification_status of this SightingSummary. + ClassificationStatus of the sighting event + + + :param classification_status: The classification_status of this SightingSummary. + :type: str + """ + allowed_values = ["FALSE_POSITIVE", "FALSE_NEGATIVE", "TRUE_POSITIVE", "TRUE_NEGATIVE", "NOT_CLASSIFIED"] + if not value_allowed_none_or_none_sentinel(classification_status, allowed_values): + classification_status = 'UNKNOWN_ENUM_VALUE' + self._classification_status = classification_status + + @property + def sighting_type(self): + """ + **[Required]** Gets the sighting_type of this SightingSummary. + Identifier for the sighting type + + + :return: The sighting_type of this SightingSummary. + :rtype: str + """ + return self._sighting_type + + @sighting_type.setter + def sighting_type(self, sighting_type): + """ + Sets the sighting_type of this SightingSummary. + Identifier for the sighting type + + + :param sighting_type: The sighting_type of this SightingSummary. + :type: str + """ + self._sighting_type = sighting_type + + @property + def sighting_type_display_name(self): + """ + **[Required]** Gets the sighting_type_display_name of this SightingSummary. + Name of the sighting type + + + :return: The sighting_type_display_name of this SightingSummary. + :rtype: str + """ + return self._sighting_type_display_name + + @sighting_type_display_name.setter + def sighting_type_display_name(self, sighting_type_display_name): + """ + Sets the sighting_type_display_name of this SightingSummary. + Name of the sighting type + + + :param sighting_type_display_name: The sighting_type_display_name of this SightingSummary. + :type: str + """ + self._sighting_type_display_name = sighting_type_display_name + + @property + def tactic_name(self): + """ + **[Required]** Gets the tactic_name of this SightingSummary. + Name of the Mitre att&ck tactic + + + :return: The tactic_name of this SightingSummary. + :rtype: str + """ + return self._tactic_name + + @tactic_name.setter + def tactic_name(self, tactic_name): + """ + Sets the tactic_name of this SightingSummary. + Name of the Mitre att&ck tactic + + + :param tactic_name: The tactic_name of this SightingSummary. + :type: str + """ + self._tactic_name = tactic_name + + @property + def technique_name(self): + """ + **[Required]** Gets the technique_name of this SightingSummary. + Name of the Mitre att&ck technique + + + :return: The technique_name of this SightingSummary. + :rtype: str + """ + return self._technique_name + + @technique_name.setter + def technique_name(self, technique_name): + """ + Sets the technique_name of this SightingSummary. + Name of the Mitre att&ck technique + + + :param technique_name: The technique_name of this SightingSummary. + :type: str + """ + self._technique_name = technique_name + + @property + def sighting_score(self): + """ + **[Required]** Gets the sighting_score of this SightingSummary. + Score for the sighting + + + :return: The sighting_score of this SightingSummary. + :rtype: int + """ + return self._sighting_score + + @sighting_score.setter + def sighting_score(self, sighting_score): + """ + Sets the sighting_score of this SightingSummary. + Score for the sighting + + + :param sighting_score: The sighting_score of this SightingSummary. + :type: int + """ + self._sighting_score = sighting_score + + @property + def severity(self): + """ + **[Required]** Gets the severity of this SightingSummary. + Severity of the sighting + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The severity of this SightingSummary. + :rtype: str + """ + return self._severity + + @severity.setter + def severity(self, severity): + """ + Sets the severity of this SightingSummary. + Severity of the sighting + + + :param severity: The severity of this SightingSummary. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(severity, allowed_values): + severity = 'UNKNOWN_ENUM_VALUE' + self._severity = severity + + @property + def confidence(self): + """ + **[Required]** Gets the confidence of this SightingSummary. + Confidence of the sighting + + Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The confidence of this SightingSummary. + :rtype: str + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this SightingSummary. + Confidence of the sighting + + + :param confidence: The confidence of this SightingSummary. + :type: str + """ + allowed_values = ["CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR"] + if not value_allowed_none_or_none_sentinel(confidence, allowed_values): + confidence = 'UNKNOWN_ENUM_VALUE' + self._confidence = confidence + + @property + def time_first_detected(self): + """ + **[Required]** Gets the time_first_detected of this SightingSummary. + The date and time the sighting was first detected. Format defined by RFC3339. + + + :return: The time_first_detected of this SightingSummary. + :rtype: datetime + """ + return self._time_first_detected + + @time_first_detected.setter + def time_first_detected(self, time_first_detected): + """ + Sets the time_first_detected of this SightingSummary. + The date and time the sighting was first detected. Format defined by RFC3339. + + + :param time_first_detected: The time_first_detected of this SightingSummary. + :type: datetime + """ + self._time_first_detected = time_first_detected + + @property + def time_last_detected(self): + """ + **[Required]** Gets the time_last_detected of this SightingSummary. + The date and time the sighting was last detected. Format defined by RFC3339. + + + :return: The time_last_detected of this SightingSummary. + :rtype: datetime + """ + return self._time_last_detected + + @time_last_detected.setter + def time_last_detected(self, time_last_detected): + """ + Sets the time_last_detected of this SightingSummary. + The date and time the sighting was last detected. Format defined by RFC3339. + + + :param time_last_detected: The time_last_detected of this SightingSummary. + :type: datetime + """ + self._time_last_detected = time_last_detected + + @property + def regions(self): + """ + **[Required]** Gets the regions of this SightingSummary. + Regions involved in the sighting + + + :return: The regions of this SightingSummary. + :rtype: list[str] + """ + return self._regions + + @regions.setter + def regions(self, regions): + """ + Sets the regions of this SightingSummary. + Regions involved in the sighting + + + :param regions: The regions of this SightingSummary. + :type: list[str] + """ + self._regions = regions + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/sighting_type.py b/src/oci/cloud_guard/models/sighting_type.py new file mode 100644 index 0000000000..29f0ea1f49 --- /dev/null +++ b/src/oci/cloud_guard/models/sighting_type.py @@ -0,0 +1,225 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SightingType(object): + """ + Specific behavior that can trigger a Sighting + """ + + def __init__(self, **kwargs): + """ + Initializes a new SightingType 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 SightingType. + :type id: str + + :param display_name: + The value to assign to the display_name property of this SightingType. + :type display_name: str + + :param description: + The value to assign to the description property of this SightingType. + :type description: str + + :param mitre_link: + The value to assign to the mitre_link property of this SightingType. + :type mitre_link: str + + :param tactic: + The value to assign to the tactic property of this SightingType. + :type tactic: str + + :param techniques: + The value to assign to the techniques property of this SightingType. + :type techniques: list[str] + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str', + 'description': 'str', + 'mitre_link': 'str', + 'tactic': 'str', + 'techniques': 'list[str]' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName', + 'description': 'description', + 'mitre_link': 'mitreLink', + 'tactic': 'tactic', + 'techniques': 'techniques' + } + + self._id = None + self._display_name = None + self._description = None + self._mitre_link = None + self._tactic = None + self._techniques = None + + @property + def id(self): + """ + Gets the id of this SightingType. + The unique identifier of sighting type + + + :return: The id of this SightingType. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SightingType. + The unique identifier of sighting type + + + :param id: The id of this SightingType. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + Gets the display_name of this SightingType. + Name of the sighting type + + + :return: The display_name of this SightingType. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this SightingType. + Name of the sighting type + + + :param display_name: The display_name of this SightingType. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this SightingType. + Description of the sighting type + + + :return: The description of this SightingType. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SightingType. + Description of the sighting type + + + :param description: The description of this SightingType. + :type: str + """ + self._description = description + + @property + def mitre_link(self): + """ + Gets the mitre_link of this SightingType. + Link of the sighting type + + + :return: The mitre_link of this SightingType. + :rtype: str + """ + return self._mitre_link + + @mitre_link.setter + def mitre_link(self, mitre_link): + """ + Sets the mitre_link of this SightingType. + Link of the sighting type + + + :param mitre_link: The mitre_link of this SightingType. + :type: str + """ + self._mitre_link = mitre_link + + @property + def tactic(self): + """ + Gets the tactic of this SightingType. + Mitre Att&ck tactic + + + :return: The tactic of this SightingType. + :rtype: str + """ + return self._tactic + + @tactic.setter + def tactic(self, tactic): + """ + Sets the tactic of this SightingType. + Mitre Att&ck tactic + + + :param tactic: The tactic of this SightingType. + :type: str + """ + self._tactic = tactic + + @property + def techniques(self): + """ + Gets the techniques of this SightingType. + List of Mitre Att&ck Techniques + + + :return: The techniques of this SightingType. + :rtype: list[str] + """ + return self._techniques + + @techniques.setter + def techniques(self, techniques): + """ + Sets the techniques of this SightingType. + List of Mitre Att&ck Techniques + + + :param techniques: The techniques of this SightingType. + :type: list[str] + """ + self._techniques = techniques + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_guard/models/tactic_collection.py b/src/oci/cloud_guard/models/tactic_collection.py new file mode 100644 index 0000000000..8bb0e0f174 --- /dev/null +++ b/src/oci/cloud_guard/models/tactic_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TacticCollection(object): + """ + Collection of tactic summaries in Cloud Guard + """ + + def __init__(self, **kwargs): + """ + Initializes a new TacticCollection 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 TacticCollection. + :type items: list[oci.cloud_guard.models.TacticSummary] + + """ + self.swagger_types = { + 'items': 'list[TacticSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TacticCollection. + List of tactic summary. + + + :return: The items of this TacticCollection. + :rtype: list[oci.cloud_guard.models.TacticSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TacticCollection. + List of tactic summary. + + + :param items: The items of this TacticCollection. + :type: list[oci.cloud_guard.models.TacticSummary] + """ + 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/cloud_guard/models/tactic_summary.py b/src/oci/cloud_guard/models/tactic_summary.py new file mode 100644 index 0000000000..60c6dc0e1d --- /dev/null +++ b/src/oci/cloud_guard/models/tactic_summary.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TacticSummary(object): + """ + Tactic summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TacticSummary 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 TacticSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TacticSummary. + :type display_name: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName' + } + + self._id = None + self._display_name = None + + @property + def id(self): + """ + **[Required]** Gets the id of this TacticSummary. + Unique identifier for the tactic. + + + :return: The id of this TacticSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TacticSummary. + Unique identifier for the tactic. + + + :param id: The id of this TacticSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this TacticSummary. + Display name of the tactic + + + :return: The display_name of this TacticSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TacticSummary. + Display name of the tactic + + + :param display_name: The display_name of this TacticSummary. + :type: str + """ + self._display_name = display_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/cloud_guard/models/target.py b/src/oci/cloud_guard/models/target.py index 2efafbceaa..0b8614dccb 100644 --- a/src/oci/cloud_guard/models/target.py +++ b/src/oci/cloud_guard/models/target.py @@ -193,7 +193,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this Target. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :return: The id of this Target. @@ -205,7 +205,7 @@ def id(self): def id(self, id): """ Sets the id of this Target. - Unique identifier that is immutable on creation + Unique identifier that is immutable on creation. :param id: The id of this Target. @@ -217,7 +217,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this Target. - Target Identifier, can be renamed + Target display name, can be renamed. :return: The display_name of this Target. @@ -229,7 +229,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Target. - Target Identifier, can be renamed + Target display name, can be renamed. :param display_name: The display_name of this Target. @@ -544,6 +544,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this Target. :rtype: dict(str, str) @@ -557,6 +559,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this Target. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/target_detector_details.py b/src/oci/cloud_guard/models/target_detector_details.py index 872f2ad365..dc59293af2 100644 --- a/src/oci/cloud_guard/models/target_detector_details.py +++ b/src/oci/cloud_guard/models/target_detector_details.py @@ -64,6 +64,18 @@ def __init__(self, **kwargs): The value to assign to the is_configuration_allowed property of this TargetDetectorDetails. :type is_configuration_allowed: bool + :param problem_threshold: + The value to assign to the problem_threshold property of this TargetDetectorDetails. + :type problem_threshold: int + + :param target_types: + The value to assign to the target_types property of this TargetDetectorDetails. + :type target_types: list[str] + + :param sighting_types: + The value to assign to the sighting_types property of this TargetDetectorDetails. + :type sighting_types: list[oci.cloud_guard.models.SightingType] + """ self.swagger_types = { 'is_enabled': 'bool', @@ -71,7 +83,10 @@ def __init__(self, **kwargs): 'configurations': 'list[DetectorConfiguration]', 'condition_groups': 'list[ConditionGroup]', 'labels': 'list[str]', - 'is_configuration_allowed': 'bool' + 'is_configuration_allowed': 'bool', + 'problem_threshold': 'int', + 'target_types': 'list[str]', + 'sighting_types': 'list[SightingType]' } self.attribute_map = { @@ -80,7 +95,10 @@ def __init__(self, **kwargs): 'configurations': 'configurations', 'condition_groups': 'conditionGroups', 'labels': 'labels', - 'is_configuration_allowed': 'isConfigurationAllowed' + 'is_configuration_allowed': 'isConfigurationAllowed', + 'problem_threshold': 'problemThreshold', + 'target_types': 'targetTypes', + 'sighting_types': 'sightingTypes' } self._is_enabled = None @@ -89,6 +107,9 @@ def __init__(self, **kwargs): self._condition_groups = None self._labels = None self._is_configuration_allowed = None + self._problem_threshold = None + self._target_types = None + self._sighting_types = None @property def is_enabled(self): @@ -117,7 +138,7 @@ def is_enabled(self, is_enabled): @property def risk_level(self): """ - **[Required]** Gets the risk_level of this TargetDetectorDetails. + Gets the risk_level of this TargetDetectorDetails. The Risk Level Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR", 'UNKNOWN_ENUM_VALUE'. @@ -240,6 +261,78 @@ def is_configuration_allowed(self, is_configuration_allowed): """ self._is_configuration_allowed = is_configuration_allowed + @property + def problem_threshold(self): + """ + Gets the problem_threshold of this TargetDetectorDetails. + Cutover point for an elevated resource Risk Score to create a Problem + + + :return: The problem_threshold of this TargetDetectorDetails. + :rtype: int + """ + return self._problem_threshold + + @problem_threshold.setter + def problem_threshold(self, problem_threshold): + """ + Sets the problem_threshold of this TargetDetectorDetails. + Cutover point for an elevated resource Risk Score to create a Problem + + + :param problem_threshold: The problem_threshold of this TargetDetectorDetails. + :type: int + """ + self._problem_threshold = problem_threshold + + @property + def target_types(self): + """ + Gets the target_types of this TargetDetectorDetails. + List of target types for which the detector rule is applicable + + + :return: The target_types of this TargetDetectorDetails. + :rtype: list[str] + """ + return self._target_types + + @target_types.setter + def target_types(self, target_types): + """ + Sets the target_types of this TargetDetectorDetails. + List of target types for which the detector rule is applicable + + + :param target_types: The target_types of this TargetDetectorDetails. + :type: list[str] + """ + self._target_types = target_types + + @property + def sighting_types(self): + """ + Gets the sighting_types of this TargetDetectorDetails. + List of sighting types + + + :return: The sighting_types of this TargetDetectorDetails. + :rtype: list[oci.cloud_guard.models.SightingType] + """ + return self._sighting_types + + @sighting_types.setter + def sighting_types(self, sighting_types): + """ + Sets the sighting_types of this TargetDetectorDetails. + List of sighting types + + + :param sighting_types: The sighting_types of this TargetDetectorDetails. + :type: list[oci.cloud_guard.models.SightingType] + """ + self._sighting_types = sighting_types + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cloud_guard/models/target_detector_recipe.py b/src/oci/cloud_guard/models/target_detector_recipe.py index 0652844079..86e5db2cbe 100644 --- a/src/oci/cloud_guard/models/target_detector_recipe.py +++ b/src/oci/cloud_guard/models/target_detector_recipe.py @@ -29,6 +29,10 @@ class TargetDetectorRecipe(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a TargetDetectorRecipe. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -90,7 +94,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this TargetDetectorRecipe. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -116,6 +120,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param source_data_retention: + The value to assign to the source_data_retention property of this TargetDetectorRecipe. + :type source_data_retention: int + """ self.swagger_types = { 'id': 'str', @@ -129,7 +137,8 @@ def __init__(self, **kwargs): 'effective_detector_rules': 'list[TargetDetectorRecipeDetectorRule]', 'time_created': 'datetime', 'time_updated': 'datetime', - 'lifecycle_state': 'str' + 'lifecycle_state': 'str', + 'source_data_retention': 'int' } self.attribute_map = { @@ -144,7 +153,8 @@ def __init__(self, **kwargs): 'effective_detector_rules': 'effectiveDetectorRules', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', - 'lifecycle_state': 'lifecycleState' + 'lifecycle_state': 'lifecycleState', + 'source_data_retention': 'sourceDataRetention' } self._id = None @@ -159,6 +169,7 @@ def __init__(self, **kwargs): self._time_created = None self._time_updated = None self._lifecycle_state = None + self._source_data_retention = None @property def id(self): @@ -188,7 +199,7 @@ def id(self, id): def display_name(self): """ **[Required]** Gets the display_name of this TargetDetectorRecipe. - DisplayName of detector recipe + Display name of detector recipe. :return: The display_name of this TargetDetectorRecipe. @@ -200,7 +211,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TargetDetectorRecipe. - DisplayName of detector recipe + Display name of detector recipe. :param display_name: The display_name of this TargetDetectorRecipe. @@ -212,7 +223,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this TargetDetectorRecipe. - Detector recipe description + Detector recipe description. :return: The description of this TargetDetectorRecipe. @@ -224,7 +235,7 @@ def description(self): def description(self, description): """ Sets the description of this TargetDetectorRecipe. - Detector recipe description + Detector recipe description. :param description: The description of this TargetDetectorRecipe. @@ -316,7 +327,7 @@ def detector(self): **[Required]** Gets the detector of this TargetDetectorRecipe. Type of detector - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -335,7 +346,7 @@ def detector(self, detector): :param detector: The detector of this TargetDetectorRecipe. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector @@ -466,6 +477,30 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def source_data_retention(self): + """ + Gets the source_data_retention of this TargetDetectorRecipe. + The number of days for which source data is retained + + + :return: The source_data_retention of this TargetDetectorRecipe. + :rtype: int + """ + return self._source_data_retention + + @source_data_retention.setter + def source_data_retention(self, source_data_retention): + """ + Sets the source_data_retention of this TargetDetectorRecipe. + The number of days for which source data is retained + + + :param source_data_retention: The source_data_retention of this TargetDetectorRecipe. + :type: int + """ + self._source_data_retention = source_data_retention + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cloud_guard/models/target_detector_recipe_detector_rule.py b/src/oci/cloud_guard/models/target_detector_recipe_detector_rule.py index c8816e6862..9637ed840b 100644 --- a/src/oci/cloud_guard/models/target_detector_recipe_detector_rule.py +++ b/src/oci/cloud_guard/models/target_detector_recipe_detector_rule.py @@ -21,6 +21,10 @@ class TargetDetectorRecipeDetectorRule(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a TargetDetectorRecipeDetectorRule. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a TargetDetectorRecipeDetectorRule. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this TargetDetectorRecipeDetectorRule. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -211,7 +215,7 @@ def __init__(self, **kwargs): def detector_rule_id(self): """ **[Required]** Gets the detector_rule_id of this TargetDetectorRecipeDetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :return: The detector_rule_id of this TargetDetectorRecipeDetectorRule. @@ -223,7 +227,7 @@ def detector_rule_id(self): def detector_rule_id(self, detector_rule_id): """ Sets the detector_rule_id of this TargetDetectorRecipeDetectorRule. - The unique identifier of the detector rule + The unique identifier of the detector rule. :param detector_rule_id: The detector_rule_id of this TargetDetectorRecipeDetectorRule. @@ -235,7 +239,7 @@ def detector_rule_id(self, detector_rule_id): def display_name(self): """ Gets the display_name of this TargetDetectorRecipeDetectorRule. - displayName + Display name for TargetDetectorRecipeDetectorRule. information. :return: The display_name of this TargetDetectorRecipeDetectorRule. @@ -247,7 +251,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TargetDetectorRecipeDetectorRule. - displayName + Display name for TargetDetectorRecipeDetectorRule. information. :param display_name: The display_name of this TargetDetectorRecipeDetectorRule. @@ -259,7 +263,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this TargetDetectorRecipeDetectorRule. - Description for TargetDetectorRecipeDetectorRule + Description for TargetDetectorRecipeDetectorRule. information. :return: The description of this TargetDetectorRecipeDetectorRule. @@ -271,7 +275,7 @@ def description(self): def description(self, description): """ Sets the description of this TargetDetectorRecipeDetectorRule. - Description for TargetDetectorRecipeDetectorRule + Description for TargetDetectorRecipeDetectorRule. information. :param description: The description of this TargetDetectorRecipeDetectorRule. @@ -309,7 +313,7 @@ def detector(self): **[Required]** Gets the detector of this TargetDetectorRecipeDetectorRule. detector for the rule - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -328,7 +332,7 @@ def detector(self, detector): :param detector: The detector of this TargetDetectorRecipeDetectorRule. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.py b/src/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.py index 89baf98328..ff0700c341 100644 --- a/src/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.py +++ b/src/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.py @@ -21,6 +21,10 @@ class TargetDetectorRecipeDetectorRuleSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a TargetDetectorRecipeDetectorRuleSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the managed_list_types property of a TargetDetectorRecipeDetectorRuleSummary. #: This constant has a value of "CIDR_BLOCK" MANAGED_LIST_TYPES_CIDR_BLOCK = "CIDR_BLOCK" @@ -120,7 +124,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this TargetDetectorRecipeDetectorRuleSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -309,7 +313,7 @@ def detector(self): **[Required]** Gets the detector of this TargetDetectorRecipeDetectorRuleSummary. possible type of detectors - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -328,7 +332,7 @@ def detector(self, detector): :param detector: The detector of this TargetDetectorRecipeDetectorRuleSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector diff --git a/src/oci/cloud_guard/models/target_detector_recipe_summary.py b/src/oci/cloud_guard/models/target_detector_recipe_summary.py index 56a284ac76..4e8e9f66ee 100644 --- a/src/oci/cloud_guard/models/target_detector_recipe_summary.py +++ b/src/oci/cloud_guard/models/target_detector_recipe_summary.py @@ -29,6 +29,10 @@ class TargetDetectorRecipeSummary(object): #: This constant has a value of "IAAS_CONFIGURATION_DETECTOR" DETECTOR_IAAS_CONFIGURATION_DETECTOR = "IAAS_CONFIGURATION_DETECTOR" + #: A constant which can be used with the detector property of a TargetDetectorRecipeSummary. + #: This constant has a value of "IAAS_THREAT_DETECTOR" + DETECTOR_IAAS_THREAT_DETECTOR = "IAAS_THREAT_DETECTOR" + #: A constant which can be used with the lifecycle_state property of a TargetDetectorRecipeSummary. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -90,7 +94,7 @@ def __init__(self, **kwargs): :param detector: The value to assign to the detector property of this TargetDetectorRecipeSummary. - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type detector: str @@ -112,6 +116,10 @@ def __init__(self, **kwargs): The value to assign to the lifecycle_details property of this TargetDetectorRecipeSummary. :type lifecycle_details: str + :param source_data_retention: + The value to assign to the source_data_retention property of this TargetDetectorRecipeSummary. + :type source_data_retention: int + """ self.swagger_types = { 'id': 'str', @@ -124,7 +132,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'str', 'time_created': 'datetime', 'time_updated': 'datetime', - 'lifecycle_details': 'str' + 'lifecycle_details': 'str', + 'source_data_retention': 'int' } self.attribute_map = { @@ -138,7 +147,8 @@ def __init__(self, **kwargs): 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', - 'lifecycle_details': 'lifecycleDetails' + 'lifecycle_details': 'lifecycleDetails', + 'source_data_retention': 'sourceDataRetention' } self._id = None @@ -152,6 +162,7 @@ def __init__(self, **kwargs): self._time_created = None self._time_updated = None self._lifecycle_details = None + self._source_data_retention = None @property def id(self): @@ -309,7 +320,7 @@ def detector(self): Gets the detector of this TargetDetectorRecipeSummary. Type of detector - Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -328,7 +339,7 @@ def detector(self, detector): :param detector: The detector of this TargetDetectorRecipeSummary. :type: str """ - allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR"] + allowed_values = ["IAAS_ACTIVITY_DETECTOR", "IAAS_CONFIGURATION_DETECTOR", "IAAS_THREAT_DETECTOR"] if not value_allowed_none_or_none_sentinel(detector, allowed_values): detector = 'UNKNOWN_ENUM_VALUE' self._detector = detector @@ -435,6 +446,30 @@ def lifecycle_details(self, lifecycle_details): """ self._lifecycle_details = lifecycle_details + @property + def source_data_retention(self): + """ + Gets the source_data_retention of this TargetDetectorRecipeSummary. + The number of days for which source data is retained + + + :return: The source_data_retention of this TargetDetectorRecipeSummary. + :rtype: int + """ + return self._source_data_retention + + @source_data_retention.setter + def source_data_retention(self, source_data_retention): + """ + Sets the source_data_retention of this TargetDetectorRecipeSummary. + The number of days for which source data is retained + + + :param source_data_retention: The source_data_retention of this TargetDetectorRecipeSummary. + :type: int + """ + self._source_data_retention = source_data_retention + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cloud_guard/models/target_responder_recipe.py b/src/oci/cloud_guard/models/target_responder_recipe.py index 8df0948f3c..b46cc4185b 100644 --- a/src/oci/cloud_guard/models/target_responder_recipe.py +++ b/src/oci/cloud_guard/models/target_responder_recipe.py @@ -110,7 +110,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this TargetResponderRecipe. - Unique identifier of TargetResponderRecipe that is immutable on creation + Unique identifier of TargetResponderRecipe that can't be changed after creation. :return: The id of this TargetResponderRecipe. @@ -122,7 +122,7 @@ def id(self): def id(self, id): """ Sets the id of this TargetResponderRecipe. - Unique identifier of TargetResponderRecipe that is immutable on creation + Unique identifier of TargetResponderRecipe that can't be changed after creation. :param id: The id of this TargetResponderRecipe. @@ -134,7 +134,7 @@ def id(self, id): def responder_recipe_id(self): """ **[Required]** Gets the responder_recipe_id of this TargetResponderRecipe. - Unique identifier for Responder Recipe of which this is an extension + Unique identifier for Responder Recipe of which this is an extension. :return: The responder_recipe_id of this TargetResponderRecipe. @@ -146,7 +146,7 @@ def responder_recipe_id(self): def responder_recipe_id(self, responder_recipe_id): """ Sets the responder_recipe_id of this TargetResponderRecipe. - Unique identifier for Responder Recipe of which this is an extension + Unique identifier for Responder Recipe of which this is an extension. :param responder_recipe_id: The responder_recipe_id of this TargetResponderRecipe. @@ -182,7 +182,7 @@ def compartment_id(self, compartment_id): def display_name(self): """ **[Required]** Gets the display_name of this TargetResponderRecipe. - ResponderRecipe Identifier Name + ResponderRecipe display name. :return: The display_name of this TargetResponderRecipe. @@ -194,7 +194,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TargetResponderRecipe. - ResponderRecipe Identifier Name + ResponderRecipe display name. :param display_name: The display_name of this TargetResponderRecipe. @@ -206,7 +206,7 @@ def display_name(self, display_name): def description(self): """ **[Required]** Gets the description of this TargetResponderRecipe. - ResponderRecipe Description + ResponderRecipe description. :return: The description of this TargetResponderRecipe. @@ -218,7 +218,7 @@ def description(self): def description(self, description): """ Sets the description of this TargetResponderRecipe. - ResponderRecipe Description + ResponderRecipe description. :param description: The description of this TargetResponderRecipe. diff --git a/src/oci/cloud_guard/models/target_responder_recipe_responder_rule.py b/src/oci/cloud_guard/models/target_responder_recipe_responder_rule.py index c8ca7471a7..de8b267464 100644 --- a/src/oci/cloud_guard/models/target_responder_recipe_responder_rule.py +++ b/src/oci/cloud_guard/models/target_responder_recipe_responder_rule.py @@ -164,7 +164,7 @@ def __init__(self, **kwargs): def responder_rule_id(self): """ **[Required]** Gets the responder_rule_id of this TargetResponderRecipeResponderRule. - Identifier for ResponderRule. + Unique ResponderRule identifier. :return: The responder_rule_id of this TargetResponderRecipeResponderRule. @@ -176,7 +176,7 @@ def responder_rule_id(self): def responder_rule_id(self, responder_rule_id): """ Sets the responder_rule_id of this TargetResponderRecipeResponderRule. - Identifier for ResponderRule. + Unique ResponderRule identifier. :param responder_rule_id: The responder_rule_id of this TargetResponderRecipeResponderRule. @@ -188,7 +188,7 @@ def responder_rule_id(self, responder_rule_id): def display_name(self): """ Gets the display_name of this TargetResponderRecipeResponderRule. - ResponderRule Display Name + ResponderRule display name. :return: The display_name of this TargetResponderRecipeResponderRule. @@ -200,7 +200,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this TargetResponderRecipeResponderRule. - ResponderRule Display Name + ResponderRule display name. :param display_name: The display_name of this TargetResponderRecipeResponderRule. @@ -212,7 +212,7 @@ def display_name(self, display_name): def description(self): """ Gets the description of this TargetResponderRecipeResponderRule. - ResponderRule Description + ResponderRule description. :return: The description of this TargetResponderRecipeResponderRule. @@ -224,7 +224,7 @@ def description(self): def description(self, description): """ Sets the description of this TargetResponderRecipeResponderRule. - ResponderRule Description + ResponderRule description. :param description: The description of this TargetResponderRecipeResponderRule. diff --git a/src/oci/cloud_guard/models/target_summary.py b/src/oci/cloud_guard/models/target_summary.py index 78a811aefd..cdeb6db952 100644 --- a/src/oci/cloud_guard/models/target_summary.py +++ b/src/oci/cloud_guard/models/target_summary.py @@ -420,6 +420,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this TargetSummary. :rtype: dict(str, str) @@ -433,6 +435,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this TargetSummary. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/technique_collection.py b/src/oci/cloud_guard/models/technique_collection.py new file mode 100644 index 0000000000..ecc7e375b8 --- /dev/null +++ b/src/oci/cloud_guard/models/technique_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TechniqueCollection(object): + """ + Collection of technique summaries in Cloud Guard + """ + + def __init__(self, **kwargs): + """ + Initializes a new TechniqueCollection 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 TechniqueCollection. + :type items: list[oci.cloud_guard.models.TechniqueSummary] + + """ + self.swagger_types = { + 'items': 'list[TechniqueSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TechniqueCollection. + List of technique summary. + + + :return: The items of this TechniqueCollection. + :rtype: list[oci.cloud_guard.models.TechniqueSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TechniqueCollection. + List of technique summary. + + + :param items: The items of this TechniqueCollection. + :type: list[oci.cloud_guard.models.TechniqueSummary] + """ + 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/cloud_guard/models/technique_summary.py b/src/oci/cloud_guard/models/technique_summary.py new file mode 100644 index 0000000000..b1407eaaa4 --- /dev/null +++ b/src/oci/cloud_guard/models/technique_summary.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TechniqueSummary(object): + """ + Technique summary. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TechniqueSummary 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 TechniqueSummary. + :type id: str + + :param display_name: + The value to assign to the display_name property of this TechniqueSummary. + :type display_name: str + + """ + self.swagger_types = { + 'id': 'str', + 'display_name': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'display_name': 'displayName' + } + + self._id = None + self._display_name = None + + @property + def id(self): + """ + **[Required]** Gets the id of this TechniqueSummary. + Unique identifier for the technique. + + + :return: The id of this TechniqueSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this TechniqueSummary. + Unique identifier for the technique. + + + :param id: The id of this TechniqueSummary. + :type: str + """ + self._id = id + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this TechniqueSummary. + Display name of the technique + + + :return: The display_name of this TechniqueSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this TechniqueSummary. + Display name of the technique + + + :param display_name: The display_name of this TechniqueSummary. + :type: str + """ + self._display_name = display_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/cloud_guard/models/update_data_mask_rule_details.py b/src/oci/cloud_guard/models/update_data_mask_rule_details.py index 9932423342..8bbb826927 100644 --- a/src/oci/cloud_guard/models/update_data_mask_rule_details.py +++ b/src/oci/cloud_guard/models/update_data_mask_rule_details.py @@ -120,7 +120,9 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateDataMaskRuleDetails. - Data Mask Rule Name + Data mask rule Name. + + Avoid entering confidential information. :return: The display_name of this UpdateDataMaskRuleDetails. @@ -132,7 +134,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateDataMaskRuleDetails. - Data Mask Rule Name + Data mask rule Name. + + Avoid entering confidential information. :param display_name: The display_name of this UpdateDataMaskRuleDetails. @@ -282,6 +286,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this UpdateDataMaskRuleDetails. :rtype: dict(str, str) @@ -295,6 +301,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this UpdateDataMaskRuleDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/update_detector_recipe_details.py b/src/oci/cloud_guard/models/update_detector_recipe_details.py index df14ecf2c9..8317c3e601 100644 --- a/src/oci/cloud_guard/models/update_detector_recipe_details.py +++ b/src/oci/cloud_guard/models/update_detector_recipe_details.py @@ -65,7 +65,9 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateDetectorRecipeDetails. - DisplayName of detector recipe + Display name of detector recipe. + + Avoid entering confidential information. :return: The display_name of this UpdateDetectorRecipeDetails. @@ -77,7 +79,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateDetectorRecipeDetails. - DisplayName of detector recipe + Display name of detector recipe. + + Avoid entering confidential information. :param display_name: The display_name of this UpdateDetectorRecipeDetails. @@ -89,7 +93,9 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateDetectorRecipeDetails. - Detector recipe description + Detector recipe description. + + Avoid entering confidential information. :return: The description of this UpdateDetectorRecipeDetails. @@ -101,7 +107,9 @@ def description(self): def description(self, description): """ Sets the description of this UpdateDetectorRecipeDetails. - Detector recipe description + Detector recipe description. + + Avoid entering confidential information. :param description: The description of this UpdateDetectorRecipeDetails. @@ -140,6 +148,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this UpdateDetectorRecipeDetails. :rtype: dict(str, str) @@ -153,6 +163,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this UpdateDetectorRecipeDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/update_detector_rule_details.py b/src/oci/cloud_guard/models/update_detector_rule_details.py index 3a65310da1..0dbf8a3ed2 100644 --- a/src/oci/cloud_guard/models/update_detector_rule_details.py +++ b/src/oci/cloud_guard/models/update_detector_rule_details.py @@ -109,7 +109,7 @@ def is_enabled(self, is_enabled): @property def risk_level(self): """ - **[Required]** Gets the risk_level of this UpdateDetectorRuleDetails. + Gets the risk_level of this UpdateDetectorRuleDetails. The Risk Level Allowed values for this property are: "CRITICAL", "HIGH", "MEDIUM", "LOW", "MINOR" diff --git a/src/oci/cloud_guard/models/update_managed_list_details.py b/src/oci/cloud_guard/models/update_managed_list_details.py index 275c418704..b5bbff2979 100644 --- a/src/oci/cloud_guard/models/update_managed_list_details.py +++ b/src/oci/cloud_guard/models/update_managed_list_details.py @@ -65,7 +65,9 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateManagedListDetails. - ManagedList display name + Managed list display name. + + Avoid entering confidential information. :return: The display_name of this UpdateManagedListDetails. @@ -77,7 +79,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateManagedListDetails. - ManagedList display name + Managed list display name. + + Avoid entering confidential information. :param display_name: The display_name of this UpdateManagedListDetails. @@ -89,7 +93,8 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateManagedListDetails. - ManagedList description + Managed list description. + Avoid entering confidential information. :return: The description of this UpdateManagedListDetails. @@ -101,7 +106,8 @@ def description(self): def description(self, description): """ Sets the description of this UpdateManagedListDetails. - ManagedList description + Managed list description. + Avoid entering confidential information. :param description: The description of this UpdateManagedListDetails. @@ -140,6 +146,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this UpdateManagedListDetails. :rtype: dict(str, str) @@ -153,6 +161,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this UpdateManagedListDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/update_responder_recipe_details.py b/src/oci/cloud_guard/models/update_responder_recipe_details.py index f2a4435e59..3b85268d15 100644 --- a/src/oci/cloud_guard/models/update_responder_recipe_details.py +++ b/src/oci/cloud_guard/models/update_responder_recipe_details.py @@ -65,7 +65,9 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this UpdateResponderRecipeDetails. - ResponderRecipe Identifier + Responder recipe identifier. + + Avoid entering confidential information. :return: The display_name of this UpdateResponderRecipeDetails. @@ -77,7 +79,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateResponderRecipeDetails. - ResponderRecipe Identifier + Responder recipe identifier. + + Avoid entering confidential information. :param display_name: The display_name of this UpdateResponderRecipeDetails. @@ -89,7 +93,9 @@ def display_name(self, display_name): def description(self): """ Gets the description of this UpdateResponderRecipeDetails. - ResponderRecipe Description + Responder recipe description. + + Avoid entering confidential information. :return: The description of this UpdateResponderRecipeDetails. @@ -101,7 +107,9 @@ def description(self): def description(self, description): """ Sets the description of this UpdateResponderRecipeDetails. - ResponderRecipe Description + Responder recipe description. + + Avoid entering confidential information. :param description: The description of this UpdateResponderRecipeDetails. @@ -140,6 +148,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this UpdateResponderRecipeDetails. :rtype: dict(str, str) @@ -153,6 +163,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this UpdateResponderRecipeDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/update_target_details.py b/src/oci/cloud_guard/models/update_target_details.py index 6e2f782fae..f3f93c214f 100644 --- a/src/oci/cloud_guard/models/update_target_details.py +++ b/src/oci/cloud_guard/models/update_target_details.py @@ -101,7 +101,9 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateTargetDetails. - DetectorTemplate Identifier + DetectorTemplate identifier. + + Avoid entering confidential information. :return: The display_name of this UpdateTargetDetails. @@ -113,7 +115,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateTargetDetails. - DetectorTemplate Identifier + DetectorTemplate identifier. + + Avoid entering confidential information. :param display_name: The display_name of this UpdateTargetDetails. @@ -208,6 +212,8 @@ def freeform_tags(self): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :return: The freeform_tags of this UpdateTargetDetails. :rtype: dict(str, str) @@ -221,6 +227,8 @@ def freeform_tags(self, freeform_tags): Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` + Avoid entering confidential information. + :param freeform_tags: The freeform_tags of this UpdateTargetDetails. :type: dict(str, str) diff --git a/src/oci/cloud_guard/models/update_target_detector_recipe_details.py b/src/oci/cloud_guard/models/update_target_detector_recipe_details.py index e9bbee92c8..a5ef7eb4f3 100644 --- a/src/oci/cloud_guard/models/update_target_detector_recipe_details.py +++ b/src/oci/cloud_guard/models/update_target_detector_recipe_details.py @@ -36,7 +36,7 @@ def __init__(self, **kwargs): @property def detector_rules(self): """ - **[Required]** Gets the detector_rules of this UpdateTargetDetectorRecipeDetails. + Gets the detector_rules of this UpdateTargetDetectorRecipeDetails. Update detector rules associated with detector recipe in a target. diff --git a/src/oci/core/compute_client.py b/src/oci/core/compute_client.py index 4f78bfbd65..9f10d9ee30 100644 --- a/src/oci/core/compute_client.py +++ b/src/oci/core/compute_client.py @@ -7744,6 +7744,9 @@ def terminate_instance(self, instance_id, **kwargs): To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`. + To preserve data volumes created with the instance, specify `true` for `PreserveDataVolumesQueryParam`. + To delete the data volumes when the instance itself is deleted, specify `false` or do not specify a value for `PreserveDataVolumesQueryParam`. + This is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily until the instance is completely removed. @@ -7762,6 +7765,10 @@ def terminate_instance(self, instance_id, **kwargs): Specifies whether to delete or preserve the boot volume when terminating an instance. When set to `true`, the boot volume is preserved. The default value is `false`. + :param bool preserve_data_volumes: (optional) + Specifies whether to delete or preserve the data volumes when terminating an instance. + When set to `true`, the boot volume is preserved. The default value is `false`. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -7788,7 +7795,8 @@ def terminate_instance(self, instance_id, **kwargs): "allow_control_chars", "retry_strategy", "if_match", - "preserve_boot_volume" + "preserve_boot_volume", + "preserve_data_volumes" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -7806,7 +7814,8 @@ def terminate_instance(self, instance_id, **kwargs): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) query_params = { - "preserveBootVolume": kwargs.get("preserve_boot_volume", missing) + "preserveBootVolume": kwargs.get("preserve_boot_volume", missing), + "preserveDataVolumes": kwargs.get("preserve_data_volumes", 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/core/models/__init__.py b/src/oci/core/models/__init__.py index d9f89510f8..5bca16d20a 100644 --- a/src/oci/core/models/__init__.py +++ b/src/oci/core/models/__init__.py @@ -354,6 +354,7 @@ from .service_id_request_details import ServiceIdRequestDetails from .service_id_response_details import ServiceIdResponseDetails from .shape import Shape +from .shape_alternative_object import ShapeAlternativeObject from .shape_max_vnic_attachment_options import ShapeMaxVnicAttachmentOptions from .shape_measured_boot_options import ShapeMeasuredBootOptions from .shape_memory_options import ShapeMemoryOptions @@ -837,6 +838,7 @@ "ServiceIdRequestDetails": ServiceIdRequestDetails, "ServiceIdResponseDetails": ServiceIdResponseDetails, "Shape": Shape, + "ShapeAlternativeObject": ShapeAlternativeObject, "ShapeMaxVnicAttachmentOptions": ShapeMaxVnicAttachmentOptions, "ShapeMeasuredBootOptions": ShapeMeasuredBootOptions, "ShapeMemoryOptions": ShapeMemoryOptions, diff --git a/src/oci/core/models/add_drg_route_distribution_statement_details.py b/src/oci/core/models/add_drg_route_distribution_statement_details.py index 496010e6e1..cf7d756a6b 100644 --- a/src/oci/core/models/add_drg_route_distribution_statement_details.py +++ b/src/oci/core/models/add_drg_route_distribution_statement_details.py @@ -57,7 +57,6 @@ def match_criteria(self): """ **[Required]** Gets the match_criteria of this AddDrgRouteDistributionStatementDetails. The action is applied only if all of the match criteria is met. - If there are no match criteria in a statement, match ALL is implied. :return: The match_criteria of this AddDrgRouteDistributionStatementDetails. @@ -70,7 +69,6 @@ def match_criteria(self, match_criteria): """ Sets the match_criteria of this AddDrgRouteDistributionStatementDetails. The action is applied only if all of the match criteria is met. - If there are no match criteria in a statement, match ALL is implied. :param match_criteria: The match_criteria of this AddDrgRouteDistributionStatementDetails. diff --git a/src/oci/core/models/add_vcn_cidr_details.py b/src/oci/core/models/add_vcn_cidr_details.py index 3e412c5ed2..ce44756395 100644 --- a/src/oci/core/models/add_vcn_cidr_details.py +++ b/src/oci/core/models/add_vcn_cidr_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AddVcnCidrDetails(object): """ - Details for adding a CIDR block to a VCN. + Details used to add a CIDR block to a VCN. """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/allowed_ike_ip_sec_parameters.py b/src/oci/core/models/allowed_ike_ip_sec_parameters.py index 86e61b3d00..2c76d261ee 100644 --- a/src/oci/core/models/allowed_ike_ip_sec_parameters.py +++ b/src/oci/core/models/allowed_ike_ip_sec_parameters.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AllowedIkeIPSecParameters(object): """ - Allowed IKE IPSec Parameters + Lists the current allowed and default IPSec tunnel parameters. """ def __init__(self, **kwargs): diff --git a/src/oci/core/models/allowed_phase_one_parameters.py b/src/oci/core/models/allowed_phase_one_parameters.py index f9af7f4cf9..335bfacb1e 100644 --- a/src/oci/core/models/allowed_phase_one_parameters.py +++ b/src/oci/core/models/allowed_phase_one_parameters.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AllowedPhaseOneParameters(object): """ - Phase One Parameters + Allowed phase one parameters. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def encryption_algorithms(self): """ Gets the encryption_algorithms of this AllowedPhaseOneParameters. - Phase One Encryption Algorithms + Allowed phase one encryption algorithms. :return: The encryption_algorithms of this AllowedPhaseOneParameters. @@ -63,7 +63,7 @@ def encryption_algorithms(self): def encryption_algorithms(self, encryption_algorithms): """ Sets the encryption_algorithms of this AllowedPhaseOneParameters. - Phase One Encryption Algorithms + Allowed phase one encryption algorithms. :param encryption_algorithms: The encryption_algorithms of this AllowedPhaseOneParameters. @@ -75,7 +75,7 @@ def encryption_algorithms(self, encryption_algorithms): def authentication_algorithms(self): """ Gets the authentication_algorithms of this AllowedPhaseOneParameters. - Phase One Authentication Algorithms + Allowed phase one authentication algorithms. :return: The authentication_algorithms of this AllowedPhaseOneParameters. @@ -87,7 +87,7 @@ def authentication_algorithms(self): def authentication_algorithms(self, authentication_algorithms): """ Sets the authentication_algorithms of this AllowedPhaseOneParameters. - Phase One Authentication Algorithms + Allowed phase one authentication algorithms. :param authentication_algorithms: The authentication_algorithms of this AllowedPhaseOneParameters. @@ -99,7 +99,7 @@ def authentication_algorithms(self, authentication_algorithms): def dh_groups(self): """ Gets the dh_groups of this AllowedPhaseOneParameters. - DH Groups + Allowed phase one Diffie-Hellman groups. :return: The dh_groups of this AllowedPhaseOneParameters. @@ -111,7 +111,7 @@ def dh_groups(self): def dh_groups(self, dh_groups): """ Sets the dh_groups of this AllowedPhaseOneParameters. - DH Groups + Allowed phase one Diffie-Hellman groups. :param dh_groups: The dh_groups of this AllowedPhaseOneParameters. diff --git a/src/oci/core/models/allowed_phase_two_parameters.py b/src/oci/core/models/allowed_phase_two_parameters.py index 251a7c8b7a..d6dfd77e58 100644 --- a/src/oci/core/models/allowed_phase_two_parameters.py +++ b/src/oci/core/models/allowed_phase_two_parameters.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AllowedPhaseTwoParameters(object): """ - Phase Two Parameters + Allowed phase two parameters. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def encryption_algorithms(self): """ Gets the encryption_algorithms of this AllowedPhaseTwoParameters. - Phase Two Encryption Algorithms + Allowed phase two encryption algorithms. :return: The encryption_algorithms of this AllowedPhaseTwoParameters. @@ -63,7 +63,7 @@ def encryption_algorithms(self): def encryption_algorithms(self, encryption_algorithms): """ Sets the encryption_algorithms of this AllowedPhaseTwoParameters. - Phase Two Encryption Algorithms + Allowed phase two encryption algorithms. :param encryption_algorithms: The encryption_algorithms of this AllowedPhaseTwoParameters. @@ -75,7 +75,7 @@ def encryption_algorithms(self, encryption_algorithms): def authentication_algorithms(self): """ Gets the authentication_algorithms of this AllowedPhaseTwoParameters. - Phase Two Authentication Algorithms + Allowed phase two authentication algorithms. :return: The authentication_algorithms of this AllowedPhaseTwoParameters. @@ -87,7 +87,7 @@ def authentication_algorithms(self): def authentication_algorithms(self, authentication_algorithms): """ Sets the authentication_algorithms of this AllowedPhaseTwoParameters. - Phase Two Authentication Algorithms + Allowed phase two authentication algorithms. :param authentication_algorithms: The authentication_algorithms of this AllowedPhaseTwoParameters. @@ -99,7 +99,7 @@ def authentication_algorithms(self, authentication_algorithms): def pfs_dh_groups(self): """ Gets the pfs_dh_groups of this AllowedPhaseTwoParameters. - PFS DH Groups + Allowed perfect forward secrecy Diffie-Hellman groups. :return: The pfs_dh_groups of this AllowedPhaseTwoParameters. @@ -111,7 +111,7 @@ def pfs_dh_groups(self): def pfs_dh_groups(self, pfs_dh_groups): """ Sets the pfs_dh_groups of this AllowedPhaseTwoParameters. - PFS DH Groups + Allowed perfect forward secrecy Diffie-Hellman groups. :param pfs_dh_groups: The pfs_dh_groups of this AllowedPhaseTwoParameters. diff --git a/src/oci/core/models/amd_milan_bm_launch_instance_platform_config.py b/src/oci/core/models/amd_milan_bm_launch_instance_platform_config.py index d03ca599e5..c25f1b4698 100644 --- a/src/oci/core/models/amd_milan_bm_launch_instance_platform_config.py +++ b/src/oci/core/models/amd_milan_bm_launch_instance_platform_config.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class AmdMilanBmLaunchInstancePlatformConfig(LaunchInstancePlatformConfig): """ - The platform configuration used when launching a bare metal instance with an E4 shape - (the AMD Milan platform). + The platform configuration used when launching a bare metal instance with an E4 shape. """ #: A constant which can be used with the numa_nodes_per_socket property of a AmdMilanBmLaunchInstancePlatformConfig. diff --git a/src/oci/core/models/amd_milan_bm_platform_config.py b/src/oci/core/models/amd_milan_bm_platform_config.py index 0c126c6eca..16e621e794 100644 --- a/src/oci/core/models/amd_milan_bm_platform_config.py +++ b/src/oci/core/models/amd_milan_bm_platform_config.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AmdMilanBmPlatformConfig(PlatformConfig): """ - The platform configuration of a bare metal instance that uses an E4 shape + The platform configuration of a bare metal instance that uses an E4 shape. (the AMD Milan platform). """ diff --git a/src/oci/core/models/boot_volume.py b/src/oci/core/models/boot_volume.py index 542acdee9c..dfc7ba0502 100644 --- a/src/oci/core/models/boot_volume.py +++ b/src/oci/core/models/boot_volume.py @@ -463,6 +463,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -485,6 +487,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -675,7 +679,8 @@ def kms_key_id(self, kms_key_id): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this BootVolume. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this BootVolume. @@ -687,7 +692,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this BootVolume. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this BootVolume. @@ -699,7 +705,7 @@ def is_auto_tune_enabled(self, is_auto_tune_enabled): def auto_tuned_vpus_per_gb(self): """ Gets the auto_tuned_vpus_per_gb of this BootVolume. - The number of Volume Performance Units per GB that this boot volume is effectively tuned to when it's idle. + The number of Volume Performance Units per GB that this boot volume is effectively tuned to. :return: The auto_tuned_vpus_per_gb of this BootVolume. @@ -711,7 +717,7 @@ def auto_tuned_vpus_per_gb(self): def auto_tuned_vpus_per_gb(self, auto_tuned_vpus_per_gb): """ Sets the auto_tuned_vpus_per_gb of this BootVolume. - The number of Volume Performance Units per GB that this boot volume is effectively tuned to when it's idle. + The number of Volume Performance Units per GB that this boot volume is effectively tuned to. :param auto_tuned_vpus_per_gb: The auto_tuned_vpus_per_gb of this BootVolume. diff --git a/src/oci/core/models/byoip_range.py b/src/oci/core/models/byoip_range.py index 14edddfa29..c91d1e1fe1 100644 --- a/src/oci/core/models/byoip_range.py +++ b/src/oci/core/models/byoip_range.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ByoipRange(object): """ - Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. + Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. The process used to `Bring Your Own IP`__ is explained in the documentation. __ https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm diff --git a/src/oci/core/models/create_boot_volume_details.py b/src/oci/core/models/create_boot_volume_details.py index dc29b40204..c7395f6ee3 100644 --- a/src/oci/core/models/create_boot_volume_details.py +++ b/src/oci/core/models/create_boot_volume_details.py @@ -346,6 +346,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -368,6 +370,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -400,7 +404,8 @@ def source_details(self, source_details): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this CreateBootVolumeDetails. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this CreateBootVolumeDetails. @@ -412,7 +417,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this CreateBootVolumeDetails. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this CreateBootVolumeDetails. diff --git a/src/oci/core/models/create_internet_gateway_details.py b/src/oci/core/models/create_internet_gateway_details.py index a3376be738..d124a91dff 100644 --- a/src/oci/core/models/create_internet_gateway_details.py +++ b/src/oci/core/models/create_internet_gateway_details.py @@ -218,7 +218,7 @@ def is_enabled(self, is_enabled): def vcn_id(self): """ **[Required]** Gets the vcn_id of this CreateInternetGatewayDetails. - The `OCID`__ of the VCN the internet gateway is attached to. + The `OCID`__ of the VCN the Internet Gateway is attached to. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -232,7 +232,7 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this CreateInternetGatewayDetails. - The `OCID`__ of the VCN the internet gateway is attached to. + The `OCID`__ of the VCN the Internet Gateway is attached to. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/create_ip_sec_connection_tunnel_details.py b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py index 07545f0ce8..0ce98e9660 100644 --- a/src/oci/core/models/create_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/create_ip_sec_connection_tunnel_details.py @@ -177,7 +177,7 @@ def display_name(self, display_name): def routing(self): """ Gets the routing of this CreateIPSecConnectionTunnelDetails. - The type of routing to use for this tunnel (either BGP dynamic routing or static routing). + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). Allowed values for this property are: "BGP", "STATIC", "POLICY" @@ -191,7 +191,7 @@ def routing(self): def routing(self, routing): """ Sets the routing of this CreateIPSecConnectionTunnelDetails. - The type of routing to use for this tunnel (either BGP dynamic routing or static routing). + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). :param routing: The routing of this CreateIPSecConnectionTunnelDetails. @@ -291,7 +291,7 @@ def bgp_session_config(self, bgp_session_config): def oracle_initiation(self): """ Gets the oracle_initiation of this CreateIPSecConnectionTunnelDetails. - Whether Oracle side is the initiator for negotiation. + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" @@ -305,7 +305,7 @@ def oracle_initiation(self): def oracle_initiation(self, oracle_initiation): """ Sets the oracle_initiation of this CreateIPSecConnectionTunnelDetails. - Whether Oracle side is the initiator for negotiation. + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. :param oracle_initiation: The oracle_initiation of this CreateIPSecConnectionTunnelDetails. @@ -323,7 +323,14 @@ def oracle_initiation(self, oracle_initiation): def nat_translation_enabled(self): """ Gets the nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" @@ -337,7 +344,14 @@ def nat_translation_enabled(self): def nat_translation_enabled(self, nat_translation_enabled): """ Sets the nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. :param nat_translation_enabled: The nat_translation_enabled of this CreateIPSecConnectionTunnelDetails. diff --git a/src/oci/core/models/create_vcn_details.py b/src/oci/core/models/create_vcn_details.py index 8a1d6e1246..bcaf9b7e22 100644 --- a/src/oci/core/models/create_vcn_details.py +++ b/src/oci/core/models/create_vcn_details.py @@ -326,6 +326,7 @@ def is_ipv6_enabled(self): Gets the is_ipv6_enabled of this CreateVcnDetails. Whether IPv6 is enabled for the VCN. Default is `false`. If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. + You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`. For important details about IPv6 addressing in a VCN, see `IPv6 Addresses`__. Example: `true` @@ -344,6 +345,7 @@ def is_ipv6_enabled(self, is_ipv6_enabled): Sets the is_ipv6_enabled of this CreateVcnDetails. Whether IPv6 is enabled for the VCN. Default is `false`. If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. + You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`. For important details about IPv6 addressing in a VCN, see `IPv6 Addresses`__. Example: `true` diff --git a/src/oci/core/models/create_volume_details.py b/src/oci/core/models/create_volume_details.py index 989a6c1367..1ebc713702 100644 --- a/src/oci/core/models/create_volume_details.py +++ b/src/oci/core/models/create_volume_details.py @@ -339,6 +339,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -363,6 +365,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -473,7 +477,8 @@ def volume_backup_id(self, volume_backup_id): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this CreateVolumeDetails. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this CreateVolumeDetails. @@ -485,7 +490,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this CreateVolumeDetails. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this CreateVolumeDetails. diff --git a/src/oci/core/models/cross_connect.py b/src/oci/core/models/cross_connect.py index d65dcfb759..921a1dc0cf 100644 --- a/src/oci/core/models/cross_connect.py +++ b/src/oci/core/models/cross_connect.py @@ -114,6 +114,14 @@ def __init__(self, **kwargs): The value to assign to the macsec_properties property of this CrossConnect. :type macsec_properties: oci.core.models.MacsecProperties + :param oci_physical_device_name: + The value to assign to the oci_physical_device_name property of this CrossConnect. + :type oci_physical_device_name: str + + :param oci_logical_device_name: + The value to assign to the oci_logical_device_name property of this CrossConnect. + :type oci_logical_device_name: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -128,7 +136,9 @@ def __init__(self, **kwargs): 'port_speed_shape_name': 'str', 'customer_reference_name': 'str', 'time_created': 'datetime', - 'macsec_properties': 'MacsecProperties' + 'macsec_properties': 'MacsecProperties', + 'oci_physical_device_name': 'str', + 'oci_logical_device_name': 'str' } self.attribute_map = { @@ -144,7 +154,9 @@ def __init__(self, **kwargs): 'port_speed_shape_name': 'portSpeedShapeName', 'customer_reference_name': 'customerReferenceName', 'time_created': 'timeCreated', - 'macsec_properties': 'macsecProperties' + 'macsec_properties': 'macsecProperties', + 'oci_physical_device_name': 'ociPhysicalDeviceName', + 'oci_logical_device_name': 'ociLogicalDeviceName' } self._compartment_id = None @@ -160,6 +172,8 @@ def __init__(self, **kwargs): self._customer_reference_name = None self._time_created = None self._macsec_properties = None + self._oci_physical_device_name = None + self._oci_logical_device_name = None @property def compartment_id(self): @@ -519,6 +533,56 @@ def macsec_properties(self, macsec_properties): """ self._macsec_properties = macsec_properties + @property + def oci_physical_device_name(self): + """ + Gets the oci_physical_device_name of this CrossConnect. + The FastConnect device that terminates the physical connection. + + + :return: The oci_physical_device_name of this CrossConnect. + :rtype: str + """ + return self._oci_physical_device_name + + @oci_physical_device_name.setter + def oci_physical_device_name(self, oci_physical_device_name): + """ + Sets the oci_physical_device_name of this CrossConnect. + The FastConnect device that terminates the physical connection. + + + :param oci_physical_device_name: The oci_physical_device_name of this CrossConnect. + :type: str + """ + self._oci_physical_device_name = oci_physical_device_name + + @property + def oci_logical_device_name(self): + """ + Gets the oci_logical_device_name of this CrossConnect. + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + + + :return: The oci_logical_device_name of this CrossConnect. + :rtype: str + """ + return self._oci_logical_device_name + + @oci_logical_device_name.setter + def oci_logical_device_name(self, oci_logical_device_name): + """ + Sets the oci_logical_device_name of this CrossConnect. + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + + + :param oci_logical_device_name: The oci_logical_device_name of this CrossConnect. + :type: str + """ + self._oci_logical_device_name = oci_logical_device_name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/cross_connect_group.py b/src/oci/core/models/cross_connect_group.py index 27d09ce92a..d31fb3f405 100644 --- a/src/oci/core/models/cross_connect_group.py +++ b/src/oci/core/models/cross_connect_group.py @@ -91,6 +91,14 @@ def __init__(self, **kwargs): The value to assign to the macsec_properties property of this CrossConnectGroup. :type macsec_properties: oci.core.models.MacsecProperties + :param oci_physical_device_name: + The value to assign to the oci_physical_device_name property of this CrossConnectGroup. + :type oci_physical_device_name: str + + :param oci_logical_device_name: + The value to assign to the oci_logical_device_name property of this CrossConnectGroup. + :type oci_logical_device_name: str + """ self.swagger_types = { 'compartment_id': 'str', @@ -101,7 +109,9 @@ def __init__(self, **kwargs): 'lifecycle_state': 'str', 'customer_reference_name': 'str', 'time_created': 'datetime', - 'macsec_properties': 'MacsecProperties' + 'macsec_properties': 'MacsecProperties', + 'oci_physical_device_name': 'str', + 'oci_logical_device_name': 'str' } self.attribute_map = { @@ -113,7 +123,9 @@ def __init__(self, **kwargs): 'lifecycle_state': 'lifecycleState', 'customer_reference_name': 'customerReferenceName', 'time_created': 'timeCreated', - 'macsec_properties': 'macsecProperties' + 'macsec_properties': 'macsecProperties', + 'oci_physical_device_name': 'ociPhysicalDeviceName', + 'oci_logical_device_name': 'ociLogicalDeviceName' } self._compartment_id = None @@ -125,6 +137,8 @@ def __init__(self, **kwargs): self._customer_reference_name = None self._time_created = None self._macsec_properties = None + self._oci_physical_device_name = None + self._oci_logical_device_name = None @property def compartment_id(self): @@ -380,6 +394,56 @@ def macsec_properties(self, macsec_properties): """ self._macsec_properties = macsec_properties + @property + def oci_physical_device_name(self): + """ + Gets the oci_physical_device_name of this CrossConnectGroup. + The FastConnect device that terminates the physical connection. + + + :return: The oci_physical_device_name of this CrossConnectGroup. + :rtype: str + """ + return self._oci_physical_device_name + + @oci_physical_device_name.setter + def oci_physical_device_name(self, oci_physical_device_name): + """ + Sets the oci_physical_device_name of this CrossConnectGroup. + The FastConnect device that terminates the physical connection. + + + :param oci_physical_device_name: The oci_physical_device_name of this CrossConnectGroup. + :type: str + """ + self._oci_physical_device_name = oci_physical_device_name + + @property + def oci_logical_device_name(self): + """ + Gets the oci_logical_device_name of this CrossConnectGroup. + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + + + :return: The oci_logical_device_name of this CrossConnectGroup. + :rtype: str + """ + return self._oci_logical_device_name + + @oci_logical_device_name.setter + def oci_logical_device_name(self, oci_logical_device_name): + """ + Sets the oci_logical_device_name of this CrossConnectGroup. + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + + + :param oci_logical_device_name: The oci_logical_device_name of this CrossConnectGroup. + :type: str + """ + self._oci_logical_device_name = oci_logical_device_name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/cross_connect_mapping_details.py b/src/oci/core/models/cross_connect_mapping_details.py index f117ca33a3..be1b1ce476 100644 --- a/src/oci/core/models/cross_connect_mapping_details.py +++ b/src/oci/core/models/cross_connect_mapping_details.py @@ -81,6 +81,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type ipv6_bgp_status: str + :param oci_logical_device_name: + The value to assign to the oci_logical_device_name property of this CrossConnectMappingDetails. + :type oci_logical_device_name: str + """ self.swagger_types = { 'bgp_md5_auth_key': 'str', @@ -91,7 +95,8 @@ def __init__(self, **kwargs): 'oracle_bgp_peering_ipv6': 'str', 'vlan': 'int', 'ipv4_bgp_status': 'str', - 'ipv6_bgp_status': 'str' + 'ipv6_bgp_status': 'str', + 'oci_logical_device_name': 'str' } self.attribute_map = { @@ -103,7 +108,8 @@ def __init__(self, **kwargs): 'oracle_bgp_peering_ipv6': 'oracleBgpPeeringIpv6', 'vlan': 'vlan', 'ipv4_bgp_status': 'ipv4BgpStatus', - 'ipv6_bgp_status': 'ipv6BgpStatus' + 'ipv6_bgp_status': 'ipv6BgpStatus', + 'oci_logical_device_name': 'ociLogicalDeviceName' } self._bgp_md5_auth_key = None @@ -115,6 +121,7 @@ def __init__(self, **kwargs): self._vlan = None self._ipv4_bgp_status = None self._ipv6_bgp_status = None + self._oci_logical_device_name = None @property def bgp_md5_auth_key(self): @@ -428,6 +435,30 @@ def ipv6_bgp_status(self, ipv6_bgp_status): ipv6_bgp_status = 'UNKNOWN_ENUM_VALUE' self._ipv6_bgp_status = ipv6_bgp_status + @property + def oci_logical_device_name(self): + """ + Gets the oci_logical_device_name of this CrossConnectMappingDetails. + The FastConnect device that terminates the logical connection. + + + :return: The oci_logical_device_name of this CrossConnectMappingDetails. + :rtype: str + """ + return self._oci_logical_device_name + + @oci_logical_device_name.setter + def oci_logical_device_name(self, oci_logical_device_name): + """ + Sets the oci_logical_device_name of this CrossConnectMappingDetails. + The FastConnect device that terminates the logical connection. + + + :param oci_logical_device_name: The oci_logical_device_name of this CrossConnectMappingDetails. + :type: str + """ + self._oci_logical_device_name = oci_logical_device_name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/default_phase_one_parameters.py b/src/oci/core/models/default_phase_one_parameters.py index 70c7f6e3ab..217801a6e2 100644 --- a/src/oci/core/models/default_phase_one_parameters.py +++ b/src/oci/core/models/default_phase_one_parameters.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DefaultPhaseOneParameters(object): """ - Phase One Parameters + Default phase one parameters. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def default_encryption_algorithms(self): """ Gets the default_encryption_algorithms of this DefaultPhaseOneParameters. - Default Phase One Encryption Algorithms + Default phase one encryption algorithms. :return: The default_encryption_algorithms of this DefaultPhaseOneParameters. @@ -63,7 +63,7 @@ def default_encryption_algorithms(self): def default_encryption_algorithms(self, default_encryption_algorithms): """ Sets the default_encryption_algorithms of this DefaultPhaseOneParameters. - Default Phase One Encryption Algorithms + Default phase one encryption algorithms. :param default_encryption_algorithms: The default_encryption_algorithms of this DefaultPhaseOneParameters. @@ -75,7 +75,7 @@ def default_encryption_algorithms(self, default_encryption_algorithms): def default_authentication_algorithms(self): """ Gets the default_authentication_algorithms of this DefaultPhaseOneParameters. - Default Phase One Authentication Algorithms + Default phase one authentication algorithms. :return: The default_authentication_algorithms of this DefaultPhaseOneParameters. @@ -87,7 +87,7 @@ def default_authentication_algorithms(self): def default_authentication_algorithms(self, default_authentication_algorithms): """ Sets the default_authentication_algorithms of this DefaultPhaseOneParameters. - Default Phase One Authentication Algorithms + Default phase one authentication algorithms. :param default_authentication_algorithms: The default_authentication_algorithms of this DefaultPhaseOneParameters. @@ -99,7 +99,7 @@ def default_authentication_algorithms(self, default_authentication_algorithms): def default_dh_groups(self): """ Gets the default_dh_groups of this DefaultPhaseOneParameters. - Default DH Groups + Default phase one Diffie-Hellman groups. :return: The default_dh_groups of this DefaultPhaseOneParameters. @@ -111,7 +111,7 @@ def default_dh_groups(self): def default_dh_groups(self, default_dh_groups): """ Sets the default_dh_groups of this DefaultPhaseOneParameters. - Default DH Groups + Default phase one Diffie-Hellman groups. :param default_dh_groups: The default_dh_groups of this DefaultPhaseOneParameters. diff --git a/src/oci/core/models/default_phase_two_parameters.py b/src/oci/core/models/default_phase_two_parameters.py index 5aafa230a2..3d06b3ae9f 100644 --- a/src/oci/core/models/default_phase_two_parameters.py +++ b/src/oci/core/models/default_phase_two_parameters.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DefaultPhaseTwoParameters(object): """ - Phase Two Parameters + Default phase two parameters. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def default_encryption_algorithms(self): """ Gets the default_encryption_algorithms of this DefaultPhaseTwoParameters. - Default Phase Two Encryption Algorithms + Default phase two encryption algorithms. :return: The default_encryption_algorithms of this DefaultPhaseTwoParameters. @@ -63,7 +63,7 @@ def default_encryption_algorithms(self): def default_encryption_algorithms(self, default_encryption_algorithms): """ Sets the default_encryption_algorithms of this DefaultPhaseTwoParameters. - Default Phase Two Encryption Algorithms + Default phase two encryption algorithms. :param default_encryption_algorithms: The default_encryption_algorithms of this DefaultPhaseTwoParameters. @@ -75,7 +75,7 @@ def default_encryption_algorithms(self, default_encryption_algorithms): def default_authentication_algorithms(self): """ Gets the default_authentication_algorithms of this DefaultPhaseTwoParameters. - Default Phase Two Authentication Algorithms + Default phase two authentication algorithms. :return: The default_authentication_algorithms of this DefaultPhaseTwoParameters. @@ -87,7 +87,7 @@ def default_authentication_algorithms(self): def default_authentication_algorithms(self, default_authentication_algorithms): """ Sets the default_authentication_algorithms of this DefaultPhaseTwoParameters. - Default Phase Two Authentication Algorithms + Default phase two authentication algorithms. :param default_authentication_algorithms: The default_authentication_algorithms of this DefaultPhaseTwoParameters. @@ -99,7 +99,7 @@ def default_authentication_algorithms(self, default_authentication_algorithms): def default_pfs_dh_group(self): """ Gets the default_pfs_dh_group of this DefaultPhaseTwoParameters. - Default PFS DH Group + Default perfect forward secrecy Diffie-Hellman groups. :return: The default_pfs_dh_group of this DefaultPhaseTwoParameters. @@ -111,7 +111,7 @@ def default_pfs_dh_group(self): def default_pfs_dh_group(self, default_pfs_dh_group): """ Sets the default_pfs_dh_group of this DefaultPhaseTwoParameters. - Default PFS DH Group + Default perfect forward secrecy Diffie-Hellman groups. :param default_pfs_dh_group: The default_pfs_dh_group of this DefaultPhaseTwoParameters. diff --git a/src/oci/core/models/dpd_config.py b/src/oci/core/models/dpd_config.py index 1614e75998..a1d7c5af93 100644 --- a/src/oci/core/models/dpd_config.py +++ b/src/oci/core/models/dpd_config.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpdConfig(object): """ - DPD Configuration Details + These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and may be used to detect that the link to the CPE has gone down. """ #: A constant which can be used with the dpd_mode property of a DpdConfig. @@ -53,7 +53,7 @@ def __init__(self, **kwargs): def dpd_mode(self): """ Gets the dpd_mode of this DpdConfig. - dpd mode + This option defines whether DPD can be initiated from the Oracle side of the connection. Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY" @@ -67,7 +67,7 @@ def dpd_mode(self): def dpd_mode(self, dpd_mode): """ Sets the dpd_mode of this DpdConfig. - dpd mode + This option defines whether DPD can be initiated from the Oracle side of the connection. :param dpd_mode: The dpd_mode of this DpdConfig. @@ -85,7 +85,7 @@ def dpd_mode(self, dpd_mode): def dpd_timeout_in_sec(self): """ Gets the dpd_timeout_in_sec of this DpdConfig. - DPD Timeout in seconds. + DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds. :return: The dpd_timeout_in_sec of this DpdConfig. @@ -97,7 +97,7 @@ def dpd_timeout_in_sec(self): def dpd_timeout_in_sec(self, dpd_timeout_in_sec): """ Sets the dpd_timeout_in_sec of this DpdConfig. - DPD Timeout in seconds. + DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds. :param dpd_timeout_in_sec: The dpd_timeout_in_sec of this DpdConfig. diff --git a/src/oci/core/models/drg_route_distribution.py b/src/oci/core/models/drg_route_distribution.py index 52120055b6..643fc98484 100644 --- a/src/oci/core/models/drg_route_distribution.py +++ b/src/oci/core/models/drg_route_distribution.py @@ -20,11 +20,11 @@ class DrgRouteDistribution(object): You can assign a route distribution as a DRG attachment's export distribution. Export route distribution statements specify how routes in a DRG attachment's assigned table are advertised out through the attachment. When a DRG attachment is created, a route distribution is created with a - single ACCEPT statement with an empty match criteria (empty match criteria implies match ALL). + single ACCEPT statement with match criteria MATCH_ALL. Exporting routes through VCN attachments is unsupported, so no VCN attachments are assigned an export distribution. The two auto-generated DRG route tables (one as the default for VCN attachments, and the other for all other types of attachments) - are each assigned an auto generated import route distribution. The default VCN table's import distribution has a single statement with empty match criteria statement to import routes from + are each assigned an auto generated import route distribution. The default VCN table's import distribution has a single statement with match criteria MATCH_ALL to import routes from each DRG attachment type. The other table's import distribution has a statement to import routes from attachments with the VCN type. The route distribution is always in the same compartment as the DRG. diff --git a/src/oci/core/models/drg_route_distribution_match_criteria.py b/src/oci/core/models/drg_route_distribution_match_criteria.py index 63687431e3..e6981adca9 100644 --- a/src/oci/core/models/drg_route_distribution_match_criteria.py +++ b/src/oci/core/models/drg_route_distribution_match_criteria.py @@ -11,7 +11,7 @@ class DrgRouteDistributionMatchCriteria(object): """ The match criteria in a route distribution statement. The match criteria outlines which routes - should be imported or exported. Leaving the match criteria empty implies match ALL. + should be imported or exported. """ #: A constant which can be used with the match_type property of a DrgRouteDistributionMatchCriteria. diff --git a/src/oci/core/models/instance_configuration_amd_milan_bm_launch_instance_platform_config.py b/src/oci/core/models/instance_configuration_amd_milan_bm_launch_instance_platform_config.py index 8f9dc5fdab..473012e428 100644 --- a/src/oci/core/models/instance_configuration_amd_milan_bm_launch_instance_platform_config.py +++ b/src/oci/core/models/instance_configuration_amd_milan_bm_launch_instance_platform_config.py @@ -10,8 +10,7 @@ @init_model_state_from_kwargs class InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig(InstanceConfigurationLaunchInstancePlatformConfig): """ - The platform configuration used when launching a bare metal instance with an E4 shape - (the AMD Milan platform). + The platform configuration used when launching a bare metal instance with an E4 shape. """ #: A constant which can be used with the numa_nodes_per_socket property of a InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig. @@ -88,7 +87,7 @@ def __init__(self, **kwargs): def numa_nodes_per_socket(self): """ Gets the numa_nodes_per_socket of this InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig. - The number of NUMA nodes per socket. + The number of NUMA nodes per socket (NPS). Allowed values for this property are: "NPS0", "NPS1", "NPS2", "NPS4", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -103,7 +102,7 @@ def numa_nodes_per_socket(self): def numa_nodes_per_socket(self, numa_nodes_per_socket): """ Sets the numa_nodes_per_socket of this InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig. - The number of NUMA nodes per socket. + The number of NUMA nodes per socket (NPS). :param numa_nodes_per_socket: The numa_nodes_per_socket of this InstanceConfigurationAmdMilanBmLaunchInstancePlatformConfig. diff --git a/src/oci/core/models/instance_configuration_create_volume_details.py b/src/oci/core/models/instance_configuration_create_volume_details.py index 13117f9f00..f35db93dc2 100644 --- a/src/oci/core/models/instance_configuration_create_volume_details.py +++ b/src/oci/core/models/instance_configuration_create_volume_details.py @@ -310,6 +310,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -334,6 +336,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm diff --git a/src/oci/core/models/internet_gateway.py b/src/oci/core/models/internet_gateway.py index 2ade61a75d..e9e8febe0d 100644 --- a/src/oci/core/models/internet_gateway.py +++ b/src/oci/core/models/internet_gateway.py @@ -358,7 +358,7 @@ def time_created(self, time_created): def vcn_id(self): """ **[Required]** Gets the vcn_id of this InternetGateway. - The `OCID`__ of the VCN the internet gateway belongs to. + The `OCID`__ of the VCN the Internet Gateway belongs to. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm @@ -372,7 +372,7 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this InternetGateway. - The `OCID`__ of the VCN the internet gateway belongs to. + The `OCID`__ of the VCN the Internet Gateway belongs to. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm diff --git a/src/oci/core/models/ip_sec_connection_tunnel.py b/src/oci/core/models/ip_sec_connection_tunnel.py index 75cacd94f8..109a81c5ef 100644 --- a/src/oci/core/models/ip_sec_connection_tunnel.py +++ b/src/oci/core/models/ip_sec_connection_tunnel.py @@ -10,8 +10,8 @@ @init_model_state_from_kwargs class IPSecConnectionTunnel(object): """ - Information about a single tunnel in an IPSec connection. This object does not include the tunnel's - shared secret (pre-shared key). That is in the + Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel's + shared secret (pre-shared key), which is found in the :class:`IPSecConnectionTunnelSharedSecret` object. """ @@ -315,7 +315,7 @@ def id(self, id): def vpn_ip(self): """ Gets the vpn_ip of this IPSecConnectionTunnel. - The IP address of Oracle's VPN headend. + The IP address of the Oracle VPN headend for the connection. Example: `203.0.113.21` @@ -329,7 +329,7 @@ def vpn_ip(self): def vpn_ip(self, vpn_ip): """ Sets the vpn_ip of this IPSecConnectionTunnel. - The IP address of Oracle's VPN headend. + The IP address of the Oracle VPN headend for the connection. Example: `203.0.113.21` @@ -343,7 +343,7 @@ def vpn_ip(self, vpn_ip): def cpe_ip(self): """ Gets the cpe_ip of this IPSecConnectionTunnel. - The IP address of the CPE's VPN headend. + The IP address of the CPE device's VPN headend. Example: `203.0.113.22` @@ -357,7 +357,7 @@ def cpe_ip(self): def cpe_ip(self, cpe_ip): """ Sets the cpe_ip of this IPSecConnectionTunnel. - The IP address of the CPE's VPN headend. + The IP address of the CPE device's VPN headend. Example: `203.0.113.22` @@ -527,7 +527,7 @@ def encryption_domain_config(self, encryption_domain_config): def routing(self): """ Gets the routing of this IPSecConnectionTunnel. - The type of routing used for this tunnel (either BGP dynamic routing or static routing). + The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing). Allowed values for this property are: "BGP", "STATIC", "POLICY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -542,7 +542,7 @@ def routing(self): def routing(self, routing): """ Sets the routing of this IPSecConnectionTunnel. - The type of routing used for this tunnel (either BGP dynamic routing or static routing). + The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing). :param routing: The routing of this IPSecConnectionTunnel. @@ -557,7 +557,7 @@ def routing(self, routing): def time_created(self): """ Gets the time_created of this IPSecConnectionTunnel. - The date and time the IPSec connection tunnel was created, in the format defined by `RFC3339`__. + The date and time the IPSec tunnel was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -573,7 +573,7 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this IPSecConnectionTunnel. - The date and time the IPSec connection tunnel was created, in the format defined by `RFC3339`__. + The date and time the IPSec tunnel was created, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -589,7 +589,7 @@ def time_created(self, time_created): def time_status_updated(self): """ Gets the time_status_updated of this IPSecConnectionTunnel. - When the status of the tunnel last changed, in the format defined by `RFC3339`__. + When the status of the IPSec tunnel last changed, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -605,7 +605,7 @@ def time_status_updated(self): def time_status_updated(self, time_status_updated): """ Sets the time_status_updated of this IPSecConnectionTunnel. - When the status of the tunnel last changed, in the format defined by `RFC3339`__. + When the status of the IPSec tunnel last changed, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -621,7 +621,7 @@ def time_status_updated(self, time_status_updated): def oracle_can_initiate(self): """ Gets the oracle_can_initiate of this IPSecConnectionTunnel. - Indicates whether Oracle can either initiate the tunnel or respond, or respond only. + Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests. Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -636,7 +636,7 @@ def oracle_can_initiate(self): def oracle_can_initiate(self, oracle_can_initiate): """ Sets the oracle_can_initiate of this IPSecConnectionTunnel. - Indicates whether Oracle can either initiate the tunnel or respond, or respond only. + Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests. :param oracle_can_initiate: The oracle_can_initiate of this IPSecConnectionTunnel. @@ -651,7 +651,17 @@ def oracle_can_initiate(self, oracle_can_initiate): def nat_translation_enabled(self): """ Gets the nat_translation_enabled of this IPSecConnectionTunnel. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. + + + . Allowed values for this property are: "ENABLED", "DISABLED", "AUTO", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -666,7 +676,17 @@ def nat_translation_enabled(self): def nat_translation_enabled(self, nat_translation_enabled): """ Sets the nat_translation_enabled of this IPSecConnectionTunnel. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. + + + . :param nat_translation_enabled: The nat_translation_enabled of this IPSecConnectionTunnel. @@ -681,7 +701,9 @@ def nat_translation_enabled(self, nat_translation_enabled): def dpd_mode(self): """ Gets the dpd_mode of this IPSecConnectionTunnel. - dpd mode + Dead peer detection (DPD) mode set on the Oracle side of the connection. + This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, + or both respond to and initiate requests. Allowed values for this property are: "INITIATE_AND_RESPOND", "RESPOND_ONLY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -696,7 +718,9 @@ def dpd_mode(self): def dpd_mode(self, dpd_mode): """ Sets the dpd_mode of this IPSecConnectionTunnel. - dpd mode + Dead peer detection (DPD) mode set on the Oracle side of the connection. + This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, + or both respond to and initiate requests. :param dpd_mode: The dpd_mode of this IPSecConnectionTunnel. @@ -711,7 +735,7 @@ def dpd_mode(self, dpd_mode): def dpd_timeout_in_sec(self): """ Gets the dpd_timeout_in_sec of this IPSecConnectionTunnel. - Dead peer detection (DPD) timeout in seconds. + DPD timeout in seconds. :return: The dpd_timeout_in_sec of this IPSecConnectionTunnel. @@ -723,7 +747,7 @@ def dpd_timeout_in_sec(self): def dpd_timeout_in_sec(self, dpd_timeout_in_sec): """ Sets the dpd_timeout_in_sec of this IPSecConnectionTunnel. - Dead peer detection (DPD) timeout in seconds. + DPD timeout in seconds. :param dpd_timeout_in_sec: The dpd_timeout_in_sec of this IPSecConnectionTunnel. diff --git a/src/oci/core/models/ip_sec_connection_tunnel_error_details.py b/src/oci/core/models/ip_sec_connection_tunnel_error_details.py index 4485c6a3a1..792302fba4 100644 --- a/src/oci/core/models/ip_sec_connection_tunnel_error_details.py +++ b/src/oci/core/models/ip_sec_connection_tunnel_error_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class IPSecConnectionTunnelErrorDetails(object): """ - Ipsec tunnels error details + Details for an error on an IPSec tunnel. """ def __init__(self, **kwargs): @@ -72,7 +72,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this IPSecConnectionTunnelErrorDetails. - unique id generated for each error report + Unique ID generated for each error report. :return: The id of this IPSecConnectionTunnelErrorDetails. @@ -84,7 +84,7 @@ def id(self): def id(self, id): """ Sets the id of this IPSecConnectionTunnelErrorDetails. - unique id generated for each error report + Unique ID generated for each error report. :param id: The id of this IPSecConnectionTunnelErrorDetails. @@ -96,7 +96,7 @@ def id(self, id): def error_code(self): """ **[Required]** Gets the error_code of this IPSecConnectionTunnelErrorDetails. - unique code describes error type + Unique code describes the error type. :return: The error_code of this IPSecConnectionTunnelErrorDetails. @@ -108,7 +108,7 @@ def error_code(self): def error_code(self, error_code): """ Sets the error_code of this IPSecConnectionTunnelErrorDetails. - unique code describes error type + Unique code describes the error type. :param error_code: The error_code of this IPSecConnectionTunnelErrorDetails. @@ -120,7 +120,7 @@ def error_code(self, error_code): def error_description(self): """ **[Required]** Gets the error_description of this IPSecConnectionTunnelErrorDetails. - detailed description of the error + A detailed description of the error. :return: The error_description of this IPSecConnectionTunnelErrorDetails. @@ -132,7 +132,7 @@ def error_description(self): def error_description(self, error_description): """ Sets the error_description of this IPSecConnectionTunnelErrorDetails. - detailed description of the error + A detailed description of the error. :param error_description: The error_description of this IPSecConnectionTunnelErrorDetails. @@ -144,7 +144,7 @@ def error_description(self, error_description): def solution(self): """ **[Required]** Gets the solution of this IPSecConnectionTunnelErrorDetails. - how to resolve the error + Resolution for the error. :return: The solution of this IPSecConnectionTunnelErrorDetails. @@ -156,7 +156,7 @@ def solution(self): def solution(self, solution): """ Sets the solution of this IPSecConnectionTunnelErrorDetails. - how to resolve the error + Resolution for the error. :param solution: The solution of this IPSecConnectionTunnelErrorDetails. @@ -168,7 +168,7 @@ def solution(self, solution): def oci_resources_link(self): """ **[Required]** Gets the oci_resources_link of this IPSecConnectionTunnelErrorDetails. - link to oracle resources + Link to more Oracle resources or relevant documentation. :return: The oci_resources_link of this IPSecConnectionTunnelErrorDetails. @@ -180,7 +180,7 @@ def oci_resources_link(self): def oci_resources_link(self, oci_resources_link): """ Sets the oci_resources_link of this IPSecConnectionTunnelErrorDetails. - link to oracle resources + Link to more Oracle resources or relevant documentation. :param oci_resources_link: The oci_resources_link of this IPSecConnectionTunnelErrorDetails. @@ -192,7 +192,7 @@ def oci_resources_link(self, oci_resources_link): def timestamp(self): """ **[Required]** Gets the timestamp of this IPSecConnectionTunnelErrorDetails. - timestamp when error occurred. + Timestamp when the error occurred. :return: The timestamp of this IPSecConnectionTunnelErrorDetails. @@ -204,7 +204,7 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this IPSecConnectionTunnelErrorDetails. - timestamp when error occurred. + Timestamp when the error occurred. :param timestamp: The timestamp of this IPSecConnectionTunnelErrorDetails. diff --git a/src/oci/core/models/phase_one_config_details.py b/src/oci/core/models/phase_one_config_details.py index af7e3072ee..0924d17bf3 100644 --- a/src/oci/core/models/phase_one_config_details.py +++ b/src/oci/core/models/phase_one_config_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PhaseOneConfigDetails(object): """ - Phase 1 Configuration Details + Configuration details for IKE phase one (ISAKMP) configuration parameters. """ #: A constant which can be used with the authentication_algorithm property of a PhaseOneConfigDetails. @@ -116,7 +116,7 @@ def __init__(self, **kwargs): def is_custom_phase_one_config(self): """ Gets the is_custom_phase_one_config of this PhaseOneConfigDetails. - Indicates whether custom phase one configuration is enabled. + Indicates whether custom configuration is enabled for phase one options. :return: The is_custom_phase_one_config of this PhaseOneConfigDetails. @@ -128,7 +128,7 @@ def is_custom_phase_one_config(self): def is_custom_phase_one_config(self, is_custom_phase_one_config): """ Sets the is_custom_phase_one_config of this PhaseOneConfigDetails. - Indicates whether custom phase one configuration is enabled. + Indicates whether custom configuration is enabled for phase one options. :param is_custom_phase_one_config: The is_custom_phase_one_config of this PhaseOneConfigDetails. @@ -140,7 +140,7 @@ def is_custom_phase_one_config(self, is_custom_phase_one_config): def authentication_algorithm(self): """ Gets the authentication_algorithm of this PhaseOneConfigDetails. - Phase one authentication algorithm supported during tunnel negotiation. + The custom authentication algorithm proposed during phase one tunnel negotiation. Allowed values for this property are: "SHA2_384", "SHA2_256", "SHA1_96" @@ -154,7 +154,7 @@ def authentication_algorithm(self): def authentication_algorithm(self, authentication_algorithm): """ Sets the authentication_algorithm of this PhaseOneConfigDetails. - Phase one authentication algorithm supported during tunnel negotiation. + The custom authentication algorithm proposed during phase one tunnel negotiation. :param authentication_algorithm: The authentication_algorithm of this PhaseOneConfigDetails. @@ -172,7 +172,7 @@ def authentication_algorithm(self, authentication_algorithm): def encryption_algorithm(self): """ Gets the encryption_algorithm of this PhaseOneConfigDetails. - Phase one encryption algorithm supported during tunnel negotiation. + The custom encryption algorithm proposed during phase one tunnel negotiation. Allowed values for this property are: "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" @@ -186,7 +186,7 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this PhaseOneConfigDetails. - Phase one encryption algorithm supported during tunnel negotiation. + The custom encryption algorithm proposed during phase one tunnel negotiation. :param encryption_algorithm: The encryption_algorithm of this PhaseOneConfigDetails. @@ -204,7 +204,7 @@ def encryption_algorithm(self, encryption_algorithm): def diffie_helman_group(self): """ Gets the diffie_helman_group of this PhaseOneConfigDetails. - Phase One Diffie Hellman group supported during tunnel negotiation. + The custom Diffie-Hellman group proposed during phase one tunnel negotiation. Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" @@ -218,7 +218,7 @@ def diffie_helman_group(self): def diffie_helman_group(self, diffie_helman_group): """ Sets the diffie_helman_group of this PhaseOneConfigDetails. - Phase One Diffie Hellman group supported during tunnel negotiation. + The custom Diffie-Hellman group proposed during phase one tunnel negotiation. :param diffie_helman_group: The diffie_helman_group of this PhaseOneConfigDetails. @@ -236,7 +236,7 @@ def diffie_helman_group(self, diffie_helman_group): def lifetime_in_seconds(self): """ Gets the lifetime_in_seconds of this PhaseOneConfigDetails. - IKE session key lifetime in seconds for IPSec phase one. + Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours. :return: The lifetime_in_seconds of this PhaseOneConfigDetails. @@ -248,7 +248,7 @@ def lifetime_in_seconds(self): def lifetime_in_seconds(self, lifetime_in_seconds): """ Sets the lifetime_in_seconds of this PhaseOneConfigDetails. - IKE session key lifetime in seconds for IPSec phase one. + Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours. :param lifetime_in_seconds: The lifetime_in_seconds of this PhaseOneConfigDetails. diff --git a/src/oci/core/models/phase_two_config_details.py b/src/oci/core/models/phase_two_config_details.py index 0a2db85b8f..e9d7b72789 100644 --- a/src/oci/core/models/phase_two_config_details.py +++ b/src/oci/core/models/phase_two_config_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class PhaseTwoConfigDetails(object): """ - Phase 2 Configuration Details + Configuration details for IPSec phase two configuration parameters. """ #: A constant which can be used with the authentication_algorithm property of a PhaseTwoConfigDetails. @@ -131,7 +131,7 @@ def __init__(self, **kwargs): def is_custom_phase_two_config(self): """ Gets the is_custom_phase_two_config of this PhaseTwoConfigDetails. - Indicates whether custom phase two configuration is enabled. + Indicates whether custom configuration is enabled for phase two options. :return: The is_custom_phase_two_config of this PhaseTwoConfigDetails. @@ -143,7 +143,7 @@ def is_custom_phase_two_config(self): def is_custom_phase_two_config(self, is_custom_phase_two_config): """ Sets the is_custom_phase_two_config of this PhaseTwoConfigDetails. - Indicates whether custom phase two configuration is enabled. + Indicates whether custom configuration is enabled for phase two options. :param is_custom_phase_two_config: The is_custom_phase_two_config of this PhaseTwoConfigDetails. @@ -155,7 +155,7 @@ def is_custom_phase_two_config(self, is_custom_phase_two_config): def authentication_algorithm(self): """ Gets the authentication_algorithm of this PhaseTwoConfigDetails. - Phase two authentication algorithm supported during tunnel negotiation. + The authentication algorithm proposed during phase two tunnel negotiation. Allowed values for this property are: "HMAC_SHA2_256_128", "HMAC_SHA1_128" @@ -169,7 +169,7 @@ def authentication_algorithm(self): def authentication_algorithm(self, authentication_algorithm): """ Sets the authentication_algorithm of this PhaseTwoConfigDetails. - Phase two authentication algorithm supported during tunnel negotiation. + The authentication algorithm proposed during phase two tunnel negotiation. :param authentication_algorithm: The authentication_algorithm of this PhaseTwoConfigDetails. @@ -187,7 +187,7 @@ def authentication_algorithm(self, authentication_algorithm): def encryption_algorithm(self): """ Gets the encryption_algorithm of this PhaseTwoConfigDetails. - Phase two encryption algorithm supported during tunnel negotiation. + The encryption algorithm proposed during phase two tunnel negotiation. Allowed values for this property are: "AES_256_GCM", "AES_192_GCM", "AES_128_GCM", "AES_256_CBC", "AES_192_CBC", "AES_128_CBC" @@ -201,7 +201,7 @@ def encryption_algorithm(self): def encryption_algorithm(self, encryption_algorithm): """ Sets the encryption_algorithm of this PhaseTwoConfigDetails. - Phase two encryption algorithm supported during tunnel negotiation. + The encryption algorithm proposed during phase two tunnel negotiation. :param encryption_algorithm: The encryption_algorithm of this PhaseTwoConfigDetails. @@ -219,7 +219,7 @@ def encryption_algorithm(self, encryption_algorithm): def lifetime_in_seconds(self): """ Gets the lifetime_in_seconds of this PhaseTwoConfigDetails. - Lifetime in seconds for IPSec phase two. + Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour. :return: The lifetime_in_seconds of this PhaseTwoConfigDetails. @@ -231,7 +231,7 @@ def lifetime_in_seconds(self): def lifetime_in_seconds(self, lifetime_in_seconds): """ Sets the lifetime_in_seconds of this PhaseTwoConfigDetails. - Lifetime in seconds for IPSec phase two. + Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour. :param lifetime_in_seconds: The lifetime_in_seconds of this PhaseTwoConfigDetails. @@ -267,7 +267,7 @@ def is_pfs_enabled(self, is_pfs_enabled): def pfs_dh_group(self): """ Gets the pfs_dh_group of this PhaseTwoConfigDetails. - Diffie-Hellman group used for PFS. + The Diffie-Hellman group used for PFS, if PFS is enabled. Allowed values for this property are: "GROUP2", "GROUP5", "GROUP14", "GROUP19", "GROUP20", "GROUP24" @@ -281,7 +281,7 @@ def pfs_dh_group(self): def pfs_dh_group(self, pfs_dh_group): """ Sets the pfs_dh_group of this PhaseTwoConfigDetails. - Diffie-Hellman group used for PFS. + The Diffie-Hellman group used for PFS, if PFS is enabled. :param pfs_dh_group: The pfs_dh_group of this PhaseTwoConfigDetails. diff --git a/src/oci/core/models/shape.py b/src/oci/core/models/shape.py index 5e38ee44a3..2d084cf0b5 100644 --- a/src/oci/core/models/shape.py +++ b/src/oci/core/models/shape.py @@ -30,6 +30,18 @@ class Shape(object): #: This constant has a value of "BASELINE_1_1" BASELINE_OCPU_UTILIZATIONS_BASELINE_1_1 = "BASELINE_1_1" + #: A constant which can be used with the billing_type property of a Shape. + #: This constant has a value of "ALWAYS_FREE" + BILLING_TYPE_ALWAYS_FREE = "ALWAYS_FREE" + + #: A constant which can be used with the billing_type property of a Shape. + #: This constant has a value of "LIMITED_FREE" + BILLING_TYPE_LIMITED_FREE = "LIMITED_FREE" + + #: A constant which can be used with the billing_type property of a Shape. + #: This constant has a value of "PAID" + BILLING_TYPE_PAID = "PAID" + def __init__(self, **kwargs): """ Initializes a new Shape object with values from keyword arguments. @@ -113,6 +125,36 @@ def __init__(self, **kwargs): The value to assign to the platform_config_options property of this Shape. :type platform_config_options: oci.core.models.ShapePlatformConfigOptions + :param is_billed_for_stopped_instance: + The value to assign to the is_billed_for_stopped_instance property of this Shape. + :type is_billed_for_stopped_instance: bool + + :param billing_type: + The value to assign to the billing_type property of this Shape. + Allowed values for this property are: "ALWAYS_FREE", "LIMITED_FREE", "PAID", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type billing_type: str + + :param quota_names: + The value to assign to the quota_names property of this Shape. + :type quota_names: list[str] + + :param is_subcore: + The value to assign to the is_subcore property of this Shape. + :type is_subcore: bool + + :param is_flexible: + The value to assign to the is_flexible property of this Shape. + :type is_flexible: bool + + :param resize_compatible_shapes: + The value to assign to the resize_compatible_shapes property of this Shape. + :type resize_compatible_shapes: list[str] + + :param recommended_alternatives: + The value to assign to the recommended_alternatives property of this Shape. + :type recommended_alternatives: list[oci.core.models.ShapeAlternativeObject] + """ self.swagger_types = { 'baseline_ocpu_utilizations': 'list[str]', @@ -133,7 +175,14 @@ def __init__(self, **kwargs): 'memory_options': 'ShapeMemoryOptions', 'networking_bandwidth_options': 'ShapeNetworkingBandwidthOptions', 'max_vnic_attachment_options': 'ShapeMaxVnicAttachmentOptions', - 'platform_config_options': 'ShapePlatformConfigOptions' + 'platform_config_options': 'ShapePlatformConfigOptions', + 'is_billed_for_stopped_instance': 'bool', + 'billing_type': 'str', + 'quota_names': 'list[str]', + 'is_subcore': 'bool', + 'is_flexible': 'bool', + 'resize_compatible_shapes': 'list[str]', + 'recommended_alternatives': 'list[ShapeAlternativeObject]' } self.attribute_map = { @@ -155,7 +204,14 @@ def __init__(self, **kwargs): 'memory_options': 'memoryOptions', 'networking_bandwidth_options': 'networkingBandwidthOptions', 'max_vnic_attachment_options': 'maxVnicAttachmentOptions', - 'platform_config_options': 'platformConfigOptions' + 'platform_config_options': 'platformConfigOptions', + 'is_billed_for_stopped_instance': 'isBilledForStoppedInstance', + 'billing_type': 'billingType', + 'quota_names': 'quotaNames', + 'is_subcore': 'isSubcore', + 'is_flexible': 'isFlexible', + 'resize_compatible_shapes': 'resizeCompatibleShapes', + 'recommended_alternatives': 'recommendedAlternatives' } self._baseline_ocpu_utilizations = None @@ -177,6 +233,13 @@ def __init__(self, **kwargs): self._networking_bandwidth_options = None self._max_vnic_attachment_options = None self._platform_config_options = None + self._is_billed_for_stopped_instance = None + self._billing_type = None + self._quota_names = None + self._is_subcore = None + self._is_flexible = None + self._resize_compatible_shapes = None + self._recommended_alternatives = None @property def baseline_ocpu_utilizations(self): @@ -636,6 +699,200 @@ def platform_config_options(self, platform_config_options): """ self._platform_config_options = platform_config_options + @property + def is_billed_for_stopped_instance(self): + """ + Gets the is_billed_for_stopped_instance of this Shape. + Whether billing continues when the instances that use this shape are in the stopped state. + + + :return: The is_billed_for_stopped_instance of this Shape. + :rtype: bool + """ + return self._is_billed_for_stopped_instance + + @is_billed_for_stopped_instance.setter + def is_billed_for_stopped_instance(self, is_billed_for_stopped_instance): + """ + Sets the is_billed_for_stopped_instance of this Shape. + Whether billing continues when the instances that use this shape are in the stopped state. + + + :param is_billed_for_stopped_instance: The is_billed_for_stopped_instance of this Shape. + :type: bool + """ + self._is_billed_for_stopped_instance = is_billed_for_stopped_instance + + @property + def billing_type(self): + """ + Gets the billing_type of this Shape. + How instances that use this shape are charged. + + Allowed values for this property are: "ALWAYS_FREE", "LIMITED_FREE", "PAID", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The billing_type of this Shape. + :rtype: str + """ + return self._billing_type + + @billing_type.setter + def billing_type(self, billing_type): + """ + Sets the billing_type of this Shape. + How instances that use this shape are charged. + + + :param billing_type: The billing_type of this Shape. + :type: str + """ + allowed_values = ["ALWAYS_FREE", "LIMITED_FREE", "PAID"] + if not value_allowed_none_or_none_sentinel(billing_type, allowed_values): + billing_type = 'UNKNOWN_ENUM_VALUE' + self._billing_type = billing_type + + @property + def quota_names(self): + """ + Gets the quota_names of this Shape. + The list of of compartment quotas for the shape. + + + :return: The quota_names of this Shape. + :rtype: list[str] + """ + return self._quota_names + + @quota_names.setter + def quota_names(self, quota_names): + """ + Sets the quota_names of this Shape. + The list of of compartment quotas for the shape. + + + :param quota_names: The quota_names of this Shape. + :type: list[str] + """ + self._quota_names = quota_names + + @property + def is_subcore(self): + """ + Gets the is_subcore of this Shape. + Whether the shape supports creating subcore or burstable instances. A `burstable instance`__ + is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional + spikes in usage. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/References/burstable-instances.htm + + + :return: The is_subcore of this Shape. + :rtype: bool + """ + return self._is_subcore + + @is_subcore.setter + def is_subcore(self, is_subcore): + """ + Sets the is_subcore of this Shape. + Whether the shape supports creating subcore or burstable instances. A `burstable instance`__ + is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional + spikes in usage. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/References/burstable-instances.htm + + + :param is_subcore: The is_subcore of this Shape. + :type: bool + """ + self._is_subcore = is_subcore + + @property + def is_flexible(self): + """ + Gets the is_flexible of this Shape. + Whether the shape supports creating flexible instances. A `flexible shape`__ + is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#flexible + + + :return: The is_flexible of this Shape. + :rtype: bool + """ + return self._is_flexible + + @is_flexible.setter + def is_flexible(self, is_flexible): + """ + Sets the is_flexible of this Shape. + Whether the shape supports creating flexible instances. A `flexible shape`__ + is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#flexible + + + :param is_flexible: The is_flexible of this Shape. + :type: bool + """ + self._is_flexible = is_flexible + + @property + def resize_compatible_shapes(self): + """ + Gets the resize_compatible_shapes of this Shape. + The list of compatible shapes that this shape can be changed to. For more information, + see `Changing the Shape of an Instance`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/resizinginstances.htm + + + :return: The resize_compatible_shapes of this Shape. + :rtype: list[str] + """ + return self._resize_compatible_shapes + + @resize_compatible_shapes.setter + def resize_compatible_shapes(self, resize_compatible_shapes): + """ + Sets the resize_compatible_shapes of this Shape. + The list of compatible shapes that this shape can be changed to. For more information, + see `Changing the Shape of an Instance`__. + + __ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/resizinginstances.htm + + + :param resize_compatible_shapes: The resize_compatible_shapes of this Shape. + :type: list[str] + """ + self._resize_compatible_shapes = resize_compatible_shapes + + @property + def recommended_alternatives(self): + """ + Gets the recommended_alternatives of this Shape. + The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape. + + + :return: The recommended_alternatives of this Shape. + :rtype: list[oci.core.models.ShapeAlternativeObject] + """ + return self._recommended_alternatives + + @recommended_alternatives.setter + def recommended_alternatives(self, recommended_alternatives): + """ + Sets the recommended_alternatives of this Shape. + The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape. + + + :param recommended_alternatives: The recommended_alternatives of this Shape. + :type: list[oci.core.models.ShapeAlternativeObject] + """ + self._recommended_alternatives = recommended_alternatives + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/core/models/shape_alternative_object.py b/src/oci/core/models/shape_alternative_object.py new file mode 100644 index 0000000000..91b6dd14b9 --- /dev/null +++ b/src/oci/core/models/shape_alternative_object.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ShapeAlternativeObject(object): + """ + The shape that Oracle recommends you to use an alternative to the current shape. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ShapeAlternativeObject object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param shape_name: + The value to assign to the shape_name property of this ShapeAlternativeObject. + :type shape_name: str + + """ + self.swagger_types = { + 'shape_name': 'str' + } + + self.attribute_map = { + 'shape_name': 'shapeName' + } + + self._shape_name = None + + @property + def shape_name(self): + """ + **[Required]** Gets the shape_name of this ShapeAlternativeObject. + The name of the shape. + + + :return: The shape_name of this ShapeAlternativeObject. + :rtype: str + """ + return self._shape_name + + @shape_name.setter + def shape_name(self, shape_name): + """ + Sets the shape_name of this ShapeAlternativeObject. + The name of the shape. + + + :param shape_name: The shape_name of this ShapeAlternativeObject. + :type: str + """ + self._shape_name = shape_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/core/models/tunnel_phase_one_details.py b/src/oci/core/models/tunnel_phase_one_details.py index 3b100a7f7a..67b408c200 100644 --- a/src/oci/core/models/tunnel_phase_one_details.py +++ b/src/oci/core/models/tunnel_phase_one_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TunnelPhaseOneDetails(object): """ - Tunnel detail information specific to IPSec phase 1. + IPSec tunnel details specific to ISAKMP phase one. """ def __init__(self, **kwargs): @@ -108,6 +108,7 @@ def is_custom_phase_one_config(self): """ Gets the is_custom_phase_one_config of this TunnelPhaseOneDetails. Indicates whether custom phase one configuration is enabled. + If this option is not enabled, default settings are proposed. :return: The is_custom_phase_one_config of this TunnelPhaseOneDetails. @@ -120,6 +121,7 @@ def is_custom_phase_one_config(self, is_custom_phase_one_config): """ Sets the is_custom_phase_one_config of this TunnelPhaseOneDetails. Indicates whether custom phase one configuration is enabled. + If this option is not enabled, default settings are proposed. :param is_custom_phase_one_config: The is_custom_phase_one_config of this TunnelPhaseOneDetails. @@ -131,7 +133,7 @@ def is_custom_phase_one_config(self, is_custom_phase_one_config): def lifetime(self): """ Gets the lifetime of this TunnelPhaseOneDetails. - The total configured lifetime of an IKE security association. + The total configured lifetime of the IKE security association. :return: The lifetime of this TunnelPhaseOneDetails. @@ -143,7 +145,7 @@ def lifetime(self): def lifetime(self, lifetime): """ Sets the lifetime of this TunnelPhaseOneDetails. - The total configured lifetime of an IKE security association. + The total configured lifetime of the IKE security association. :param lifetime: The lifetime of this TunnelPhaseOneDetails. @@ -155,7 +157,7 @@ def lifetime(self, lifetime): def remaining_lifetime(self): """ Gets the remaining_lifetime of this TunnelPhaseOneDetails. - The lifetime remaining before the key is refreshed. + The remaining lifetime before the key is refreshed. :return: The remaining_lifetime of this TunnelPhaseOneDetails. @@ -167,7 +169,7 @@ def remaining_lifetime(self): def remaining_lifetime(self, remaining_lifetime): """ Sets the remaining_lifetime of this TunnelPhaseOneDetails. - The lifetime remaining before the key is refreshed. + The remaining lifetime before the key is refreshed. :param remaining_lifetime: The remaining_lifetime of this TunnelPhaseOneDetails. @@ -179,7 +181,7 @@ def remaining_lifetime(self, remaining_lifetime): def custom_authentication_algorithm(self): """ Gets the custom_authentication_algorithm of this TunnelPhaseOneDetails. - Custom authentication algorithm + The proposed custom authentication algorithm. :return: The custom_authentication_algorithm of this TunnelPhaseOneDetails. @@ -191,7 +193,7 @@ def custom_authentication_algorithm(self): def custom_authentication_algorithm(self, custom_authentication_algorithm): """ Sets the custom_authentication_algorithm of this TunnelPhaseOneDetails. - Custom authentication algorithm + The proposed custom authentication algorithm. :param custom_authentication_algorithm: The custom_authentication_algorithm of this TunnelPhaseOneDetails. @@ -227,7 +229,7 @@ def negotiated_authentication_algorithm(self, negotiated_authentication_algorith def custom_encryption_algorithm(self): """ Gets the custom_encryption_algorithm of this TunnelPhaseOneDetails. - Custom encryption algorithm. + The proposed custom encryption algorithm. :return: The custom_encryption_algorithm of this TunnelPhaseOneDetails. @@ -239,7 +241,7 @@ def custom_encryption_algorithm(self): def custom_encryption_algorithm(self, custom_encryption_algorithm): """ Sets the custom_encryption_algorithm of this TunnelPhaseOneDetails. - Custom encryption algorithm. + The proposed custom encryption algorithm. :param custom_encryption_algorithm: The custom_encryption_algorithm of this TunnelPhaseOneDetails. @@ -275,7 +277,7 @@ def negotiated_encryption_algorithm(self, negotiated_encryption_algorithm): def custom_dh_group(self): """ Gets the custom_dh_group of this TunnelPhaseOneDetails. - Custom Diffie-Hellman group. + The proposed custom Diffie-Hellman group. :return: The custom_dh_group of this TunnelPhaseOneDetails. @@ -287,7 +289,7 @@ def custom_dh_group(self): def custom_dh_group(self, custom_dh_group): """ Sets the custom_dh_group of this TunnelPhaseOneDetails. - Custom Diffie-Hellman group. + The proposed custom Diffie-Hellman group. :param custom_dh_group: The custom_dh_group of this TunnelPhaseOneDetails. @@ -323,7 +325,7 @@ def negotiated_dh_group(self, negotiated_dh_group): def is_ike_established(self): """ Gets the is_ike_established of this TunnelPhaseOneDetails. - Indicates whether IKE Phase 1 is established. + Indicates whether IKE phase one is established. :return: The is_ike_established of this TunnelPhaseOneDetails. @@ -335,7 +337,7 @@ def is_ike_established(self): def is_ike_established(self, is_ike_established): """ Sets the is_ike_established of this TunnelPhaseOneDetails. - Indicates whether IKE Phase 1 is established. + Indicates whether IKE phase one is established. :param is_ike_established: The is_ike_established of this TunnelPhaseOneDetails. diff --git a/src/oci/core/models/tunnel_phase_two_details.py b/src/oci/core/models/tunnel_phase_two_details.py index 101fb79dd0..d4305e8d96 100644 --- a/src/oci/core/models/tunnel_phase_two_details.py +++ b/src/oci/core/models/tunnel_phase_two_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TunnelPhaseTwoDetails(object): """ - Tunnel detail information specific to IPSec phase 2. + IPsec tunnel detail information specific to phase two. """ def __init__(self, **kwargs): @@ -115,6 +115,7 @@ def is_custom_phase_two_config(self): """ Gets the is_custom_phase_two_config of this TunnelPhaseTwoDetails. Indicates whether custom phase two configuration is enabled. + If this option is not enabled, default settings are proposed. :return: The is_custom_phase_two_config of this TunnelPhaseTwoDetails. @@ -127,6 +128,7 @@ def is_custom_phase_two_config(self, is_custom_phase_two_config): """ Sets the is_custom_phase_two_config of this TunnelPhaseTwoDetails. Indicates whether custom phase two configuration is enabled. + If this option is not enabled, default settings are proposed. :param is_custom_phase_two_config: The is_custom_phase_two_config of this TunnelPhaseTwoDetails. @@ -138,7 +140,7 @@ def is_custom_phase_two_config(self, is_custom_phase_two_config): def lifetime(self): """ Gets the lifetime of this TunnelPhaseTwoDetails. - The total configured lifetime of an IKE security association. + The total configured lifetime of the IKE security association. :return: The lifetime of this TunnelPhaseTwoDetails. @@ -150,7 +152,7 @@ def lifetime(self): def lifetime(self, lifetime): """ Sets the lifetime of this TunnelPhaseTwoDetails. - The total configured lifetime of an IKE security association. + The total configured lifetime of the IKE security association. :param lifetime: The lifetime of this TunnelPhaseTwoDetails. @@ -162,7 +164,7 @@ def lifetime(self, lifetime): def remaining_lifetime(self): """ Gets the remaining_lifetime of this TunnelPhaseTwoDetails. - The lifetime remaining before the key is refreshed. + The remaining lifetime before the key is refreshed. :return: The remaining_lifetime of this TunnelPhaseTwoDetails. @@ -174,7 +176,7 @@ def remaining_lifetime(self): def remaining_lifetime(self, remaining_lifetime): """ Sets the remaining_lifetime of this TunnelPhaseTwoDetails. - The lifetime remaining before the key is refreshed. + The remaining lifetime before the key is refreshed. :param remaining_lifetime: The remaining_lifetime of this TunnelPhaseTwoDetails. @@ -186,7 +188,7 @@ def remaining_lifetime(self, remaining_lifetime): def custom_authentication_algorithm(self): """ Gets the custom_authentication_algorithm of this TunnelPhaseTwoDetails. - Phase Two authentication algorithm supported during tunnel negotiation. + Phase two authentication algorithm proposed during tunnel negotiation. :return: The custom_authentication_algorithm of this TunnelPhaseTwoDetails. @@ -198,7 +200,7 @@ def custom_authentication_algorithm(self): def custom_authentication_algorithm(self, custom_authentication_algorithm): """ Sets the custom_authentication_algorithm of this TunnelPhaseTwoDetails. - Phase Two authentication algorithm supported during tunnel negotiation. + Phase two authentication algorithm proposed during tunnel negotiation. :param custom_authentication_algorithm: The custom_authentication_algorithm of this TunnelPhaseTwoDetails. @@ -210,7 +212,7 @@ def custom_authentication_algorithm(self, custom_authentication_algorithm): def negotiated_authentication_algorithm(self): """ Gets the negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. - The negotiated authentication algorithm. + The negotiated phase two authentication algorithm. :return: The negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. @@ -222,7 +224,7 @@ def negotiated_authentication_algorithm(self): def negotiated_authentication_algorithm(self, negotiated_authentication_algorithm): """ Sets the negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. - The negotiated authentication algorithm. + The negotiated phase two authentication algorithm. :param negotiated_authentication_algorithm: The negotiated_authentication_algorithm of this TunnelPhaseTwoDetails. @@ -234,7 +236,7 @@ def negotiated_authentication_algorithm(self, negotiated_authentication_algorith def custom_encryption_algorithm(self): """ Gets the custom_encryption_algorithm of this TunnelPhaseTwoDetails. - Custom Encryption Algorithm + The proposed custom phase two encryption algorithm. :return: The custom_encryption_algorithm of this TunnelPhaseTwoDetails. @@ -246,7 +248,7 @@ def custom_encryption_algorithm(self): def custom_encryption_algorithm(self, custom_encryption_algorithm): """ Sets the custom_encryption_algorithm of this TunnelPhaseTwoDetails. - Custom Encryption Algorithm + The proposed custom phase two encryption algorithm. :param custom_encryption_algorithm: The custom_encryption_algorithm of this TunnelPhaseTwoDetails. @@ -282,7 +284,7 @@ def negotiated_encryption_algorithm(self, negotiated_encryption_algorithm): def dh_group(self): """ Gets the dh_group of this TunnelPhaseTwoDetails. - Proposed Diffie-Hellman group. + The proposed Diffie-Hellman group. :return: The dh_group of this TunnelPhaseTwoDetails. @@ -294,7 +296,7 @@ def dh_group(self): def dh_group(self, dh_group): """ Sets the dh_group of this TunnelPhaseTwoDetails. - Proposed Diffie-Hellman group. + The proposed Diffie-Hellman group. :param dh_group: The dh_group of this TunnelPhaseTwoDetails. @@ -330,7 +332,7 @@ def negotiated_dh_group(self, negotiated_dh_group): def is_esp_established(self): """ Gets the is_esp_established of this TunnelPhaseTwoDetails. - ESP Phase 2 established + Indicates that ESP phase two is established. :return: The is_esp_established of this TunnelPhaseTwoDetails. @@ -342,7 +344,7 @@ def is_esp_established(self): def is_esp_established(self, is_esp_established): """ Sets the is_esp_established of this TunnelPhaseTwoDetails. - ESP Phase 2 established + Indicates that ESP phase two is established. :param is_esp_established: The is_esp_established of this TunnelPhaseTwoDetails. @@ -354,7 +356,7 @@ def is_esp_established(self, is_esp_established): def is_pfs_enabled(self): """ Gets the is_pfs_enabled of this TunnelPhaseTwoDetails. - Is PFS (perfect forward secrecy) enabled + Indicates that PFS (perfect forward secrecy) is enabled. :return: The is_pfs_enabled of this TunnelPhaseTwoDetails. @@ -366,7 +368,7 @@ def is_pfs_enabled(self): def is_pfs_enabled(self, is_pfs_enabled): """ Sets the is_pfs_enabled of this TunnelPhaseTwoDetails. - Is PFS (perfect forward secrecy) enabled + Indicates that PFS (perfect forward secrecy) is enabled. :param is_pfs_enabled: The is_pfs_enabled of this TunnelPhaseTwoDetails. @@ -378,7 +380,7 @@ def is_pfs_enabled(self, is_pfs_enabled): def remaining_lifetime_last_retrieved(self): """ Gets the remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. - The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + The date and time the remaining lifetime was last retrieved, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` @@ -394,7 +396,7 @@ def remaining_lifetime_last_retrieved(self): def remaining_lifetime_last_retrieved(self, remaining_lifetime_last_retrieved): """ Sets the remaining_lifetime_last_retrieved of this TunnelPhaseTwoDetails. - The date and time we retrieved the remaining lifetime, in the format defined by `RFC3339`__. + The date and time the remaining lifetime was last retrieved, in the format defined by `RFC3339`__. Example: `2016-08-25T21:10:29.600Z` diff --git a/src/oci/core/models/tunnel_route_summary.py b/src/oci/core/models/tunnel_route_summary.py index 1c36ef60af..efc4fbe1ea 100644 --- a/src/oci/core/models/tunnel_route_summary.py +++ b/src/oci/core/models/tunnel_route_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TunnelRouteSummary(object): """ - The routes advertised to the Customer and the routes received from the Customer + A summary of the routes advertised to and received from the on-premises network. """ #: A constant which can be used with the advertiser property of a TunnelRouteSummary. @@ -75,7 +75,7 @@ def __init__(self, **kwargs): def prefix(self): """ Gets the prefix of this TunnelRouteSummary. - BGP Network Layer Reachability Information + The BGP network layer reachability information. :return: The prefix of this TunnelRouteSummary. @@ -87,7 +87,7 @@ def prefix(self): def prefix(self, prefix): """ Sets the prefix of this TunnelRouteSummary. - BGP Network Layer Reachability Information + The BGP network layer reachability information. :param prefix: The prefix of this TunnelRouteSummary. @@ -99,7 +99,7 @@ def prefix(self, prefix): def age(self): """ Gets the age of this TunnelRouteSummary. - The age of the route + The age of the route. :return: The age of this TunnelRouteSummary. @@ -111,7 +111,7 @@ def age(self): def age(self, age): """ Sets the age of this TunnelRouteSummary. - The age of the route + The age of the route. :param age: The age of this TunnelRouteSummary. @@ -123,7 +123,7 @@ def age(self, age): def is_best_path(self): """ Gets the is_best_path of this TunnelRouteSummary. - Is this the best route + Indicates this is the best route. :return: The is_best_path of this TunnelRouteSummary. @@ -135,7 +135,7 @@ def is_best_path(self): def is_best_path(self, is_best_path): """ Sets the is_best_path of this TunnelRouteSummary. - Is this the best route + Indicates this is the best route. :param is_best_path: The is_best_path of this TunnelRouteSummary. @@ -147,7 +147,7 @@ def is_best_path(self, is_best_path): def as_path(self): """ Gets the as_path of this TunnelRouteSummary. - List of ASNs in AS Path + A list of ASNs in AS_Path. :return: The as_path of this TunnelRouteSummary. @@ -159,7 +159,7 @@ def as_path(self): def as_path(self, as_path): """ Sets the as_path of this TunnelRouteSummary. - List of ASNs in AS Path + A list of ASNs in AS_Path. :param as_path: The as_path of this TunnelRouteSummary. @@ -171,7 +171,7 @@ def as_path(self, as_path): def advertiser(self): """ Gets the advertiser of this TunnelRouteSummary. - Route advertiser + The source of the route advertisement. Allowed values for this property are: "CUSTOMER", "ORACLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -186,7 +186,7 @@ def advertiser(self): def advertiser(self, advertiser): """ Sets the advertiser of this TunnelRouteSummary. - Route advertiser + The source of the route advertisement. :param advertiser: The advertiser of this TunnelRouteSummary. diff --git a/src/oci/core/models/tunnel_security_association_summary.py b/src/oci/core/models/tunnel_security_association_summary.py index 2960700a70..396603aa58 100644 --- a/src/oci/core/models/tunnel_security_association_summary.py +++ b/src/oci/core/models/tunnel_security_association_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class TunnelSecurityAssociationSummary(object): """ - Detailed Tunnel SA + A summary of the IPSec tunnel security association details. """ #: A constant which can be used with the tunnel_sa_status property of a TunnelSecurityAssociationSummary. @@ -91,7 +91,7 @@ def __init__(self, **kwargs): def cpe_subnet(self): """ Gets the cpe_subnet of this TunnelSecurityAssociationSummary. - IP and mask of the Partner Subnet for Policy Based VPNs or Static Routes + The IP address and mask of the partner subnet used in policy based VPNs or static routes. :return: The cpe_subnet of this TunnelSecurityAssociationSummary. @@ -103,7 +103,7 @@ def cpe_subnet(self): def cpe_subnet(self, cpe_subnet): """ Sets the cpe_subnet of this TunnelSecurityAssociationSummary. - IP and mask of the Partner Subnet for Policy Based VPNs or Static Routes + The IP address and mask of the partner subnet used in policy based VPNs or static routes. :param cpe_subnet: The cpe_subnet of this TunnelSecurityAssociationSummary. @@ -115,7 +115,7 @@ def cpe_subnet(self, cpe_subnet): def oracle_subnet(self): """ Gets the oracle_subnet of this TunnelSecurityAssociationSummary. - IP and mask of the Local Subnet for Policy Based VPNs or Static Routes + The IP address and mask of the local subnet used in policy based VPNs or static routes. :return: The oracle_subnet of this TunnelSecurityAssociationSummary. @@ -127,7 +127,7 @@ def oracle_subnet(self): def oracle_subnet(self, oracle_subnet): """ Sets the oracle_subnet of this TunnelSecurityAssociationSummary. - IP and mask of the Local Subnet for Policy Based VPNs or Static Routes + The IP address and mask of the local subnet used in policy based VPNs or static routes. :param oracle_subnet: The oracle_subnet of this TunnelSecurityAssociationSummary. @@ -139,7 +139,7 @@ def oracle_subnet(self, oracle_subnet): def tunnel_sa_status(self): """ Gets the tunnel_sa_status of this TunnelSecurityAssociationSummary. - Phase 1 Status of the Tunnel + The IPSec tunnel's phase one status. Allowed values for this property are: "INITIATING", "LISTENING", "UP", "DOWN", "ERROR", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -154,7 +154,7 @@ def tunnel_sa_status(self): def tunnel_sa_status(self, tunnel_sa_status): """ Sets the tunnel_sa_status of this TunnelSecurityAssociationSummary. - Phase 1 Status of the Tunnel + The IPSec tunnel's phase one status. :param tunnel_sa_status: The tunnel_sa_status of this TunnelSecurityAssociationSummary. @@ -169,7 +169,7 @@ def tunnel_sa_status(self, tunnel_sa_status): def tunnel_sa_error_info(self): """ Gets the tunnel_sa_error_info of this TunnelSecurityAssociationSummary. - Current state if status is not up, including phase1/phase2 and possible reason for tunnel not up + Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`. :return: The tunnel_sa_error_info of this TunnelSecurityAssociationSummary. @@ -181,7 +181,7 @@ def tunnel_sa_error_info(self): def tunnel_sa_error_info(self, tunnel_sa_error_info): """ Sets the tunnel_sa_error_info of this TunnelSecurityAssociationSummary. - Current state if status is not up, including phase1/phase2 and possible reason for tunnel not up + Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`. :param tunnel_sa_error_info: The tunnel_sa_error_info of this TunnelSecurityAssociationSummary. @@ -193,7 +193,7 @@ def tunnel_sa_error_info(self, tunnel_sa_error_info): def time(self): """ Gets the time of this TunnelSecurityAssociationSummary. - Seconds in current state + Time in the current state, in seconds. :return: The time of this TunnelSecurityAssociationSummary. @@ -205,7 +205,7 @@ def time(self): def time(self, time): """ Sets the time of this TunnelSecurityAssociationSummary. - Seconds in current state + Time in the current state, in seconds. :param time: The time of this TunnelSecurityAssociationSummary. diff --git a/src/oci/core/models/update_boot_volume_details.py b/src/oci/core/models/update_boot_volume_details.py index 4514cfc1bf..c7954584e6 100644 --- a/src/oci/core/models/update_boot_volume_details.py +++ b/src/oci/core/models/update_boot_volume_details.py @@ -207,6 +207,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -229,6 +231,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -241,7 +245,8 @@ def vpus_per_gb(self, vpus_per_gb): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this UpdateBootVolumeDetails. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this UpdateBootVolumeDetails. @@ -253,7 +258,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this UpdateBootVolumeDetails. - Specifies whether the auto-tune performance is enabled for this boot volume. + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this UpdateBootVolumeDetails. diff --git a/src/oci/core/models/update_drg_route_distribution_statement_details.py b/src/oci/core/models/update_drg_route_distribution_statement_details.py index a13e9651cb..63718971ee 100644 --- a/src/oci/core/models/update_drg_route_distribution_statement_details.py +++ b/src/oci/core/models/update_drg_route_distribution_statement_details.py @@ -76,7 +76,6 @@ def match_criteria(self): """ Gets the match_criteria of this UpdateDrgRouteDistributionStatementDetails. The action is applied only if all of the match criteria is met. - If there are no match criteria in a statement, match ALL is implied. :return: The match_criteria of this UpdateDrgRouteDistributionStatementDetails. @@ -89,7 +88,6 @@ def match_criteria(self, match_criteria): """ Sets the match_criteria of this UpdateDrgRouteDistributionStatementDetails. The action is applied only if all of the match criteria is met. - If there are no match criteria in a statement, match ALL is implied. :param match_criteria: The match_criteria of this UpdateDrgRouteDistributionStatementDetails. diff --git a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py index c507b9b231..7c1ce37868 100644 --- a/src/oci/core/models/update_ip_sec_connection_tunnel_details.py +++ b/src/oci/core/models/update_ip_sec_connection_tunnel_details.py @@ -170,7 +170,7 @@ def display_name(self, display_name): def routing(self): """ Gets the routing of this UpdateIPSecConnectionTunnelDetails. - The type of routing to use for this tunnel (either BGP dynamic routing or static routing). + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). Allowed values for this property are: "BGP", "STATIC", "POLICY" @@ -184,7 +184,7 @@ def routing(self): def routing(self, routing): """ Sets the routing of this UpdateIPSecConnectionTunnelDetails. - The type of routing to use for this tunnel (either BGP dynamic routing or static routing). + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). :param routing: The routing of this UpdateIPSecConnectionTunnelDetails. @@ -254,7 +254,7 @@ def bgp_session_config(self, bgp_session_config): def oracle_initiation(self): """ Gets the oracle_initiation of this UpdateIPSecConnectionTunnelDetails. - Whether Oracle side is the initiator for negotiation. + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. Allowed values for this property are: "INITIATOR_OR_RESPONDER", "RESPONDER_ONLY" @@ -268,7 +268,7 @@ def oracle_initiation(self): def oracle_initiation(self, oracle_initiation): """ Sets the oracle_initiation of this UpdateIPSecConnectionTunnelDetails. - Whether Oracle side is the initiator for negotiation. + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. :param oracle_initiation: The oracle_initiation of this UpdateIPSecConnectionTunnelDetails. @@ -286,7 +286,14 @@ def oracle_initiation(self, oracle_initiation): def nat_translation_enabled(self): """ Gets the nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. Allowed values for this property are: "ENABLED", "DISABLED", "AUTO" @@ -300,7 +307,14 @@ def nat_translation_enabled(self): def nat_translation_enabled(self, nat_translation_enabled): """ Sets the nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. - Whether NAT-T Enabled on the tunnel + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. :param nat_translation_enabled: The nat_translation_enabled of this UpdateIPSecConnectionTunnelDetails. diff --git a/src/oci/core/models/update_volume_details.py b/src/oci/core/models/update_volume_details.py index 9ccf924a4f..8c051b82b0 100644 --- a/src/oci/core/models/update_volume_details.py +++ b/src/oci/core/models/update_volume_details.py @@ -185,6 +185,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -209,6 +211,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -245,7 +249,8 @@ def size_in_gbs(self, size_in_gbs): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this UpdateVolumeDetails. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this UpdateVolumeDetails. @@ -257,7 +262,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this UpdateVolumeDetails. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this UpdateVolumeDetails. diff --git a/src/oci/core/models/volume.py b/src/oci/core/models/volume.py index 0d41804d76..349c0b7929 100644 --- a/src/oci/core/models/volume.py +++ b/src/oci/core/models/volume.py @@ -487,6 +487,8 @@ def vpus_per_gb(self): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -511,6 +513,8 @@ def vpus_per_gb(self, vpus_per_gb): * `20`: Represents Higher Performance option. + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm @@ -645,7 +649,8 @@ def volume_group_id(self, volume_group_id): def is_auto_tune_enabled(self): """ Gets the is_auto_tune_enabled of this Volume. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :return: The is_auto_tune_enabled of this Volume. @@ -657,7 +662,8 @@ def is_auto_tune_enabled(self): def is_auto_tune_enabled(self, is_auto_tune_enabled): """ Sets the is_auto_tune_enabled of this Volume. - Specifies whether the auto-tune performance is enabled for this volume. + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. :param is_auto_tune_enabled: The is_auto_tune_enabled of this Volume. @@ -669,7 +675,7 @@ def is_auto_tune_enabled(self, is_auto_tune_enabled): def auto_tuned_vpus_per_gb(self): """ Gets the auto_tuned_vpus_per_gb of this Volume. - The number of Volume Performance Units per GB that this volume is effectively tuned to when it's idle. + The number of Volume Performance Units per GB that this volume is effectively tuned to. :return: The auto_tuned_vpus_per_gb of this Volume. @@ -681,7 +687,7 @@ def auto_tuned_vpus_per_gb(self): def auto_tuned_vpus_per_gb(self, auto_tuned_vpus_per_gb): """ Sets the auto_tuned_vpus_per_gb of this Volume. - The number of Volume Performance Units per GB that this volume is effectively tuned to when it's idle. + The number of Volume Performance Units per GB that this volume is effectively tuned to. :param auto_tuned_vpus_per_gb: The auto_tuned_vpus_per_gb of this Volume. diff --git a/src/oci/core/virtual_network_client.py b/src/oci/core/virtual_network_client.py index ba5c21fa7a..060d6530ec 100644 --- a/src/oci/core/virtual_network_client.py +++ b/src/oci/core/virtual_network_client.py @@ -8442,7 +8442,7 @@ def get_all_drg_attachments(self, drg_id, **kwargs): def get_allowed_ike_ip_sec_parameters(self, **kwargs): """ - The allowed parameters for IKE IPSec + The parameters allowed for IKE IPSec tunnels. :param str opc_request_id: (optional) @@ -10207,7 +10207,7 @@ def get_ip_sec_connection_tunnel(self, ipsc_id, tunnel_id, **kwargs): def get_ip_sec_connection_tunnel_error(self, ipsc_id, tunnel_id, **kwargs): """ - Get the identified error for the specified IPSec Tunnel ID. + Gets the identified error for the specified IPSec tunnel ID. :param str ipsc_id: (required) @@ -15278,7 +15278,7 @@ def list_internet_gateways(self, compartment_id, **kwargs): def list_ip_sec_connection_tunnel_routes(self, ipsc_id, tunnel_id, **kwargs): """ - The routes advertised to the Customer and the routes received from the Customer. + The routes advertised to the on-premises network and the routes received from the on-premises network. :param str ipsc_id: (required) @@ -15308,9 +15308,9 @@ def list_ip_sec_connection_tunnel_routes(self, ipsc_id, tunnel_id, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str advertiser: (optional) - Specifies the advertiser of the routes. If set to ORACLE, then returns only the - routes advertised by ORACLE, else if set to CUSTOMER, then returns only the - routes advertised by the CUSTOMER. + Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the + routes advertised by Oracle. When set to `CUSTOMER`, this returns only the + routes advertised by the CPE. Allowed values are: "CUSTOMER", "ORACLE" @@ -15406,7 +15406,7 @@ def list_ip_sec_connection_tunnel_routes(self, ipsc_id, tunnel_id, **kwargs): def list_ip_sec_connection_tunnel_security_associations(self, ipsc_id, tunnel_id, **kwargs): """ - Lists the tunnel Security Associations information for the specified IPSec Tunnel ID. + Lists the tunnel security associations information for the specified IPSec tunnel ID. :param str ipsc_id: (required) diff --git a/src/oci/data_connectivity/__init__.py b/src/oci/data_connectivity/__init__.py new file mode 100644 index 0000000000..17104371aa --- /dev/null +++ b/src/oci/data_connectivity/__init__.py @@ -0,0 +1,14 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + + +from .data_connectivity_management_client import DataConnectivityManagementClient +from .data_connectivity_management_client_composite_operations import DataConnectivityManagementClientCompositeOperations +from .network_validation_client import NetworkValidationClient +from .network_validation_client_composite_operations import NetworkValidationClientCompositeOperations +from . import models + +__all__ = ["DataConnectivityManagementClient", "DataConnectivityManagementClientCompositeOperations", "NetworkValidationClient", "NetworkValidationClientCompositeOperations", "models"] diff --git a/src/oci/data_connectivity/data_connectivity_management_client.py b/src/oci/data_connectivity/data_connectivity_management_client.py new file mode 100644 index 0000000000..7c146e0fbe --- /dev/null +++ b/src/oci/data_connectivity/data_connectivity_management_client.py @@ -0,0 +1,6832 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import data_connectivity_type_mapping +missing = Sentinel("Missing") + + +class DataConnectivityManagementClient(object): + """ + Use the DCMS APIs to perform Metadata/Data operations. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20210217', + 'service_endpoint_template': 'https://dataconnectivity.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("data_connectivity_management", config, signer, data_connectivity_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def change_endpoint_compartment(self, endpoint_id, change_endpoint_compartment_details, **kwargs): + """ + The Endpoint will be moved to the desired compartment. + + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.ChangeEndpointCompartmentDetails change_endpoint_compartment_details: (required) + The details of change compartment action. + + :param str registry_id: (optional) + DCMS registry 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_endpoint_compartment API. + """ + resource_path = "/endpoints/{endpointId}/actions/changeCompartment" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_endpoint_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "registryId": kwargs.get("registry_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=change_endpoint_compartment_details) + 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_endpoint_compartment_details) + + def change_registry_compartment(self, registry_id, change_registry_compartment_details, **kwargs): + """ + The registry will be moved to the desired compartment. + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.ChangeRegistryCompartmentDetails change_registry_compartment_details: (required) + The details of change compartment action. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use change_registry_compartment API. + """ + resource_path = "/registries/{registryId}/actions/changeCompartment" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "change_registry_compartment got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_registry_compartment_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=change_registry_compartment_details) + + def create_attach_data_asset(self, registry_id, endpoint_id, create_attach_data_asset_details, **kwargs): + """ + Attaches list of DataAssets to the given endpoint + + + :param str registry_id: (required) + The registry Ocid. + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.CreateAttachDataAssetDetails create_attach_data_asset_details: (required) + Request body parameters to attach data asset to an private endpoint + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.AttachDataAssetInfo` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_attach_data_asset API. + """ + resource_path = "/registries/{registryId}/endpoints/{endpointId}/actions/attachDataAssets" + method = "POST" + + # 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( + "create_attach_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_attach_data_asset_details, + response_type="AttachDataAssetInfo") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_attach_data_asset_details, + response_type="AttachDataAssetInfo") + + def create_connection(self, registry_id, create_connection_details, **kwargs): + """ + Creates a connection under an existing data asset. + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateConnectionDetails create_connection_details: (required) + The information needed to create a connection. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Connection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_connection API. + """ + resource_path = "/registries/{registryId}/connections" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_connection_details, + response_type="Connection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_connection_details, + response_type="Connection") + + def create_connection_validation(self, registry_id, create_connection_validation_details, **kwargs): + """ + Creates a connection validation. + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateConnectionValidationDetails create_connection_validation_details: (required) + The information needed to validate a connection. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ConnectionValidation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_connection_validation API. + """ + resource_path = "/registries/{registryId}/connectionValidations" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_connection_validation got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + query_params=query_params, + header_params=header_params, + body=create_connection_validation_details, + response_type="ConnectionValidation") + 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=create_connection_validation_details, + response_type="ConnectionValidation") + + def create_connectivity_validation(self, registry_id, create_connectivity_validation_details, **kwargs): + """ + This endpoint is used to trigger validation of dataAsset, connection, schema, entity, dataOperationConfig + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateConnectivityValidationDetails create_connectivity_validation_details: (required) + Request body parameters to trigger connectivity validations + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ConnectivityValidation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_connectivity_validation API. + """ + resource_path = "/registries/{registryId}/actions/connectivityValidation" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_connectivity_validation got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + query_params=query_params, + header_params=header_params, + body=create_connectivity_validation_details, + response_type="ConnectivityValidation") + 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=create_connectivity_validation_details, + response_type="ConnectivityValidation") + + def create_data_asset(self, registry_id, create_data_asset_details, **kwargs): + """ + Creates a data asset with default connection. + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateDataAssetDetails create_data_asset_details: (required) + The information needed to create a data asset. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_data_asset API. + """ + resource_path = "/registries/{registryId}/dataAssets" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_data_asset_details, + response_type="DataAsset") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_data_asset_details, + response_type="DataAsset") + + def create_data_preview(self, registry_id, create_data_preview_details, **kwargs): + """ + Provide data preview on live schema + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateDataPreviewDetails create_data_preview_details: (required) + Request body parameters to provide data preview + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataPreview` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_data_preview API. + """ + resource_path = "/registries/{registryId}/actions/dataPreview" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_data_preview got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=create_data_preview_details, + response_type="DataPreview") + 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=create_data_preview_details, + response_type="DataPreview") + + def create_data_profile(self, registry_id, create_data_profile_details, **kwargs): + """ + Execute data profiling on live schema + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateDataProfileDetails create_data_profile_details: (required) + Request body parameters to execute data profiling + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataProfile` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_data_profile API. + """ + resource_path = "/registries/{registryId}/actions/dataProfile" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_data_profile got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=create_data_profile_details, + response_type="DataProfile") + 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=create_data_profile_details, + response_type="DataProfile") + + def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_reference_artifact_details, **kwargs): + """ + DeRereferenced a dcms artifact. + + + :param str registry_id: (required) + The registry Ocid. + + :param str dcms_artifact_id: (required) + The ID of a dcms artifact (DataAsset or Endpoint). + + :param oci.data_connectivity.models.CreateDeReferenceArtifactDetails create_de_reference_artifact_details: (required) + The information needed to delete a dcms artifact reference. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DeReferenceInfo` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_de_reference_artifact API. + """ + resource_path = "/registries/{registryId}/dcmsArtifacts/{dcmsArtifactId}/actions/deReferenceArtifact" + method = "POST" + + # 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( + "create_de_reference_artifact got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dcmsArtifactId": dcms_artifact_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_de_reference_artifact_details, + response_type="DeReferenceInfo") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_de_reference_artifact_details, + response_type="DeReferenceInfo") + + def create_detach_data_asset(self, registry_id, endpoint_id, create_detach_data_asset_details, **kwargs): + """ + Detaches list of DataAssets to the given endpoint + + + :param str registry_id: (required) + The registry Ocid. + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.CreateDetachDataAssetDetails create_detach_data_asset_details: (required) + Request body parameters to detach data asset to an private endpoint + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DetachDataAssetInfo` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_detach_data_asset API. + """ + resource_path = "/registries/{registryId}/endpoints/{endpointId}/actions/detachDataAssets" + method = "POST" + + # 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( + "create_detach_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_detach_data_asset_details, + response_type="DetachDataAssetInfo") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_detach_data_asset_details, + response_type="DetachDataAssetInfo") + + def create_endpoint(self, create_endpoint_details, **kwargs): + """ + Creates a new Data Connectivity Management Endpoint ready for performing data Connectivity. + + + :param oci.data_connectivity.models.CreateEndpointDetails create_endpoint_details: (required) + Details for the new Data Connectivity Management Endpoint. + + :param str registry_id: (optional) + DCMS registry id + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_endpoint API. + """ + resource_path = "/endpoints" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_endpoint got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "registryId": kwargs.get("registry_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-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, + query_params=query_params, + header_params=header_params, + body=create_endpoint_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + body=create_endpoint_details) + + def create_entity_shape(self, registry_id, connection_key, schema_resource_name, create_entity_shape_details, **kwargs): + """ + Creates the data entity shape using the shape from the data asset. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param oci.data_connectivity.models.CreateEntityShapeDetails create_entity_shape_details: (required) + The details needed to create the data entity shape. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str authorization_mode: (optional) + Authorization mode for communicating with another OCI service relevant for the API. + + Allowed values are: "OBO", "USER_PRINCIPAL", "RESOURCE_PRINCIPAL", "INSTANCE_PRINCIPAL", "UNDEFINED" + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.EntityShape` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_entity_shape API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/actions/entityShapes" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match", + "authorization_mode", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_entity_shape got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'authorization_mode' in kwargs: + authorization_mode_allowed_values = ["OBO", "USER_PRINCIPAL", "RESOURCE_PRINCIPAL", "INSTANCE_PRINCIPAL", "UNDEFINED"] + if kwargs['authorization_mode'] not in authorization_mode_allowed_values: + raise ValueError( + "Invalid value for `authorization_mode`, must be one of {0}".format(authorization_mode_allowed_values) + ) + + query_params = { + "authorizationMode": kwargs.get("authorization_mode", missing), + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=create_entity_shape_details, + response_type="EntityShape") + 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=create_entity_shape_details, + response_type="EntityShape") + + def create_execute_operation_job(self, registry_id, connection_key, schema_resource_name, create_execute_operation_job_details, **kwargs): + """ + Call the operation to execute + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param oci.data_connectivity.models.CreateExecuteOperationJobDetails create_execute_operation_job_details: (required) + Request body parameter for execute operation job input. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :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. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ExecuteOperationJobDetails` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_execute_operation_job API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/actions/executeOperationJobs" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_execute_operation_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + query_params=query_params, + header_params=header_params, + body=create_execute_operation_job_details, + response_type="ExecuteOperationJobDetails") + 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=create_execute_operation_job_details, + response_type="ExecuteOperationJobDetails") + + def create_folder(self, registry_id, create_folder_details, **kwargs): + """ + Creates a folder under a specefied registry. + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateFolderDetails create_folder_details: (required) + The information needed to create a folder. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Folder` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_folder API. + """ + resource_path = "/registries/{registryId}/folders" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_folder got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_folder_details, + response_type="Folder") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_folder_details, + response_type="Folder") + + def create_full_push_down_task(self, registry_id, create_full_push_down_task_details, **kwargs): + """ + This endpoint is used to create a connectivity task (like PushdownTask). + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateFullPushDownTaskDetails create_full_push_down_task_details: (required) + Request body parameter for full pushdown task + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.FullPushDownTaskResponse` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_full_push_down_task API. + """ + resource_path = "/registries/{registryId}/actions/fullPushDownTask" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "if_match", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_full_push_down_task got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=create_full_push_down_task_details, + response_type="FullPushDownTaskResponse") + 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=create_full_push_down_task_details, + response_type="FullPushDownTaskResponse") + + def create_reference_artifact(self, registry_id, dcms_artifact_id, create_reference_artifact_details, **kwargs): + """ + Reference a data asset. + + + :param str registry_id: (required) + The registry Ocid. + + :param str dcms_artifact_id: (required) + The ID of a dcms artifact (DataAsset or Endpoint). + + :param oci.data_connectivity.models.CreateReferenceArtifactDetails create_reference_artifact_details: (required) + The information needed to reference a dcms artifact + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ReferenceInfo` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_reference_artifact API. + """ + resource_path = "/registries/{registryId}/dcmsArtifacts/{dcmsArtifactId}/actions/referenceArtifact" + method = "POST" + + # 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( + "create_reference_artifact got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dcmsArtifactId": dcms_artifact_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_reference_artifact_details, + response_type="ReferenceInfo") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=create_reference_artifact_details, + response_type="ReferenceInfo") + + def create_registry(self, create_registry_details, **kwargs): + """ + Creates a new Data Connectivity Management Registry ready for performing data Connectivity Management. + + + :param oci.data_connectivity.models.CreateRegistryDetails create_registry_details: (required) + Details for the new Data Connectivity Management Registry. + + :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. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_registry API. + """ + resource_path = "/registries" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_retry_token", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_registry got unknown kwargs: {!r}".format(extra_kwargs)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_registry_details) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + header_params=header_params, + body=create_registry_details) + + def create_test_network_connectivity(self, registry_id, create_test_network_connectivity_details, **kwargs): + """ + Execute network validation on selected data assets associated with the provided private endpoint + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.CreateTestNetworkConnectivityDetails create_test_network_connectivity_details: (required) + Request body parameters to execute network validation + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.TestNetworkConnectivity` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use create_test_network_connectivity API. + """ + resource_path = "/registries/{registryId}/actions/testNetworkConnectivity" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "endpoint_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "create_test_network_connectivity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=create_test_network_connectivity_details, + response_type="TestNetworkConnectivity") + 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=create_test_network_connectivity_details, + response_type="TestNetworkConnectivity") + + def delete_connection(self, registry_id, connection_key, **kwargs): + """ + Removes a connection using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_connection API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_connection_validation(self, registry_id, connection_validation_key, **kwargs): + """ + Deletes a connection validation. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_validation_key: (required) + The key of the connection validation. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_connection_validation API. + """ + resource_path = "/registries/{registryId}/connectionValidations/{connectionValidationKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_connection_validation got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionValidationKey": connection_validation_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params) + 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) + + def delete_data_asset(self, registry_id, data_asset_key, **kwargs): + """ + Removes a data asset using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str data_asset_key: (required) + The data asset key. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_data_asset API. + """ + resource_path = "/registries/{registryId}/dataAssets/{dataAssetKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dataAssetKey": data_asset_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_endpoint(self, endpoint_id, **kwargs): + """ + Deletes a Data Connectivity Management Endpoint resource by identifier + + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param str registry_id: (optional) + DCMS registry id + + :param bool is_force_operation: (optional) + Try to delete forcefully after drain timeout. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_endpoint API. + """ + resource_path = "/endpoints/{endpointId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "is_force_operation", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_endpoint got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "registryId": kwargs.get("registry_id", missing), + "isForceOperation": kwargs.get("is_force_operation", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params) + 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) + + def delete_folder(self, registry_id, folder_key, **kwargs): + """ + Removes a folder using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str folder_key: (required) + The folder 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_folder API. + """ + resource_path = "/registries/{registryId}/folders/{folderKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_folder got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "folderKey": folder_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "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) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_network_connectivity_status(self, registry_id, network_validation_status_key, **kwargs): + """ + This api is used to delete a persisted NetworkValidationStatus by its key + + + :param str registry_id: (required) + The registry Ocid. + + :param str network_validation_status_key: (required) + NetworkValidationStatus key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_network_connectivity_status API. + """ + resource_path = "/registries/{registryId}/networkConnectivityStatus/{networkValidationStatusKey}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_network_connectivity_status got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "networkValidationStatusKey": network_validation_status_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params) + + def delete_registry(self, registry_id, **kwargs): + """ + Deletes a Data Connectivity Management Registry resource by identifier + + + :param str registry_id: (required) + The registry Ocid. + + :param bool is_force_operation: (optional) + Try to delete forcefully after drain timeout. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_registry API. + """ + resource_path = "/registries/{registryId}" + method = "DELETE" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "is_force_operation", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "delete_registry got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "isForceOperation": kwargs.get("is_force_operation", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params) + 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) + + def get_connection(self, registry_id, connection_key, **kwargs): + """ + Retrieves the connection details using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Connection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_connection API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Connection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Connection") + + def get_connection_validation(self, registry_id, connection_validation_key, **kwargs): + """ + Retrieves a connection validation using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_validation_key: (required) + The key of the connection validation. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ConnectionValidation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_connection_validation API. + """ + resource_path = "/registries/{registryId}/connectionValidations/{connectionValidationKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_connection_validation got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionValidationKey": connection_validation_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ConnectionValidation") + 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="ConnectionValidation") + + def get_data_asset(self, registry_id, data_asset_key, **kwargs): + """ + Retrieves details of a data asset using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str data_asset_key: (required) + The data asset key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.DataAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_data_asset API. + """ + resource_path = "/registries/{registryId}/dataAssets/{dataAssetKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dataAssetKey": data_asset_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="DataAsset") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="DataAsset") + + def get_data_entity(self, registry_id, connection_key, schema_resource_name, data_entity_key, **kwargs): + """ + Retrieves the data entity details with the given name from live schema. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str data_entity_key: (required) + The key of the data entity. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataEntity` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_data_entity API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities/{dataEntityKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_data_entity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name, + "dataEntityKey": data_entity_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="DataEntity") + 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="DataEntity") + + def get_endpoint(self, endpoint_id, **kwargs): + """ + Gets a Data Connectivity Management Endpoint by identifier + + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param str registry_id: (optional) + DCMS registry id + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Endpoint` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_endpoint API. + """ + resource_path = "/endpoints/{endpointId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_endpoint got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "registryId": kwargs.get("registry_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Endpoint") + 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="Endpoint") + + def get_execute_operation_job(self, registry_id, connection_key, schema_resource_name, execute_operation_job_key, **kwargs): + """ + Get the operation status or operation execution result + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str execute_operation_job_key: (required) + Job id returned by execute operation job api + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ExecuteOperationJob` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_execute_operation_job API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/executeOperationJobs/{executeOperationJobKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_execute_operation_job got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name, + "executeOperationJobKey": execute_operation_job_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ExecuteOperationJob") + 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="ExecuteOperationJob") + + def get_folder(self, registry_id, folder_key, **kwargs): + """ + Retrieves the folder details using the specified identifier. + + + :param str registry_id: (required) + The registry Ocid. + + :param str folder_key: (required) + The folder ID. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Folder` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_folder API. + """ + resource_path = "/registries/{registryId}/folders/{folderKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_folder got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "folderKey": folder_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Folder") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Folder") + + def get_network_connectivity_status(self, registry_id, data_asset_key, **kwargs): + """ + Get Status of network reachability check, with the timestamp when the status was last checked, for a given PrivateEndpoint-DataAsset pair + + + :param str registry_id: (required) + The registry Ocid. + + :param str data_asset_key: (required) + The data asset key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.NetworkConnectivityStatus` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_network_connectivity_status API. + """ + resource_path = "/registries/{registryId}/dataAssets/{dataAssetKey}/networkConnectivityStatus" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "endpoint_id", + "if_match" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_network_connectivity_status got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dataAssetKey": data_asset_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="NetworkConnectivityStatus") + 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="NetworkConnectivityStatus") + + def get_operation(self, registry_id, connection_key, schema_resource_name, operation_resource_name, **kwargs): + """ + Retrieves the details of operation with given resource name. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str operation_resource_name: (required) + The opeartion resource name used for retrieving the details of operation. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Operation` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_operation API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/operations/{operationResourceName}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_operation got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name, + "operationResourceName": operation_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Operation") + 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="Operation") + + def get_registry(self, registry_id, **kwargs): + """ + Gets a Data Connectivity Management Registry by identifier + + + :param str registry_id: (required) + The registry Ocid. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Registry` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_registry API. + """ + resource_path = "/registries/{registryId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_registry got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Registry") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="Registry") + + def get_schema(self, registry_id, connection_key, schema_resource_name, **kwargs): + """ + Retrieves a schema that can be accessed using the specified connection. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Schema` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_schema API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_schema got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Schema") + 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="Schema") + + def get_type(self, registry_id, type_key, **kwargs): + """ + This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry + + + :param str registry_id: (required) + The registry Ocid. + + :param str type_key: (required) + key of the a specefic Type. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Type` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_type API. + """ + resource_path = "/registries/{registryId}/types/{typeKey}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "fields" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_type got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "typeKey": type_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi') + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="Type") + 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="Type") + + def get_work_request(self, work_request_id, **kwargs): + """ + Gets the status of the work request with the given ID. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.WorkRequest` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_work_request API. + """ + resource_path = "/workRequests/{workRequestId}" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_work_request got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="WorkRequest") + + def list_connection_validations(self, registry_id, **kwargs): + """ + Retrieves a list of connection validations within the specified registry. + + + :param str registry_id: (required) + The registry Ocid. + + :param str key: (optional) + Used to filter by the key of the object. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str identifier: (optional) + Used to filter by the identifier of the object. + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ConnectionValidationSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_connection_validations API. + """ + resource_path = "/registries/{registryId}/connectionValidations" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "key", + "name", + "identifier", + "fields", + "page", + "limit", + "sort_by", + "sort_order", + "opc_request_id", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_connection_validations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "key": kwargs.get("key", missing), + "name": kwargs.get("name", missing), + "identifier": kwargs.get("identifier", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ConnectionValidationSummaryCollection") + 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="ConnectionValidationSummaryCollection") + + def list_connections(self, registry_id, data_asset_key, **kwargs): + """ + Retrieves a list of all connections. + + + :param str registry_id: (required) + The registry Ocid. + + :param str data_asset_key: (required) + Used to filter by the data asset key of the object. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str type: (optional) + Type of the object to filter the results with. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str favorites_query_param: (optional) + If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL. + + Allowed values are: "FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ConnectionSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_connections API. + """ + resource_path = "/registries/{registryId}/connections" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "name", + "page", + "limit", + "fields", + "type", + "sort_by", + "sort_order", + "opc_request_id", + "favorites_query_param" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_connections got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'favorites_query_param' in kwargs: + favorites_query_param_allowed_values = ["FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL"] + if kwargs['favorites_query_param'] not in favorites_query_param_allowed_values: + raise ValueError( + "Invalid value for `favorites_query_param`, must be one of {0}".format(favorites_query_param_allowed_values) + ) + + query_params = { + "dataAssetKey": data_asset_key, + "name": kwargs.get("name", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "type": kwargs.get("type", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "favoritesQueryParam": kwargs.get("favorites_query_param", 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="ConnectionSummaryCollection") + 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="ConnectionSummaryCollection") + + def list_data_assets(self, registry_id, **kwargs): + """ + Retrieves a list of all data asset summaries. + + + :param str registry_id: (required) + The registry Ocid. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param list[str] include_types: (optional) + DataAsset type which needs to be listed while listing dataAssets + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str name: (optional) + Used to filter by the name of the object. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param list[str] exclude_types: (optional) + Types which wont be listed while listing dataAsset/Connection + + :param str favorites_query_param: (optional) + If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL. + + Allowed values are: "FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL" + + :param str folder_id: (optional) + Unique key of the folder. + + :param list[str] endpoint_ids: (optional) + Endpoint Ids used for data-plane APIs to filter or prefer specific endpoint. + + :param list[str] exclude_endpoint_ids: (optional) + Endpoints which will be excluded while listing dataAssets + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataAssetSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_data_assets API. + """ + resource_path = "/registries/{registryId}/dataAssets" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "page", + "limit", + "fields", + "include_types", + "sort_by", + "sort_order", + "name", + "opc_request_id", + "exclude_types", + "favorites_query_param", + "folder_id", + "endpoint_ids", + "exclude_endpoint_ids" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_data_assets got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'favorites_query_param' in kwargs: + favorites_query_param_allowed_values = ["FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL"] + if kwargs['favorites_query_param'] not in favorites_query_param_allowed_values: + raise ValueError( + "Invalid value for `favorites_query_param`, must be one of {0}".format(favorites_query_param_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "includeTypes": self.base_client.generate_collection_format_param(kwargs.get("include_types", missing), 'multi'), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "name": kwargs.get("name", missing), + "excludeTypes": self.base_client.generate_collection_format_param(kwargs.get("exclude_types", missing), 'multi'), + "favoritesQueryParam": kwargs.get("favorites_query_param", missing), + "folderId": kwargs.get("folder_id", missing), + "endpointIds": self.base_client.generate_collection_format_param(kwargs.get("endpoint_ids", missing), 'multi'), + "excludeEndpointIds": self.base_client.generate_collection_format_param(kwargs.get("exclude_endpoint_ids", missing), 'multi') + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="DataAssetSummaryCollection") + 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="DataAssetSummaryCollection") + + def list_data_entities(self, registry_id, connection_key, schema_resource_name, **kwargs): + """ + Lists a summary of data entities from the data asset using the specified connection. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str type: (optional) + Type of the object to filter the results with. + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str api_mode: (optional) + This parameter can be used to set the api response type to preview. + + Allowed values are: "PREVIEW", "ALL" + + :param list[str] name_list: (optional) + Used to filter by the name of the object. + + :param bool is_pattern: (optional) + This parameter can be used to specify whether entity search type is pattern search or not. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataEntitySummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_data_entities API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "name", + "page", + "type", + "limit", + "fields", + "sort_by", + "sort_order", + "opc_request_id", + "api_mode", + "name_list", + "is_pattern", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_data_entities got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'api_mode' in kwargs: + api_mode_allowed_values = ["PREVIEW", "ALL"] + if kwargs['api_mode'] not in api_mode_allowed_values: + raise ValueError( + "Invalid value for `api_mode`, must be one of {0}".format(api_mode_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "page": kwargs.get("page", missing), + "type": kwargs.get("type", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "apiMode": kwargs.get("api_mode", missing), + "nameList": self.base_client.generate_collection_format_param(kwargs.get("name_list", missing), 'multi'), + "isPattern": kwargs.get("is_pattern", missing), + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="DataEntitySummaryCollection") + 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="DataEntitySummaryCollection") + + def list_endpoints(self, compartment_id, **kwargs): + """ + Returns a list of Data Connectivity Management Endpoints. + + + :param str compartment_id: (required) + The OCID of the compartment containing the resources you want to list. + + :param str registry_id: (optional) + DCMS registry id + + :param str name: (optional) + Used to filter by the name of the object. + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str lifecycle_state: (optional) + Lifecycle state of the resource. + + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str sort_by: (optional) + This parameter allows users to specify a sort field. Default sort order is the descending order of `timeCreated` (most recently created objects at the top). Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "TIMECREATED", "DISPLAYNAME", "TIMEUPDATED" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.EndpointSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_endpoints API. + """ + resource_path = "/endpoints" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "name", + "limit", + "page", + "lifecycle_state", + "sort_order", + "sort_by", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_endpoints got unknown kwargs: {!r}".format(extra_kwargs)) + + 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( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME", "TIMEUPDATED"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "registryId": kwargs.get("registry_id", missing), + "name": kwargs.get("name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "lifecycleState": kwargs.get("lifecycle_state", missing), + "sortOrder": kwargs.get("sort_order", missing), + "sortBy": kwargs.get("sort_by", missing) + } + 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="EndpointSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="EndpointSummaryCollection") + + def list_folders(self, registry_id, **kwargs): + """ + Retrieves a list of all folders. + + + :param str registry_id: (required) + The registry Ocid. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str type: (optional) + Type of the object to filter the results with. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str favorites_query_param: (optional) + If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL. + + Allowed values are: "FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.FolderSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_folders API. + """ + resource_path = "/registries/{registryId}/folders" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "name", + "page", + "limit", + "fields", + "type", + "sort_by", + "sort_order", + "opc_request_id", + "favorites_query_param" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_folders got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'favorites_query_param' in kwargs: + favorites_query_param_allowed_values = ["FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL"] + if kwargs['favorites_query_param'] not in favorites_query_param_allowed_values: + raise ValueError( + "Invalid value for `favorites_query_param`, must be one of {0}".format(favorites_query_param_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "type": kwargs.get("type", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "favoritesQueryParam": kwargs.get("favorites_query_param", 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="FolderSummaryCollection") + 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="FolderSummaryCollection") + + def list_operations(self, registry_id, connection_key, schema_resource_name, **kwargs): + """ + Lists the summary of operations present in the schema identified by schema name. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str schema_resource_name: (required) + The schema resource name used for retrieving schemas. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.OperationSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_operations API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas/{schemaResourceName}/operations" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "name", + "page", + "limit", + "sort_by", + "sort_order", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_operations got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key, + "schemaResourceName": schema_resource_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "name": kwargs.get("name", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="OperationSummaryCollection") + 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="OperationSummaryCollection") + + def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): + """ + Retrieves a list of all reference info of a dcms artifact. + + + :param str registry_id: (required) + The registry Ocid. + + :param str dcms_artifact_id: (required) + The ID of a dcms artifact (DataAsset or Endpoint). + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str type: (optional) + Type of the object to filter the results with. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str name: (optional) + Used to filter by the name of the object. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param list[str] exclude_types: (optional) + Types which wont be listed while listing dataAsset/Connection + + :param str favorites_query_param: (optional) + If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL. + + Allowed values are: "FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL" + + :param str service_artifact_id: (optional) + Unique key of the service. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.ReferenceArtifactSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_reference_artifacts API. + """ + resource_path = "/registries/{registryId}/dcmsArtifacts/{dcmsArtifactId}/referenceArtifacts" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "page", + "limit", + "fields", + "type", + "sort_by", + "sort_order", + "name", + "opc_request_id", + "exclude_types", + "favorites_query_param", + "service_artifact_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_reference_artifacts got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dcmsArtifactId": dcms_artifact_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + if 'favorites_query_param' in kwargs: + favorites_query_param_allowed_values = ["FAVORITES_ONLY", "NON_FAVORITES_ONLY", "ALL"] + if kwargs['favorites_query_param'] not in favorites_query_param_allowed_values: + raise ValueError( + "Invalid value for `favorites_query_param`, must be one of {0}".format(favorites_query_param_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "type": kwargs.get("type", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "name": kwargs.get("name", missing), + "excludeTypes": self.base_client.generate_collection_format_param(kwargs.get("exclude_types", missing), 'multi'), + "favoritesQueryParam": kwargs.get("favorites_query_param", missing), + "serviceArtifactId": kwargs.get("service_artifact_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="ReferenceArtifactSummaryCollection") + 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="ReferenceArtifactSummaryCollection") + + def list_registries(self, compartment_id, **kwargs): + """ + Returns a list of Data Connectivity Management Registries. + + + :param str compartment_id: (required) + The OCID of the compartment containing the resources you want to list. + + :param str name: (optional) + Used to filter by the name of the object. + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param bool is_deep_lookup: (optional) + This parameter allows list registries to deep look at whole tenancy. + + :param str lifecycle_state: (optional) + Lifecycle state of the resource. + + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.RegistrySummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_registries API. + """ + resource_path = "/registries" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "name", + "limit", + "page", + "is_deep_lookup", + "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( + "list_registries got unknown kwargs: {!r}".format(extra_kwargs)) + + 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( + "Invalid value for `lifecycle_state`, must be one of {0}".format(lifecycle_state_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "name": kwargs.get("name", missing), + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "isDeepLookup": kwargs.get("is_deep_lookup", 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, + query_params=query_params, + header_params=header_params, + response_type="RegistrySummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="RegistrySummaryCollection") + + def list_schemas(self, registry_id, connection_key, **kwargs): + """ + Retrieves a list of all the schemas that can be accessed using the specified connection. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param list[str] fields: (optional) + Specifies the fields to get for an object. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str schema_resource_key: (optional) + Schema resource name used for retrieving schemas. + + :param str name: (optional) + Used to filter by the name of the object. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param list[str] name_list: (optional) + Used to filter by the name of the object. + + :param str endpoint_id: (optional) + Endpoint Id used for getDataAssetFullDetails. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.SchemaSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_schemas API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/schemas" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "page", + "limit", + "fields", + "sort_by", + "sort_order", + "schema_resource_key", + "name", + "opc_request_id", + "name_list", + "endpoint_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_schemas got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "schemaResourceKey": kwargs.get("schema_resource_key", missing), + "name": kwargs.get("name", missing), + "nameList": self.base_client.generate_collection_format_param(kwargs.get("name_list", missing), 'multi'), + "endpointId": kwargs.get("endpoint_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + 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="SchemaSummaryCollection") + 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="SchemaSummaryCollection") + + def list_types(self, registry_id, **kwargs): + """ + This endpoint retrieves list of all the supported connector types + + + :param str registry_id: (required) + The registry Ocid. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str type: (optional) + Type of the object to filter the results with. + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param str name: (optional) + Used to filter by the name of the object. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.TypesSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_types API. + """ + resource_path = "/registries/{registryId}/types" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "type", + "sort_by", + "sort_order", + "name" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_types got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "type": kwargs.get("type", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing), + "name": kwargs.get("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="TypesSummaryCollection") + 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="TypesSummaryCollection") + + def list_work_request_errors(self, work_request_id, **kwargs): + """ + Return a (paginated) list of errors for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.WorkRequestErrorCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_errors API. + """ + resource_path = "/workRequests/{workRequestId}/workRequestErrors" + method = "GET" + + # 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( + "list_work_request_errors got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestErrorCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestErrorCollection") + + def list_work_request_logs(self, work_request_id, **kwargs): + """ + Return a (paginated) list of logs for a given work request. + + + :param str work_request_id: (required) + The ID of the asynchronous request. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.WorkRequestLogCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_request_logs API. + """ + resource_path = "/workRequests/{workRequestId}/logs" + method = "GET" + + # 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( + "list_work_request_logs got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "workRequestId": work_request_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestLogCollection") + 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="WorkRequestLogCollection") + + def list_work_requests(self, compartment_id, **kwargs): + """ + Lists the work requests in a compartment. + + + :param str compartment_id: (required) + The OCID of the compartment containing the resources you want to list. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str resource_id: (optional) + DCMS registry or endpoint id + + :param str work_request_status: (optional) + Work Request status. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.WorkRequestSummaryCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_work_requests API. + """ + resource_path = "/workRequests" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "resource_id", + "work_request_status", + "page", + "limit" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) + + if 'work_request_status' in kwargs: + work_request_status_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['work_request_status'] not in work_request_status_allowed_values: + raise ValueError( + "Invalid value for `work_request_status`, must be one of {0}".format(work_request_status_allowed_values) + ) + + query_params = { + "compartmentId": compartment_id, + "resourceId": kwargs.get("resource_id", missing), + "workRequestStatus": kwargs.get("work_request_status", missing), + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="WorkRequestSummaryCollection") + + def update_connection(self, registry_id, connection_key, update_connection_details, **kwargs): + """ + Updates a connection under a data asset. + + + :param str registry_id: (required) + The registry Ocid. + + :param str connection_key: (required) + The connection key. + + :param oci.data_connectivity.models.UpdateConnectionDetails update_connection_details: (required) + The information needed to update a connection. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Connection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_connection API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}" + method = "PUT" + + # 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( + "update_connection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "connectionKey": connection_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_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_connection_details, + response_type="Connection") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_connection_details, + response_type="Connection") + + def update_data_asset(self, registry_id, data_asset_key, update_data_asset_details, **kwargs): + """ + Updates a specific data asset with default connection. + + + :param str registry_id: (required) + The registry Ocid. + + :param str data_asset_key: (required) + The data asset key. + + :param oci.data_connectivity.models.UpdateDataAssetDetails update_data_asset_details: (required) + The information needed to update a data asset. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.DataAsset` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_data_asset API. + """ + resource_path = "/registries/{registryId}/dataAssets/{dataAssetKey}" + method = "PUT" + + # 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( + "update_data_asset got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "dataAssetKey": data_asset_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_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_data_asset_details, + response_type="DataAsset") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_data_asset_details, + response_type="DataAsset") + + def update_endpoint(self, endpoint_id, update_endpoint_details, **kwargs): + """ + Updates the Data Connectivity Management Endpoint + + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.UpdateEndpointDetails update_endpoint_details: (required) + The information to be updated. + + :param str registry_id: (optional) + DCMS registry 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Endpoint` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_endpoint API. + """ + resource_path = "/endpoints/{endpointId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "registry_id", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_endpoint got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "registryId": kwargs.get("registry_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=update_endpoint_details, + response_type="Endpoint") + 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_endpoint_details, + response_type="Endpoint") + + def update_folder(self, registry_id, folder_key, update_folder_details, **kwargs): + """ + Updates a folder under a specefied registry. + + + :param str registry_id: (required) + The registry Ocid. + + :param str folder_key: (required) + The folder ID. + + :param oci.data_connectivity.models.UpdateFolderDetails update_folder_details: (required) + The information needed to update a folder. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any 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.data_connectivity.models.Folder` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_folder API. + """ + resource_path = "/registries/{registryId}/folders/{folderKey}" + method = "PUT" + + # 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( + "update_folder got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "folderKey": folder_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_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_folder_details, + response_type="Folder") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_folder_details, + response_type="Folder") + + def update_registry(self, registry_id, update_registry_details, **kwargs): + """ + Updates the Data Connectivity Management Registry + + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.UpdateRegistryDetails update_registry_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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation 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.data_connectivity.models.Registry` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_registry API. + """ + resource_path = "/registries/{registryId}" + method = "PUT" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "update_registry got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_registry_details, + response_type="Registry") + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_registry_details, + response_type="Registry") + + def validate_data_asset_network_reachablity(self, endpoint_id, **kwargs): + """ + Validates the dataAsset network Reachability. + + + :param str endpoint_id: (required) + DCMS Endpoint 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. + When 'if-match' is provided and its value does not exactly match the 'etag' of the resource on the server, the request fails with the 412 response code. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str registry_id: (optional) + DCMS registry id + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use validate_data_asset_network_reachablity API. + """ + resource_path = "/endpoints/{endpointId}/actions/validateDataAssetNetworkReachablity" + method = "POST" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "if_match", + "opc_request_id", + "opc_retry_token", + "registry_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "validate_data_asset_network_reachablity got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "endpointId": endpoint_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "registryId": kwargs.get("registry_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "if-match": kwargs.get("if_match", missing), + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params) + 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) diff --git a/src/oci/data_connectivity/data_connectivity_management_client_composite_operations.py b/src/oci/data_connectivity/data_connectivity_management_client_composite_operations.py new file mode 100644 index 0000000000..565a17e7bb --- /dev/null +++ b/src/oci/data_connectivity/data_connectivity_management_client_composite_operations.py @@ -0,0 +1,394 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class DataConnectivityManagementClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.data_connectivity.DataConnectivityManagementClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new DataConnectivityManagementClientCompositeOperations object + + :param DataConnectivityManagementClient client: + The service client which will be wrapped by this object + """ + self.client = client + + def change_endpoint_compartment_and_wait_for_state(self, endpoint_id, change_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.change_endpoint_compartment` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.ChangeEndpointCompartmentDetails change_endpoint_compartment_details: (required) + The details of change compartment action. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.change_endpoint_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_endpoint_compartment(endpoint_id, change_endpoint_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def change_registry_compartment_and_wait_for_state(self, registry_id, change_registry_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.change_registry_compartment` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.ChangeRegistryCompartmentDetails change_registry_compartment_details: (required) + The details of change compartment action. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.change_registry_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_registry_compartment(registry_id, change_registry_compartment_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_endpoint_and_wait_for_state(self, create_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.create_endpoint` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param oci.data_connectivity.models.CreateEndpointDetails create_endpoint_details: (required) + Details for the new Data Connectivity Management Endpoint. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.create_endpoint` + + :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_endpoint(create_endpoint_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def create_registry_and_wait_for_state(self, create_registry_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.create_registry` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param oci.data_connectivity.models.CreateRegistryDetails create_registry_details: (required) + Details for the new Data Connectivity Management Registry. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.create_registry` + + :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_registry(create_registry_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_endpoint_and_wait_for_state(self, endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.delete_endpoint` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.delete_endpoint` + + :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_endpoint(endpoint_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def delete_registry_and_wait_for_state(self, registry_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.delete_registry` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str registry_id: (required) + The registry Ocid. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.delete_registry` + + :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_registry(registry_id, **operation_kwargs) + except oci.exceptions.ServiceError as e: + if e.status == 404: + return WAIT_RESOURCE_NOT_FOUND + else: + raise e + + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_endpoint_and_wait_for_state(self, endpoint_id, update_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.update_endpoint` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param oci.data_connectivity.models.UpdateEndpointDetails update_endpoint_details: (required) + The information to be updated. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.update_endpoint` + + :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_endpoint(endpoint_id, update_endpoint_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def update_registry_and_wait_for_state(self, registry_id, update_registry_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.update_registry` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str registry_id: (required) + The registry Ocid. + + :param oci.data_connectivity.models.UpdateRegistryDetails update_registry_details: (required) + The information to be updated. + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.update_registry` + + :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_registry(registry_id, update_registry_details, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) + + def validate_data_asset_network_reachablity_and_wait_for_state(self, endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}): + """ + Calls :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.validate_data_asset_network_reachablity` and waits for the :py:class:`~oci.data_connectivity.models.WorkRequest` + to enter the given state(s). + + :param str endpoint_id: (required) + DCMS Endpoint id + + :param list[str] wait_for_states: + An array of states to wait on. These should be valid values for :py:attr:`~oci.data_connectivity.models.WorkRequest.status` + + :param dict operation_kwargs: + A dictionary of keyword arguments to pass to :py:func:`~oci.data_connectivity.DataConnectivityManagementClient.validate_data_asset_network_reachablity` + + :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.validate_data_asset_network_reachablity(endpoint_id, **operation_kwargs) + if not wait_for_states: + return operation_result + + lowered_wait_for_states = [w.lower() for w in wait_for_states] + wait_for_resource_id = operation_result.headers['opc-work-request-id'] + + try: + waiter_result = oci.wait_until( + self.client, + self.client.get_work_request(wait_for_resource_id), + evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states, + **waiter_kwargs + ) + result_to_return = waiter_result + + return result_to_return + except Exception as e: + raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e) diff --git a/src/oci/data_connectivity/models/__init__.py b/src/oci/data_connectivity/models/__init__.py new file mode 100644 index 0000000000..5218e00689 --- /dev/null +++ b/src/oci/data_connectivity/models/__init__.py @@ -0,0 +1,428 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from .abstract_call_attribute import AbstractCallAttribute +from .abstract_data_operation_config import AbstractDataOperationConfig +from .abstract_format_attribute import AbstractFormatAttribute +from .abstract_read_attribute import AbstractReadAttribute +from .abstract_write_attribute import AbstractWriteAttribute +from .aggregator_summary import AggregatorSummary +from .attach_data_asset_info import AttachDataAssetInfo +from .attribute import Attribute +from .attribute_profile_result import AttributeProfileResult +from .avro_format_attribute import AvroFormatAttribute +from .base_type import BaseType +from .bicc_read_attributes import BiccReadAttributes +from .bip_call_attribute import BipCallAttribute +from .call_operation_config import CallOperationConfig +from .change_endpoint_compartment_details import ChangeEndpointCompartmentDetails +from .change_registry_compartment_details import ChangeRegistryCompartmentDetails +from .column import Column +from .composite_type import CompositeType +from .compression import Compression +from .config_definition import ConfigDefinition +from .config_parameter_definition import ConfigParameterDefinition +from .config_parameter_value import ConfigParameterValue +from .config_values import ConfigValues +from .configured_type import ConfiguredType +from .connection import Connection +from .connection_property import ConnectionProperty +from .connection_summary import ConnectionSummary +from .connection_summary_collection import ConnectionSummaryCollection +from .connection_validation import ConnectionValidation +from .connection_validation_summary import ConnectionValidationSummary +from .connection_validation_summary_collection import ConnectionValidationSummaryCollection +from .connectivity_validation import ConnectivityValidation +from .connector_attribute import ConnectorAttribute +from .create_attach_data_asset_details import CreateAttachDataAssetDetails +from .create_connection_details import CreateConnectionDetails +from .create_connection_validation_details import CreateConnectionValidationDetails +from .create_connectivity_validation_details import CreateConnectivityValidationDetails +from .create_data_asset_details import CreateDataAssetDetails +from .create_data_preview_details import CreateDataPreviewDetails +from .create_data_profile_details import CreateDataProfileDetails +from .create_de_reference_artifact_details import CreateDeReferenceArtifactDetails +from .create_detach_data_asset_details import CreateDetachDataAssetDetails +from .create_dp_endpoint_details import CreateDpEndpointDetails +from .create_dp_endpoint_from_private import CreateDpEndpointFromPrivate +from .create_dp_endpoint_from_public import CreateDpEndpointFromPublic +from .create_endpoint_details import CreateEndpointDetails +from .create_entity_shape_details import CreateEntityShapeDetails +from .create_entity_shape_from_data_store import CreateEntityShapeFromDataStore +from .create_entity_shape_from_file import CreateEntityShapeFromFile +from .create_entity_shape_from_sql import CreateEntityShapeFromSQL +from .create_entity_shape_from_table import CreateEntityShapeFromTable +from .create_entity_shape_from_view import CreateEntityShapeFromView +from .create_execute_operation_job_details import CreateExecuteOperationJobDetails +from .create_folder_details import CreateFolderDetails +from .create_full_push_down_task_details import CreateFullPushDownTaskDetails +from .create_reference_artifact_details import CreateReferenceArtifactDetails +from .create_registry_details import CreateRegistryDetails +from .create_test_network_connectivity_details import CreateTestNetworkConnectivityDetails +from .csv_format_attribute import CsvFormatAttribute +from .data_asset import DataAsset +from .data_asset_summary import DataAssetSummary +from .data_asset_summary_collection import DataAssetSummaryCollection +from .data_entity import DataEntity +from .data_entity_details import DataEntityDetails +from .data_entity_from_data_store import DataEntityFromDataStore +from .data_entity_from_data_store_entity_details import DataEntityFromDataStoreEntityDetails +from .data_entity_from_file import DataEntityFromFile +from .data_entity_from_file_entity_details import DataEntityFromFileEntityDetails +from .data_entity_from_sql import DataEntityFromSql +from .data_entity_from_sql_entity_details import DataEntityFromSqlEntityDetails +from .data_entity_from_table import DataEntityFromTable +from .data_entity_from_table_entity_details import DataEntityFromTableEntityDetails +from .data_entity_from_view import DataEntityFromView +from .data_entity_from_view_entity_details import DataEntityFromViewEntityDetails +from .data_entity_summary import DataEntitySummary +from .data_entity_summary_collection import DataEntitySummaryCollection +from .data_entity_summary_from_data_store import DataEntitySummaryFromDataStore +from .data_entity_summary_from_file import DataEntitySummaryFromFile +from .data_entity_summary_from_sql import DataEntitySummaryFromSql +from .data_entity_summary_from_table import DataEntitySummaryFromTable +from .data_entity_summary_from_view import DataEntitySummaryFromView +from .data_format import DataFormat +from .data_preview import DataPreview +from .data_profile import DataProfile +from .data_type import DataType +from .data_type_stat import DataTypeStat +from .date_attribute import DateAttribute +from .de_reference_info import DeReferenceInfo +from .derived_type import DerivedType +from .detach_data_asset_info import DetachDataAssetInfo +from .dp_endpoint import DpEndpoint +from .dp_endpoint_details import DpEndpointDetails +from .dp_endpoint_from_private import DpEndpointFromPrivate +from .dp_endpoint_from_private_details import DpEndpointFromPrivateDetails +from .dp_endpoint_from_public import DpEndpointFromPublic +from .dp_endpoint_from_public_details import DpEndpointFromPublicDetails +from .dp_endpoint_summary import DpEndpointSummary +from .dp_endpoint_summary_from_private import DpEndpointSummaryFromPrivate +from .dp_endpoint_summary_from_public import DpEndpointSummaryFromPublic +from .endpoint import Endpoint +from .endpoint_summary import EndpointSummary +from .endpoint_summary_collection import EndpointSummaryCollection +from .entity_profile_result import EntityProfileResult +from .entity_shape import EntityShape +from .entity_shape_from_data_store import EntityShapeFromDataStore +from .entity_shape_from_file import EntityShapeFromFile +from .entity_shape_from_sql import EntityShapeFromSQL +from .entity_shape_from_table import EntityShapeFromTable +from .entity_shape_from_view import EntityShapeFromView +from .error_details import ErrorDetails +from .execute_operation_job import ExecuteOperationJob +from .execute_operation_job_details import ExecuteOperationJobDetails +from .external_storage import ExternalStorage +from .filter_push import FilterPush +from .folder import Folder +from .folder_summary import FolderSummary +from .folder_summary_collection import FolderSummaryCollection +from .foreign_key import ForeignKey +from .full_push_down_task_response import FullPushDownTaskResponse +from .hdfs_write_attributes import HdfsWriteAttributes +from .histogram import Histogram +from .input_port import InputPort +from .join import Join +from .json_format_attribute import JsonFormatAttribute +from .key import Key +from .key_attribute import KeyAttribute +from .key_range import KeyRange +from .key_range_partition_config import KeyRangePartitionConfig +from .message import Message +from .native_shape_field import NativeShapeField +from .network_connectivity_status import NetworkConnectivityStatus +from .network_connectivity_status_collection import NetworkConnectivityStatusCollection +from .numeric_attribute import NumericAttribute +from .object_freq_stat import ObjectFreqStat +from .object_metadata import ObjectMetadata +from .object_storage_write_attributes import ObjectStorageWriteAttributes +from .operation import Operation +from .operation_exec_result import OperationExecResult +from .operation_from_procedure import OperationFromProcedure +from .operation_input_record import OperationInputRecord +from .operation_summary import OperationSummary +from .operation_summary_collection import OperationSummaryCollection +from .operation_summary_from_procedure import OperationSummaryFromProcedure +from .oracle_adwc_write_attributes import OracleAdwcWriteAttributes +from .oracle_atp_write_attributes import OracleAtpWriteAttributes +from .oracle_read_attribute import OracleReadAttribute +from .oracle_read_attributes import OracleReadAttributes +from .oracle_write_attributes import OracleWriteAttributes +from .outlier import Outlier +from .output_port import OutputPort +from .parameter import Parameter +from .parent_reference import ParentReference +from .parquet_format_attribute import ParquetFormatAttribute +from .partition_config import PartitionConfig +from .primary_key import PrimaryKey +from .profile_config import ProfileConfig +from .profile_stat import ProfileStat +from .push_down_operation import PushDownOperation +from .query import Query +from .read_operation_config import ReadOperationConfig +from .reference_artifact_summary import ReferenceArtifactSummary +from .reference_artifact_summary_collection import ReferenceArtifactSummaryCollection +from .reference_info import ReferenceInfo +from .registry import Registry +from .registry_metadata import RegistryMetadata +from .registry_summary import RegistrySummary +from .registry_summary_collection import RegistrySummaryCollection +from .row import Row +from .schema import Schema +from .schema_drift_config import SchemaDriftConfig +from .schema_summary import SchemaSummary +from .schema_summary_collection import SchemaSummaryCollection +from .select import Select +from .shape import Shape +from .shape_field import ShapeField +from .sort import Sort +from .sort_clause import SortClause +from .source import Source +from .string_attribute import StringAttribute +from .structured_type import StructuredType +from .target import Target +from .test_network_connectivity import TestNetworkConnectivity +from .type import Type +from .type_library import TypeLibrary +from .type_summary import TypeSummary +from .type_system import TypeSystem +from .typed_object import TypedObject +from .types_summary_collection import TypesSummaryCollection +from .unique_key import UniqueKey +from .update_connection_details import UpdateConnectionDetails +from .update_data_asset_details import UpdateDataAssetDetails +from .update_dp_endpoint_details import UpdateDpEndpointDetails +from .update_dp_endpoint_from_private import UpdateDpEndpointFromPrivate +from .update_dp_endpoint_from_public import UpdateDpEndpointFromPublic +from .update_endpoint_details import UpdateEndpointDetails +from .update_folder_details import UpdateFolderDetails +from .update_registry_details import UpdateRegistryDetails +from .validation_message import ValidationMessage +from .validation_result import ValidationResult +from .work_request import WorkRequest +from .work_request_error import WorkRequestError +from .work_request_error_collection import WorkRequestErrorCollection +from .work_request_error_summary import WorkRequestErrorSummary +from .work_request_log import WorkRequestLog +from .work_request_log_collection import WorkRequestLogCollection +from .work_request_resource import WorkRequestResource +from .work_request_summary import WorkRequestSummary +from .work_request_summary_collection import WorkRequestSummaryCollection +from .write_operation_config import WriteOperationConfig + +# Maps type names to classes for data_connectivity services. +data_connectivity_type_mapping = { + "AbstractCallAttribute": AbstractCallAttribute, + "AbstractDataOperationConfig": AbstractDataOperationConfig, + "AbstractFormatAttribute": AbstractFormatAttribute, + "AbstractReadAttribute": AbstractReadAttribute, + "AbstractWriteAttribute": AbstractWriteAttribute, + "AggregatorSummary": AggregatorSummary, + "AttachDataAssetInfo": AttachDataAssetInfo, + "Attribute": Attribute, + "AttributeProfileResult": AttributeProfileResult, + "AvroFormatAttribute": AvroFormatAttribute, + "BaseType": BaseType, + "BiccReadAttributes": BiccReadAttributes, + "BipCallAttribute": BipCallAttribute, + "CallOperationConfig": CallOperationConfig, + "ChangeEndpointCompartmentDetails": ChangeEndpointCompartmentDetails, + "ChangeRegistryCompartmentDetails": ChangeRegistryCompartmentDetails, + "Column": Column, + "CompositeType": CompositeType, + "Compression": Compression, + "ConfigDefinition": ConfigDefinition, + "ConfigParameterDefinition": ConfigParameterDefinition, + "ConfigParameterValue": ConfigParameterValue, + "ConfigValues": ConfigValues, + "ConfiguredType": ConfiguredType, + "Connection": Connection, + "ConnectionProperty": ConnectionProperty, + "ConnectionSummary": ConnectionSummary, + "ConnectionSummaryCollection": ConnectionSummaryCollection, + "ConnectionValidation": ConnectionValidation, + "ConnectionValidationSummary": ConnectionValidationSummary, + "ConnectionValidationSummaryCollection": ConnectionValidationSummaryCollection, + "ConnectivityValidation": ConnectivityValidation, + "ConnectorAttribute": ConnectorAttribute, + "CreateAttachDataAssetDetails": CreateAttachDataAssetDetails, + "CreateConnectionDetails": CreateConnectionDetails, + "CreateConnectionValidationDetails": CreateConnectionValidationDetails, + "CreateConnectivityValidationDetails": CreateConnectivityValidationDetails, + "CreateDataAssetDetails": CreateDataAssetDetails, + "CreateDataPreviewDetails": CreateDataPreviewDetails, + "CreateDataProfileDetails": CreateDataProfileDetails, + "CreateDeReferenceArtifactDetails": CreateDeReferenceArtifactDetails, + "CreateDetachDataAssetDetails": CreateDetachDataAssetDetails, + "CreateDpEndpointDetails": CreateDpEndpointDetails, + "CreateDpEndpointFromPrivate": CreateDpEndpointFromPrivate, + "CreateDpEndpointFromPublic": CreateDpEndpointFromPublic, + "CreateEndpointDetails": CreateEndpointDetails, + "CreateEntityShapeDetails": CreateEntityShapeDetails, + "CreateEntityShapeFromDataStore": CreateEntityShapeFromDataStore, + "CreateEntityShapeFromFile": CreateEntityShapeFromFile, + "CreateEntityShapeFromSQL": CreateEntityShapeFromSQL, + "CreateEntityShapeFromTable": CreateEntityShapeFromTable, + "CreateEntityShapeFromView": CreateEntityShapeFromView, + "CreateExecuteOperationJobDetails": CreateExecuteOperationJobDetails, + "CreateFolderDetails": CreateFolderDetails, + "CreateFullPushDownTaskDetails": CreateFullPushDownTaskDetails, + "CreateReferenceArtifactDetails": CreateReferenceArtifactDetails, + "CreateRegistryDetails": CreateRegistryDetails, + "CreateTestNetworkConnectivityDetails": CreateTestNetworkConnectivityDetails, + "CsvFormatAttribute": CsvFormatAttribute, + "DataAsset": DataAsset, + "DataAssetSummary": DataAssetSummary, + "DataAssetSummaryCollection": DataAssetSummaryCollection, + "DataEntity": DataEntity, + "DataEntityDetails": DataEntityDetails, + "DataEntityFromDataStore": DataEntityFromDataStore, + "DataEntityFromDataStoreEntityDetails": DataEntityFromDataStoreEntityDetails, + "DataEntityFromFile": DataEntityFromFile, + "DataEntityFromFileEntityDetails": DataEntityFromFileEntityDetails, + "DataEntityFromSql": DataEntityFromSql, + "DataEntityFromSqlEntityDetails": DataEntityFromSqlEntityDetails, + "DataEntityFromTable": DataEntityFromTable, + "DataEntityFromTableEntityDetails": DataEntityFromTableEntityDetails, + "DataEntityFromView": DataEntityFromView, + "DataEntityFromViewEntityDetails": DataEntityFromViewEntityDetails, + "DataEntitySummary": DataEntitySummary, + "DataEntitySummaryCollection": DataEntitySummaryCollection, + "DataEntitySummaryFromDataStore": DataEntitySummaryFromDataStore, + "DataEntitySummaryFromFile": DataEntitySummaryFromFile, + "DataEntitySummaryFromSql": DataEntitySummaryFromSql, + "DataEntitySummaryFromTable": DataEntitySummaryFromTable, + "DataEntitySummaryFromView": DataEntitySummaryFromView, + "DataFormat": DataFormat, + "DataPreview": DataPreview, + "DataProfile": DataProfile, + "DataType": DataType, + "DataTypeStat": DataTypeStat, + "DateAttribute": DateAttribute, + "DeReferenceInfo": DeReferenceInfo, + "DerivedType": DerivedType, + "DetachDataAssetInfo": DetachDataAssetInfo, + "DpEndpoint": DpEndpoint, + "DpEndpointDetails": DpEndpointDetails, + "DpEndpointFromPrivate": DpEndpointFromPrivate, + "DpEndpointFromPrivateDetails": DpEndpointFromPrivateDetails, + "DpEndpointFromPublic": DpEndpointFromPublic, + "DpEndpointFromPublicDetails": DpEndpointFromPublicDetails, + "DpEndpointSummary": DpEndpointSummary, + "DpEndpointSummaryFromPrivate": DpEndpointSummaryFromPrivate, + "DpEndpointSummaryFromPublic": DpEndpointSummaryFromPublic, + "Endpoint": Endpoint, + "EndpointSummary": EndpointSummary, + "EndpointSummaryCollection": EndpointSummaryCollection, + "EntityProfileResult": EntityProfileResult, + "EntityShape": EntityShape, + "EntityShapeFromDataStore": EntityShapeFromDataStore, + "EntityShapeFromFile": EntityShapeFromFile, + "EntityShapeFromSQL": EntityShapeFromSQL, + "EntityShapeFromTable": EntityShapeFromTable, + "EntityShapeFromView": EntityShapeFromView, + "ErrorDetails": ErrorDetails, + "ExecuteOperationJob": ExecuteOperationJob, + "ExecuteOperationJobDetails": ExecuteOperationJobDetails, + "ExternalStorage": ExternalStorage, + "FilterPush": FilterPush, + "Folder": Folder, + "FolderSummary": FolderSummary, + "FolderSummaryCollection": FolderSummaryCollection, + "ForeignKey": ForeignKey, + "FullPushDownTaskResponse": FullPushDownTaskResponse, + "HdfsWriteAttributes": HdfsWriteAttributes, + "Histogram": Histogram, + "InputPort": InputPort, + "Join": Join, + "JsonFormatAttribute": JsonFormatAttribute, + "Key": Key, + "KeyAttribute": KeyAttribute, + "KeyRange": KeyRange, + "KeyRangePartitionConfig": KeyRangePartitionConfig, + "Message": Message, + "NativeShapeField": NativeShapeField, + "NetworkConnectivityStatus": NetworkConnectivityStatus, + "NetworkConnectivityStatusCollection": NetworkConnectivityStatusCollection, + "NumericAttribute": NumericAttribute, + "ObjectFreqStat": ObjectFreqStat, + "ObjectMetadata": ObjectMetadata, + "ObjectStorageWriteAttributes": ObjectStorageWriteAttributes, + "Operation": Operation, + "OperationExecResult": OperationExecResult, + "OperationFromProcedure": OperationFromProcedure, + "OperationInputRecord": OperationInputRecord, + "OperationSummary": OperationSummary, + "OperationSummaryCollection": OperationSummaryCollection, + "OperationSummaryFromProcedure": OperationSummaryFromProcedure, + "OracleAdwcWriteAttributes": OracleAdwcWriteAttributes, + "OracleAtpWriteAttributes": OracleAtpWriteAttributes, + "OracleReadAttribute": OracleReadAttribute, + "OracleReadAttributes": OracleReadAttributes, + "OracleWriteAttributes": OracleWriteAttributes, + "Outlier": Outlier, + "OutputPort": OutputPort, + "Parameter": Parameter, + "ParentReference": ParentReference, + "ParquetFormatAttribute": ParquetFormatAttribute, + "PartitionConfig": PartitionConfig, + "PrimaryKey": PrimaryKey, + "ProfileConfig": ProfileConfig, + "ProfileStat": ProfileStat, + "PushDownOperation": PushDownOperation, + "Query": Query, + "ReadOperationConfig": ReadOperationConfig, + "ReferenceArtifactSummary": ReferenceArtifactSummary, + "ReferenceArtifactSummaryCollection": ReferenceArtifactSummaryCollection, + "ReferenceInfo": ReferenceInfo, + "Registry": Registry, + "RegistryMetadata": RegistryMetadata, + "RegistrySummary": RegistrySummary, + "RegistrySummaryCollection": RegistrySummaryCollection, + "Row": Row, + "Schema": Schema, + "SchemaDriftConfig": SchemaDriftConfig, + "SchemaSummary": SchemaSummary, + "SchemaSummaryCollection": SchemaSummaryCollection, + "Select": Select, + "Shape": Shape, + "ShapeField": ShapeField, + "Sort": Sort, + "SortClause": SortClause, + "Source": Source, + "StringAttribute": StringAttribute, + "StructuredType": StructuredType, + "Target": Target, + "TestNetworkConnectivity": TestNetworkConnectivity, + "Type": Type, + "TypeLibrary": TypeLibrary, + "TypeSummary": TypeSummary, + "TypeSystem": TypeSystem, + "TypedObject": TypedObject, + "TypesSummaryCollection": TypesSummaryCollection, + "UniqueKey": UniqueKey, + "UpdateConnectionDetails": UpdateConnectionDetails, + "UpdateDataAssetDetails": UpdateDataAssetDetails, + "UpdateDpEndpointDetails": UpdateDpEndpointDetails, + "UpdateDpEndpointFromPrivate": UpdateDpEndpointFromPrivate, + "UpdateDpEndpointFromPublic": UpdateDpEndpointFromPublic, + "UpdateEndpointDetails": UpdateEndpointDetails, + "UpdateFolderDetails": UpdateFolderDetails, + "UpdateRegistryDetails": UpdateRegistryDetails, + "ValidationMessage": ValidationMessage, + "ValidationResult": ValidationResult, + "WorkRequest": WorkRequest, + "WorkRequestError": WorkRequestError, + "WorkRequestErrorCollection": WorkRequestErrorCollection, + "WorkRequestErrorSummary": WorkRequestErrorSummary, + "WorkRequestLog": WorkRequestLog, + "WorkRequestLogCollection": WorkRequestLogCollection, + "WorkRequestResource": WorkRequestResource, + "WorkRequestSummary": WorkRequestSummary, + "WorkRequestSummaryCollection": WorkRequestSummaryCollection, + "WriteOperationConfig": WriteOperationConfig +} diff --git a/src/oci/data_connectivity/models/abstract_call_attribute.py b/src/oci/data_connectivity/models/abstract_call_attribute.py new file mode 100644 index 0000000000..088f8d7d78 --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_call_attribute.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractCallAttribute(object): + """ + The call attributes + """ + + #: A constant which can be used with the model_type property of a AbstractCallAttribute. + #: This constant has a value of "BIPCALLATTRIBUTE" + MODEL_TYPE_BIPCALLATTRIBUTE = "BIPCALLATTRIBUTE" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractCallAttribute object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.BipCallAttribute` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AbstractCallAttribute. + Allowed values for this property are: "BIPCALLATTRIBUTE" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'BIPCALLATTRIBUTE': + return 'BipCallAttribute' + else: + return 'AbstractCallAttribute' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractCallAttribute. + The operation type + + Allowed values for this property are: "BIPCALLATTRIBUTE" + + + :return: The model_type of this AbstractCallAttribute. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractCallAttribute. + The operation type + + + :param model_type: The model_type of this AbstractCallAttribute. + :type: str + """ + allowed_values = ["BIPCALLATTRIBUTE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/abstract_data_operation_config.py b/src/oci/data_connectivity/models/abstract_data_operation_config.py new file mode 100644 index 0000000000..8463d5e70c --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_data_operation_config.py @@ -0,0 +1,108 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractDataOperationConfig(object): + """ + The information about the data operation. + """ + + #: A constant which can be used with the model_type property of a AbstractDataOperationConfig. + #: This constant has a value of "READ_OPERATION_CONFIG" + MODEL_TYPE_READ_OPERATION_CONFIG = "READ_OPERATION_CONFIG" + + #: A constant which can be used with the model_type property of a AbstractDataOperationConfig. + #: This constant has a value of "WRITE_OPERATION_CONFIG" + MODEL_TYPE_WRITE_OPERATION_CONFIG = "WRITE_OPERATION_CONFIG" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractDataOperationConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.WriteOperationConfig` + * :class:`~oci.data_connectivity.models.ReadOperationConfig` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AbstractDataOperationConfig. + Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'WRITE_OPERATION_CONFIG': + return 'WriteOperationConfig' + + if type == 'READ_OPERATION_CONFIG': + return 'ReadOperationConfig' + else: + return 'AbstractDataOperationConfig' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractDataOperationConfig. + The type of data operation. + + Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" + + + :return: The model_type of this AbstractDataOperationConfig. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractDataOperationConfig. + The type of data operation. + + + :param model_type: The model_type of this AbstractDataOperationConfig. + :type: str + """ + allowed_values = ["READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/abstract_format_attribute.py b/src/oci/data_connectivity/models/abstract_format_attribute.py new file mode 100644 index 0000000000..e5d85c48ea --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_format_attribute.py @@ -0,0 +1,123 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractFormatAttribute(object): + """ + The abstract format attribute. + """ + + #: A constant which can be used with the model_type property of a AbstractFormatAttribute. + #: This constant has a value of "JSON_FORMAT" + MODEL_TYPE_JSON_FORMAT = "JSON_FORMAT" + + #: A constant which can be used with the model_type property of a AbstractFormatAttribute. + #: This constant has a value of "CSV_FORMAT" + MODEL_TYPE_CSV_FORMAT = "CSV_FORMAT" + + #: A constant which can be used with the model_type property of a AbstractFormatAttribute. + #: This constant has a value of "AVRO_FORMAT" + MODEL_TYPE_AVRO_FORMAT = "AVRO_FORMAT" + + #: A constant which can be used with the model_type property of a AbstractFormatAttribute. + #: This constant has a value of "PARQUET_FORMAT" + MODEL_TYPE_PARQUET_FORMAT = "PARQUET_FORMAT" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractFormatAttribute object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.AvroFormatAttribute` + * :class:`~oci.data_connectivity.models.JsonFormatAttribute` + * :class:`~oci.data_connectivity.models.CsvFormatAttribute` + * :class:`~oci.data_connectivity.models.ParquetFormatAttribute` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AbstractFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'AVRO_FORMAT': + return 'AvroFormatAttribute' + + if type == 'JSON_FORMAT': + return 'JsonFormatAttribute' + + if type == 'CSV_FORMAT': + return 'CsvFormatAttribute' + + if type == 'PARQUET_FORMAT': + return 'ParquetFormatAttribute' + else: + return 'AbstractFormatAttribute' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractFormatAttribute. + The type of the format attribute. + + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this AbstractFormatAttribute. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractFormatAttribute. + The type of the format attribute. + + + :param model_type: The model_type of this AbstractFormatAttribute. + :type: str + """ + allowed_values = ["JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/abstract_read_attribute.py b/src/oci/data_connectivity/models/abstract_read_attribute.py new file mode 100644 index 0000000000..e49755f74a --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_read_attribute.py @@ -0,0 +1,116 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractReadAttribute(object): + """ + The abstract read attribute. + """ + + #: A constant which can be used with the model_type property of a AbstractReadAttribute. + #: This constant has a value of "ORACLEREADATTRIBUTE" + MODEL_TYPE_ORACLEREADATTRIBUTE = "ORACLEREADATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractReadAttribute. + #: This constant has a value of "ORACLE_READ_ATTRIBUTE" + MODEL_TYPE_ORACLE_READ_ATTRIBUTE = "ORACLE_READ_ATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractReadAttribute. + #: This constant has a value of "BICC_READ_ATTRIBUTE" + MODEL_TYPE_BICC_READ_ATTRIBUTE = "BICC_READ_ATTRIBUTE" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractReadAttribute object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.OracleReadAttributes` + * :class:`~oci.data_connectivity.models.BiccReadAttributes` + * :class:`~oci.data_connectivity.models.OracleReadAttribute` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AbstractReadAttribute. + Allowed values for this property are: "ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'ORACLE_READ_ATTRIBUTE': + return 'OracleReadAttributes' + + if type == 'BICC_READ_ATTRIBUTE': + return 'BiccReadAttributes' + + if type == 'ORACLEREADATTRIBUTE': + return 'OracleReadAttribute' + else: + return 'AbstractReadAttribute' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractReadAttribute. + The type of the abstract read attribute. + + Allowed values for this property are: "ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE" + + + :return: The model_type of this AbstractReadAttribute. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractReadAttribute. + The type of the abstract read attribute. + + + :param model_type: The model_type of this AbstractReadAttribute. + :type: str + """ + allowed_values = ["ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/abstract_write_attribute.py b/src/oci/data_connectivity/models/abstract_write_attribute.py new file mode 100644 index 0000000000..0ca7ada446 --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_write_attribute.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractWriteAttribute(object): + """ + The abstract write attribute. + """ + + #: A constant which can be used with the model_type property of a AbstractWriteAttribute. + #: This constant has a value of "ORACLE_WRITE_ATTRIBUTE" + MODEL_TYPE_ORACLE_WRITE_ATTRIBUTE = "ORACLE_WRITE_ATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractWriteAttribute. + #: This constant has a value of "ORACLE_ATP_WRITE_ATTRIBUTE" + MODEL_TYPE_ORACLE_ATP_WRITE_ATTRIBUTE = "ORACLE_ATP_WRITE_ATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractWriteAttribute. + #: This constant has a value of "ORACLE_ADWC_WRITE_ATTRIBUTE" + MODEL_TYPE_ORACLE_ADWC_WRITE_ATTRIBUTE = "ORACLE_ADWC_WRITE_ATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractWriteAttribute. + #: This constant has a value of "OBJECT_STORAGE_WRITE_ATTRIBUTE" + MODEL_TYPE_OBJECT_STORAGE_WRITE_ATTRIBUTE = "OBJECT_STORAGE_WRITE_ATTRIBUTE" + + #: A constant which can be used with the model_type property of a AbstractWriteAttribute. + #: This constant has a value of "HDFS_WRITE_ATTRIBUTE" + MODEL_TYPE_HDFS_WRITE_ATTRIBUTE = "HDFS_WRITE_ATTRIBUTE" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractWriteAttribute object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.OracleAtpWriteAttributes` + * :class:`~oci.data_connectivity.models.HdfsWriteAttributes` + * :class:`~oci.data_connectivity.models.OracleWriteAttributes` + * :class:`~oci.data_connectivity.models.OracleAdwcWriteAttributes` + * :class:`~oci.data_connectivity.models.ObjectStorageWriteAttributes` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AbstractWriteAttribute. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'ORACLE_ATP_WRITE_ATTRIBUTE': + return 'OracleAtpWriteAttributes' + + if type == 'HDFS_WRITE_ATTRIBUTE': + return 'HdfsWriteAttributes' + + if type == 'ORACLE_WRITE_ATTRIBUTE': + return 'OracleWriteAttributes' + + if type == 'ORACLE_ADWC_WRITE_ATTRIBUTE': + return 'OracleAdwcWriteAttributes' + + if type == 'OBJECT_STORAGE_WRITE_ATTRIBUTE': + return 'ObjectStorageWriteAttributes' + else: + return 'AbstractWriteAttribute' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractWriteAttribute. + The type of the abstract write attribute. + + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + + + :return: The model_type of this AbstractWriteAttribute. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractWriteAttribute. + The type of the abstract write attribute. + + + :param model_type: The model_type of this AbstractWriteAttribute. + :type: str + """ + allowed_values = ["ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/aggregator_summary.py b/src/oci/data_connectivity/models/aggregator_summary.py new file mode 100644 index 0000000000..6f66f31f9d --- /dev/null +++ b/src/oci/data_connectivity/models/aggregator_summary.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AggregatorSummary(object): + """ + A summary type containing information about the object's aggregator including its type, key, name and description. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AggregatorSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this AggregatorSummary. + :type type: str + + :param key: + The value to assign to the key property of this AggregatorSummary. + :type key: str + + :param name: + The value to assign to the name property of this AggregatorSummary. + :type name: str + + :param identifier: + The value to assign to the identifier property of this AggregatorSummary. + :type identifier: str + + :param description: + The value to assign to the description property of this AggregatorSummary. + :type description: str + + """ + self.swagger_types = { + 'type': 'str', + 'key': 'str', + 'name': 'str', + 'identifier': 'str', + 'description': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'key': 'key', + 'name': 'name', + 'identifier': 'identifier', + 'description': 'description' + } + + self._type = None + self._key = None + self._name = None + self._identifier = None + self._description = None + + @property + def type(self): + """ + Gets the type of this AggregatorSummary. + The type of the aggregator. + + + :return: The type of this AggregatorSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this AggregatorSummary. + The type of the aggregator. + + + :param type: The type of this AggregatorSummary. + :type: str + """ + self._type = type + + @property + def key(self): + """ + Gets the key of this AggregatorSummary. + The key of the aggregator object. + + + :return: The key of this AggregatorSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this AggregatorSummary. + The key of the aggregator object. + + + :param key: The key of this AggregatorSummary. + :type: str + """ + self._key = key + + @property + def name(self): + """ + Gets the name of this AggregatorSummary. + The name of the aggregator. + + + :return: The name of this AggregatorSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AggregatorSummary. + The name of the aggregator. + + + :param name: The name of this AggregatorSummary. + :type: str + """ + self._name = name + + @property + def identifier(self): + """ + Gets the identifier of this AggregatorSummary. + The identifier of the aggregator. + + + :return: The identifier of this AggregatorSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this AggregatorSummary. + The identifier of the aggregator. + + + :param identifier: The identifier of this AggregatorSummary. + :type: str + """ + self._identifier = identifier + + @property + def description(self): + """ + Gets the description of this AggregatorSummary. + The description of the aggregator. + + + :return: The description of this AggregatorSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AggregatorSummary. + The description of the aggregator. + + + :param description: The description of this AggregatorSummary. + :type: str + """ + self._description = description + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/attach_data_asset_info.py b/src/oci/data_connectivity/models/attach_data_asset_info.py new file mode 100644 index 0000000000..035d04073e --- /dev/null +++ b/src/oci/data_connectivity/models/attach_data_asset_info.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AttachDataAssetInfo(object): + """ + The attach DataAsset response. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AttachDataAssetInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_info: + The value to assign to the reference_info property of this AttachDataAssetInfo. + :type reference_info: dict(str, ValidationResult) + + """ + self.swagger_types = { + 'reference_info': 'dict(str, ValidationResult)' + } + + self.attribute_map = { + 'reference_info': 'referenceInfo' + } + + self._reference_info = None + + @property + def reference_info(self): + """ + **[Required]** Gets the reference_info of this AttachDataAssetInfo. + Map of DataAsset name as key and results as value + + + :return: The reference_info of this AttachDataAssetInfo. + :rtype: dict(str, ValidationResult) + """ + return self._reference_info + + @reference_info.setter + def reference_info(self, reference_info): + """ + Sets the reference_info of this AttachDataAssetInfo. + Map of DataAsset name as key and results as value + + + :param reference_info: The reference_info of this AttachDataAssetInfo. + :type: dict(str, ValidationResult) + """ + self._reference_info = reference_info + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/attribute.py b/src/oci/data_connectivity/models/attribute.py new file mode 100644 index 0000000000..0a6af11857 --- /dev/null +++ b/src/oci/data_connectivity/models/attribute.py @@ -0,0 +1,256 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Attribute(object): + """ + Registry Attribute Object, to get connector details + """ + + def __init__(self, **kwargs): + """ + Initializes a new Attribute 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 Attribute. + :type name: str + + :param is_sensitive: + The value to assign to the is_sensitive property of this Attribute. + :type is_sensitive: bool + + :param is_mandatory: + The value to assign to the is_mandatory property of this Attribute. + :type is_mandatory: bool + + :param is_generated: + The value to assign to the is_generated property of this Attribute. + :type is_generated: bool + + :param is_base64_encoded: + The value to assign to the is_base64_encoded property of this Attribute. + :type is_base64_encoded: bool + + :param valid_key_list: + The value to assign to the valid_key_list property of this Attribute. + :type valid_key_list: list[str] + + :param attribute_type: + The value to assign to the attribute_type property of this Attribute. + :type attribute_type: str + + """ + self.swagger_types = { + 'name': 'str', + 'is_sensitive': 'bool', + 'is_mandatory': 'bool', + 'is_generated': 'bool', + 'is_base64_encoded': 'bool', + 'valid_key_list': 'list[str]', + 'attribute_type': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'is_sensitive': 'isSensitive', + 'is_mandatory': 'isMandatory', + 'is_generated': 'isGenerated', + 'is_base64_encoded': 'isBase64Encoded', + 'valid_key_list': 'validKeyList', + 'attribute_type': 'attributeType' + } + + self._name = None + self._is_sensitive = None + self._is_mandatory = None + self._is_generated = None + self._is_base64_encoded = None + self._valid_key_list = None + self._attribute_type = None + + @property + def name(self): + """ + **[Required]** Gets the name of this Attribute. + The name of of the Attribute. + + + :return: The name of this Attribute. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Attribute. + The name of of the Attribute. + + + :param name: The name of this Attribute. + :type: str + """ + self._name = name + + @property + def is_sensitive(self): + """ + Gets the is_sensitive of this Attribute. + True if Attribute is sensitive. + + + :return: The is_sensitive of this Attribute. + :rtype: bool + """ + return self._is_sensitive + + @is_sensitive.setter + def is_sensitive(self, is_sensitive): + """ + Sets the is_sensitive of this Attribute. + True if Attribute is sensitive. + + + :param is_sensitive: The is_sensitive of this Attribute. + :type: bool + """ + self._is_sensitive = is_sensitive + + @property + def is_mandatory(self): + """ + Gets the is_mandatory of this Attribute. + True if Attribute is mandatory. + + + :return: The is_mandatory of this Attribute. + :rtype: bool + """ + return self._is_mandatory + + @is_mandatory.setter + def is_mandatory(self, is_mandatory): + """ + Sets the is_mandatory of this Attribute. + True if Attribute is mandatory. + + + :param is_mandatory: The is_mandatory of this Attribute. + :type: bool + """ + self._is_mandatory = is_mandatory + + @property + def is_generated(self): + """ + Gets the is_generated of this Attribute. + True if Attribute is generated. + + + :return: The is_generated of this Attribute. + :rtype: bool + """ + return self._is_generated + + @is_generated.setter + def is_generated(self, is_generated): + """ + Sets the is_generated of this Attribute. + True if Attribute is generated. + + + :param is_generated: The is_generated of this Attribute. + :type: bool + """ + self._is_generated = is_generated + + @property + def is_base64_encoded(self): + """ + Gets the is_base64_encoded of this Attribute. + True if Attribute is encoded. + + + :return: The is_base64_encoded of this Attribute. + :rtype: bool + """ + return self._is_base64_encoded + + @is_base64_encoded.setter + def is_base64_encoded(self, is_base64_encoded): + """ + Sets the is_base64_encoded of this Attribute. + True if Attribute is encoded. + + + :param is_base64_encoded: The is_base64_encoded of this Attribute. + :type: bool + """ + self._is_base64_encoded = is_base64_encoded + + @property + def valid_key_list(self): + """ + Gets the valid_key_list of this Attribute. + List of valid key list + + + :return: The valid_key_list of this Attribute. + :rtype: list[str] + """ + return self._valid_key_list + + @valid_key_list.setter + def valid_key_list(self, valid_key_list): + """ + Sets the valid_key_list of this Attribute. + List of valid key list + + + :param valid_key_list: The valid_key_list of this Attribute. + :type: list[str] + """ + self._valid_key_list = valid_key_list + + @property + def attribute_type(self): + """ + Gets the attribute_type of this Attribute. + Attribute type details + + + :return: The attribute_type of this Attribute. + :rtype: str + """ + return self._attribute_type + + @attribute_type.setter + def attribute_type(self, attribute_type): + """ + Sets the attribute_type of this Attribute. + Attribute type details + + + :param attribute_type: The attribute_type of this Attribute. + :type: str + """ + self._attribute_type = attribute_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/attribute_profile_result.py b/src/oci/data_connectivity/models/attribute_profile_result.py new file mode 100644 index 0000000000..42832703c4 --- /dev/null +++ b/src/oci/data_connectivity/models/attribute_profile_result.py @@ -0,0 +1,319 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AttributeProfileResult(object): + """ + A summary of profiling results of a specefic attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AttributeProfileResult object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.StringAttribute` + * :class:`~oci.data_connectivity.models.NumericAttribute` + * :class:`~oci.data_connectivity.models.DateAttribute` + + 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 AttributeProfileResult. + :type type: object + + :param name: + The value to assign to the name property of this AttributeProfileResult. + :type name: str + + :param min: + The value to assign to the min property of this AttributeProfileResult. + :type min: oci.data_connectivity.models.ProfileStat + + :param max: + The value to assign to the max property of this AttributeProfileResult. + :type max: oci.data_connectivity.models.ProfileStat + + :param null_count: + The value to assign to the null_count property of this AttributeProfileResult. + :type null_count: oci.data_connectivity.models.ProfileStat + + :param distinct_count: + The value to assign to the distinct_count property of this AttributeProfileResult. + :type distinct_count: oci.data_connectivity.models.ProfileStat + + :param unique_count: + The value to assign to the unique_count property of this AttributeProfileResult. + :type unique_count: oci.data_connectivity.models.ProfileStat + + :param duplicate_count: + The value to assign to the duplicate_count property of this AttributeProfileResult. + :type duplicate_count: oci.data_connectivity.models.ProfileStat + + :param value_frequencies: + The value to assign to the value_frequencies property of this AttributeProfileResult. + :type value_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + """ + self.swagger_types = { + 'type': 'object', + 'name': 'str', + 'min': 'ProfileStat', + 'max': 'ProfileStat', + 'null_count': 'ProfileStat', + 'distinct_count': 'ProfileStat', + 'unique_count': 'ProfileStat', + 'duplicate_count': 'ProfileStat', + 'value_frequencies': 'list[ObjectFreqStat]' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name', + 'min': 'min', + 'max': 'max', + 'null_count': 'nullCount', + 'distinct_count': 'distinctCount', + 'unique_count': 'uniqueCount', + 'duplicate_count': 'duplicateCount', + 'value_frequencies': 'valueFrequencies' + } + + self._type = None + self._name = None + self._min = None + self._max = None + self._null_count = None + self._distinct_count = None + self._unique_count = None + self._duplicate_count = None + self._value_frequencies = 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 == 'STRING': + return 'StringAttribute' + + if type == 'NUMERIC': + return 'NumericAttribute' + + if type == 'DATE_TIME': + return 'DateAttribute' + else: + return 'AttributeProfileResult' + + @property + def type(self): + """ + Gets the type of this AttributeProfileResult. + Type of attribute + + + :return: The type of this AttributeProfileResult. + :rtype: object + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this AttributeProfileResult. + Type of attribute + + + :param type: The type of this AttributeProfileResult. + :type: object + """ + self._type = type + + @property + def name(self): + """ + Gets the name of this AttributeProfileResult. + Name of attribute + + + :return: The name of this AttributeProfileResult. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AttributeProfileResult. + Name of attribute + + + :param name: The name of this AttributeProfileResult. + :type: str + """ + self._name = name + + @property + def min(self): + """ + Gets the min of this AttributeProfileResult. + + :return: The min of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._min + + @min.setter + def min(self, min): + """ + Sets the min of this AttributeProfileResult. + + :param min: The min of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._min = min + + @property + def max(self): + """ + Gets the max of this AttributeProfileResult. + + :return: The max of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._max + + @max.setter + def max(self, max): + """ + Sets the max of this AttributeProfileResult. + + :param max: The max of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._max = max + + @property + def null_count(self): + """ + Gets the null_count of this AttributeProfileResult. + + :return: The null_count of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._null_count + + @null_count.setter + def null_count(self, null_count): + """ + Sets the null_count of this AttributeProfileResult. + + :param null_count: The null_count of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._null_count = null_count + + @property + def distinct_count(self): + """ + Gets the distinct_count of this AttributeProfileResult. + + :return: The distinct_count of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._distinct_count + + @distinct_count.setter + def distinct_count(self, distinct_count): + """ + Sets the distinct_count of this AttributeProfileResult. + + :param distinct_count: The distinct_count of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._distinct_count = distinct_count + + @property + def unique_count(self): + """ + Gets the unique_count of this AttributeProfileResult. + + :return: The unique_count of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._unique_count + + @unique_count.setter + def unique_count(self, unique_count): + """ + Sets the unique_count of this AttributeProfileResult. + + :param unique_count: The unique_count of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._unique_count = unique_count + + @property + def duplicate_count(self): + """ + Gets the duplicate_count of this AttributeProfileResult. + + :return: The duplicate_count of this AttributeProfileResult. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._duplicate_count + + @duplicate_count.setter + def duplicate_count(self, duplicate_count): + """ + Sets the duplicate_count of this AttributeProfileResult. + + :param duplicate_count: The duplicate_count of this AttributeProfileResult. + :type: oci.data_connectivity.models.ProfileStat + """ + self._duplicate_count = duplicate_count + + @property + def value_frequencies(self): + """ + Gets the value_frequencies of this AttributeProfileResult. + Top N value frequencies for the column as described already in profile config topNValueFrequency property. + + + :return: The value_frequencies of this AttributeProfileResult. + :rtype: list[oci.data_connectivity.models.ObjectFreqStat] + """ + return self._value_frequencies + + @value_frequencies.setter + def value_frequencies(self, value_frequencies): + """ + Sets the value_frequencies of this AttributeProfileResult. + Top N value frequencies for the column as described already in profile config topNValueFrequency property. + + + :param value_frequencies: The value_frequencies of this AttributeProfileResult. + :type: list[oci.data_connectivity.models.ObjectFreqStat] + """ + self._value_frequencies = value_frequencies + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/avro_format_attribute.py b/src/oci/data_connectivity/models/avro_format_attribute.py new file mode 100644 index 0000000000..8ec4985d48 --- /dev/null +++ b/src/oci/data_connectivity/models/avro_format_attribute.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_format_attribute import AbstractFormatAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AvroFormatAttribute(AbstractFormatAttribute): + """ + The AVRO format attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AvroFormatAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.AvroFormatAttribute.model_type` attribute + of this class is ``AVRO_FORMAT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this AvroFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT" + :type model_type: str + + :param compression: + The value to assign to the compression property of this AvroFormatAttribute. + :type compression: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'compression': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'compression': 'compression' + } + + self._model_type = None + self._compression = None + self._model_type = 'AVRO_FORMAT' + + @property + def compression(self): + """ + Gets the compression of this AvroFormatAttribute. + The compression for the file. + + + :return: The compression of this AvroFormatAttribute. + :rtype: str + """ + return self._compression + + @compression.setter + def compression(self, compression): + """ + Sets the compression of this AvroFormatAttribute. + The compression for the file. + + + :param compression: The compression of this AvroFormatAttribute. + :type: str + """ + self._compression = compression + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/base_type.py b/src/oci/data_connectivity/models/base_type.py new file mode 100644 index 0000000000..4bab557c2c --- /dev/null +++ b/src/oci/data_connectivity/models/base_type.py @@ -0,0 +1,313 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class BaseType(object): + """ + Base type for the type system. + """ + + #: A constant which can be used with the model_type property of a BaseType. + #: This constant has a value of "STRUCTURED_TYPE" + MODEL_TYPE_STRUCTURED_TYPE = "STRUCTURED_TYPE" + + #: A constant which can be used with the model_type property of a BaseType. + #: This constant has a value of "DATA_TYPE" + MODEL_TYPE_DATA_TYPE = "DATA_TYPE" + + #: A constant which can be used with the model_type property of a BaseType. + #: This constant has a value of "CONFIGURED_TYPE" + MODEL_TYPE_CONFIGURED_TYPE = "CONFIGURED_TYPE" + + #: A constant which can be used with the model_type property of a BaseType. + #: This constant has a value of "COMPOSITE_TYPE" + MODEL_TYPE_COMPOSITE_TYPE = "COMPOSITE_TYPE" + + #: A constant which can be used with the model_type property of a BaseType. + #: This constant has a value of "DERIVED_TYPE" + MODEL_TYPE_DERIVED_TYPE = "DERIVED_TYPE" + + def __init__(self, **kwargs): + """ + Initializes a new BaseType object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.ConfiguredType` + * :class:`~oci.data_connectivity.models.DerivedType` + * :class:`~oci.data_connectivity.models.DataType` + * :class:`~oci.data_connectivity.models.StructuredType` + * :class:`~oci.data_connectivity.models.CompositeType` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this BaseType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this BaseType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this BaseType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this BaseType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this BaseType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this BaseType. + :type object_status: int + + :param description: + The value to assign to the description property of this BaseType. + :type description: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['modelType'] + + if type == 'CONFIGURED_TYPE': + return 'ConfiguredType' + + if type == 'DERIVED_TYPE': + return 'DerivedType' + + if type == 'DATA_TYPE': + return 'DataType' + + if type == 'STRUCTURED_TYPE': + return 'StructuredType' + + if type == 'COMPOSITE_TYPE': + return 'CompositeType' + else: + return 'BaseType' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this BaseType. + The property which disciminates the subtypes. + + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this BaseType. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this BaseType. + The property which disciminates the subtypes. + + + :param model_type: The model_type of this BaseType. + :type: str + """ + allowed_values = ["STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this BaseType. + The key of the object. + + + :return: The key of this BaseType. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this BaseType. + The key of the object. + + + :param key: The key of this BaseType. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this BaseType. + The model version of an object. + + + :return: The model_version of this BaseType. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this BaseType. + The model version of an object. + + + :param model_version: The model_version of this BaseType. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this BaseType. + + :return: The parent_ref of this BaseType. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this BaseType. + + :param parent_ref: The parent_ref of this BaseType. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this BaseType. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this BaseType. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this BaseType. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this BaseType. + :type: str + """ + self._name = name + + @property + def object_status(self): + """ + Gets the object_status of this BaseType. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this BaseType. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this BaseType. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this BaseType. + :type: int + """ + self._object_status = object_status + + @property + def description(self): + """ + Gets the description of this BaseType. + A user defined description for the object. + + + :return: The description of this BaseType. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this BaseType. + A user defined description for the object. + + + :param description: The description of this BaseType. + :type: str + """ + self._description = description + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/bicc_read_attributes.py b/src/oci/data_connectivity/models/bicc_read_attributes.py new file mode 100644 index 0000000000..b8bde688dc --- /dev/null +++ b/src/oci/data_connectivity/models/bicc_read_attributes.py @@ -0,0 +1,217 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_read_attribute import AbstractReadAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class BiccReadAttributes(AbstractReadAttribute): + """ + Properties to configure reading from an Oracle Database. + """ + + #: A constant which can be used with the extract_strategy property of a BiccReadAttributes. + #: This constant has a value of "FULL" + EXTRACT_STRATEGY_FULL = "FULL" + + #: A constant which can be used with the extract_strategy property of a BiccReadAttributes. + #: This constant has a value of "INCREMENTAL" + EXTRACT_STRATEGY_INCREMENTAL = "INCREMENTAL" + + def __init__(self, **kwargs): + """ + Initializes a new BiccReadAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.BiccReadAttributes.model_type` attribute + of this class is ``BICC_READ_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this BiccReadAttributes. + Allowed values for this property are: "ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE" + :type model_type: str + + :param fetch_size: + The value to assign to the fetch_size property of this BiccReadAttributes. + :type fetch_size: int + + :param extract_strategy: + The value to assign to the extract_strategy property of this BiccReadAttributes. + Allowed values for this property are: "FULL", "INCREMENTAL" + :type extract_strategy: str + + :param external_storage: + The value to assign to the external_storage property of this BiccReadAttributes. + :type external_storage: oci.data_connectivity.models.ExternalStorage + + :param initial_extract_date: + The value to assign to the initial_extract_date property of this BiccReadAttributes. + :type initial_extract_date: datetime + + :param last_extract_date: + The value to assign to the last_extract_date property of this BiccReadAttributes. + :type last_extract_date: datetime + + """ + self.swagger_types = { + 'model_type': 'str', + 'fetch_size': 'int', + 'extract_strategy': 'str', + 'external_storage': 'ExternalStorage', + 'initial_extract_date': 'datetime', + 'last_extract_date': 'datetime' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'fetch_size': 'fetchSize', + 'extract_strategy': 'extractStrategy', + 'external_storage': 'externalStorage', + 'initial_extract_date': 'initialExtractDate', + 'last_extract_date': 'lastExtractDate' + } + + self._model_type = None + self._fetch_size = None + self._extract_strategy = None + self._external_storage = None + self._initial_extract_date = None + self._last_extract_date = None + self._model_type = 'BICC_READ_ATTRIBUTE' + + @property + def fetch_size(self): + """ + Gets the fetch_size of this BiccReadAttributes. + The fetch size for reading. + + + :return: The fetch_size of this BiccReadAttributes. + :rtype: int + """ + return self._fetch_size + + @fetch_size.setter + def fetch_size(self, fetch_size): + """ + Sets the fetch_size of this BiccReadAttributes. + The fetch size for reading. + + + :param fetch_size: The fetch_size of this BiccReadAttributes. + :type: int + """ + self._fetch_size = fetch_size + + @property + def extract_strategy(self): + """ + Gets the extract_strategy of this BiccReadAttributes. + Extraction Strategy - FULL|INCREMENTAL + + Allowed values for this property are: "FULL", "INCREMENTAL" + + + :return: The extract_strategy of this BiccReadAttributes. + :rtype: str + """ + return self._extract_strategy + + @extract_strategy.setter + def extract_strategy(self, extract_strategy): + """ + Sets the extract_strategy of this BiccReadAttributes. + Extraction Strategy - FULL|INCREMENTAL + + + :param extract_strategy: The extract_strategy of this BiccReadAttributes. + :type: str + """ + allowed_values = ["FULL", "INCREMENTAL"] + if not value_allowed_none_or_none_sentinel(extract_strategy, allowed_values): + raise ValueError( + "Invalid value for `extract_strategy`, must be None or one of {0}" + .format(allowed_values) + ) + self._extract_strategy = extract_strategy + + @property + def external_storage(self): + """ + Gets the external_storage of this BiccReadAttributes. + + :return: The external_storage of this BiccReadAttributes. + :rtype: oci.data_connectivity.models.ExternalStorage + """ + return self._external_storage + + @external_storage.setter + def external_storage(self, external_storage): + """ + Sets the external_storage of this BiccReadAttributes. + + :param external_storage: The external_storage of this BiccReadAttributes. + :type: oci.data_connectivity.models.ExternalStorage + """ + self._external_storage = external_storage + + @property + def initial_extract_date(self): + """ + Gets the initial_extract_date of this BiccReadAttributes. + Date from where extract should start + + + :return: The initial_extract_date of this BiccReadAttributes. + :rtype: datetime + """ + return self._initial_extract_date + + @initial_extract_date.setter + def initial_extract_date(self, initial_extract_date): + """ + Sets the initial_extract_date of this BiccReadAttributes. + Date from where extract should start + + + :param initial_extract_date: The initial_extract_date of this BiccReadAttributes. + :type: datetime + """ + self._initial_extract_date = initial_extract_date + + @property + def last_extract_date(self): + """ + Gets the last_extract_date of this BiccReadAttributes. + Date last extracted + + + :return: The last_extract_date of this BiccReadAttributes. + :rtype: datetime + """ + return self._last_extract_date + + @last_extract_date.setter + def last_extract_date(self, last_extract_date): + """ + Sets the last_extract_date of this BiccReadAttributes. + Date last extracted + + + :param last_extract_date: The last_extract_date of this BiccReadAttributes. + :type: datetime + """ + self._last_extract_date = last_extract_date + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/bip_call_attribute.py b/src/oci/data_connectivity/models/bip_call_attribute.py new file mode 100644 index 0000000000..8bc51a15ae --- /dev/null +++ b/src/oci/data_connectivity/models/bip_call_attribute.py @@ -0,0 +1,223 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_call_attribute import AbstractCallAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class BipCallAttribute(AbstractCallAttribute): + """ + The call attributes impl + """ + + def __init__(self, **kwargs): + """ + Initializes a new BipCallAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.BipCallAttribute.model_type` attribute + of this class is ``BIPCALLATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this BipCallAttribute. + Allowed values for this property are: "BIPCALLATTRIBUTE" + :type model_type: str + + :param staging_bucket: + The value to assign to the staging_bucket property of this BipCallAttribute. + :type staging_bucket: oci.data_connectivity.models.Schema + + :param offset_parameter: + The value to assign to the offset_parameter property of this BipCallAttribute. + :type offset_parameter: str + + :param fetch_next_rows_parameter: + The value to assign to the fetch_next_rows_parameter property of this BipCallAttribute. + :type fetch_next_rows_parameter: str + + :param staging_data_asset: + The value to assign to the staging_data_asset property of this BipCallAttribute. + :type staging_data_asset: oci.data_connectivity.models.DataAsset + + :param staging_connection: + The value to assign to the staging_connection property of this BipCallAttribute. + :type staging_connection: oci.data_connectivity.models.Connection + + :param staging_prefix: + The value to assign to the staging_prefix property of this BipCallAttribute. + :type staging_prefix: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'staging_bucket': 'Schema', + 'offset_parameter': 'str', + 'fetch_next_rows_parameter': 'str', + 'staging_data_asset': 'DataAsset', + 'staging_connection': 'Connection', + 'staging_prefix': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'staging_bucket': 'stagingBucket', + 'offset_parameter': 'offsetParameter', + 'fetch_next_rows_parameter': 'fetchNextRowsParameter', + 'staging_data_asset': 'stagingDataAsset', + 'staging_connection': 'stagingConnection', + 'staging_prefix': 'stagingPrefix' + } + + self._model_type = None + self._staging_bucket = None + self._offset_parameter = None + self._fetch_next_rows_parameter = None + self._staging_data_asset = None + self._staging_connection = None + self._staging_prefix = None + self._model_type = 'BIPCALLATTRIBUTE' + + @property + def staging_bucket(self): + """ + Gets the staging_bucket of this BipCallAttribute. + + :return: The staging_bucket of this BipCallAttribute. + :rtype: oci.data_connectivity.models.Schema + """ + return self._staging_bucket + + @staging_bucket.setter + def staging_bucket(self, staging_bucket): + """ + Sets the staging_bucket of this BipCallAttribute. + + :param staging_bucket: The staging_bucket of this BipCallAttribute. + :type: oci.data_connectivity.models.Schema + """ + self._staging_bucket = staging_bucket + + @property + def offset_parameter(self): + """ + Gets the offset_parameter of this BipCallAttribute. + Parameter to set offset + + + :return: The offset_parameter of this BipCallAttribute. + :rtype: str + """ + return self._offset_parameter + + @offset_parameter.setter + def offset_parameter(self, offset_parameter): + """ + Sets the offset_parameter of this BipCallAttribute. + Parameter to set offset + + + :param offset_parameter: The offset_parameter of this BipCallAttribute. + :type: str + """ + self._offset_parameter = offset_parameter + + @property + def fetch_next_rows_parameter(self): + """ + Gets the fetch_next_rows_parameter of this BipCallAttribute. + Parameter to fetch next set of rows + + + :return: The fetch_next_rows_parameter of this BipCallAttribute. + :rtype: str + """ + return self._fetch_next_rows_parameter + + @fetch_next_rows_parameter.setter + def fetch_next_rows_parameter(self, fetch_next_rows_parameter): + """ + Sets the fetch_next_rows_parameter of this BipCallAttribute. + Parameter to fetch next set of rows + + + :param fetch_next_rows_parameter: The fetch_next_rows_parameter of this BipCallAttribute. + :type: str + """ + self._fetch_next_rows_parameter = fetch_next_rows_parameter + + @property + def staging_data_asset(self): + """ + Gets the staging_data_asset of this BipCallAttribute. + + :return: The staging_data_asset of this BipCallAttribute. + :rtype: oci.data_connectivity.models.DataAsset + """ + return self._staging_data_asset + + @staging_data_asset.setter + def staging_data_asset(self, staging_data_asset): + """ + Sets the staging_data_asset of this BipCallAttribute. + + :param staging_data_asset: The staging_data_asset of this BipCallAttribute. + :type: oci.data_connectivity.models.DataAsset + """ + self._staging_data_asset = staging_data_asset + + @property + def staging_connection(self): + """ + Gets the staging_connection of this BipCallAttribute. + + :return: The staging_connection of this BipCallAttribute. + :rtype: oci.data_connectivity.models.Connection + """ + return self._staging_connection + + @staging_connection.setter + def staging_connection(self, staging_connection): + """ + Sets the staging_connection of this BipCallAttribute. + + :param staging_connection: The staging_connection of this BipCallAttribute. + :type: oci.data_connectivity.models.Connection + """ + self._staging_connection = staging_connection + + @property + def staging_prefix(self): + """ + Gets the staging_prefix of this BipCallAttribute. + Prefix for the staging DataAsset + + + :return: The staging_prefix of this BipCallAttribute. + :rtype: str + """ + return self._staging_prefix + + @staging_prefix.setter + def staging_prefix(self, staging_prefix): + """ + Sets the staging_prefix of this BipCallAttribute. + Prefix for the staging DataAsset + + + :param staging_prefix: The staging_prefix of this BipCallAttribute. + :type: str + """ + self._staging_prefix = staging_prefix + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/call_operation_config.py b/src/oci/data_connectivity/models/call_operation_config.py new file mode 100644 index 0000000000..b59b428be1 --- /dev/null +++ b/src/oci/data_connectivity/models/call_operation_config.py @@ -0,0 +1,159 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CallOperationConfig(object): + """ + Holder for parameters names. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CallOperationConfig object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param in_fields: + The value to assign to the in_fields property of this CallOperationConfig. + :type in_fields: list[str] + + :param out_fields: + The value to assign to the out_fields property of this CallOperationConfig. + :type out_fields: list[str] + + :param call_attribute: + The value to assign to the call_attribute property of this CallOperationConfig. + :type call_attribute: oci.data_connectivity.models.AbstractCallAttribute + + :param push_down_operations: + The value to assign to the push_down_operations property of this CallOperationConfig. + :type push_down_operations: list[oci.data_connectivity.models.PushDownOperation] + + """ + self.swagger_types = { + 'in_fields': 'list[str]', + 'out_fields': 'list[str]', + 'call_attribute': 'AbstractCallAttribute', + 'push_down_operations': 'list[PushDownOperation]' + } + + self.attribute_map = { + 'in_fields': 'inFields', + 'out_fields': 'outFields', + 'call_attribute': 'callAttribute', + 'push_down_operations': 'pushDownOperations' + } + + self._in_fields = None + self._out_fields = None + self._call_attribute = None + self._push_down_operations = None + + @property + def in_fields(self): + """ + Gets the in_fields of this CallOperationConfig. + List of names of IN/INOUT parameters. + + + :return: The in_fields of this CallOperationConfig. + :rtype: list[str] + """ + return self._in_fields + + @in_fields.setter + def in_fields(self, in_fields): + """ + Sets the in_fields of this CallOperationConfig. + List of names of IN/INOUT parameters. + + + :param in_fields: The in_fields of this CallOperationConfig. + :type: list[str] + """ + self._in_fields = in_fields + + @property + def out_fields(self): + """ + Gets the out_fields of this CallOperationConfig. + List of names of OUT/INOUT parameters. + + + :return: The out_fields of this CallOperationConfig. + :rtype: list[str] + """ + return self._out_fields + + @out_fields.setter + def out_fields(self, out_fields): + """ + Sets the out_fields of this CallOperationConfig. + List of names of OUT/INOUT parameters. + + + :param out_fields: The out_fields of this CallOperationConfig. + :type: list[str] + """ + self._out_fields = out_fields + + @property + def call_attribute(self): + """ + Gets the call_attribute of this CallOperationConfig. + + :return: The call_attribute of this CallOperationConfig. + :rtype: oci.data_connectivity.models.AbstractCallAttribute + """ + return self._call_attribute + + @call_attribute.setter + def call_attribute(self, call_attribute): + """ + Sets the call_attribute of this CallOperationConfig. + + :param call_attribute: The call_attribute of this CallOperationConfig. + :type: oci.data_connectivity.models.AbstractCallAttribute + """ + self._call_attribute = call_attribute + + @property + def push_down_operations(self): + """ + Gets the push_down_operations of this CallOperationConfig. + List of push down operations. + + + :return: The push_down_operations of this CallOperationConfig. + :rtype: list[oci.data_connectivity.models.PushDownOperation] + """ + return self._push_down_operations + + @push_down_operations.setter + def push_down_operations(self, push_down_operations): + """ + Sets the push_down_operations of this CallOperationConfig. + List of push down operations. + + + :param push_down_operations: The push_down_operations of this CallOperationConfig. + :type: list[oci.data_connectivity.models.PushDownOperation] + """ + self._push_down_operations = push_down_operations + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/change_endpoint_compartment_details.py b/src/oci/data_connectivity/models/change_endpoint_compartment_details.py new file mode 100644 index 0000000000..d6cf22b0b2 --- /dev/null +++ b/src/oci/data_connectivity/models/change_endpoint_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeEndpointCompartmentDetails(object): + """ + The information about change compartment action. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeEndpointCompartmentDetails 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 ChangeEndpointCompartmentDetails. + :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 ChangeEndpointCompartmentDetails. + Compartment Identifier + + + :return: The compartment_id of this ChangeEndpointCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeEndpointCompartmentDetails. + Compartment Identifier + + + :param compartment_id: The compartment_id of this ChangeEndpointCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/change_registry_compartment_details.py b/src/oci/data_connectivity/models/change_registry_compartment_details.py new file mode 100644 index 0000000000..aeec339faa --- /dev/null +++ b/src/oci/data_connectivity/models/change_registry_compartment_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChangeRegistryCompartmentDetails(object): + """ + The information about change compartment action. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChangeRegistryCompartmentDetails 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 ChangeRegistryCompartmentDetails. + :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 ChangeRegistryCompartmentDetails. + Compartment Identifier + + + :return: The compartment_id of this ChangeRegistryCompartmentDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this ChangeRegistryCompartmentDetails. + Compartment Identifier + + + :param compartment_id: The compartment_id of this ChangeRegistryCompartmentDetails. + :type: str + """ + self._compartment_id = compartment_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/column.py b/src/oci/data_connectivity/models/column.py new file mode 100644 index 0000000000..05b740632b --- /dev/null +++ b/src/oci/data_connectivity/models/column.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Column(object): + """ + Data preview column definition. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Column 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 Column. + :type name: str + + :param data_type: + The value to assign to the data_type property of this Column. + :type data_type: str + + """ + self.swagger_types = { + 'name': 'str', + 'data_type': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'data_type': 'dataType' + } + + self._name = None + self._data_type = None + + @property + def name(self): + """ + Gets the name of this Column. + Column Name. + + + :return: The name of this Column. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Column. + Column Name. + + + :param name: The name of this Column. + :type: str + """ + self._name = name + + @property + def data_type(self): + """ + Gets the data_type of this Column. + Data type of the specified column. + + + :return: The data_type of this Column. + :rtype: str + """ + return self._data_type + + @data_type.setter + def data_type(self, data_type): + """ + Sets the data_type of this Column. + Data type of the specified column. + + + :param data_type: The data_type of this Column. + :type: str + """ + self._data_type = data_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/composite_type.py b/src/oci/data_connectivity/models/composite_type.py new file mode 100644 index 0000000000..73b441d5a9 --- /dev/null +++ b/src/oci/data_connectivity/models/composite_type.py @@ -0,0 +1,176 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .base_type import BaseType +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CompositeType(BaseType): + """ + A `CompositeType` represents a type that is composed of a list of sub-types, for example an `Address` type. The sub-types can be simple `DataType` or other `CompositeType` objects. Typically, a `CompositeType` may represent an arbitrarily deep hierarchy of types. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CompositeType object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CompositeType.model_type` attribute + of this class is ``COMPOSITE_TYPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CompositeType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE" + :type model_type: str + + :param key: + The value to assign to the key property of this CompositeType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CompositeType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CompositeType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CompositeType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this CompositeType. + :type object_status: int + + :param description: + The value to assign to the description property of this CompositeType. + :type description: str + + :param parent_type: + The value to assign to the parent_type property of this CompositeType. + :type parent_type: oci.data_connectivity.models.CompositeType + + :param elements: + The value to assign to the elements property of this CompositeType. + :type elements: list[oci.data_connectivity.models.TypedObject] + + :param config_definition: + The value to assign to the config_definition property of this CompositeType. + :type config_definition: oci.data_connectivity.models.ConfigDefinition + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str', + 'parent_type': 'CompositeType', + 'elements': 'list[TypedObject]', + 'config_definition': 'ConfigDefinition' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description', + 'parent_type': 'parentType', + 'elements': 'elements', + 'config_definition': 'configDefinition' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + self._parent_type = None + self._elements = None + self._config_definition = None + self._model_type = 'COMPOSITE_TYPE' + + @property + def parent_type(self): + """ + Gets the parent_type of this CompositeType. + + :return: The parent_type of this CompositeType. + :rtype: oci.data_connectivity.models.CompositeType + """ + return self._parent_type + + @parent_type.setter + def parent_type(self, parent_type): + """ + Sets the parent_type of this CompositeType. + + :param parent_type: The parent_type of this CompositeType. + :type: oci.data_connectivity.models.CompositeType + """ + self._parent_type = parent_type + + @property + def elements(self): + """ + Gets the elements of this CompositeType. + An array of elements. + + + :return: The elements of this CompositeType. + :rtype: list[oci.data_connectivity.models.TypedObject] + """ + return self._elements + + @elements.setter + def elements(self, elements): + """ + Sets the elements of this CompositeType. + An array of elements. + + + :param elements: The elements of this CompositeType. + :type: list[oci.data_connectivity.models.TypedObject] + """ + self._elements = elements + + @property + def config_definition(self): + """ + Gets the config_definition of this CompositeType. + + :return: The config_definition of this CompositeType. + :rtype: oci.data_connectivity.models.ConfigDefinition + """ + return self._config_definition + + @config_definition.setter + def config_definition(self, config_definition): + """ + Sets the config_definition of this CompositeType. + + :param config_definition: The config_definition of this CompositeType. + :type: oci.data_connectivity.models.ConfigDefinition + """ + self._config_definition = config_definition + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/compression.py b/src/oci/data_connectivity/models/compression.py new file mode 100644 index 0000000000..3fce235ce6 --- /dev/null +++ b/src/oci/data_connectivity/models/compression.py @@ -0,0 +1,106 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Compression(object): + """ + The optional compression configuration. + """ + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "NONE" + CODEC_NONE = "NONE" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "AUTO" + CODEC_AUTO = "AUTO" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "GZIP" + CODEC_GZIP = "GZIP" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "BZIP2" + CODEC_BZIP2 = "BZIP2" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "DEFLATE" + CODEC_DEFLATE = "DEFLATE" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "LZ4" + CODEC_LZ4 = "LZ4" + + #: A constant which can be used with the codec property of a Compression. + #: This constant has a value of "SNAPPY" + CODEC_SNAPPY = "SNAPPY" + + def __init__(self, **kwargs): + """ + Initializes a new Compression object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param codec: + The value to assign to the codec property of this Compression. + Allowed values for this property are: "NONE", "AUTO", "GZIP", "BZIP2", "DEFLATE", "LZ4", "SNAPPY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type codec: str + + """ + self.swagger_types = { + 'codec': 'str' + } + + self.attribute_map = { + 'codec': 'codec' + } + + self._codec = None + + @property + def codec(self): + """ + **[Required]** Gets the codec of this Compression. + Compression algorithm + + Allowed values for this property are: "NONE", "AUTO", "GZIP", "BZIP2", "DEFLATE", "LZ4", "SNAPPY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The codec of this Compression. + :rtype: str + """ + return self._codec + + @codec.setter + def codec(self, codec): + """ + Sets the codec of this Compression. + Compression algorithm + + + :param codec: The codec of this Compression. + :type: str + """ + allowed_values = ["NONE", "AUTO", "GZIP", "BZIP2", "DEFLATE", "LZ4", "SNAPPY"] + if not value_allowed_none_or_none_sentinel(codec, allowed_values): + codec = 'UNKNOWN_ENUM_VALUE' + self._codec = codec + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/config_definition.py b/src/oci/data_connectivity/models/config_definition.py new file mode 100644 index 0000000000..ec1cb13734 --- /dev/null +++ b/src/oci/data_connectivity/models/config_definition.py @@ -0,0 +1,283 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigDefinition(object): + """ + The configuration details of a configurable object. This contains one or more config param definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigDefinition object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this ConfigDefinition. + :type key: str + + :param model_type: + The value to assign to the model_type property of this ConfigDefinition. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ConfigDefinition. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ConfigDefinition. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ConfigDefinition. + :type name: str + + :param is_contained: + The value to assign to the is_contained property of this ConfigDefinition. + :type is_contained: bool + + :param object_status: + The value to assign to the object_status property of this ConfigDefinition. + :type object_status: int + + :param config_parameter_definitions: + The value to assign to the config_parameter_definitions property of this ConfigDefinition. + :type config_parameter_definitions: dict(str, ConfigParameterDefinition) + + """ + self.swagger_types = { + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'is_contained': 'bool', + 'object_status': 'int', + 'config_parameter_definitions': 'dict(str, ConfigParameterDefinition)' + } + + self.attribute_map = { + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'is_contained': 'isContained', + 'object_status': 'objectStatus', + 'config_parameter_definitions': 'configParameterDefinitions' + } + + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._is_contained = None + self._object_status = None + self._config_parameter_definitions = None + + @property + def key(self): + """ + Gets the key of this ConfigDefinition. + The key of the object. + + + :return: The key of this ConfigDefinition. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ConfigDefinition. + The key of the object. + + + :param key: The key of this ConfigDefinition. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + Gets the model_type of this ConfigDefinition. + The type of the object. + + + :return: The model_type of this ConfigDefinition. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ConfigDefinition. + The type of the object. + + + :param model_type: The model_type of this ConfigDefinition. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this ConfigDefinition. + The model version of an object. + + + :return: The model_version of this ConfigDefinition. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ConfigDefinition. + The model version of an object. + + + :param model_version: The model_version of this ConfigDefinition. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ConfigDefinition. + + :return: The parent_ref of this ConfigDefinition. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ConfigDefinition. + + :param parent_ref: The parent_ref of this ConfigDefinition. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this ConfigDefinition. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ConfigDefinition. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConfigDefinition. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ConfigDefinition. + :type: str + """ + self._name = name + + @property + def is_contained(self): + """ + Gets the is_contained of this ConfigDefinition. + Specifies whether the configuration is contained or not. + + + :return: The is_contained of this ConfigDefinition. + :rtype: bool + """ + return self._is_contained + + @is_contained.setter + def is_contained(self, is_contained): + """ + Sets the is_contained of this ConfigDefinition. + Specifies whether the configuration is contained or not. + + + :param is_contained: The is_contained of this ConfigDefinition. + :type: bool + """ + self._is_contained = is_contained + + @property + def object_status(self): + """ + Gets the object_status of this ConfigDefinition. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ConfigDefinition. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ConfigDefinition. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ConfigDefinition. + :type: int + """ + self._object_status = object_status + + @property + def config_parameter_definitions(self): + """ + Gets the config_parameter_definitions of this ConfigDefinition. + The parameter configuration details. + + + :return: The config_parameter_definitions of this ConfigDefinition. + :rtype: dict(str, ConfigParameterDefinition) + """ + return self._config_parameter_definitions + + @config_parameter_definitions.setter + def config_parameter_definitions(self, config_parameter_definitions): + """ + Sets the config_parameter_definitions of this ConfigDefinition. + The parameter configuration details. + + + :param config_parameter_definitions: The config_parameter_definitions of this ConfigDefinition. + :type: dict(str, ConfigParameterDefinition) + """ + self._config_parameter_definitions = config_parameter_definitions + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/config_parameter_definition.py b/src/oci/data_connectivity/models/config_parameter_definition.py new file mode 100644 index 0000000000..94275a2761 --- /dev/null +++ b/src/oci/data_connectivity/models/config_parameter_definition.py @@ -0,0 +1,252 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigParameterDefinition(object): + """ + The configurable properties of an object type. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigParameterDefinition object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param parameter_type: + The value to assign to the parameter_type property of this ConfigParameterDefinition. + :type parameter_type: oci.data_connectivity.models.BaseType + + :param parameter_name: + The value to assign to the parameter_name property of this ConfigParameterDefinition. + :type parameter_name: str + + :param description: + The value to assign to the description property of this ConfigParameterDefinition. + :type description: str + + :param default_value: + The value to assign to the default_value property of this ConfigParameterDefinition. + :type default_value: object + + :param class_field_name: + The value to assign to the class_field_name property of this ConfigParameterDefinition. + :type class_field_name: str + + :param is_static: + The value to assign to the is_static property of this ConfigParameterDefinition. + :type is_static: bool + + :param is_class_field_value: + The value to assign to the is_class_field_value property of this ConfigParameterDefinition. + :type is_class_field_value: bool + + """ + self.swagger_types = { + 'parameter_type': 'BaseType', + 'parameter_name': 'str', + 'description': 'str', + 'default_value': 'object', + 'class_field_name': 'str', + 'is_static': 'bool', + 'is_class_field_value': 'bool' + } + + self.attribute_map = { + 'parameter_type': 'parameterType', + 'parameter_name': 'parameterName', + 'description': 'description', + 'default_value': 'defaultValue', + 'class_field_name': 'classFieldName', + 'is_static': 'isStatic', + 'is_class_field_value': 'isClassFieldValue' + } + + self._parameter_type = None + self._parameter_name = None + self._description = None + self._default_value = None + self._class_field_name = None + self._is_static = None + self._is_class_field_value = None + + @property + def parameter_type(self): + """ + Gets the parameter_type of this ConfigParameterDefinition. + + :return: The parameter_type of this ConfigParameterDefinition. + :rtype: oci.data_connectivity.models.BaseType + """ + return self._parameter_type + + @parameter_type.setter + def parameter_type(self, parameter_type): + """ + Sets the parameter_type of this ConfigParameterDefinition. + + :param parameter_type: The parameter_type of this ConfigParameterDefinition. + :type: oci.data_connectivity.models.BaseType + """ + self._parameter_type = parameter_type + + @property + def parameter_name(self): + """ + Gets the parameter_name of this ConfigParameterDefinition. + This object represents the configurable properties for an object type. + + + :return: The parameter_name of this ConfigParameterDefinition. + :rtype: str + """ + return self._parameter_name + + @parameter_name.setter + def parameter_name(self, parameter_name): + """ + Sets the parameter_name of this ConfigParameterDefinition. + This object represents the configurable properties for an object type. + + + :param parameter_name: The parameter_name of this ConfigParameterDefinition. + :type: str + """ + self._parameter_name = parameter_name + + @property + def description(self): + """ + Gets the description of this ConfigParameterDefinition. + A user defined description for the object. + + + :return: The description of this ConfigParameterDefinition. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ConfigParameterDefinition. + A user defined description for the object. + + + :param description: The description of this ConfigParameterDefinition. + :type: str + """ + self._description = description + + @property + def default_value(self): + """ + Gets the default_value of this ConfigParameterDefinition. + The default value for the parameter. + + + :return: The default_value of this ConfigParameterDefinition. + :rtype: object + """ + return self._default_value + + @default_value.setter + def default_value(self, default_value): + """ + Sets the default_value of this ConfigParameterDefinition. + The default value for the parameter. + + + :param default_value: The default_value of this ConfigParameterDefinition. + :type: object + """ + self._default_value = default_value + + @property + def class_field_name(self): + """ + Gets the class_field_name of this ConfigParameterDefinition. + The parameter class field name. + + + :return: The class_field_name of this ConfigParameterDefinition. + :rtype: str + """ + return self._class_field_name + + @class_field_name.setter + def class_field_name(self, class_field_name): + """ + Sets the class_field_name of this ConfigParameterDefinition. + The parameter class field name. + + + :param class_field_name: The class_field_name of this ConfigParameterDefinition. + :type: str + """ + self._class_field_name = class_field_name + + @property + def is_static(self): + """ + Gets the is_static of this ConfigParameterDefinition. + Specifies whether the parameter is static or not. + + + :return: The is_static of this ConfigParameterDefinition. + :rtype: bool + """ + return self._is_static + + @is_static.setter + def is_static(self, is_static): + """ + Sets the is_static of this ConfigParameterDefinition. + Specifies whether the parameter is static or not. + + + :param is_static: The is_static of this ConfigParameterDefinition. + :type: bool + """ + self._is_static = is_static + + @property + def is_class_field_value(self): + """ + Gets the is_class_field_value of this ConfigParameterDefinition. + Specifies whether the parameter is a class field or not. + + + :return: The is_class_field_value of this ConfigParameterDefinition. + :rtype: bool + """ + return self._is_class_field_value + + @is_class_field_value.setter + def is_class_field_value(self, is_class_field_value): + """ + Sets the is_class_field_value of this ConfigParameterDefinition. + Specifies whether the parameter is a class field or not. + + + :param is_class_field_value: The is_class_field_value of this ConfigParameterDefinition. + :type: bool + """ + self._is_class_field_value = is_class_field_value + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/config_parameter_value.py b/src/oci/data_connectivity/models/config_parameter_value.py new file mode 100644 index 0000000000..bc97d96e95 --- /dev/null +++ b/src/oci/data_connectivity/models/config_parameter_value.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigParameterValue(object): + """ + Contains the parameter configuration values. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigParameterValue object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param string_value: + The value to assign to the string_value property of this ConfigParameterValue. + :type string_value: str + + :param int_value: + The value to assign to the int_value property of this ConfigParameterValue. + :type int_value: int + + :param object_value: + The value to assign to the object_value property of this ConfigParameterValue. + :type object_value: object + + :param ref_value: + The value to assign to the ref_value property of this ConfigParameterValue. + :type ref_value: object + + :param parameter_value: + The value to assign to the parameter_value property of this ConfigParameterValue. + :type parameter_value: str + + """ + self.swagger_types = { + 'string_value': 'str', + 'int_value': 'int', + 'object_value': 'object', + 'ref_value': 'object', + 'parameter_value': 'str' + } + + self.attribute_map = { + 'string_value': 'stringValue', + 'int_value': 'intValue', + 'object_value': 'objectValue', + 'ref_value': 'refValue', + 'parameter_value': 'parameterValue' + } + + self._string_value = None + self._int_value = None + self._object_value = None + self._ref_value = None + self._parameter_value = None + + @property + def string_value(self): + """ + Gets the string_value of this ConfigParameterValue. + A string value of the parameter. + + + :return: The string_value of this ConfigParameterValue. + :rtype: str + """ + return self._string_value + + @string_value.setter + def string_value(self, string_value): + """ + Sets the string_value of this ConfigParameterValue. + A string value of the parameter. + + + :param string_value: The string_value of this ConfigParameterValue. + :type: str + """ + self._string_value = string_value + + @property + def int_value(self): + """ + Gets the int_value of this ConfigParameterValue. + An integer value of the parameter. + + + :return: The int_value of this ConfigParameterValue. + :rtype: int + """ + return self._int_value + + @int_value.setter + def int_value(self, int_value): + """ + Sets the int_value of this ConfigParameterValue. + An integer value of the parameter. + + + :param int_value: The int_value of this ConfigParameterValue. + :type: int + """ + self._int_value = int_value + + @property + def object_value(self): + """ + Gets the object_value of this ConfigParameterValue. + An object value of the parameter. + + + :return: The object_value of this ConfigParameterValue. + :rtype: object + """ + return self._object_value + + @object_value.setter + def object_value(self, object_value): + """ + Sets the object_value of this ConfigParameterValue. + An object value of the parameter. + + + :param object_value: The object_value of this ConfigParameterValue. + :type: object + """ + self._object_value = object_value + + @property + def ref_value(self): + """ + Gets the ref_value of this ConfigParameterValue. + The root object reference value. + + + :return: The ref_value of this ConfigParameterValue. + :rtype: object + """ + return self._ref_value + + @ref_value.setter + def ref_value(self, ref_value): + """ + Sets the ref_value of this ConfigParameterValue. + The root object reference value. + + + :param ref_value: The ref_value of this ConfigParameterValue. + :type: object + """ + self._ref_value = ref_value + + @property + def parameter_value(self): + """ + Gets the parameter_value of this ConfigParameterValue. + Reference to the parameter by its key. + + + :return: The parameter_value of this ConfigParameterValue. + :rtype: str + """ + return self._parameter_value + + @parameter_value.setter + def parameter_value(self, parameter_value): + """ + Sets the parameter_value of this ConfigParameterValue. + Reference to the parameter by its key. + + + :param parameter_value: The parameter_value of this ConfigParameterValue. + :type: str + """ + self._parameter_value = parameter_value + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/config_values.py b/src/oci/data_connectivity/models/config_values.py new file mode 100644 index 0000000000..39e4dac128 --- /dev/null +++ b/src/oci/data_connectivity/models/config_values.py @@ -0,0 +1,97 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfigValues(object): + """ + Configuration values can be string, objects, or parameters. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigValues object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param config_param_values: + The value to assign to the config_param_values property of this ConfigValues. + :type config_param_values: dict(str, ConfigParameterValue) + + :param parent_ref: + The value to assign to the parent_ref property of this ConfigValues. + :type parent_ref: oci.data_connectivity.models.ParentReference + + """ + self.swagger_types = { + 'config_param_values': 'dict(str, ConfigParameterValue)', + 'parent_ref': 'ParentReference' + } + + self.attribute_map = { + 'config_param_values': 'configParamValues', + 'parent_ref': 'parentRef' + } + + self._config_param_values = None + self._parent_ref = None + + @property + def config_param_values(self): + """ + Gets the config_param_values of this ConfigValues. + The configuration parameter values. + + + :return: The config_param_values of this ConfigValues. + :rtype: dict(str, ConfigParameterValue) + """ + return self._config_param_values + + @config_param_values.setter + def config_param_values(self, config_param_values): + """ + Sets the config_param_values of this ConfigValues. + The configuration parameter values. + + + :param config_param_values: The config_param_values of this ConfigValues. + :type: dict(str, ConfigParameterValue) + """ + self._config_param_values = config_param_values + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ConfigValues. + + :return: The parent_ref of this ConfigValues. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ConfigValues. + + :param parent_ref: The parent_ref of this ConfigValues. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/configured_type.py b/src/oci/data_connectivity/models/configured_type.py new file mode 100644 index 0000000000..0a03ce3751 --- /dev/null +++ b/src/oci/data_connectivity/models/configured_type.py @@ -0,0 +1,172 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .base_type import BaseType +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConfiguredType(BaseType): + """ + A `ConfiguredType` represents a type that has built-in configuration to the type itself. An example is a `SSN` type whose basic type is `VARCHAR`, but the type itself also has a built-in configuration like length=10. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfiguredType object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ConfiguredType.model_type` attribute + of this class is ``CONFIGURED_TYPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ConfiguredType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE" + :type model_type: str + + :param key: + The value to assign to the key property of this ConfiguredType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ConfiguredType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ConfiguredType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ConfiguredType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this ConfiguredType. + :type object_status: int + + :param description: + The value to assign to the description property of this ConfiguredType. + :type description: str + + :param wrapped_type: + The value to assign to the wrapped_type property of this ConfiguredType. + :type wrapped_type: oci.data_connectivity.models.BaseType + + :param config_values: + The value to assign to the config_values property of this ConfiguredType. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param config_definition: + The value to assign to the config_definition property of this ConfiguredType. + :type config_definition: oci.data_connectivity.models.ConfigDefinition + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str', + 'wrapped_type': 'BaseType', + 'config_values': 'ConfigValues', + 'config_definition': 'ConfigDefinition' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description', + 'wrapped_type': 'wrappedType', + 'config_values': 'configValues', + 'config_definition': 'configDefinition' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + self._wrapped_type = None + self._config_values = None + self._config_definition = None + self._model_type = 'CONFIGURED_TYPE' + + @property + def wrapped_type(self): + """ + Gets the wrapped_type of this ConfiguredType. + + :return: The wrapped_type of this ConfiguredType. + :rtype: oci.data_connectivity.models.BaseType + """ + return self._wrapped_type + + @wrapped_type.setter + def wrapped_type(self, wrapped_type): + """ + Sets the wrapped_type of this ConfiguredType. + + :param wrapped_type: The wrapped_type of this ConfiguredType. + :type: oci.data_connectivity.models.BaseType + """ + self._wrapped_type = wrapped_type + + @property + def config_values(self): + """ + Gets the config_values of this ConfiguredType. + + :return: The config_values of this ConfiguredType. + :rtype: oci.data_connectivity.models.ConfigValues + """ + return self._config_values + + @config_values.setter + def config_values(self, config_values): + """ + Sets the config_values of this ConfiguredType. + + :param config_values: The config_values of this ConfiguredType. + :type: oci.data_connectivity.models.ConfigValues + """ + self._config_values = config_values + + @property + def config_definition(self): + """ + Gets the config_definition of this ConfiguredType. + + :return: The config_definition of this ConfiguredType. + :rtype: oci.data_connectivity.models.ConfigDefinition + """ + return self._config_definition + + @config_definition.setter + def config_definition(self, config_definition): + """ + Sets the config_definition of this ConfiguredType. + + :param config_definition: The config_definition of this ConfiguredType. + :type: oci.data_connectivity.models.ConfigDefinition + """ + self._config_definition = config_definition + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection.py b/src/oci/data_connectivity/models/connection.py new file mode 100644 index 0000000000..c0a0c21395 --- /dev/null +++ b/src/oci/data_connectivity/models/connection.py @@ -0,0 +1,492 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Connection(object): + """ + The connection for a data asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Connection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this Connection. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Connection. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this Connection. + :type model_type: str + + :param name: + The value to assign to the name property of this Connection. + :type name: str + + :param description: + The value to assign to the description property of this Connection. + :type description: str + + :param object_version: + The value to assign to the object_version property of this Connection. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this Connection. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this Connection. + :type identifier: str + + :param primary_schema: + The value to assign to the primary_schema property of this Connection. + :type primary_schema: oci.data_connectivity.models.Schema + + :param connection_properties: + The value to assign to the connection_properties property of this Connection. + :type connection_properties: list[oci.data_connectivity.models.ConnectionProperty] + + :param properties: + The value to assign to the properties property of this Connection. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this Connection. + :type type: str + + :param is_default: + The value to assign to the is_default property of this Connection. + :type is_default: bool + + :param metadata: + The value to assign to the metadata property of this Connection. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param registry_metadata: + The value to assign to the registry_metadata property of this Connection. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'primary_schema': 'Schema', + 'connection_properties': 'list[ConnectionProperty]', + 'properties': 'dict(str, object)', + 'type': 'str', + 'is_default': 'bool', + 'metadata': 'ObjectMetadata', + 'registry_metadata': 'RegistryMetadata' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'primary_schema': 'primarySchema', + 'connection_properties': 'connectionProperties', + 'properties': 'properties', + 'type': 'type', + 'is_default': 'isDefault', + 'metadata': 'metadata', + 'registry_metadata': 'registryMetadata' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._primary_schema = None + self._connection_properties = None + self._properties = None + self._type = None + self._is_default = None + self._metadata = None + self._registry_metadata = None + + @property + def key(self): + """ + **[Required]** Gets the key of this Connection. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :return: The key of this Connection. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this Connection. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :param key: The key of this Connection. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this Connection. + The model version of an object. + + + :return: The model_version of this Connection. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this Connection. + The model version of an object. + + + :param model_version: The model_version of this Connection. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this Connection. + The type of the object. + + + :return: The model_type of this Connection. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this Connection. + The type of the object. + + + :param model_type: The model_type of this Connection. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this Connection. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this Connection. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Connection. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this Connection. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this Connection. + User-defined description for the connection. + + + :return: The description of this Connection. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Connection. + User-defined description for the connection. + + + :param description: The description of this Connection. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this Connection. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this Connection. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this Connection. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this Connection. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this Connection. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this Connection. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this Connection. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this Connection. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this Connection. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this Connection. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this Connection. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this Connection. + :type: str + """ + self._identifier = identifier + + @property + def primary_schema(self): + """ + Gets the primary_schema of this Connection. + + :return: The primary_schema of this Connection. + :rtype: oci.data_connectivity.models.Schema + """ + return self._primary_schema + + @primary_schema.setter + def primary_schema(self, primary_schema): + """ + Sets the primary_schema of this Connection. + + :param primary_schema: The primary_schema of this Connection. + :type: oci.data_connectivity.models.Schema + """ + self._primary_schema = primary_schema + + @property + def connection_properties(self): + """ + Gets the connection_properties of this Connection. + The properties for the connection. + + + :return: The connection_properties of this Connection. + :rtype: list[oci.data_connectivity.models.ConnectionProperty] + """ + return self._connection_properties + + @connection_properties.setter + def connection_properties(self, connection_properties): + """ + Sets the connection_properties of this Connection. + The properties for the connection. + + + :param connection_properties: The connection_properties of this Connection. + :type: list[oci.data_connectivity.models.ConnectionProperty] + """ + self._connection_properties = connection_properties + + @property + def properties(self): + """ + Gets the properties of this Connection. + All the properties for the connection in a key-value map format. + + + :return: The properties of this Connection. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this Connection. + All the properties for the connection in a key-value map format. + + + :param properties: The properties of this Connection. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + Gets the type of this Connection. + Specific Connection Type + + + :return: The type of this Connection. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Connection. + Specific Connection Type + + + :param type: The type of this Connection. + :type: str + """ + self._type = type + + @property + def is_default(self): + """ + Gets the is_default of this Connection. + The default property for the connection. + + + :return: The is_default of this Connection. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this Connection. + The default property for the connection. + + + :param is_default: The is_default of this Connection. + :type: bool + """ + self._is_default = is_default + + @property + def metadata(self): + """ + Gets the metadata of this Connection. + + :return: The metadata of this Connection. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this Connection. + + :param metadata: The metadata of this Connection. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this Connection. + + :return: The registry_metadata of this Connection. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this Connection. + + :param registry_metadata: The registry_metadata of this Connection. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_property.py b/src/oci/data_connectivity/models/connection_property.py new file mode 100644 index 0000000000..2ebd5af95b --- /dev/null +++ b/src/oci/data_connectivity/models/connection_property.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionProperty(object): + """ + The connection name/value pair. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionProperty 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 ConnectionProperty. + :type name: str + + :param value: + The value to assign to the value property of this ConnectionProperty. + :type value: str + + """ + self.swagger_types = { + 'name': 'str', + 'value': 'str' + } + + self.attribute_map = { + 'name': 'name', + 'value': 'value' + } + + self._name = None + self._value = None + + @property + def name(self): + """ + Gets the name of this ConnectionProperty. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ConnectionProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConnectionProperty. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ConnectionProperty. + :type: str + """ + self._name = name + + @property + def value(self): + """ + Gets the value of this ConnectionProperty. + The value for the connection name property. + + + :return: The value of this ConnectionProperty. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ConnectionProperty. + The value for the connection name property. + + + :param value: The value of this ConnectionProperty. + :type: str + """ + self._value = value + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_summary.py b/src/oci/data_connectivity/models/connection_summary.py new file mode 100644 index 0000000000..dbc655518d --- /dev/null +++ b/src/oci/data_connectivity/models/connection_summary.py @@ -0,0 +1,492 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionSummary(object): + """ + The connection summary object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this ConnectionSummary. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ConnectionSummary. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this ConnectionSummary. + :type model_type: str + + :param name: + The value to assign to the name property of this ConnectionSummary. + :type name: str + + :param description: + The value to assign to the description property of this ConnectionSummary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this ConnectionSummary. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this ConnectionSummary. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this ConnectionSummary. + :type identifier: str + + :param primary_schema: + The value to assign to the primary_schema property of this ConnectionSummary. + :type primary_schema: oci.data_connectivity.models.Schema + + :param connection_properties: + The value to assign to the connection_properties property of this ConnectionSummary. + :type connection_properties: list[oci.data_connectivity.models.ConnectionProperty] + + :param properties: + The value to assign to the properties property of this ConnectionSummary. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this ConnectionSummary. + :type type: str + + :param is_default: + The value to assign to the is_default property of this ConnectionSummary. + :type is_default: bool + + :param metadata: + The value to assign to the metadata property of this ConnectionSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param registry_metadata: + The value to assign to the registry_metadata property of this ConnectionSummary. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'primary_schema': 'Schema', + 'connection_properties': 'list[ConnectionProperty]', + 'properties': 'dict(str, object)', + 'type': 'str', + 'is_default': 'bool', + 'metadata': 'ObjectMetadata', + 'registry_metadata': 'RegistryMetadata' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'primary_schema': 'primarySchema', + 'connection_properties': 'connectionProperties', + 'properties': 'properties', + 'type': 'type', + 'is_default': 'isDefault', + 'metadata': 'metadata', + 'registry_metadata': 'registryMetadata' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._primary_schema = None + self._connection_properties = None + self._properties = None + self._type = None + self._is_default = None + self._metadata = None + self._registry_metadata = None + + @property + def key(self): + """ + **[Required]** Gets the key of this ConnectionSummary. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :return: The key of this ConnectionSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ConnectionSummary. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :param key: The key of this ConnectionSummary. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this ConnectionSummary. + The model version of an object. + + + :return: The model_version of this ConnectionSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ConnectionSummary. + The model version of an object. + + + :param model_version: The model_version of this ConnectionSummary. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this ConnectionSummary. + The type of the object. + + + :return: The model_type of this ConnectionSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ConnectionSummary. + The type of the object. + + + :param model_type: The model_type of this ConnectionSummary. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this ConnectionSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ConnectionSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConnectionSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ConnectionSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ConnectionSummary. + User-defined description for the connection. + + + :return: The description of this ConnectionSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ConnectionSummary. + User-defined description for the connection. + + + :param description: The description of this ConnectionSummary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this ConnectionSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ConnectionSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ConnectionSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ConnectionSummary. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this ConnectionSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ConnectionSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ConnectionSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ConnectionSummary. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this ConnectionSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this ConnectionSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ConnectionSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this ConnectionSummary. + :type: str + """ + self._identifier = identifier + + @property + def primary_schema(self): + """ + Gets the primary_schema of this ConnectionSummary. + + :return: The primary_schema of this ConnectionSummary. + :rtype: oci.data_connectivity.models.Schema + """ + return self._primary_schema + + @primary_schema.setter + def primary_schema(self, primary_schema): + """ + Sets the primary_schema of this ConnectionSummary. + + :param primary_schema: The primary_schema of this ConnectionSummary. + :type: oci.data_connectivity.models.Schema + """ + self._primary_schema = primary_schema + + @property + def connection_properties(self): + """ + Gets the connection_properties of this ConnectionSummary. + The properties for the connection. + + + :return: The connection_properties of this ConnectionSummary. + :rtype: list[oci.data_connectivity.models.ConnectionProperty] + """ + return self._connection_properties + + @connection_properties.setter + def connection_properties(self, connection_properties): + """ + Sets the connection_properties of this ConnectionSummary. + The properties for the connection. + + + :param connection_properties: The connection_properties of this ConnectionSummary. + :type: list[oci.data_connectivity.models.ConnectionProperty] + """ + self._connection_properties = connection_properties + + @property + def properties(self): + """ + Gets the properties of this ConnectionSummary. + All the properties for the connection in a key-value map format. + + + :return: The properties of this ConnectionSummary. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this ConnectionSummary. + All the properties for the connection in a key-value map format. + + + :param properties: The properties of this ConnectionSummary. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + Gets the type of this ConnectionSummary. + Specific Connection Type + + + :return: The type of this ConnectionSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ConnectionSummary. + Specific Connection Type + + + :param type: The type of this ConnectionSummary. + :type: str + """ + self._type = type + + @property + def is_default(self): + """ + Gets the is_default of this ConnectionSummary. + The default property for the connection. + + + :return: The is_default of this ConnectionSummary. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this ConnectionSummary. + The default property for the connection. + + + :param is_default: The is_default of this ConnectionSummary. + :type: bool + """ + self._is_default = is_default + + @property + def metadata(self): + """ + Gets the metadata of this ConnectionSummary. + + :return: The metadata of this ConnectionSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this ConnectionSummary. + + :param metadata: The metadata of this ConnectionSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this ConnectionSummary. + + :return: The registry_metadata of this ConnectionSummary. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this ConnectionSummary. + + :param registry_metadata: The registry_metadata of this ConnectionSummary. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_summary_collection.py b/src/oci/data_connectivity/models/connection_summary_collection.py new file mode 100644 index 0000000000..044c046c18 --- /dev/null +++ b/src/oci/data_connectivity/models/connection_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionSummaryCollection(object): + """ + This is the collection of connection summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionSummaryCollection 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 ConnectionSummaryCollection. + :type items: list[oci.data_connectivity.models.ConnectionSummary] + + """ + self.swagger_types = { + 'items': 'list[ConnectionSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ConnectionSummaryCollection. + The array of connection summaries. + + + :return: The items of this ConnectionSummaryCollection. + :rtype: list[oci.data_connectivity.models.ConnectionSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ConnectionSummaryCollection. + The array of connection summaries. + + + :param items: The items of this ConnectionSummaryCollection. + :type: list[oci.data_connectivity.models.ConnectionSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_validation.py b/src/oci/data_connectivity/models/connection_validation.py new file mode 100644 index 0000000000..0f5ec38773 --- /dev/null +++ b/src/oci/data_connectivity/models/connection_validation.py @@ -0,0 +1,449 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionValidation(object): + """ + The information about connection validation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionValidation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param validation_message: + The value to assign to the validation_message property of this ConnectionValidation. + :type validation_message: oci.data_connectivity.models.Message + + :param key: + The value to assign to the key property of this ConnectionValidation. + :type key: str + + :param model_type: + The value to assign to the model_type property of this ConnectionValidation. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ConnectionValidation. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ConnectionValidation. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ConnectionValidation. + :type name: str + + :param description: + The value to assign to the description property of this ConnectionValidation. + :type description: str + + :param object_version: + The value to assign to the object_version property of this ConnectionValidation. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this ConnectionValidation. + :type object_status: int + + :param registry_metadata: + The value to assign to the registry_metadata property of this ConnectionValidation. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param connection: + The value to assign to the connection property of this ConnectionValidation. + :type connection: oci.data_connectivity.models.CreateConnectionDetails + + :param data_asset: + The value to assign to the data_asset property of this ConnectionValidation. + :type data_asset: oci.data_connectivity.models.CreateDataAssetDetails + + :param identifier: + The value to assign to the identifier property of this ConnectionValidation. + :type identifier: str + + :param metadata: + The value to assign to the metadata property of this ConnectionValidation. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'validation_message': 'Message', + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'registry_metadata': 'RegistryMetadata', + 'connection': 'CreateConnectionDetails', + 'data_asset': 'CreateDataAssetDetails', + 'identifier': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'validation_message': 'validationMessage', + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'registry_metadata': 'registryMetadata', + 'connection': 'connection', + 'data_asset': 'dataAsset', + 'identifier': 'identifier', + 'metadata': 'metadata' + } + + self._validation_message = None + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._registry_metadata = None + self._connection = None + self._data_asset = None + self._identifier = None + self._metadata = None + + @property + def validation_message(self): + """ + Gets the validation_message of this ConnectionValidation. + + :return: The validation_message of this ConnectionValidation. + :rtype: oci.data_connectivity.models.Message + """ + return self._validation_message + + @validation_message.setter + def validation_message(self, validation_message): + """ + Sets the validation_message of this ConnectionValidation. + + :param validation_message: The validation_message of this ConnectionValidation. + :type: oci.data_connectivity.models.Message + """ + self._validation_message = validation_message + + @property + def key(self): + """ + Gets the key of this ConnectionValidation. + Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. + + + :return: The key of this ConnectionValidation. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ConnectionValidation. + Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. + + + :param key: The key of this ConnectionValidation. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this ConnectionValidation. + The type of the object. + + + :return: The model_type of this ConnectionValidation. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ConnectionValidation. + The type of the object. + + + :param model_type: The model_type of this ConnectionValidation. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this ConnectionValidation. + The model version of an object. + + + :return: The model_version of this ConnectionValidation. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ConnectionValidation. + The model version of an object. + + + :param model_version: The model_version of this ConnectionValidation. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ConnectionValidation. + + :return: The parent_ref of this ConnectionValidation. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ConnectionValidation. + + :param parent_ref: The parent_ref of this ConnectionValidation. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this ConnectionValidation. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ConnectionValidation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConnectionValidation. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ConnectionValidation. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ConnectionValidation. + Detailed description for the object. + + + :return: The description of this ConnectionValidation. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ConnectionValidation. + Detailed description for the object. + + + :param description: The description of this ConnectionValidation. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this ConnectionValidation. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ConnectionValidation. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ConnectionValidation. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ConnectionValidation. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this ConnectionValidation. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ConnectionValidation. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ConnectionValidation. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ConnectionValidation. + :type: int + """ + self._object_status = object_status + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this ConnectionValidation. + + :return: The registry_metadata of this ConnectionValidation. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this ConnectionValidation. + + :param registry_metadata: The registry_metadata of this ConnectionValidation. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def connection(self): + """ + Gets the connection of this ConnectionValidation. + + :return: The connection of this ConnectionValidation. + :rtype: oci.data_connectivity.models.CreateConnectionDetails + """ + return self._connection + + @connection.setter + def connection(self, connection): + """ + Sets the connection of this ConnectionValidation. + + :param connection: The connection of this ConnectionValidation. + :type: oci.data_connectivity.models.CreateConnectionDetails + """ + self._connection = connection + + @property + def data_asset(self): + """ + Gets the data_asset of this ConnectionValidation. + + :return: The data_asset of this ConnectionValidation. + :rtype: oci.data_connectivity.models.CreateDataAssetDetails + """ + return self._data_asset + + @data_asset.setter + def data_asset(self, data_asset): + """ + Sets the data_asset of this ConnectionValidation. + + :param data_asset: The data_asset of this ConnectionValidation. + :type: oci.data_connectivity.models.CreateDataAssetDetails + """ + self._data_asset = data_asset + + @property + def identifier(self): + """ + Gets the identifier of this ConnectionValidation. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this ConnectionValidation. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ConnectionValidation. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this ConnectionValidation. + :type: str + """ + self._identifier = identifier + + @property + def metadata(self): + """ + Gets the metadata of this ConnectionValidation. + + :return: The metadata of this ConnectionValidation. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this ConnectionValidation. + + :param metadata: The metadata of this ConnectionValidation. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_validation_summary.py b/src/oci/data_connectivity/models/connection_validation_summary.py new file mode 100644 index 0000000000..f0947dd93b --- /dev/null +++ b/src/oci/data_connectivity/models/connection_validation_summary.py @@ -0,0 +1,449 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionValidationSummary(object): + """ + The information about connection validation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionValidationSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param validation_message: + The value to assign to the validation_message property of this ConnectionValidationSummary. + :type validation_message: oci.data_connectivity.models.Message + + :param key: + The value to assign to the key property of this ConnectionValidationSummary. + :type key: str + + :param model_type: + The value to assign to the model_type property of this ConnectionValidationSummary. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ConnectionValidationSummary. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ConnectionValidationSummary. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ConnectionValidationSummary. + :type name: str + + :param description: + The value to assign to the description property of this ConnectionValidationSummary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this ConnectionValidationSummary. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this ConnectionValidationSummary. + :type object_status: int + + :param registry_metadata: + The value to assign to the registry_metadata property of this ConnectionValidationSummary. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param connection: + The value to assign to the connection property of this ConnectionValidationSummary. + :type connection: oci.data_connectivity.models.CreateConnectionDetails + + :param data_asset: + The value to assign to the data_asset property of this ConnectionValidationSummary. + :type data_asset: oci.data_connectivity.models.CreateDataAssetDetails + + :param identifier: + The value to assign to the identifier property of this ConnectionValidationSummary. + :type identifier: str + + :param metadata: + The value to assign to the metadata property of this ConnectionValidationSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'validation_message': 'Message', + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'registry_metadata': 'RegistryMetadata', + 'connection': 'CreateConnectionDetails', + 'data_asset': 'CreateDataAssetDetails', + 'identifier': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'validation_message': 'validationMessage', + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'registry_metadata': 'registryMetadata', + 'connection': 'connection', + 'data_asset': 'dataAsset', + 'identifier': 'identifier', + 'metadata': 'metadata' + } + + self._validation_message = None + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._registry_metadata = None + self._connection = None + self._data_asset = None + self._identifier = None + self._metadata = None + + @property + def validation_message(self): + """ + Gets the validation_message of this ConnectionValidationSummary. + + :return: The validation_message of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.Message + """ + return self._validation_message + + @validation_message.setter + def validation_message(self, validation_message): + """ + Sets the validation_message of this ConnectionValidationSummary. + + :param validation_message: The validation_message of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.Message + """ + self._validation_message = validation_message + + @property + def key(self): + """ + Gets the key of this ConnectionValidationSummary. + Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. + + + :return: The key of this ConnectionValidationSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ConnectionValidationSummary. + Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. + + + :param key: The key of this ConnectionValidationSummary. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this ConnectionValidationSummary. + The type of the object. + + + :return: The model_type of this ConnectionValidationSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ConnectionValidationSummary. + The type of the object. + + + :param model_type: The model_type of this ConnectionValidationSummary. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this ConnectionValidationSummary. + The model version of an object. + + + :return: The model_version of this ConnectionValidationSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ConnectionValidationSummary. + The model version of an object. + + + :param model_version: The model_version of this ConnectionValidationSummary. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ConnectionValidationSummary. + + :return: The parent_ref of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ConnectionValidationSummary. + + :param parent_ref: The parent_ref of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this ConnectionValidationSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ConnectionValidationSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ConnectionValidationSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ConnectionValidationSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ConnectionValidationSummary. + Detailed description for the object. + + + :return: The description of this ConnectionValidationSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ConnectionValidationSummary. + Detailed description for the object. + + + :param description: The description of this ConnectionValidationSummary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this ConnectionValidationSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ConnectionValidationSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ConnectionValidationSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ConnectionValidationSummary. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this ConnectionValidationSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ConnectionValidationSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ConnectionValidationSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ConnectionValidationSummary. + :type: int + """ + self._object_status = object_status + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this ConnectionValidationSummary. + + :return: The registry_metadata of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this ConnectionValidationSummary. + + :param registry_metadata: The registry_metadata of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def connection(self): + """ + Gets the connection of this ConnectionValidationSummary. + + :return: The connection of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.CreateConnectionDetails + """ + return self._connection + + @connection.setter + def connection(self, connection): + """ + Sets the connection of this ConnectionValidationSummary. + + :param connection: The connection of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.CreateConnectionDetails + """ + self._connection = connection + + @property + def data_asset(self): + """ + Gets the data_asset of this ConnectionValidationSummary. + + :return: The data_asset of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.CreateDataAssetDetails + """ + return self._data_asset + + @data_asset.setter + def data_asset(self, data_asset): + """ + Sets the data_asset of this ConnectionValidationSummary. + + :param data_asset: The data_asset of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.CreateDataAssetDetails + """ + self._data_asset = data_asset + + @property + def identifier(self): + """ + Gets the identifier of this ConnectionValidationSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this ConnectionValidationSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ConnectionValidationSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this ConnectionValidationSummary. + :type: str + """ + self._identifier = identifier + + @property + def metadata(self): + """ + Gets the metadata of this ConnectionValidationSummary. + + :return: The metadata of this ConnectionValidationSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this ConnectionValidationSummary. + + :param metadata: The metadata of this ConnectionValidationSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connection_validation_summary_collection.py b/src/oci/data_connectivity/models/connection_validation_summary_collection.py new file mode 100644 index 0000000000..05db102833 --- /dev/null +++ b/src/oci/data_connectivity/models/connection_validation_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectionValidationSummaryCollection(object): + """ + A list of connection validation summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectionValidationSummaryCollection 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 ConnectionValidationSummaryCollection. + :type items: list[oci.data_connectivity.models.ConnectionValidationSummary] + + """ + self.swagger_types = { + 'items': 'list[ConnectionValidationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ConnectionValidationSummaryCollection. + An array of connection validation summaries. + + + :return: The items of this ConnectionValidationSummaryCollection. + :rtype: list[oci.data_connectivity.models.ConnectionValidationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ConnectionValidationSummaryCollection. + An array of connection validation summaries. + + + :param items: The items of this ConnectionValidationSummaryCollection. + :type: list[oci.data_connectivity.models.ConnectionValidationSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/connectivity_validation.py b/src/oci/data_connectivity/models/connectivity_validation.py new file mode 100644 index 0000000000..6045f1b0f4 --- /dev/null +++ b/src/oci/data_connectivity/models/connectivity_validation.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectivityValidation(object): + """ + The information about connectivity validation results + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectivityValidation object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param total_message_count: + The value to assign to the total_message_count property of this ConnectivityValidation. + :type total_message_count: int + + :param error_message_count: + The value to assign to the error_message_count property of this ConnectivityValidation. + :type error_message_count: int + + :param warn_message_count: + The value to assign to the warn_message_count property of this ConnectivityValidation. + :type warn_message_count: int + + :param info_message_count: + The value to assign to the info_message_count property of this ConnectivityValidation. + :type info_message_count: int + + :param validation_messages: + The value to assign to the validation_messages property of this ConnectivityValidation. + :type validation_messages: dict(str, list[ValidationMessage]) + + """ + self.swagger_types = { + 'total_message_count': 'int', + 'error_message_count': 'int', + 'warn_message_count': 'int', + 'info_message_count': 'int', + 'validation_messages': 'dict(str, list[ValidationMessage])' + } + + self.attribute_map = { + 'total_message_count': 'totalMessageCount', + 'error_message_count': 'errorMessageCount', + 'warn_message_count': 'warnMessageCount', + 'info_message_count': 'infoMessageCount', + 'validation_messages': 'validationMessages' + } + + self._total_message_count = None + self._error_message_count = None + self._warn_message_count = None + self._info_message_count = None + self._validation_messages = None + + @property + def total_message_count(self): + """ + **[Required]** Gets the total_message_count of this ConnectivityValidation. + Total number of validation messages + + + :return: The total_message_count of this ConnectivityValidation. + :rtype: int + """ + return self._total_message_count + + @total_message_count.setter + def total_message_count(self, total_message_count): + """ + Sets the total_message_count of this ConnectivityValidation. + Total number of validation messages + + + :param total_message_count: The total_message_count of this ConnectivityValidation. + :type: int + """ + self._total_message_count = total_message_count + + @property + def error_message_count(self): + """ + Gets the error_message_count of this ConnectivityValidation. + Total number of validation error messages + + + :return: The error_message_count of this ConnectivityValidation. + :rtype: int + """ + return self._error_message_count + + @error_message_count.setter + def error_message_count(self, error_message_count): + """ + Sets the error_message_count of this ConnectivityValidation. + Total number of validation error messages + + + :param error_message_count: The error_message_count of this ConnectivityValidation. + :type: int + """ + self._error_message_count = error_message_count + + @property + def warn_message_count(self): + """ + Gets the warn_message_count of this ConnectivityValidation. + Total number of validation warning messages + + + :return: The warn_message_count of this ConnectivityValidation. + :rtype: int + """ + return self._warn_message_count + + @warn_message_count.setter + def warn_message_count(self, warn_message_count): + """ + Sets the warn_message_count of this ConnectivityValidation. + Total number of validation warning messages + + + :param warn_message_count: The warn_message_count of this ConnectivityValidation. + :type: int + """ + self._warn_message_count = warn_message_count + + @property + def info_message_count(self): + """ + Gets the info_message_count of this ConnectivityValidation. + Total number of validation information messages + + + :return: The info_message_count of this ConnectivityValidation. + :rtype: int + """ + return self._info_message_count + + @info_message_count.setter + def info_message_count(self, info_message_count): + """ + Sets the info_message_count of this ConnectivityValidation. + Total number of validation information messages + + + :param info_message_count: The info_message_count of this ConnectivityValidation. + :type: int + """ + self._info_message_count = info_message_count + + @property + def validation_messages(self): + """ + Gets the validation_messages of this ConnectivityValidation. + Detailed information of the connectivity validation. + + + :return: The validation_messages of this ConnectivityValidation. + :rtype: dict(str, list[ValidationMessage]) + """ + return self._validation_messages + + @validation_messages.setter + def validation_messages(self, validation_messages): + """ + Sets the validation_messages of this ConnectivityValidation. + Detailed information of the connectivity validation. + + + :param validation_messages: The validation_messages of this ConnectivityValidation. + :type: dict(str, list[ValidationMessage]) + """ + self._validation_messages = validation_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/data_connectivity/models/connector_attribute.py b/src/oci/data_connectivity/models/connector_attribute.py new file mode 100644 index 0000000000..eeb9ea9ba2 --- /dev/null +++ b/src/oci/data_connectivity/models/connector_attribute.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ConnectorAttribute(object): + """ + Marker class for connector attributes. + """ + + #: A constant which can be used with the model_type property of a ConnectorAttribute. + #: This constant has a value of "EXTERNAL_STORAGE" + MODEL_TYPE_EXTERNAL_STORAGE = "EXTERNAL_STORAGE" + + def __init__(self, **kwargs): + """ + Initializes a new ConnectorAttribute object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.ExternalStorage` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ConnectorAttribute. + Allowed values for this property are: "EXTERNAL_STORAGE" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'EXTERNAL_STORAGE': + return 'ExternalStorage' + else: + return 'ConnectorAttribute' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this ConnectorAttribute. + The type of the abstract read attribute. + + Allowed values for this property are: "EXTERNAL_STORAGE" + + + :return: The model_type of this ConnectorAttribute. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ConnectorAttribute. + The type of the abstract read attribute. + + + :param model_type: The model_type of this ConnectorAttribute. + :type: str + """ + allowed_values = ["EXTERNAL_STORAGE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_attach_data_asset_details.py b/src/oci/data_connectivity/models/create_attach_data_asset_details.py new file mode 100644 index 0000000000..fc9b9f329a --- /dev/null +++ b/src/oci/data_connectivity/models/create_attach_data_asset_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateAttachDataAssetDetails(object): + """ + The attach DataAsset payload. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateAttachDataAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_assets: + The value to assign to the data_assets property of this CreateAttachDataAssetDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'data_assets': 'dataAssets' + } + + self._data_assets = None + + @property + def data_assets(self): + """ + **[Required]** Gets the data_assets of this CreateAttachDataAssetDetails. + The array of DataAsset keys + + + :return: The data_assets of this CreateAttachDataAssetDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this CreateAttachDataAssetDetails. + The array of DataAsset keys + + + :param data_assets: The data_assets of this CreateAttachDataAssetDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_connection_details.py b/src/oci/data_connectivity/models/create_connection_details.py new file mode 100644 index 0000000000..ac7b00ab79 --- /dev/null +++ b/src/oci/data_connectivity/models/create_connection_details.py @@ -0,0 +1,492 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateConnectionDetails(object): + """ + Properties used in connection create operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateConnectionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this CreateConnectionDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateConnectionDetails. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this CreateConnectionDetails. + :type model_type: str + + :param name: + The value to assign to the name property of this CreateConnectionDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateConnectionDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this CreateConnectionDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this CreateConnectionDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateConnectionDetails. + :type identifier: str + + :param primary_schema: + The value to assign to the primary_schema property of this CreateConnectionDetails. + :type primary_schema: oci.data_connectivity.models.Schema + + :param connection_properties: + The value to assign to the connection_properties property of this CreateConnectionDetails. + :type connection_properties: list[oci.data_connectivity.models.ConnectionProperty] + + :param properties: + The value to assign to the properties property of this CreateConnectionDetails. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this CreateConnectionDetails. + :type type: str + + :param is_default: + The value to assign to the is_default property of this CreateConnectionDetails. + :type is_default: bool + + :param metadata: + The value to assign to the metadata property of this CreateConnectionDetails. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param registry_metadata: + The value to assign to the registry_metadata property of this CreateConnectionDetails. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'primary_schema': 'Schema', + 'connection_properties': 'list[ConnectionProperty]', + 'properties': 'dict(str, object)', + 'type': 'str', + 'is_default': 'bool', + 'metadata': 'ObjectMetadata', + 'registry_metadata': 'RegistryMetadata' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'primary_schema': 'primarySchema', + 'connection_properties': 'connectionProperties', + 'properties': 'properties', + 'type': 'type', + 'is_default': 'isDefault', + 'metadata': 'metadata', + 'registry_metadata': 'registryMetadata' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._primary_schema = None + self._connection_properties = None + self._properties = None + self._type = None + self._is_default = None + self._metadata = None + self._registry_metadata = None + + @property + def key(self): + """ + Gets the key of this CreateConnectionDetails. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :return: The key of this CreateConnectionDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateConnectionDetails. + Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. + + + :param key: The key of this CreateConnectionDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateConnectionDetails. + The model version of an object. + + + :return: The model_version of this CreateConnectionDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateConnectionDetails. + The model version of an object. + + + :param model_version: The model_version of this CreateConnectionDetails. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this CreateConnectionDetails. + The type of the object. + + + :return: The model_type of this CreateConnectionDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateConnectionDetails. + The type of the object. + + + :param model_type: The model_type of this CreateConnectionDetails. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateConnectionDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateConnectionDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateConnectionDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateConnectionDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateConnectionDetails. + User-defined description for the connection. + + + :return: The description of this CreateConnectionDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateConnectionDetails. + User-defined description for the connection. + + + :param description: The description of this CreateConnectionDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this CreateConnectionDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateConnectionDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateConnectionDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateConnectionDetails. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this CreateConnectionDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateConnectionDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateConnectionDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateConnectionDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this CreateConnectionDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateConnectionDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateConnectionDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateConnectionDetails. + :type: str + """ + self._identifier = identifier + + @property + def primary_schema(self): + """ + Gets the primary_schema of this CreateConnectionDetails. + + :return: The primary_schema of this CreateConnectionDetails. + :rtype: oci.data_connectivity.models.Schema + """ + return self._primary_schema + + @primary_schema.setter + def primary_schema(self, primary_schema): + """ + Sets the primary_schema of this CreateConnectionDetails. + + :param primary_schema: The primary_schema of this CreateConnectionDetails. + :type: oci.data_connectivity.models.Schema + """ + self._primary_schema = primary_schema + + @property + def connection_properties(self): + """ + Gets the connection_properties of this CreateConnectionDetails. + The properties for the connection. + + + :return: The connection_properties of this CreateConnectionDetails. + :rtype: list[oci.data_connectivity.models.ConnectionProperty] + """ + return self._connection_properties + + @connection_properties.setter + def connection_properties(self, connection_properties): + """ + Sets the connection_properties of this CreateConnectionDetails. + The properties for the connection. + + + :param connection_properties: The connection_properties of this CreateConnectionDetails. + :type: list[oci.data_connectivity.models.ConnectionProperty] + """ + self._connection_properties = connection_properties + + @property + def properties(self): + """ + **[Required]** Gets the properties of this CreateConnectionDetails. + All the properties for the connection in a key-value map format. + + + :return: The properties of this CreateConnectionDetails. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this CreateConnectionDetails. + All the properties for the connection in a key-value map format. + + + :param properties: The properties of this CreateConnectionDetails. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + **[Required]** Gets the type of this CreateConnectionDetails. + Specific Connection Type + + + :return: The type of this CreateConnectionDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this CreateConnectionDetails. + Specific Connection Type + + + :param type: The type of this CreateConnectionDetails. + :type: str + """ + self._type = type + + @property + def is_default(self): + """ + Gets the is_default of this CreateConnectionDetails. + The default property for the connection. + + + :return: The is_default of this CreateConnectionDetails. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this CreateConnectionDetails. + The default property for the connection. + + + :param is_default: The is_default of this CreateConnectionDetails. + :type: bool + """ + self._is_default = is_default + + @property + def metadata(self): + """ + Gets the metadata of this CreateConnectionDetails. + + :return: The metadata of this CreateConnectionDetails. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this CreateConnectionDetails. + + :param metadata: The metadata of this CreateConnectionDetails. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this CreateConnectionDetails. + + :return: The registry_metadata of this CreateConnectionDetails. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this CreateConnectionDetails. + + :param registry_metadata: The registry_metadata of this CreateConnectionDetails. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_connection_validation_details.py b/src/oci/data_connectivity/models/create_connection_validation_details.py new file mode 100644 index 0000000000..4d975147ec --- /dev/null +++ b/src/oci/data_connectivity/models/create_connection_validation_details.py @@ -0,0 +1,120 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateConnectionValidationDetails(object): + """ + The properties used in create connection validation operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateConnectionValidationDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_asset: + The value to assign to the data_asset property of this CreateConnectionValidationDetails. + :type data_asset: oci.data_connectivity.models.CreateDataAssetDetails + + :param connection: + The value to assign to the connection property of this CreateConnectionValidationDetails. + :type connection: oci.data_connectivity.models.CreateConnectionDetails + + :param registry_metadata: + The value to assign to the registry_metadata property of this CreateConnectionValidationDetails. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + """ + self.swagger_types = { + 'data_asset': 'CreateDataAssetDetails', + 'connection': 'CreateConnectionDetails', + 'registry_metadata': 'RegistryMetadata' + } + + self.attribute_map = { + 'data_asset': 'dataAsset', + 'connection': 'connection', + 'registry_metadata': 'registryMetadata' + } + + self._data_asset = None + self._connection = None + self._registry_metadata = None + + @property + def data_asset(self): + """ + Gets the data_asset of this CreateConnectionValidationDetails. + + :return: The data_asset of this CreateConnectionValidationDetails. + :rtype: oci.data_connectivity.models.CreateDataAssetDetails + """ + return self._data_asset + + @data_asset.setter + def data_asset(self, data_asset): + """ + Sets the data_asset of this CreateConnectionValidationDetails. + + :param data_asset: The data_asset of this CreateConnectionValidationDetails. + :type: oci.data_connectivity.models.CreateDataAssetDetails + """ + self._data_asset = data_asset + + @property + def connection(self): + """ + Gets the connection of this CreateConnectionValidationDetails. + + :return: The connection of this CreateConnectionValidationDetails. + :rtype: oci.data_connectivity.models.CreateConnectionDetails + """ + return self._connection + + @connection.setter + def connection(self, connection): + """ + Sets the connection of this CreateConnectionValidationDetails. + + :param connection: The connection of this CreateConnectionValidationDetails. + :type: oci.data_connectivity.models.CreateConnectionDetails + """ + self._connection = connection + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this CreateConnectionValidationDetails. + + :return: The registry_metadata of this CreateConnectionValidationDetails. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this CreateConnectionValidationDetails. + + :param registry_metadata: The registry_metadata of this CreateConnectionValidationDetails. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_connectivity_validation_details.py b/src/oci/data_connectivity/models/create_connectivity_validation_details.py new file mode 100644 index 0000000000..66e887c809 --- /dev/null +++ b/src/oci/data_connectivity/models/create_connectivity_validation_details.py @@ -0,0 +1,472 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateConnectivityValidationDetails(object): + """ + Input to perform connector validation. If defines some data integration semantics in a data flow. It may be reading/writing data or transforming the data. + """ + + #: A constant which can be used with the model_type property of a CreateConnectivityValidationDetails. + #: This constant has a value of "SOURCE_OPERATOR" + MODEL_TYPE_SOURCE_OPERATOR = "SOURCE_OPERATOR" + + #: A constant which can be used with the model_type property of a CreateConnectivityValidationDetails. + #: This constant has a value of "TARGET_OPERATOR" + MODEL_TYPE_TARGET_OPERATOR = "TARGET_OPERATOR" + + def __init__(self, **kwargs): + """ + Initializes a new CreateConnectivityValidationDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.Target` + * :class:`~oci.data_connectivity.models.Source` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateConnectivityValidationDetails. + Allowed values for this property are: "SOURCE_OPERATOR", "TARGET_OPERATOR" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateConnectivityValidationDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateConnectivityValidationDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateConnectivityValidationDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateConnectivityValidationDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateConnectivityValidationDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this CreateConnectivityValidationDetails. + :type object_version: int + + :param input_ports: + The value to assign to the input_ports property of this CreateConnectivityValidationDetails. + :type input_ports: list[oci.data_connectivity.models.InputPort] + + :param output_ports: + The value to assign to the output_ports property of this CreateConnectivityValidationDetails. + :type output_ports: list[oci.data_connectivity.models.OutputPort] + + :param object_status: + The value to assign to the object_status property of this CreateConnectivityValidationDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateConnectivityValidationDetails. + :type identifier: str + + :param parameters: + The value to assign to the parameters property of this CreateConnectivityValidationDetails. + :type parameters: list[oci.data_connectivity.models.Parameter] + + :param op_config_values: + The value to assign to the op_config_values property of this CreateConnectivityValidationDetails. + :type op_config_values: oci.data_connectivity.models.ConfigValues + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'input_ports': 'list[InputPort]', + 'output_ports': 'list[OutputPort]', + 'object_status': 'int', + 'identifier': 'str', + 'parameters': 'list[Parameter]', + 'op_config_values': 'ConfigValues' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'input_ports': 'inputPorts', + 'output_ports': 'outputPorts', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'parameters': 'parameters', + 'op_config_values': 'opConfigValues' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._input_ports = None + self._output_ports = None + self._object_status = None + self._identifier = None + self._parameters = None + self._op_config_values = 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['modelType'] + + if type == 'TARGET_OPERATOR': + return 'Target' + + if type == 'SOURCE_OPERATOR': + return 'Source' + else: + return 'CreateConnectivityValidationDetails' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this CreateConnectivityValidationDetails. + The model type of the operator. + + Allowed values for this property are: "SOURCE_OPERATOR", "TARGET_OPERATOR" + + + :return: The model_type of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateConnectivityValidationDetails. + The model type of the operator. + + + :param model_type: The model_type of this CreateConnectivityValidationDetails. + :type: str + """ + allowed_values = ["SOURCE_OPERATOR", "TARGET_OPERATOR"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this CreateConnectivityValidationDetails. + The key of the object. + + + :return: The key of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateConnectivityValidationDetails. + The key of the object. + + + :param key: The key of this CreateConnectivityValidationDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateConnectivityValidationDetails. + The model version of an object. + + + :return: The model_version of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateConnectivityValidationDetails. + The model version of an object. + + + :param model_version: The model_version of this CreateConnectivityValidationDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this CreateConnectivityValidationDetails. + + :return: The parent_ref of this CreateConnectivityValidationDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this CreateConnectivityValidationDetails. + + :param parent_ref: The parent_ref of this CreateConnectivityValidationDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this CreateConnectivityValidationDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateConnectivityValidationDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateConnectivityValidationDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateConnectivityValidationDetails. + Details about the operator. + + + :return: The description of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateConnectivityValidationDetails. + Details about the operator. + + + :param description: The description of this CreateConnectivityValidationDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this CreateConnectivityValidationDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateConnectivityValidationDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateConnectivityValidationDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateConnectivityValidationDetails. + :type: int + """ + self._object_version = object_version + + @property + def input_ports(self): + """ + Gets the input_ports of this CreateConnectivityValidationDetails. + An array of input ports. + + + :return: The input_ports of this CreateConnectivityValidationDetails. + :rtype: list[oci.data_connectivity.models.InputPort] + """ + return self._input_ports + + @input_ports.setter + def input_ports(self, input_ports): + """ + Sets the input_ports of this CreateConnectivityValidationDetails. + An array of input ports. + + + :param input_ports: The input_ports of this CreateConnectivityValidationDetails. + :type: list[oci.data_connectivity.models.InputPort] + """ + self._input_ports = input_ports + + @property + def output_ports(self): + """ + Gets the output_ports of this CreateConnectivityValidationDetails. + An array of output ports. + + + :return: The output_ports of this CreateConnectivityValidationDetails. + :rtype: list[oci.data_connectivity.models.OutputPort] + """ + return self._output_ports + + @output_ports.setter + def output_ports(self, output_ports): + """ + Sets the output_ports of this CreateConnectivityValidationDetails. + An array of output ports. + + + :param output_ports: The output_ports of this CreateConnectivityValidationDetails. + :type: list[oci.data_connectivity.models.OutputPort] + """ + self._output_ports = output_ports + + @property + def object_status(self): + """ + Gets the object_status of this CreateConnectivityValidationDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateConnectivityValidationDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateConnectivityValidationDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateConnectivityValidationDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this CreateConnectivityValidationDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateConnectivityValidationDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateConnectivityValidationDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateConnectivityValidationDetails. + :type: str + """ + self._identifier = identifier + + @property + def parameters(self): + """ + Gets the parameters of this CreateConnectivityValidationDetails. + An array of parameters used in the data flow. + + + :return: The parameters of this CreateConnectivityValidationDetails. + :rtype: list[oci.data_connectivity.models.Parameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this CreateConnectivityValidationDetails. + An array of parameters used in the data flow. + + + :param parameters: The parameters of this CreateConnectivityValidationDetails. + :type: list[oci.data_connectivity.models.Parameter] + """ + self._parameters = parameters + + @property + def op_config_values(self): + """ + Gets the op_config_values of this CreateConnectivityValidationDetails. + + :return: The op_config_values of this CreateConnectivityValidationDetails. + :rtype: oci.data_connectivity.models.ConfigValues + """ + return self._op_config_values + + @op_config_values.setter + def op_config_values(self, op_config_values): + """ + Sets the op_config_values of this CreateConnectivityValidationDetails. + + :param op_config_values: The op_config_values of this CreateConnectivityValidationDetails. + :type: oci.data_connectivity.models.ConfigValues + """ + self._op_config_values = op_config_values + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_data_asset_details.py b/src/oci/data_connectivity/models/create_data_asset_details.py new file mode 100644 index 0000000000..fb99894603 --- /dev/null +++ b/src/oci/data_connectivity/models/create_data_asset_details.py @@ -0,0 +1,550 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDataAssetDetails(object): + """ + Properties used in data asset Create operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDataAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this CreateDataAssetDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateDataAssetDetails. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this CreateDataAssetDetails. + :type model_type: str + + :param name: + The value to assign to the name property of this CreateDataAssetDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateDataAssetDetails. + :type description: str + + :param object_status: + The value to assign to the object_status property of this CreateDataAssetDetails. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this CreateDataAssetDetails. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this CreateDataAssetDetails. + :type identifier: str + + :param external_key: + The value to assign to the external_key property of this CreateDataAssetDetails. + :type external_key: str + + :param asset_properties: + The value to assign to the asset_properties property of this CreateDataAssetDetails. + :type asset_properties: dict(str, str) + + :param properties: + The value to assign to the properties property of this CreateDataAssetDetails. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this CreateDataAssetDetails. + :type type: str + + :param native_type_system: + The value to assign to the native_type_system property of this CreateDataAssetDetails. + :type native_type_system: oci.data_connectivity.models.TypeSystem + + :param registry_metadata: + The value to assign to the registry_metadata property of this CreateDataAssetDetails. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this CreateDataAssetDetails. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param default_connection: + The value to assign to the default_connection property of this CreateDataAssetDetails. + :type default_connection: oci.data_connectivity.models.Connection + + :param end_points: + The value to assign to the end_points property of this CreateDataAssetDetails. + :type end_points: list[oci.data_connectivity.models.DpEndpoint] + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'external_key': 'str', + 'asset_properties': 'dict(str, str)', + 'properties': 'dict(str, object)', + 'type': 'str', + 'native_type_system': 'TypeSystem', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata', + 'default_connection': 'Connection', + 'end_points': 'list[DpEndpoint]' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'external_key': 'externalKey', + 'asset_properties': 'assetProperties', + 'properties': 'properties', + 'type': 'type', + 'native_type_system': 'nativeTypeSystem', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata', + 'default_connection': 'defaultConnection', + 'end_points': 'endPoints' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._external_key = None + self._asset_properties = None + self._properties = None + self._type = None + self._native_type_system = None + self._registry_metadata = None + self._metadata = None + self._default_connection = None + self._end_points = None + + @property + def key(self): + """ + Gets the key of this CreateDataAssetDetails. + Generated key that can be used in API calls to identify dataasset. + + + :return: The key of this CreateDataAssetDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateDataAssetDetails. + Generated key that can be used in API calls to identify dataasset. + + + :param key: The key of this CreateDataAssetDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateDataAssetDetails. + The model version of an object. + + + :return: The model_version of this CreateDataAssetDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateDataAssetDetails. + The model version of an object. + + + :param model_version: The model_version of this CreateDataAssetDetails. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this CreateDataAssetDetails. + The type of the object. + + + :return: The model_type of this CreateDataAssetDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateDataAssetDetails. + The type of the object. + + + :param model_type: The model_type of this CreateDataAssetDetails. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateDataAssetDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateDataAssetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateDataAssetDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateDataAssetDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateDataAssetDetails. + User-defined description of the data asset. + + + :return: The description of this CreateDataAssetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateDataAssetDetails. + User-defined description of the data asset. + + + :param description: The description of this CreateDataAssetDetails. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this CreateDataAssetDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateDataAssetDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateDataAssetDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateDataAssetDetails. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this CreateDataAssetDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateDataAssetDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateDataAssetDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateDataAssetDetails. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this CreateDataAssetDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateDataAssetDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateDataAssetDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateDataAssetDetails. + :type: str + """ + self._identifier = identifier + + @property + def external_key(self): + """ + Gets the external_key of this CreateDataAssetDetails. + The external key for the object. + + + :return: The external_key of this CreateDataAssetDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this CreateDataAssetDetails. + The external key for the object. + + + :param external_key: The external_key of this CreateDataAssetDetails. + :type: str + """ + self._external_key = external_key + + @property + def asset_properties(self): + """ + Gets the asset_properties of this CreateDataAssetDetails. + Additional properties for the data asset. + + + :return: The asset_properties of this CreateDataAssetDetails. + :rtype: dict(str, str) + """ + return self._asset_properties + + @asset_properties.setter + def asset_properties(self, asset_properties): + """ + Sets the asset_properties of this CreateDataAssetDetails. + Additional properties for the data asset. + + + :param asset_properties: The asset_properties of this CreateDataAssetDetails. + :type: dict(str, str) + """ + self._asset_properties = asset_properties + + @property + def properties(self): + """ + **[Required]** Gets the properties of this CreateDataAssetDetails. + All the properties for the data asset in a key-value map format. + + + :return: The properties of this CreateDataAssetDetails. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this CreateDataAssetDetails. + All the properties for the data asset in a key-value map format. + + + :param properties: The properties of this CreateDataAssetDetails. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + **[Required]** Gets the type of this CreateDataAssetDetails. + Specific DataAsset Type + + + :return: The type of this CreateDataAssetDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this CreateDataAssetDetails. + Specific DataAsset Type + + + :param type: The type of this CreateDataAssetDetails. + :type: str + """ + self._type = type + + @property + def native_type_system(self): + """ + Gets the native_type_system of this CreateDataAssetDetails. + + :return: The native_type_system of this CreateDataAssetDetails. + :rtype: oci.data_connectivity.models.TypeSystem + """ + return self._native_type_system + + @native_type_system.setter + def native_type_system(self, native_type_system): + """ + Sets the native_type_system of this CreateDataAssetDetails. + + :param native_type_system: The native_type_system of this CreateDataAssetDetails. + :type: oci.data_connectivity.models.TypeSystem + """ + self._native_type_system = native_type_system + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this CreateDataAssetDetails. + + :return: The registry_metadata of this CreateDataAssetDetails. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this CreateDataAssetDetails. + + :param registry_metadata: The registry_metadata of this CreateDataAssetDetails. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this CreateDataAssetDetails. + + :return: The metadata of this CreateDataAssetDetails. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this CreateDataAssetDetails. + + :param metadata: The metadata of this CreateDataAssetDetails. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def default_connection(self): + """ + Gets the default_connection of this CreateDataAssetDetails. + + :return: The default_connection of this CreateDataAssetDetails. + :rtype: oci.data_connectivity.models.Connection + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this CreateDataAssetDetails. + + :param default_connection: The default_connection of this CreateDataAssetDetails. + :type: oci.data_connectivity.models.Connection + """ + self._default_connection = default_connection + + @property + def end_points(self): + """ + Gets the end_points of this CreateDataAssetDetails. + The list of endpoints with which this data asset is associated. + + + :return: The end_points of this CreateDataAssetDetails. + :rtype: list[oci.data_connectivity.models.DpEndpoint] + """ + return self._end_points + + @end_points.setter + def end_points(self, end_points): + """ + Sets the end_points of this CreateDataAssetDetails. + The list of endpoints with which this data asset is associated. + + + :param end_points: The end_points of this CreateDataAssetDetails. + :type: list[oci.data_connectivity.models.DpEndpoint] + """ + self._end_points = end_points + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_data_preview_details.py b/src/oci/data_connectivity/models/create_data_preview_details.py new file mode 100644 index 0000000000..ee3225698f --- /dev/null +++ b/src/oci/data_connectivity/models/create_data_preview_details.py @@ -0,0 +1,174 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDataPreviewDetails(object): + """ + The data preview request payload. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDataPreviewDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param read_operation_config: + The value to assign to the read_operation_config property of this CreateDataPreviewDetails. + :type read_operation_config: oci.data_connectivity.models.ReadOperationConfig + + :param data_asset: + The value to assign to the data_asset property of this CreateDataPreviewDetails. + :type data_asset: oci.data_connectivity.models.DataAsset + + :param connection: + The value to assign to the connection property of this CreateDataPreviewDetails. + :type connection: oci.data_connectivity.models.Connection + + :param schema: + The value to assign to the schema property of this CreateDataPreviewDetails. + :type schema: oci.data_connectivity.models.Schema + + :param data_entity: + The value to assign to the data_entity property of this CreateDataPreviewDetails. + :type data_entity: oci.data_connectivity.models.DataEntity + + """ + self.swagger_types = { + 'read_operation_config': 'ReadOperationConfig', + 'data_asset': 'DataAsset', + 'connection': 'Connection', + 'schema': 'Schema', + 'data_entity': 'DataEntity' + } + + self.attribute_map = { + 'read_operation_config': 'readOperationConfig', + 'data_asset': 'dataAsset', + 'connection': 'connection', + 'schema': 'schema', + 'data_entity': 'dataEntity' + } + + self._read_operation_config = None + self._data_asset = None + self._connection = None + self._schema = None + self._data_entity = None + + @property + def read_operation_config(self): + """ + Gets the read_operation_config of this CreateDataPreviewDetails. + + :return: The read_operation_config of this CreateDataPreviewDetails. + :rtype: oci.data_connectivity.models.ReadOperationConfig + """ + return self._read_operation_config + + @read_operation_config.setter + def read_operation_config(self, read_operation_config): + """ + Sets the read_operation_config of this CreateDataPreviewDetails. + + :param read_operation_config: The read_operation_config of this CreateDataPreviewDetails. + :type: oci.data_connectivity.models.ReadOperationConfig + """ + self._read_operation_config = read_operation_config + + @property + def data_asset(self): + """ + Gets the data_asset of this CreateDataPreviewDetails. + + :return: The data_asset of this CreateDataPreviewDetails. + :rtype: oci.data_connectivity.models.DataAsset + """ + return self._data_asset + + @data_asset.setter + def data_asset(self, data_asset): + """ + Sets the data_asset of this CreateDataPreviewDetails. + + :param data_asset: The data_asset of this CreateDataPreviewDetails. + :type: oci.data_connectivity.models.DataAsset + """ + self._data_asset = data_asset + + @property + def connection(self): + """ + Gets the connection of this CreateDataPreviewDetails. + + :return: The connection of this CreateDataPreviewDetails. + :rtype: oci.data_connectivity.models.Connection + """ + return self._connection + + @connection.setter + def connection(self, connection): + """ + Sets the connection of this CreateDataPreviewDetails. + + :param connection: The connection of this CreateDataPreviewDetails. + :type: oci.data_connectivity.models.Connection + """ + self._connection = connection + + @property + def schema(self): + """ + Gets the schema of this CreateDataPreviewDetails. + + :return: The schema of this CreateDataPreviewDetails. + :rtype: oci.data_connectivity.models.Schema + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this CreateDataPreviewDetails. + + :param schema: The schema of this CreateDataPreviewDetails. + :type: oci.data_connectivity.models.Schema + """ + self._schema = schema + + @property + def data_entity(self): + """ + Gets the data_entity of this CreateDataPreviewDetails. + + :return: The data_entity of this CreateDataPreviewDetails. + :rtype: oci.data_connectivity.models.DataEntity + """ + return self._data_entity + + @data_entity.setter + def data_entity(self, data_entity): + """ + Sets the data_entity of this CreateDataPreviewDetails. + + :param data_entity: The data_entity of this CreateDataPreviewDetails. + :type: oci.data_connectivity.models.DataEntity + """ + self._data_entity = data_entity + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_data_profile_details.py b/src/oci/data_connectivity/models/create_data_profile_details.py new file mode 100644 index 0000000000..4cf4dfe900 --- /dev/null +++ b/src/oci/data_connectivity/models/create_data_profile_details.py @@ -0,0 +1,201 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDataProfileDetails(object): + """ + The data profile payload. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDataProfileDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param read_operation_config: + The value to assign to the read_operation_config property of this CreateDataProfileDetails. + :type read_operation_config: oci.data_connectivity.models.ReadOperationConfig + + :param data_asset: + The value to assign to the data_asset property of this CreateDataProfileDetails. + :type data_asset: oci.data_connectivity.models.DataAsset + + :param connection: + The value to assign to the connection property of this CreateDataProfileDetails. + :type connection: oci.data_connectivity.models.Connection + + :param schema: + The value to assign to the schema property of this CreateDataProfileDetails. + :type schema: oci.data_connectivity.models.Schema + + :param data_entity: + The value to assign to the data_entity property of this CreateDataProfileDetails. + :type data_entity: oci.data_connectivity.models.DataEntity + + :param profile_config: + The value to assign to the profile_config property of this CreateDataProfileDetails. + :type profile_config: oci.data_connectivity.models.ProfileConfig + + """ + self.swagger_types = { + 'read_operation_config': 'ReadOperationConfig', + 'data_asset': 'DataAsset', + 'connection': 'Connection', + 'schema': 'Schema', + 'data_entity': 'DataEntity', + 'profile_config': 'ProfileConfig' + } + + self.attribute_map = { + 'read_operation_config': 'readOperationConfig', + 'data_asset': 'dataAsset', + 'connection': 'connection', + 'schema': 'schema', + 'data_entity': 'dataEntity', + 'profile_config': 'profileConfig' + } + + self._read_operation_config = None + self._data_asset = None + self._connection = None + self._schema = None + self._data_entity = None + self._profile_config = None + + @property + def read_operation_config(self): + """ + Gets the read_operation_config of this CreateDataProfileDetails. + + :return: The read_operation_config of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.ReadOperationConfig + """ + return self._read_operation_config + + @read_operation_config.setter + def read_operation_config(self, read_operation_config): + """ + Sets the read_operation_config of this CreateDataProfileDetails. + + :param read_operation_config: The read_operation_config of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.ReadOperationConfig + """ + self._read_operation_config = read_operation_config + + @property + def data_asset(self): + """ + Gets the data_asset of this CreateDataProfileDetails. + + :return: The data_asset of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.DataAsset + """ + return self._data_asset + + @data_asset.setter + def data_asset(self, data_asset): + """ + Sets the data_asset of this CreateDataProfileDetails. + + :param data_asset: The data_asset of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.DataAsset + """ + self._data_asset = data_asset + + @property + def connection(self): + """ + Gets the connection of this CreateDataProfileDetails. + + :return: The connection of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.Connection + """ + return self._connection + + @connection.setter + def connection(self, connection): + """ + Sets the connection of this CreateDataProfileDetails. + + :param connection: The connection of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.Connection + """ + self._connection = connection + + @property + def schema(self): + """ + Gets the schema of this CreateDataProfileDetails. + + :return: The schema of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.Schema + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this CreateDataProfileDetails. + + :param schema: The schema of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.Schema + """ + self._schema = schema + + @property + def data_entity(self): + """ + Gets the data_entity of this CreateDataProfileDetails. + + :return: The data_entity of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.DataEntity + """ + return self._data_entity + + @data_entity.setter + def data_entity(self, data_entity): + """ + Sets the data_entity of this CreateDataProfileDetails. + + :param data_entity: The data_entity of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.DataEntity + """ + self._data_entity = data_entity + + @property + def profile_config(self): + """ + Gets the profile_config of this CreateDataProfileDetails. + + :return: The profile_config of this CreateDataProfileDetails. + :rtype: oci.data_connectivity.models.ProfileConfig + """ + return self._profile_config + + @profile_config.setter + def profile_config(self, profile_config): + """ + Sets the profile_config of this CreateDataProfileDetails. + + :param profile_config: The profile_config of this CreateDataProfileDetails. + :type: oci.data_connectivity.models.ProfileConfig + """ + self._profile_config = profile_config + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_de_reference_artifact_details.py b/src/oci/data_connectivity/models/create_de_reference_artifact_details.py new file mode 100644 index 0000000000..6994f47f89 --- /dev/null +++ b/src/oci/data_connectivity/models/create_de_reference_artifact_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDeReferenceArtifactDetails(object): + """ + Represents the info needed for de-referencing a dcms artifact. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDeReferenceArtifactDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param service_artifact_id: + The value to assign to the service_artifact_id property of this CreateDeReferenceArtifactDetails. + :type service_artifact_id: str + + """ + self.swagger_types = { + 'service_artifact_id': 'str' + } + + self.attribute_map = { + 'service_artifact_id': 'serviceArtifactId' + } + + self._service_artifact_id = None + + @property + def service_artifact_id(self): + """ + **[Required]** Gets the service_artifact_id of this CreateDeReferenceArtifactDetails. + unique id of service which is referencing data asset. + + + :return: The service_artifact_id of this CreateDeReferenceArtifactDetails. + :rtype: str + """ + return self._service_artifact_id + + @service_artifact_id.setter + def service_artifact_id(self, service_artifact_id): + """ + Sets the service_artifact_id of this CreateDeReferenceArtifactDetails. + unique id of service which is referencing data asset. + + + :param service_artifact_id: The service_artifact_id of this CreateDeReferenceArtifactDetails. + :type: str + """ + self._service_artifact_id = service_artifact_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_detach_data_asset_details.py b/src/oci/data_connectivity/models/create_detach_data_asset_details.py new file mode 100644 index 0000000000..e9d5938366 --- /dev/null +++ b/src/oci/data_connectivity/models/create_detach_data_asset_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDetachDataAssetDetails(object): + """ + The detach DataAsset payload. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDetachDataAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_assets: + The value to assign to the data_assets property of this CreateDetachDataAssetDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'data_assets': 'dataAssets' + } + + self._data_assets = None + + @property + def data_assets(self): + """ + **[Required]** Gets the data_assets of this CreateDetachDataAssetDetails. + The array of DataAsset keys + + + :return: The data_assets of this CreateDetachDataAssetDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this CreateDetachDataAssetDetails. + The array of DataAsset keys + + + :param data_assets: The data_assets of this CreateDetachDataAssetDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_dp_endpoint_details.py b/src/oci/data_connectivity/models/create_dp_endpoint_details.py new file mode 100644 index 0000000000..c46575e049 --- /dev/null +++ b/src/oci/data_connectivity/models/create_dp_endpoint_details.py @@ -0,0 +1,383 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDpEndpointDetails(object): + """ + Properties used in endpoint create operations. + """ + + #: A constant which can be used with the model_type property of a CreateDpEndpointDetails. + #: This constant has a value of "PRIVATE_END_POINT" + MODEL_TYPE_PRIVATE_END_POINT = "PRIVATE_END_POINT" + + #: A constant which can be used with the model_type property of a CreateDpEndpointDetails. + #: This constant has a value of "PUBLIC_END_POINT" + MODEL_TYPE_PUBLIC_END_POINT = "PUBLIC_END_POINT" + + def __init__(self, **kwargs): + """ + Initializes a new CreateDpEndpointDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.CreateDpEndpointFromPublic` + * :class:`~oci.data_connectivity.models.CreateDpEndpointFromPrivate` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateDpEndpointDetails. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateDpEndpointDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateDpEndpointDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateDpEndpointDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateDpEndpointDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateDpEndpointDetails. + :type description: str + + :param object_status: + The value to assign to the object_status property of this CreateDpEndpointDetails. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this CreateDpEndpointDetails. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this CreateDpEndpointDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this CreateDpEndpointDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = 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['modelType'] + + if type == 'PUBLIC_END_POINT': + return 'CreateDpEndpointFromPublic' + + if type == 'PRIVATE_END_POINT': + return 'CreateDpEndpointFromPrivate' + else: + return 'CreateDpEndpointDetails' + + @property + def model_type(self): + """ + Gets the model_type of this CreateDpEndpointDetails. + The type of the endpoint. + + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + + + :return: The model_type of this CreateDpEndpointDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateDpEndpointDetails. + The type of the endpoint. + + + :param model_type: The model_type of this CreateDpEndpointDetails. + :type: str + """ + allowed_values = ["PRIVATE_END_POINT", "PUBLIC_END_POINT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this CreateDpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :return: The key of this CreateDpEndpointDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateDpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :param key: The key of this CreateDpEndpointDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateDpEndpointDetails. + The model version of an object. + + + :return: The model_version of this CreateDpEndpointDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateDpEndpointDetails. + The model version of an object. + + + :param model_version: The model_version of this CreateDpEndpointDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this CreateDpEndpointDetails. + + :return: The parent_ref of this CreateDpEndpointDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this CreateDpEndpointDetails. + + :param parent_ref: The parent_ref of this CreateDpEndpointDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateDpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateDpEndpointDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateDpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateDpEndpointDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateDpEndpointDetails. + User-defined description for the endpoint. + + + :return: The description of this CreateDpEndpointDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateDpEndpointDetails. + User-defined description for the endpoint. + + + :param description: The description of this CreateDpEndpointDetails. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this CreateDpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateDpEndpointDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateDpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateDpEndpointDetails. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this CreateDpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateDpEndpointDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateDpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateDpEndpointDetails. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this CreateDpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateDpEndpointDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateDpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateDpEndpointDetails. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this CreateDpEndpointDetails. + List of data assets which belongs to this endpoint + + + :return: The data_assets of this CreateDpEndpointDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this CreateDpEndpointDetails. + List of data assets which belongs to this endpoint + + + :param data_assets: The data_assets of this CreateDpEndpointDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_dp_endpoint_from_private.py b/src/oci/data_connectivity/models/create_dp_endpoint_from_private.py new file mode 100644 index 0000000000..30a268c8a7 --- /dev/null +++ b/src/oci/data_connectivity/models/create_dp_endpoint_from_private.py @@ -0,0 +1,346 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_dp_endpoint_details import CreateDpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDpEndpointFromPrivate(CreateDpEndpointDetails): + """ + The details to create a private endpoint. + """ + + #: A constant which can be used with the state property of a CreateDpEndpointFromPrivate. + #: This constant has a value of "ACTIVE" + STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the state property of a CreateDpEndpointFromPrivate. + #: This constant has a value of "INACTIVE" + STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new CreateDpEndpointFromPrivate object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateDpEndpointFromPrivate.model_type` attribute + of this class is ``PRIVATE_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateDpEndpointFromPrivate. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateDpEndpointFromPrivate. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateDpEndpointFromPrivate. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateDpEndpointFromPrivate. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateDpEndpointFromPrivate. + :type name: str + + :param description: + The value to assign to the description property of this CreateDpEndpointFromPrivate. + :type description: str + + :param object_status: + The value to assign to the object_status property of this CreateDpEndpointFromPrivate. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this CreateDpEndpointFromPrivate. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this CreateDpEndpointFromPrivate. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this CreateDpEndpointFromPrivate. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + :param dcms_endpoint_id: + The value to assign to the dcms_endpoint_id property of this CreateDpEndpointFromPrivate. + :type dcms_endpoint_id: str + + :param pe_id: + The value to assign to the pe_id property of this CreateDpEndpointFromPrivate. + :type pe_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateDpEndpointFromPrivate. + :type compartment_id: str + + :param dns_proxy_ip: + The value to assign to the dns_proxy_ip property of this CreateDpEndpointFromPrivate. + :type dns_proxy_ip: str + + :param private_endpoint_ip: + The value to assign to the private_endpoint_ip property of this CreateDpEndpointFromPrivate. + :type private_endpoint_ip: str + + :param dns_zones: + The value to assign to the dns_zones property of this CreateDpEndpointFromPrivate. + :type dns_zones: list[str] + + :param state: + The value to assign to the state property of this CreateDpEndpointFromPrivate. + Allowed values for this property are: "ACTIVE", "INACTIVE" + :type state: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]', + 'dcms_endpoint_id': 'str', + 'pe_id': 'str', + 'compartment_id': 'str', + 'dns_proxy_ip': 'str', + 'private_endpoint_ip': 'str', + 'dns_zones': 'list[str]', + 'state': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets', + 'dcms_endpoint_id': 'dcmsEndpointId', + 'pe_id': 'peId', + 'compartment_id': 'compartmentId', + 'dns_proxy_ip': 'dnsProxyIp', + 'private_endpoint_ip': 'privateEndpointIp', + 'dns_zones': 'dnsZones', + 'state': 'state' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = None + self._dcms_endpoint_id = None + self._pe_id = None + self._compartment_id = None + self._dns_proxy_ip = None + self._private_endpoint_ip = None + self._dns_zones = None + self._state = None + self._model_type = 'PRIVATE_END_POINT' + + @property + def dcms_endpoint_id(self): + """ + **[Required]** Gets the dcms_endpoint_id of this CreateDpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :return: The dcms_endpoint_id of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._dcms_endpoint_id + + @dcms_endpoint_id.setter + def dcms_endpoint_id(self, dcms_endpoint_id): + """ + Sets the dcms_endpoint_id of this CreateDpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :param dcms_endpoint_id: The dcms_endpoint_id of this CreateDpEndpointFromPrivate. + :type: str + """ + self._dcms_endpoint_id = dcms_endpoint_id + + @property + def pe_id(self): + """ + Gets the pe_id of this CreateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The pe_id of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._pe_id + + @pe_id.setter + def pe_id(self, pe_id): + """ + Sets the pe_id of this CreateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param pe_id: The pe_id of this CreateDpEndpointFromPrivate. + :type: str + """ + self._pe_id = pe_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this CreateDpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :return: The compartment_id of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateDpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :param compartment_id: The compartment_id of this CreateDpEndpointFromPrivate. + :type: str + """ + self._compartment_id = compartment_id + + @property + def dns_proxy_ip(self): + """ + Gets the dns_proxy_ip of this CreateDpEndpointFromPrivate. + The IP address of dns proxy. + + + :return: The dns_proxy_ip of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._dns_proxy_ip + + @dns_proxy_ip.setter + def dns_proxy_ip(self, dns_proxy_ip): + """ + Sets the dns_proxy_ip of this CreateDpEndpointFromPrivate. + The IP address of dns proxy. + + + :param dns_proxy_ip: The dns_proxy_ip of this CreateDpEndpointFromPrivate. + :type: str + """ + self._dns_proxy_ip = dns_proxy_ip + + @property + def private_endpoint_ip(self): + """ + Gets the private_endpoint_ip of this CreateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The private_endpoint_ip of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._private_endpoint_ip + + @private_endpoint_ip.setter + def private_endpoint_ip(self, private_endpoint_ip): + """ + Sets the private_endpoint_ip of this CreateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param private_endpoint_ip: The private_endpoint_ip of this CreateDpEndpointFromPrivate. + :type: str + """ + self._private_endpoint_ip = private_endpoint_ip + + @property + def dns_zones(self): + """ + Gets the dns_zones of this CreateDpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :return: The dns_zones of this CreateDpEndpointFromPrivate. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this CreateDpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :param dns_zones: The dns_zones of this CreateDpEndpointFromPrivate. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def state(self): + """ + Gets the state of this CreateDpEndpointFromPrivate. + Specifies the private endpoint state. + + Allowed values for this property are: "ACTIVE", "INACTIVE" + + + :return: The state of this CreateDpEndpointFromPrivate. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this CreateDpEndpointFromPrivate. + Specifies the private endpoint state. + + + :param state: The state of this CreateDpEndpointFromPrivate. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + raise ValueError( + "Invalid value for `state`, must be None or one of {0}" + .format(allowed_values) + ) + self._state = 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/data_connectivity/models/create_dp_endpoint_from_public.py b/src/oci/data_connectivity/models/create_dp_endpoint_from_public.py new file mode 100644 index 0000000000..a9858787d5 --- /dev/null +++ b/src/oci/data_connectivity/models/create_dp_endpoint_from_public.py @@ -0,0 +1,112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_dp_endpoint_details import CreateDpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateDpEndpointFromPublic(CreateDpEndpointDetails): + """ + The details to create a public endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateDpEndpointFromPublic object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateDpEndpointFromPublic.model_type` attribute + of this class is ``PUBLIC_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateDpEndpointFromPublic. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateDpEndpointFromPublic. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateDpEndpointFromPublic. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateDpEndpointFromPublic. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateDpEndpointFromPublic. + :type name: str + + :param description: + The value to assign to the description property of this CreateDpEndpointFromPublic. + :type description: str + + :param object_status: + The value to assign to the object_status property of this CreateDpEndpointFromPublic. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this CreateDpEndpointFromPublic. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this CreateDpEndpointFromPublic. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this CreateDpEndpointFromPublic. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = None + self._model_type = 'PUBLIC_END_POINT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_endpoint_details.py b/src/oci/data_connectivity/models/create_endpoint_details.py new file mode 100644 index 0000000000..f87abe193e --- /dev/null +++ b/src/oci/data_connectivity/models/create_endpoint_details.py @@ -0,0 +1,355 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEndpointDetails(object): + """ + The information about new Endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEndpointDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vcn_id: + The value to assign to the vcn_id property of this CreateEndpointDetails. + :type vcn_id: str + + :param subnet_id: + The value to assign to the subnet_id property of this CreateEndpointDetails. + :type subnet_id: str + + :param dns_zones: + The value to assign to the dns_zones property of this CreateEndpointDetails. + :type dns_zones: list[str] + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateEndpointDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateEndpointDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this CreateEndpointDetails. + :type description: str + + :param display_name: + The value to assign to the display_name property of this CreateEndpointDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateEndpointDetails. + :type compartment_id: str + + :param endpoint_size: + The value to assign to the endpoint_size property of this CreateEndpointDetails. + :type endpoint_size: int + + :param nsg_ids: + The value to assign to the nsg_ids property of this CreateEndpointDetails. + :type nsg_ids: list[str] + + """ + self.swagger_types = { + 'vcn_id': 'str', + 'subnet_id': 'str', + 'dns_zones': 'list[str]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'endpoint_size': 'int', + 'nsg_ids': 'list[str]' + } + + self.attribute_map = { + 'vcn_id': 'vcnId', + 'subnet_id': 'subnetId', + 'dns_zones': 'dnsZones', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'endpoint_size': 'endpointSize', + 'nsg_ids': 'nsgIds' + } + + self._vcn_id = None + self._subnet_id = None + self._dns_zones = None + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + self._compartment_id = None + self._endpoint_size = None + self._nsg_ids = None + + @property + def vcn_id(self): + """ + Gets the vcn_id of this CreateEndpointDetails. + VCN Identifier where the subnet resides. + + + :return: The vcn_id of this CreateEndpointDetails. + :rtype: str + """ + return self._vcn_id + + @vcn_id.setter + def vcn_id(self, vcn_id): + """ + Sets the vcn_id of this CreateEndpointDetails. + VCN Identifier where the subnet resides. + + + :param vcn_id: The vcn_id of this CreateEndpointDetails. + :type: str + """ + self._vcn_id = vcn_id + + @property + def subnet_id(self): + """ + Gets the subnet_id of this CreateEndpointDetails. + Subnet Identifier for customer connected databases + + + :return: The subnet_id of this CreateEndpointDetails. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this CreateEndpointDetails. + Subnet Identifier for customer connected databases + + + :param subnet_id: The subnet_id of this CreateEndpointDetails. + :type: str + """ + self._subnet_id = subnet_id + + @property + def dns_zones(self): + """ + Gets the dns_zones of this CreateEndpointDetails. + List of DNS zones to be used by the data assets to be harvested. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :return: The dns_zones of this CreateEndpointDetails. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this CreateEndpointDetails. + List of DNS zones to be used by the data assets to be harvested. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :param dns_zones: The dns_zones of this CreateEndpointDetails. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateEndpointDetails. + 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 CreateEndpointDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateEndpointDetails. + 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 CreateEndpointDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateEndpointDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateEndpointDetails. + :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 CreateEndpointDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateEndpointDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this CreateEndpointDetails. + Data Connectivity Management Registry description + + + :return: The description of this CreateEndpointDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateEndpointDetails. + Data Connectivity Management Registry description + + + :param description: The description of this CreateEndpointDetails. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateEndpointDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this CreateEndpointDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateEndpointDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this CreateEndpointDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this CreateEndpointDetails. + Compartment Identifier + + + :return: The compartment_id of this CreateEndpointDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateEndpointDetails. + Compartment Identifier + + + :param compartment_id: The compartment_id of this CreateEndpointDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def endpoint_size(self): + """ + Gets the endpoint_size of this CreateEndpointDetails. + Endpoint size for reverse connection capacity. + + + :return: The endpoint_size of this CreateEndpointDetails. + :rtype: int + """ + return self._endpoint_size + + @endpoint_size.setter + def endpoint_size(self, endpoint_size): + """ + Sets the endpoint_size of this CreateEndpointDetails. + Endpoint size for reverse connection capacity. + + + :param endpoint_size: The endpoint_size of this CreateEndpointDetails. + :type: int + """ + self._endpoint_size = endpoint_size + + @property + def nsg_ids(self): + """ + Gets the nsg_ids of this CreateEndpointDetails. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :return: The nsg_ids of this CreateEndpointDetails. + :rtype: list[str] + """ + return self._nsg_ids + + @nsg_ids.setter + def nsg_ids(self, nsg_ids): + """ + Sets the nsg_ids of this CreateEndpointDetails. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :param nsg_ids: The nsg_ids of this CreateEndpointDetails. + :type: list[str] + """ + self._nsg_ids = nsg_ids + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_entity_shape_details.py b/src/oci/data_connectivity/models/create_entity_shape_details.py new file mode 100644 index 0000000000..da9b4c5ba4 --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_details.py @@ -0,0 +1,672 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeDetails(object): + """ + The data entity shape object. + """ + + #: A constant which can be used with the model_type property of a CreateEntityShapeDetails. + #: This constant has a value of "VIEW_ENTITY" + MODEL_TYPE_VIEW_ENTITY = "VIEW_ENTITY" + + #: A constant which can be used with the model_type property of a CreateEntityShapeDetails. + #: This constant has a value of "TABLE_ENTITY" + MODEL_TYPE_TABLE_ENTITY = "TABLE_ENTITY" + + #: A constant which can be used with the model_type property of a CreateEntityShapeDetails. + #: This constant has a value of "FILE_ENTITY" + MODEL_TYPE_FILE_ENTITY = "FILE_ENTITY" + + #: A constant which can be used with the model_type property of a CreateEntityShapeDetails. + #: This constant has a value of "DATA_STORE_ENTITY" + MODEL_TYPE_DATA_STORE_ENTITY = "DATA_STORE_ENTITY" + + #: A constant which can be used with the model_type property of a CreateEntityShapeDetails. + #: This constant has a value of "SQL_ENTITY" + MODEL_TYPE_SQL_ENTITY = "SQL_ENTITY" + + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.CreateEntityShapeFromDataStore` + * :class:`~oci.data_connectivity.models.CreateEntityShapeFromTable` + * :class:`~oci.data_connectivity.models.CreateEntityShapeFromSQL` + * :class:`~oci.data_connectivity.models.CreateEntityShapeFromFile` + * :class:`~oci.data_connectivity.models.CreateEntityShapeFromView` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeDetails. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeDetails. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeDetails. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeDetails. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeDetails. + :type entity_properties: dict(str, str) + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = 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['modelType'] + + if type == 'DATA_STORE_ENTITY': + return 'CreateEntityShapeFromDataStore' + + if type == 'TABLE_ENTITY': + return 'CreateEntityShapeFromTable' + + if type == 'SQL_ENTITY': + return 'CreateEntityShapeFromSQL' + + if type == 'FILE_ENTITY': + return 'CreateEntityShapeFromFile' + + if type == 'VIEW_ENTITY': + return 'CreateEntityShapeFromView' + else: + return 'CreateEntityShapeDetails' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this CreateEntityShapeDetails. + The data entity type. + + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + + + :return: The model_type of this CreateEntityShapeDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateEntityShapeDetails. + The data entity type. + + + :param model_type: The model_type of this CreateEntityShapeDetails. + :type: str + """ + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this CreateEntityShapeDetails. + The object key. + + + :return: The key of this CreateEntityShapeDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateEntityShapeDetails. + The object key. + + + :param key: The key of this CreateEntityShapeDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateEntityShapeDetails. + The object's model version. + + + :return: The model_version of this CreateEntityShapeDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateEntityShapeDetails. + The object's model version. + + + :param model_version: The model_version of this CreateEntityShapeDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this CreateEntityShapeDetails. + + :return: The parent_ref of this CreateEntityShapeDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this CreateEntityShapeDetails. + + :param parent_ref: The parent_ref of this CreateEntityShapeDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateEntityShapeDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateEntityShapeDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateEntityShapeDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateEntityShapeDetails. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this CreateEntityShapeDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateEntityShapeDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateEntityShapeDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateEntityShapeDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this CreateEntityShapeDetails. + The external key for the object. + + + :return: The external_key of this CreateEntityShapeDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this CreateEntityShapeDetails. + The external key for the object. + + + :param external_key: The external_key of this CreateEntityShapeDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this CreateEntityShapeDetails. + + :return: The shape of this CreateEntityShapeDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this CreateEntityShapeDetails. + + :param shape: The shape of this CreateEntityShapeDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this CreateEntityShapeDetails. + The shape ID. + + + :return: The shape_id of this CreateEntityShapeDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this CreateEntityShapeDetails. + The shape ID. + + + :param shape_id: The shape_id of this CreateEntityShapeDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this CreateEntityShapeDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + + + :return: The entity_type of this CreateEntityShapeDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this CreateEntityShapeDetails. + The entity type. + + + :param entity_type: The entity_type of this CreateEntityShapeDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this CreateEntityShapeDetails. + Specifies other type label. + + + :return: The other_type_label of this CreateEntityShapeDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this CreateEntityShapeDetails. + Specifies other type label. + + + :param other_type_label: The other_type_label of this CreateEntityShapeDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this CreateEntityShapeDetails. + An array of unique keys. + + + :return: The unique_keys of this CreateEntityShapeDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this CreateEntityShapeDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this CreateEntityShapeDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this CreateEntityShapeDetails. + An array of foreign keys. + + + :return: The foreign_keys of this CreateEntityShapeDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this CreateEntityShapeDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this CreateEntityShapeDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this CreateEntityShapeDetails. + The resource name. + + + :return: The resource_name of this CreateEntityShapeDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this CreateEntityShapeDetails. + The resource name. + + + :param resource_name: The resource_name of this CreateEntityShapeDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this CreateEntityShapeDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateEntityShapeDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateEntityShapeDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateEntityShapeDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this CreateEntityShapeDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateEntityShapeDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateEntityShapeDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateEntityShapeDetails. + :type: str + """ + self._identifier = identifier + + @property + def types(self): + """ + Gets the types of this CreateEntityShapeDetails. + + :return: The types of this CreateEntityShapeDetails. + :rtype: oci.data_connectivity.models.TypeLibrary + """ + return self._types + + @types.setter + def types(self, types): + """ + Sets the types of this CreateEntityShapeDetails. + + :param types: The types of this CreateEntityShapeDetails. + :type: oci.data_connectivity.models.TypeLibrary + """ + self._types = types + + @property + def entity_properties(self): + """ + Gets the entity_properties of this CreateEntityShapeDetails. + Map for entity properties + + + :return: The entity_properties of this CreateEntityShapeDetails. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this CreateEntityShapeDetails. + Map for entity properties + + + :param entity_properties: The entity_properties of this CreateEntityShapeDetails. + :type: dict(str, str) + """ + self._entity_properties = entity_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/data_connectivity/models/create_entity_shape_from_data_store.py b/src/oci/data_connectivity/models/create_entity_shape_from_data_store.py new file mode 100644 index 0000000000..3b3cca4c05 --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_data_store.py @@ -0,0 +1,169 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_entity_shape_details import CreateEntityShapeDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeFromDataStore(CreateEntityShapeDetails): + """ + The data store entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromDataStore object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromDataStore.model_type` attribute + of this class is ``DATA_STORE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeFromDataStore. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromDataStore. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromDataStore. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromDataStore. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromDataStore. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromDataStore. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromDataStore. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromDataStore. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromDataStore. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromDataStore. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromDataStore. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromDataStore. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromDataStore. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromDataStore. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromDataStore. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromDataStore. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromDataStore. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromDataStore. + :type entity_properties: dict(str, str) + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = None + self._model_type = 'DATA_STORE_ENTITY' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_entity_shape_from_file.py b/src/oci/data_connectivity/models/create_entity_shape_from_file.py new file mode 100644 index 0000000000..ece6b7089a --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_file.py @@ -0,0 +1,196 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_entity_shape_details import CreateEntityShapeDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeFromFile(CreateEntityShapeDetails): + """ + The file data entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromFile object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromFile.model_type` attribute + of this class is ``FILE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeFromFile. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromFile. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromFile. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromFile. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromFile. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromFile. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromFile. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromFile. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromFile. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromFile. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromFile. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromFile. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromFile. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromFile. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromFile. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromFile. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromFile. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromFile. + :type entity_properties: dict(str, str) + + :param data_format: + The value to assign to the data_format property of this CreateEntityShapeFromFile. + :type data_format: oci.data_connectivity.models.DataFormat + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)', + 'data_format': 'DataFormat' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties', + 'data_format': 'dataFormat' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = None + self._data_format = None + self._model_type = 'FILE_ENTITY' + + @property + def data_format(self): + """ + Gets the data_format of this CreateEntityShapeFromFile. + + :return: The data_format of this CreateEntityShapeFromFile. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this CreateEntityShapeFromFile. + + :param data_format: The data_format of this CreateEntityShapeFromFile. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_entity_shape_from_sql.py b/src/oci/data_connectivity/models/create_entity_shape_from_sql.py new file mode 100644 index 0000000000..2441a3f7ec --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_sql.py @@ -0,0 +1,200 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_entity_shape_details import CreateEntityShapeDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeFromSQL(CreateEntityShapeDetails): + """ + The SQL entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromSQL object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromSQL.model_type` attribute + of this class is ``SQL_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeFromSQL. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromSQL. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromSQL. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromSQL. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromSQL. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromSQL. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromSQL. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromSQL. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromSQL. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromSQL. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromSQL. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromSQL. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromSQL. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromSQL. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromSQL. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromSQL. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromSQL. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromSQL. + :type entity_properties: dict(str, str) + + :param sql_query: + The value to assign to the sql_query property of this CreateEntityShapeFromSQL. + :type sql_query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)', + 'sql_query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties', + 'sql_query': 'sqlQuery' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = None + self._sql_query = None + self._model_type = 'SQL_ENTITY' + + @property + def sql_query(self): + """ + Gets the sql_query of this CreateEntityShapeFromSQL. + sqlQuery + + + :return: The sql_query of this CreateEntityShapeFromSQL. + :rtype: str + """ + return self._sql_query + + @sql_query.setter + def sql_query(self, sql_query): + """ + Sets the sql_query of this CreateEntityShapeFromSQL. + sqlQuery + + + :param sql_query: The sql_query of this CreateEntityShapeFromSQL. + :type: str + """ + self._sql_query = sql_query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_entity_shape_from_table.py b/src/oci/data_connectivity/models/create_entity_shape_from_table.py new file mode 100644 index 0000000000..7af9530797 --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_table.py @@ -0,0 +1,169 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_entity_shape_details import CreateEntityShapeDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeFromTable(CreateEntityShapeDetails): + """ + The table data entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromTable object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromTable.model_type` attribute + of this class is ``TABLE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeFromTable. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromTable. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromTable. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromTable. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromTable. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromTable. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromTable. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromTable. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromTable. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromTable. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromTable. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromTable. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromTable. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromTable. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromTable. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromTable. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromTable. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromTable. + :type entity_properties: dict(str, str) + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = None + self._model_type = 'TABLE_ENTITY' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_entity_shape_from_view.py b/src/oci/data_connectivity/models/create_entity_shape_from_view.py new file mode 100644 index 0000000000..28f12f267a --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_view.py @@ -0,0 +1,169 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_entity_shape_details import CreateEntityShapeDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateEntityShapeFromView(CreateEntityShapeDetails): + """ + The view data entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromView object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromView.model_type` attribute + of this class is ``VIEW_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateEntityShapeFromView. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromView. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromView. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromView. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromView. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromView. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromView. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromView. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromView. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromView. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromView. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromView. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromView. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromView. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromView. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromView. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromView. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromView. + :type entity_properties: dict(str, str) + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'TypeLibrary', + 'entity_properties': 'dict(str, str)' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types', + 'entity_properties': 'entityProperties' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._types = None + self._entity_properties = None + self._model_type = 'VIEW_ENTITY' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_execute_operation_job_details.py b/src/oci/data_connectivity/models/create_execute_operation_job_details.py new file mode 100644 index 0000000000..f1fd9b58be --- /dev/null +++ b/src/oci/data_connectivity/models/create_execute_operation_job_details.py @@ -0,0 +1,124 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateExecuteOperationJobDetails(object): + """ + Input details to execute operation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateExecuteOperationJobDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation: + The value to assign to the operation property of this CreateExecuteOperationJobDetails. + :type operation: oci.data_connectivity.models.Operation + + :param call_operation_config: + The value to assign to the call_operation_config property of this CreateExecuteOperationJobDetails. + :type call_operation_config: oci.data_connectivity.models.CallOperationConfig + + :param input_records: + The value to assign to the input_records property of this CreateExecuteOperationJobDetails. + :type input_records: list[oci.data_connectivity.models.OperationInputRecord] + + """ + self.swagger_types = { + 'operation': 'Operation', + 'call_operation_config': 'CallOperationConfig', + 'input_records': 'list[OperationInputRecord]' + } + + self.attribute_map = { + 'operation': 'operation', + 'call_operation_config': 'callOperationConfig', + 'input_records': 'inputRecords' + } + + self._operation = None + self._call_operation_config = None + self._input_records = None + + @property + def operation(self): + """ + Gets the operation of this CreateExecuteOperationJobDetails. + + :return: The operation of this CreateExecuteOperationJobDetails. + :rtype: oci.data_connectivity.models.Operation + """ + return self._operation + + @operation.setter + def operation(self, operation): + """ + Sets the operation of this CreateExecuteOperationJobDetails. + + :param operation: The operation of this CreateExecuteOperationJobDetails. + :type: oci.data_connectivity.models.Operation + """ + self._operation = operation + + @property + def call_operation_config(self): + """ + Gets the call_operation_config of this CreateExecuteOperationJobDetails. + + :return: The call_operation_config of this CreateExecuteOperationJobDetails. + :rtype: oci.data_connectivity.models.CallOperationConfig + """ + return self._call_operation_config + + @call_operation_config.setter + def call_operation_config(self, call_operation_config): + """ + Sets the call_operation_config of this CreateExecuteOperationJobDetails. + + :param call_operation_config: The call_operation_config of this CreateExecuteOperationJobDetails. + :type: oci.data_connectivity.models.CallOperationConfig + """ + self._call_operation_config = call_operation_config + + @property + def input_records(self): + """ + Gets the input_records of this CreateExecuteOperationJobDetails. + Collection of input parameters supplied. + + + :return: The input_records of this CreateExecuteOperationJobDetails. + :rtype: list[oci.data_connectivity.models.OperationInputRecord] + """ + return self._input_records + + @input_records.setter + def input_records(self, input_records): + """ + Sets the input_records of this CreateExecuteOperationJobDetails. + Collection of input parameters supplied. + + + :param input_records: The input_records of this CreateExecuteOperationJobDetails. + :type: list[oci.data_connectivity.models.OperationInputRecord] + """ + self._input_records = input_records + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_folder_details.py b/src/oci/data_connectivity/models/create_folder_details.py new file mode 100644 index 0000000000..397f077039 --- /dev/null +++ b/src/oci/data_connectivity/models/create_folder_details.py @@ -0,0 +1,345 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateFolderDetails(object): + """ + Properties used in folder create operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateFolderDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateFolderDetails. + :type model_type: str + + :param key: + The value to assign to the key property of this CreateFolderDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateFolderDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateFolderDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateFolderDetails. + :type name: str + + :param description: + The value to assign to the description property of this CreateFolderDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this CreateFolderDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this CreateFolderDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateFolderDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this CreateFolderDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + + @property + def model_type(self): + """ + Gets the model_type of this CreateFolderDetails. + The type of the folder. + + + :return: The model_type of this CreateFolderDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateFolderDetails. + The type of the folder. + + + :param model_type: The model_type of this CreateFolderDetails. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this CreateFolderDetails. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :return: The key of this CreateFolderDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this CreateFolderDetails. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :param key: The key of this CreateFolderDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this CreateFolderDetails. + The model version of an object. + + + :return: The model_version of this CreateFolderDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this CreateFolderDetails. + The model version of an object. + + + :param model_version: The model_version of this CreateFolderDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this CreateFolderDetails. + + :return: The parent_ref of this CreateFolderDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this CreateFolderDetails. + + :param parent_ref: The parent_ref of this CreateFolderDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this CreateFolderDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this CreateFolderDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CreateFolderDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this CreateFolderDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this CreateFolderDetails. + User-defined description for the folder. + + + :return: The description of this CreateFolderDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateFolderDetails. + User-defined description for the folder. + + + :param description: The description of this CreateFolderDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this CreateFolderDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this CreateFolderDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this CreateFolderDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this CreateFolderDetails. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this CreateFolderDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this CreateFolderDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this CreateFolderDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this CreateFolderDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this CreateFolderDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this CreateFolderDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this CreateFolderDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this CreateFolderDetails. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this CreateFolderDetails. + List of data assets which belongs to this folder + + + :return: The data_assets of this CreateFolderDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this CreateFolderDetails. + List of data assets which belongs to this folder + + + :param data_assets: The data_assets of this CreateFolderDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_full_push_down_task_details.py b/src/oci/data_connectivity/models/create_full_push_down_task_details.py new file mode 100644 index 0000000000..e3f0318144 --- /dev/null +++ b/src/oci/data_connectivity/models/create_full_push_down_task_details.py @@ -0,0 +1,124 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateFullPushDownTaskDetails(object): + """ + The full pushdown task parameter + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateFullPushDownTaskDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CreateFullPushDownTaskDetails. + :type model_type: str + + :param source: + The value to assign to the source property of this CreateFullPushDownTaskDetails. + :type source: oci.data_connectivity.models.Source + + :param target: + The value to assign to the target property of this CreateFullPushDownTaskDetails. + :type target: oci.data_connectivity.models.Target + + """ + self.swagger_types = { + 'model_type': 'str', + 'source': 'Source', + 'target': 'Target' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'source': 'source', + 'target': 'target' + } + + self._model_type = None + self._source = None + self._target = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this CreateFullPushDownTaskDetails. + The type of of FullPushDownTask. + + + :return: The model_type of this CreateFullPushDownTaskDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this CreateFullPushDownTaskDetails. + The type of of FullPushDownTask. + + + :param model_type: The model_type of this CreateFullPushDownTaskDetails. + :type: str + """ + self._model_type = model_type + + @property + def source(self): + """ + Gets the source of this CreateFullPushDownTaskDetails. + + :return: The source of this CreateFullPushDownTaskDetails. + :rtype: oci.data_connectivity.models.Source + """ + return self._source + + @source.setter + def source(self, source): + """ + Sets the source of this CreateFullPushDownTaskDetails. + + :param source: The source of this CreateFullPushDownTaskDetails. + :type: oci.data_connectivity.models.Source + """ + self._source = source + + @property + def target(self): + """ + Gets the target of this CreateFullPushDownTaskDetails. + + :return: The target of this CreateFullPushDownTaskDetails. + :rtype: oci.data_connectivity.models.Target + """ + return self._target + + @target.setter + def target(self, target): + """ + Sets the target of this CreateFullPushDownTaskDetails. + + :param target: The target of this CreateFullPushDownTaskDetails. + :type: oci.data_connectivity.models.Target + """ + 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/data_connectivity/models/create_reference_artifact_details.py b/src/oci/data_connectivity/models/create_reference_artifact_details.py new file mode 100644 index 0000000000..ca2f36fc39 --- /dev/null +++ b/src/oci/data_connectivity/models/create_reference_artifact_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateReferenceArtifactDetails(object): + """ + Represents the info needed for creating dcms artifact reference. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateReferenceArtifactDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param service_artifact_id: + The value to assign to the service_artifact_id property of this CreateReferenceArtifactDetails. + :type service_artifact_id: str + + """ + self.swagger_types = { + 'service_artifact_id': 'str' + } + + self.attribute_map = { + 'service_artifact_id': 'serviceArtifactId' + } + + self._service_artifact_id = None + + @property + def service_artifact_id(self): + """ + **[Required]** Gets the service_artifact_id of this CreateReferenceArtifactDetails. + unique id of service which is referencing data asset. + + + :return: The service_artifact_id of this CreateReferenceArtifactDetails. + :rtype: str + """ + return self._service_artifact_id + + @service_artifact_id.setter + def service_artifact_id(self, service_artifact_id): + """ + Sets the service_artifact_id of this CreateReferenceArtifactDetails. + unique id of service which is referencing data asset. + + + :param service_artifact_id: The service_artifact_id of this CreateReferenceArtifactDetails. + :type: str + """ + self._service_artifact_id = service_artifact_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_registry_details.py b/src/oci/data_connectivity/models/create_registry_details.py new file mode 100644 index 0000000000..23f0d8acf6 --- /dev/null +++ b/src/oci/data_connectivity/models/create_registry_details.py @@ -0,0 +1,198 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateRegistryDetails(object): + """ + The information about new Registry. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateRegistryDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param freeform_tags: + The value to assign to the freeform_tags property of this CreateRegistryDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this CreateRegistryDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this CreateRegistryDetails. + :type description: str + + :param display_name: + The value to assign to the display_name property of this CreateRegistryDetails. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this CreateRegistryDetails. + :type compartment_id: str + + """ + self.swagger_types = { + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str', + 'compartment_id': 'str' + } + + self.attribute_map = { + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId' + } + + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + self._compartment_id = None + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this CreateRegistryDetails. + 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 CreateRegistryDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this CreateRegistryDetails. + 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 CreateRegistryDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this CreateRegistryDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this CreateRegistryDetails. + :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 CreateRegistryDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this CreateRegistryDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this CreateRegistryDetails. + Data Connectivity Management Registry description + + + :return: The description of this CreateRegistryDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this CreateRegistryDetails. + Data Connectivity Management Registry description + + + :param description: The description of this CreateRegistryDetails. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this CreateRegistryDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this CreateRegistryDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this CreateRegistryDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this CreateRegistryDetails. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this CreateRegistryDetails. + Compartment Identifier + + + :return: The compartment_id of this CreateRegistryDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this CreateRegistryDetails. + Compartment Identifier + + + :param compartment_id: The compartment_id of this CreateRegistryDetails. + :type: str + """ + self._compartment_id = compartment_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/create_test_network_connectivity_details.py b/src/oci/data_connectivity/models/create_test_network_connectivity_details.py new file mode 100644 index 0000000000..473874b106 --- /dev/null +++ b/src/oci/data_connectivity/models/create_test_network_connectivity_details.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateTestNetworkConnectivityDetails(object): + """ + The network validation payload. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateTestNetworkConnectivityDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_asset_key: + The value to assign to the data_asset_key property of this CreateTestNetworkConnectivityDetails. + :type data_asset_key: str + + """ + self.swagger_types = { + 'data_asset_key': 'str' + } + + self.attribute_map = { + 'data_asset_key': 'dataAssetKey' + } + + self._data_asset_key = None + + @property + def data_asset_key(self): + """ + **[Required]** Gets the data_asset_key of this CreateTestNetworkConnectivityDetails. + Data Asset key + + + :return: The data_asset_key of this CreateTestNetworkConnectivityDetails. + :rtype: str + """ + return self._data_asset_key + + @data_asset_key.setter + def data_asset_key(self, data_asset_key): + """ + Sets the data_asset_key of this CreateTestNetworkConnectivityDetails. + Data Asset key + + + :param data_asset_key: The data_asset_key of this CreateTestNetworkConnectivityDetails. + :type: str + """ + self._data_asset_key = data_asset_key + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/csv_format_attribute.py b/src/oci/data_connectivity/models/csv_format_attribute.py new file mode 100644 index 0000000000..a94165b66c --- /dev/null +++ b/src/oci/data_connectivity/models/csv_format_attribute.py @@ -0,0 +1,266 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_format_attribute import AbstractFormatAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CsvFormatAttribute(AbstractFormatAttribute): + """ + The CSV format attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CsvFormatAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CsvFormatAttribute.model_type` attribute + of this class is ``CSV_FORMAT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this CsvFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT" + :type model_type: str + + :param encoding: + The value to assign to the encoding property of this CsvFormatAttribute. + :type encoding: str + + :param escape_character: + The value to assign to the escape_character property of this CsvFormatAttribute. + :type escape_character: str + + :param delimiter: + The value to assign to the delimiter property of this CsvFormatAttribute. + :type delimiter: str + + :param quote_character: + The value to assign to the quote_character property of this CsvFormatAttribute. + :type quote_character: str + + :param has_header: + The value to assign to the has_header property of this CsvFormatAttribute. + :type has_header: bool + + :param is_file_pattern: + The value to assign to the is_file_pattern property of this CsvFormatAttribute. + :type is_file_pattern: bool + + :param timestamp_format: + The value to assign to the timestamp_format property of this CsvFormatAttribute. + :type timestamp_format: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'encoding': 'str', + 'escape_character': 'str', + 'delimiter': 'str', + 'quote_character': 'str', + 'has_header': 'bool', + 'is_file_pattern': 'bool', + 'timestamp_format': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'encoding': 'encoding', + 'escape_character': 'escapeCharacter', + 'delimiter': 'delimiter', + 'quote_character': 'quoteCharacter', + 'has_header': 'hasHeader', + 'is_file_pattern': 'isFilePattern', + 'timestamp_format': 'timestampFormat' + } + + self._model_type = None + self._encoding = None + self._escape_character = None + self._delimiter = None + self._quote_character = None + self._has_header = None + self._is_file_pattern = None + self._timestamp_format = None + self._model_type = 'CSV_FORMAT' + + @property + def encoding(self): + """ + Gets the encoding of this CsvFormatAttribute. + The encoding for the file. + + + :return: The encoding of this CsvFormatAttribute. + :rtype: str + """ + return self._encoding + + @encoding.setter + def encoding(self, encoding): + """ + Sets the encoding of this CsvFormatAttribute. + The encoding for the file. + + + :param encoding: The encoding of this CsvFormatAttribute. + :type: str + """ + self._encoding = encoding + + @property + def escape_character(self): + """ + Gets the escape_character of this CsvFormatAttribute. + The escape character for the CSV format. + + + :return: The escape_character of this CsvFormatAttribute. + :rtype: str + """ + return self._escape_character + + @escape_character.setter + def escape_character(self, escape_character): + """ + Sets the escape_character of this CsvFormatAttribute. + The escape character for the CSV format. + + + :param escape_character: The escape_character of this CsvFormatAttribute. + :type: str + """ + self._escape_character = escape_character + + @property + def delimiter(self): + """ + Gets the delimiter of this CsvFormatAttribute. + The delimiter for the CSV format. + + + :return: The delimiter of this CsvFormatAttribute. + :rtype: str + """ + return self._delimiter + + @delimiter.setter + def delimiter(self, delimiter): + """ + Sets the delimiter of this CsvFormatAttribute. + The delimiter for the CSV format. + + + :param delimiter: The delimiter of this CsvFormatAttribute. + :type: str + """ + self._delimiter = delimiter + + @property + def quote_character(self): + """ + Gets the quote_character of this CsvFormatAttribute. + The quote character for the CSV format. + + + :return: The quote_character of this CsvFormatAttribute. + :rtype: str + """ + return self._quote_character + + @quote_character.setter + def quote_character(self, quote_character): + """ + Sets the quote_character of this CsvFormatAttribute. + The quote character for the CSV format. + + + :param quote_character: The quote_character of this CsvFormatAttribute. + :type: str + """ + self._quote_character = quote_character + + @property + def has_header(self): + """ + Gets the has_header of this CsvFormatAttribute. + Defines whether the file has a header row. + + + :return: The has_header of this CsvFormatAttribute. + :rtype: bool + """ + return self._has_header + + @has_header.setter + def has_header(self, has_header): + """ + Sets the has_header of this CsvFormatAttribute. + Defines whether the file has a header row. + + + :param has_header: The has_header of this CsvFormatAttribute. + :type: bool + """ + self._has_header = has_header + + @property + def is_file_pattern(self): + """ + Gets the is_file_pattern of this CsvFormatAttribute. + Defines whether a file pattern is supported. + + + :return: The is_file_pattern of this CsvFormatAttribute. + :rtype: bool + """ + return self._is_file_pattern + + @is_file_pattern.setter + def is_file_pattern(self, is_file_pattern): + """ + Sets the is_file_pattern of this CsvFormatAttribute. + Defines whether a file pattern is supported. + + + :param is_file_pattern: The is_file_pattern of this CsvFormatAttribute. + :type: bool + """ + self._is_file_pattern = is_file_pattern + + @property + def timestamp_format(self): + """ + Gets the timestamp_format of this CsvFormatAttribute. + Format for timestamp information. + + + :return: The timestamp_format of this CsvFormatAttribute. + :rtype: str + """ + return self._timestamp_format + + @timestamp_format.setter + def timestamp_format(self, timestamp_format): + """ + Sets the timestamp_format of this CsvFormatAttribute. + Format for timestamp information. + + + :param timestamp_format: The timestamp_format of this CsvFormatAttribute. + :type: str + """ + self._timestamp_format = timestamp_format + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_asset.py b/src/oci/data_connectivity/models/data_asset.py new file mode 100644 index 0000000000..cae9dd460f --- /dev/null +++ b/src/oci/data_connectivity/models/data_asset.py @@ -0,0 +1,550 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataAsset(object): + """ + Represents a data source in the Data Integration service. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataAsset object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this DataAsset. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataAsset. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this DataAsset. + :type model_type: str + + :param name: + The value to assign to the name property of this DataAsset. + :type name: str + + :param description: + The value to assign to the description property of this DataAsset. + :type description: str + + :param object_status: + The value to assign to the object_status property of this DataAsset. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this DataAsset. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this DataAsset. + :type identifier: str + + :param external_key: + The value to assign to the external_key property of this DataAsset. + :type external_key: str + + :param asset_properties: + The value to assign to the asset_properties property of this DataAsset. + :type asset_properties: dict(str, str) + + :param properties: + The value to assign to the properties property of this DataAsset. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this DataAsset. + :type type: str + + :param native_type_system: + The value to assign to the native_type_system property of this DataAsset. + :type native_type_system: oci.data_connectivity.models.TypeSystem + + :param registry_metadata: + The value to assign to the registry_metadata property of this DataAsset. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this DataAsset. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param default_connection: + The value to assign to the default_connection property of this DataAsset. + :type default_connection: oci.data_connectivity.models.Connection + + :param end_points: + The value to assign to the end_points property of this DataAsset. + :type end_points: list[oci.data_connectivity.models.DpEndpoint] + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'external_key': 'str', + 'asset_properties': 'dict(str, str)', + 'properties': 'dict(str, object)', + 'type': 'str', + 'native_type_system': 'TypeSystem', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata', + 'default_connection': 'Connection', + 'end_points': 'list[DpEndpoint]' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'external_key': 'externalKey', + 'asset_properties': 'assetProperties', + 'properties': 'properties', + 'type': 'type', + 'native_type_system': 'nativeTypeSystem', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata', + 'default_connection': 'defaultConnection', + 'end_points': 'endPoints' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._external_key = None + self._asset_properties = None + self._properties = None + self._type = None + self._native_type_system = None + self._registry_metadata = None + self._metadata = None + self._default_connection = None + self._end_points = None + + @property + def key(self): + """ + **[Required]** Gets the key of this DataAsset. + Currently not used on data asset creation. Reserved for future. + + + :return: The key of this DataAsset. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataAsset. + Currently not used on data asset creation. Reserved for future. + + + :param key: The key of this DataAsset. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataAsset. + The model version of an object. + + + :return: The model_version of this DataAsset. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataAsset. + The model version of an object. + + + :param model_version: The model_version of this DataAsset. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this DataAsset. + The type of the object. + + + :return: The model_type of this DataAsset. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DataAsset. + The type of the object. + + + :param model_type: The model_type of this DataAsset. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this DataAsset. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataAsset. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataAsset. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataAsset. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataAsset. + User-defined description of the data asset. + + + :return: The description of this DataAsset. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataAsset. + User-defined description of the data asset. + + + :param description: The description of this DataAsset. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this DataAsset. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataAsset. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataAsset. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataAsset. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this DataAsset. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataAsset. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataAsset. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataAsset. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this DataAsset. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataAsset. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataAsset. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataAsset. + :type: str + """ + self._identifier = identifier + + @property + def external_key(self): + """ + Gets the external_key of this DataAsset. + The external key for the object. + + + :return: The external_key of this DataAsset. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataAsset. + The external key for the object. + + + :param external_key: The external_key of this DataAsset. + :type: str + """ + self._external_key = external_key + + @property + def asset_properties(self): + """ + Gets the asset_properties of this DataAsset. + Additional properties for the data asset. + + + :return: The asset_properties of this DataAsset. + :rtype: dict(str, str) + """ + return self._asset_properties + + @asset_properties.setter + def asset_properties(self, asset_properties): + """ + Sets the asset_properties of this DataAsset. + Additional properties for the data asset. + + + :param asset_properties: The asset_properties of this DataAsset. + :type: dict(str, str) + """ + self._asset_properties = asset_properties + + @property + def properties(self): + """ + Gets the properties of this DataAsset. + All the properties for the data asset in a key-value map format. + + + :return: The properties of this DataAsset. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this DataAsset. + All the properties for the data asset in a key-value map format. + + + :param properties: The properties of this DataAsset. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + Gets the type of this DataAsset. + Specific DataAsset Type + + + :return: The type of this DataAsset. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this DataAsset. + Specific DataAsset Type + + + :param type: The type of this DataAsset. + :type: str + """ + self._type = type + + @property + def native_type_system(self): + """ + Gets the native_type_system of this DataAsset. + + :return: The native_type_system of this DataAsset. + :rtype: oci.data_connectivity.models.TypeSystem + """ + return self._native_type_system + + @native_type_system.setter + def native_type_system(self, native_type_system): + """ + Sets the native_type_system of this DataAsset. + + :param native_type_system: The native_type_system of this DataAsset. + :type: oci.data_connectivity.models.TypeSystem + """ + self._native_type_system = native_type_system + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this DataAsset. + + :return: The registry_metadata of this DataAsset. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this DataAsset. + + :param registry_metadata: The registry_metadata of this DataAsset. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this DataAsset. + + :return: The metadata of this DataAsset. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this DataAsset. + + :param metadata: The metadata of this DataAsset. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def default_connection(self): + """ + Gets the default_connection of this DataAsset. + + :return: The default_connection of this DataAsset. + :rtype: oci.data_connectivity.models.Connection + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this DataAsset. + + :param default_connection: The default_connection of this DataAsset. + :type: oci.data_connectivity.models.Connection + """ + self._default_connection = default_connection + + @property + def end_points(self): + """ + Gets the end_points of this DataAsset. + The list of endpoints with which this data asset is associated. + + + :return: The end_points of this DataAsset. + :rtype: list[oci.data_connectivity.models.DpEndpoint] + """ + return self._end_points + + @end_points.setter + def end_points(self, end_points): + """ + Sets the end_points of this DataAsset. + The list of endpoints with which this data asset is associated. + + + :param end_points: The end_points of this DataAsset. + :type: list[oci.data_connectivity.models.DpEndpoint] + """ + self._end_points = end_points + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_asset_summary.py b/src/oci/data_connectivity/models/data_asset_summary.py new file mode 100644 index 0000000000..3b6b1b87b6 --- /dev/null +++ b/src/oci/data_connectivity/models/data_asset_summary.py @@ -0,0 +1,550 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataAssetSummary(object): + """ + The summary object for data asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataAssetSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this DataAssetSummary. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataAssetSummary. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this DataAssetSummary. + :type model_type: str + + :param name: + The value to assign to the name property of this DataAssetSummary. + :type name: str + + :param description: + The value to assign to the description property of this DataAssetSummary. + :type description: str + + :param object_status: + The value to assign to the object_status property of this DataAssetSummary. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this DataAssetSummary. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this DataAssetSummary. + :type identifier: str + + :param external_key: + The value to assign to the external_key property of this DataAssetSummary. + :type external_key: str + + :param asset_properties: + The value to assign to the asset_properties property of this DataAssetSummary. + :type asset_properties: dict(str, str) + + :param properties: + The value to assign to the properties property of this DataAssetSummary. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this DataAssetSummary. + :type type: str + + :param native_type_system: + The value to assign to the native_type_system property of this DataAssetSummary. + :type native_type_system: oci.data_connectivity.models.TypeSystem + + :param registry_metadata: + The value to assign to the registry_metadata property of this DataAssetSummary. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this DataAssetSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param default_connection: + The value to assign to the default_connection property of this DataAssetSummary. + :type default_connection: oci.data_connectivity.models.Connection + + :param end_points: + The value to assign to the end_points property of this DataAssetSummary. + :type end_points: list[oci.data_connectivity.models.DpEndpoint] + + """ + self.swagger_types = { + 'key': 'str', + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'external_key': 'str', + 'asset_properties': 'dict(str, str)', + 'properties': 'dict(str, object)', + 'type': 'str', + 'native_type_system': 'TypeSystem', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata', + 'default_connection': 'Connection', + 'end_points': 'list[DpEndpoint]' + } + + self.attribute_map = { + 'key': 'key', + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'external_key': 'externalKey', + 'asset_properties': 'assetProperties', + 'properties': 'properties', + 'type': 'type', + 'native_type_system': 'nativeTypeSystem', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata', + 'default_connection': 'defaultConnection', + 'end_points': 'endPoints' + } + + self._key = None + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._external_key = None + self._asset_properties = None + self._properties = None + self._type = None + self._native_type_system = None + self._registry_metadata = None + self._metadata = None + self._default_connection = None + self._end_points = None + + @property + def key(self): + """ + **[Required]** Gets the key of this DataAssetSummary. + Currently not used on data asset creation. Reserved for future. + + + :return: The key of this DataAssetSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataAssetSummary. + Currently not used on data asset creation. Reserved for future. + + + :param key: The key of this DataAssetSummary. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataAssetSummary. + The model version of an object. + + + :return: The model_version of this DataAssetSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataAssetSummary. + The model version of an object. + + + :param model_version: The model_version of this DataAssetSummary. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this DataAssetSummary. + The type of the object. + + + :return: The model_type of this DataAssetSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DataAssetSummary. + The type of the object. + + + :param model_type: The model_type of this DataAssetSummary. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + **[Required]** Gets the name of this DataAssetSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataAssetSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataAssetSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataAssetSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataAssetSummary. + User-defined description of the data asset. + + + :return: The description of this DataAssetSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataAssetSummary. + User-defined description of the data asset. + + + :param description: The description of this DataAssetSummary. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this DataAssetSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataAssetSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataAssetSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataAssetSummary. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this DataAssetSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataAssetSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataAssetSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataAssetSummary. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this DataAssetSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataAssetSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataAssetSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataAssetSummary. + :type: str + """ + self._identifier = identifier + + @property + def external_key(self): + """ + Gets the external_key of this DataAssetSummary. + The external key for the object. + + + :return: The external_key of this DataAssetSummary. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataAssetSummary. + The external key for the object. + + + :param external_key: The external_key of this DataAssetSummary. + :type: str + """ + self._external_key = external_key + + @property + def asset_properties(self): + """ + Gets the asset_properties of this DataAssetSummary. + Additional properties for the data asset. + + + :return: The asset_properties of this DataAssetSummary. + :rtype: dict(str, str) + """ + return self._asset_properties + + @asset_properties.setter + def asset_properties(self, asset_properties): + """ + Sets the asset_properties of this DataAssetSummary. + Additional properties for the data asset. + + + :param asset_properties: The asset_properties of this DataAssetSummary. + :type: dict(str, str) + """ + self._asset_properties = asset_properties + + @property + def properties(self): + """ + Gets the properties of this DataAssetSummary. + All the properties for the data asset in a key-value map format. + + + :return: The properties of this DataAssetSummary. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this DataAssetSummary. + All the properties for the data asset in a key-value map format. + + + :param properties: The properties of this DataAssetSummary. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + Gets the type of this DataAssetSummary. + Specific DataAsset Type + + + :return: The type of this DataAssetSummary. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this DataAssetSummary. + Specific DataAsset Type + + + :param type: The type of this DataAssetSummary. + :type: str + """ + self._type = type + + @property + def native_type_system(self): + """ + Gets the native_type_system of this DataAssetSummary. + + :return: The native_type_system of this DataAssetSummary. + :rtype: oci.data_connectivity.models.TypeSystem + """ + return self._native_type_system + + @native_type_system.setter + def native_type_system(self, native_type_system): + """ + Sets the native_type_system of this DataAssetSummary. + + :param native_type_system: The native_type_system of this DataAssetSummary. + :type: oci.data_connectivity.models.TypeSystem + """ + self._native_type_system = native_type_system + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this DataAssetSummary. + + :return: The registry_metadata of this DataAssetSummary. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this DataAssetSummary. + + :param registry_metadata: The registry_metadata of this DataAssetSummary. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this DataAssetSummary. + + :return: The metadata of this DataAssetSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this DataAssetSummary. + + :param metadata: The metadata of this DataAssetSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def default_connection(self): + """ + Gets the default_connection of this DataAssetSummary. + + :return: The default_connection of this DataAssetSummary. + :rtype: oci.data_connectivity.models.Connection + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this DataAssetSummary. + + :param default_connection: The default_connection of this DataAssetSummary. + :type: oci.data_connectivity.models.Connection + """ + self._default_connection = default_connection + + @property + def end_points(self): + """ + Gets the end_points of this DataAssetSummary. + The list of endpoints with which this data asset is associated. + + + :return: The end_points of this DataAssetSummary. + :rtype: list[oci.data_connectivity.models.DpEndpoint] + """ + return self._end_points + + @end_points.setter + def end_points(self, end_points): + """ + Sets the end_points of this DataAssetSummary. + The list of endpoints with which this data asset is associated. + + + :param end_points: The end_points of this DataAssetSummary. + :type: list[oci.data_connectivity.models.DpEndpoint] + """ + self._end_points = end_points + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_asset_summary_collection.py b/src/oci/data_connectivity/models/data_asset_summary_collection.py new file mode 100644 index 0000000000..1d414e4088 --- /dev/null +++ b/src/oci/data_connectivity/models/data_asset_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataAssetSummaryCollection(object): + """ + This is the collection of data asset summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataAssetSummaryCollection 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 DataAssetSummaryCollection. + :type items: list[oci.data_connectivity.models.DataAssetSummary] + + """ + self.swagger_types = { + 'items': 'list[DataAssetSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DataAssetSummaryCollection. + The array of data asset summaries. + + + :return: The items of this DataAssetSummaryCollection. + :rtype: list[oci.data_connectivity.models.DataAssetSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DataAssetSummaryCollection. + The array of data asset summaries. + + + :param items: The items of this DataAssetSummaryCollection. + :type: list[oci.data_connectivity.models.DataAssetSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity.py b/src/oci/data_connectivity/models/data_entity.py new file mode 100644 index 0000000000..4003a4dc5c --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity.py @@ -0,0 +1,158 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntity(object): + """ + The data entity object. + """ + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "VIEW_ENTITY" + MODEL_TYPE_VIEW_ENTITY = "VIEW_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "TABLE_ENTITY" + MODEL_TYPE_TABLE_ENTITY = "TABLE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "FILE_ENTITY" + MODEL_TYPE_FILE_ENTITY = "FILE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "DATA_STORE_ENTITY" + MODEL_TYPE_DATA_STORE_ENTITY = "DATA_STORE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "SQL_ENTITY" + MODEL_TYPE_SQL_ENTITY = "SQL_ENTITY" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntity object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DataEntityFromTable` + * :class:`~oci.data_connectivity.models.DataEntityFromDataStore` + * :class:`~oci.data_connectivity.models.DataEntityFromView` + * :class:`~oci.data_connectivity.models.DataEntityFromSql` + * :class:`~oci.data_connectivity.models.DataEntityFromFile` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntity. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntity. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata' + } + + self._model_type = None + self._metadata = 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['modelType'] + + if type == 'TABLE_ENTITY': + return 'DataEntityFromTable' + + if type == 'DATA_STORE_ENTITY': + return 'DataEntityFromDataStore' + + if type == 'VIEW_ENTITY': + return 'DataEntityFromView' + + if type == 'SQL_ENTITY': + return 'DataEntityFromSql' + + if type == 'FILE_ENTITY': + return 'DataEntityFromFile' + else: + return 'DataEntity' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DataEntity. + The data entity type. + + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this DataEntity. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DataEntity. + The data entity type. + + + :param model_type: The model_type of this DataEntity. + :type: str + """ + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def metadata(self): + """ + Gets the metadata of this DataEntity. + + :return: The metadata of this DataEntity. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this DataEntity. + + :param metadata: The metadata of this DataEntity. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_details.py b/src/oci/data_connectivity/models/data_entity_details.py new file mode 100644 index 0000000000..e4658d948f --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_details.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityDetails(object): + """ + The data entity details object. + """ + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "VIEW_ENTITY" + MODEL_TYPE_VIEW_ENTITY = "VIEW_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "TABLE_ENTITY" + MODEL_TYPE_TABLE_ENTITY = "TABLE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "FILE_ENTITY" + MODEL_TYPE_FILE_ENTITY = "FILE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "DATA_STORE_ENTITY" + MODEL_TYPE_DATA_STORE_ENTITY = "DATA_STORE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "SQL_ENTITY" + MODEL_TYPE_SQL_ENTITY = "SQL_ENTITY" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DataEntityFromFileEntityDetails` + * :class:`~oci.data_connectivity.models.DataEntityFromViewEntityDetails` + * :class:`~oci.data_connectivity.models.DataEntityFromSqlEntityDetails` + * :class:`~oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails` + * :class:`~oci.data_connectivity.models.DataEntityFromTableEntityDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'FILE_ENTITY': + return 'DataEntityFromFileEntityDetails' + + if type == 'VIEW_ENTITY': + return 'DataEntityFromViewEntityDetails' + + if type == 'SQL_ENTITY': + return 'DataEntityFromSqlEntityDetails' + + if type == 'DATA_STORE_ENTITY': + return 'DataEntityFromDataStoreEntityDetails' + + if type == 'TABLE_ENTITY': + return 'DataEntityFromTableEntityDetails' + else: + return 'DataEntityDetails' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DataEntityDetails. + The data entity type. + + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + + + :return: The model_type of this DataEntityDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DataEntityDetails. + The data entity type. + + + :param model_type: The model_type of this DataEntityDetails. + :type: str + """ + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_data_store.py b/src/oci/data_connectivity/models/data_entity_from_data_store.py new file mode 100644 index 0000000000..f8028e3fa9 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_data_store.py @@ -0,0 +1,728 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity import DataEntity +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromDataStore(DataEntity): + """ + The view entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromDataStore object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromDataStore.model_type` attribute + of this class is ``DATA_STORE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromDataStore. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntityFromDataStore. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntityFromDataStore. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromDataStore. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromDataStore. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromDataStore. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromDataStore. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromDataStore. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromDataStore. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromDataStore. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromDataStore. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromDataStore. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromDataStore. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromDataStore. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromDataStore. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromDataStore. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromDataStore. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromDataStore. + :type identifier: str + + :param filters: + The value to assign to the filters property of this DataEntityFromDataStore. + :type filters: str + + :param is_effective_date_disabled: + The value to assign to the is_effective_date_disabled property of this DataEntityFromDataStore. + :type is_effective_date_disabled: bool + + :param is_flex_data_store: + The value to assign to the is_flex_data_store property of this DataEntityFromDataStore. + :type is_flex_data_store: bool + + :param is_silent_error: + The value to assign to the is_silent_error property of this DataEntityFromDataStore. + :type is_silent_error: bool + + :param supports_incremental: + The value to assign to the supports_incremental property of this DataEntityFromDataStore. + :type supports_incremental: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'filters': 'str', + 'is_effective_date_disabled': 'bool', + 'is_flex_data_store': 'bool', + 'is_silent_error': 'bool', + 'supports_incremental': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'filters': 'filters', + 'is_effective_date_disabled': 'isEffectiveDateDisabled', + 'is_flex_data_store': 'isFlexDataStore', + 'is_silent_error': 'isSilentError', + 'supports_incremental': 'supportsIncremental' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._filters = None + self._is_effective_date_disabled = None + self._is_flex_data_store = None + self._is_silent_error = None + self._supports_incremental = None + self._model_type = 'DATA_STORE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromDataStore. + The object key. + + + :return: The key of this DataEntityFromDataStore. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromDataStore. + The object key. + + + :param key: The key of this DataEntityFromDataStore. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromDataStore. + The object's model version. + + + :return: The model_version of this DataEntityFromDataStore. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromDataStore. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromDataStore. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromDataStore. + + :return: The parent_ref of this DataEntityFromDataStore. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromDataStore. + + :param parent_ref: The parent_ref of this DataEntityFromDataStore. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromDataStore. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromDataStore. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromDataStore. + Detailed description for the object. + + + :return: The description of this DataEntityFromDataStore. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromDataStore. + Detailed description for the object. + + + :param description: The description of this DataEntityFromDataStore. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromDataStore. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromDataStore. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromDataStore. + The external key for the object + + + :return: The external_key of this DataEntityFromDataStore. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromDataStore. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromDataStore. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromDataStore. + + :return: The shape of this DataEntityFromDataStore. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromDataStore. + + :param shape: The shape of this DataEntityFromDataStore. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromDataStore. + The shape ID. + + + :return: The shape_id of this DataEntityFromDataStore. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromDataStore. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromDataStore. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromDataStore. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntityFromDataStore. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromDataStore. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromDataStore. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromDataStore. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromDataStore. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromDataStore. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromDataStore. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromDataStore. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromDataStore. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromDataStore. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromDataStore. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromDataStore. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromDataStore. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromDataStore. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromDataStore. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromDataStore. + The resource name. + + + :return: The resource_name of this DataEntityFromDataStore. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromDataStore. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromDataStore. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromDataStore. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromDataStore. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromDataStore. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromDataStore. + :type: str + """ + self._identifier = identifier + + @property + def filters(self): + """ + Gets the filters of this DataEntityFromDataStore. + Filters present in the Datastore. It can be Null. + + + :return: The filters of this DataEntityFromDataStore. + :rtype: str + """ + return self._filters + + @filters.setter + def filters(self, filters): + """ + Sets the filters of this DataEntityFromDataStore. + Filters present in the Datastore. It can be Null. + + + :param filters: The filters of this DataEntityFromDataStore. + :type: str + """ + self._filters = filters + + @property + def is_effective_date_disabled(self): + """ + Gets the is_effective_date_disabled of this DataEntityFromDataStore. + It shows whether or not effective date is disabled + + + :return: The is_effective_date_disabled of this DataEntityFromDataStore. + :rtype: bool + """ + return self._is_effective_date_disabled + + @is_effective_date_disabled.setter + def is_effective_date_disabled(self, is_effective_date_disabled): + """ + Sets the is_effective_date_disabled of this DataEntityFromDataStore. + It shows whether or not effective date is disabled + + + :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntityFromDataStore. + :type: bool + """ + self._is_effective_date_disabled = is_effective_date_disabled + + @property + def is_flex_data_store(self): + """ + Gets the is_flex_data_store of this DataEntityFromDataStore. + It shows whether the datastore is of flex type + + + :return: The is_flex_data_store of this DataEntityFromDataStore. + :rtype: bool + """ + return self._is_flex_data_store + + @is_flex_data_store.setter + def is_flex_data_store(self, is_flex_data_store): + """ + Sets the is_flex_data_store of this DataEntityFromDataStore. + It shows whether the datastore is of flex type + + + :param is_flex_data_store: The is_flex_data_store of this DataEntityFromDataStore. + :type: bool + """ + self._is_flex_data_store = is_flex_data_store + + @property + def is_silent_error(self): + """ + Gets the is_silent_error of this DataEntityFromDataStore. + It shows whether the extraction of this datastore will stop on error + + + :return: The is_silent_error of this DataEntityFromDataStore. + :rtype: bool + """ + return self._is_silent_error + + @is_silent_error.setter + def is_silent_error(self, is_silent_error): + """ + Sets the is_silent_error of this DataEntityFromDataStore. + It shows whether the extraction of this datastore will stop on error + + + :param is_silent_error: The is_silent_error of this DataEntityFromDataStore. + :type: bool + """ + self._is_silent_error = is_silent_error + + @property + def supports_incremental(self): + """ + Gets the supports_incremental of this DataEntityFromDataStore. + It shows whether the datastore supports Incremental Extract or not. + + + :return: The supports_incremental of this DataEntityFromDataStore. + :rtype: bool + """ + return self._supports_incremental + + @supports_incremental.setter + def supports_incremental(self, supports_incremental): + """ + Sets the supports_incremental of this DataEntityFromDataStore. + It shows whether the datastore supports Incremental Extract or not. + + + :param supports_incremental: The supports_incremental of this DataEntityFromDataStore. + :type: bool + """ + self._supports_incremental = supports_incremental + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_data_store_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_data_store_entity_details.py new file mode 100644 index 0000000000..bcafafd71c --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_data_store_entity_details.py @@ -0,0 +1,721 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_details import DataEntityDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromDataStoreEntityDetails(DataEntityDetails): + """ + The data store entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromDataStoreEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails.model_type` attribute + of this class is ``DATA_STORE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromDataStoreEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromDataStoreEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromDataStoreEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromDataStoreEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromDataStoreEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromDataStoreEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromDataStoreEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromDataStoreEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromDataStoreEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromDataStoreEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromDataStoreEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromDataStoreEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromDataStoreEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromDataStoreEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromDataStoreEntityDetails. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromDataStoreEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromDataStoreEntityDetails. + :type identifier: str + + :param filters: + The value to assign to the filters property of this DataEntityFromDataStoreEntityDetails. + :type filters: str + + :param is_effective_date_disabled: + The value to assign to the is_effective_date_disabled property of this DataEntityFromDataStoreEntityDetails. + :type is_effective_date_disabled: bool + + :param is_flex_data_store: + The value to assign to the is_flex_data_store property of this DataEntityFromDataStoreEntityDetails. + :type is_flex_data_store: bool + + :param is_silent_error: + The value to assign to the is_silent_error property of this DataEntityFromDataStoreEntityDetails. + :type is_silent_error: bool + + :param supports_incremental: + The value to assign to the supports_incremental property of this DataEntityFromDataStoreEntityDetails. + :type supports_incremental: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'filters': 'str', + 'is_effective_date_disabled': 'bool', + 'is_flex_data_store': 'bool', + 'is_silent_error': 'bool', + 'supports_incremental': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'filters': 'filters', + 'is_effective_date_disabled': 'isEffectiveDateDisabled', + 'is_flex_data_store': 'isFlexDataStore', + 'is_silent_error': 'isSilentError', + 'supports_incremental': 'supportsIncremental' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._filters = None + self._is_effective_date_disabled = None + self._is_flex_data_store = None + self._is_silent_error = None + self._supports_incremental = None + self._model_type = 'DATA_STORE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromDataStoreEntityDetails. + The object key. + + + :return: The key of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromDataStoreEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromDataStoreEntityDetails. + The object's model version. + + + :return: The model_version of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromDataStoreEntityDetails. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromDataStoreEntityDetails. + + :return: The parent_ref of this DataEntityFromDataStoreEntityDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromDataStoreEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromDataStoreEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromDataStoreEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromDataStoreEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromDataStoreEntityDetails. + Detailed description for the object. + + + :return: The description of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromDataStoreEntityDetails. + Detailed description for the object. + + + :param description: The description of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromDataStoreEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromDataStoreEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromDataStoreEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromDataStoreEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromDataStoreEntityDetails. + The external key for the object + + + :return: The external_key of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromDataStoreEntityDetails. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromDataStoreEntityDetails. + + :return: The shape of this DataEntityFromDataStoreEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromDataStoreEntityDetails. + + :param shape: The shape of this DataEntityFromDataStoreEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromDataStoreEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromDataStoreEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromDataStoreEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + + + :return: The entity_type of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromDataStoreEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromDataStoreEntityDetails. + Specifies other type labels. + + + :return: The other_type_label of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromDataStoreEntityDetails. + Specifies other type labels. + + + :param other_type_label: The other_type_label of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromDataStoreEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromDataStoreEntityDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromDataStoreEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromDataStoreEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromDataStoreEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromDataStoreEntityDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromDataStoreEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromDataStoreEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromDataStoreEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromDataStoreEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromDataStoreEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromDataStoreEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromDataStoreEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromDataStoreEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromDataStoreEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromDataStoreEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._identifier = identifier + + @property + def filters(self): + """ + Gets the filters of this DataEntityFromDataStoreEntityDetails. + Filters present in the Datastore. It can be Null. + + + :return: The filters of this DataEntityFromDataStoreEntityDetails. + :rtype: str + """ + return self._filters + + @filters.setter + def filters(self, filters): + """ + Sets the filters of this DataEntityFromDataStoreEntityDetails. + Filters present in the Datastore. It can be Null. + + + :param filters: The filters of this DataEntityFromDataStoreEntityDetails. + :type: str + """ + self._filters = filters + + @property + def is_effective_date_disabled(self): + """ + Gets the is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. + It shows whether or not effective date is disabled + + + :return: The is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. + :rtype: bool + """ + return self._is_effective_date_disabled + + @is_effective_date_disabled.setter + def is_effective_date_disabled(self, is_effective_date_disabled): + """ + Sets the is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. + It shows whether or not effective date is disabled + + + :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. + :type: bool + """ + self._is_effective_date_disabled = is_effective_date_disabled + + @property + def is_flex_data_store(self): + """ + Gets the is_flex_data_store of this DataEntityFromDataStoreEntityDetails. + It shows whether the datastore is of flex type + + + :return: The is_flex_data_store of this DataEntityFromDataStoreEntityDetails. + :rtype: bool + """ + return self._is_flex_data_store + + @is_flex_data_store.setter + def is_flex_data_store(self, is_flex_data_store): + """ + Sets the is_flex_data_store of this DataEntityFromDataStoreEntityDetails. + It shows whether the datastore is of flex type + + + :param is_flex_data_store: The is_flex_data_store of this DataEntityFromDataStoreEntityDetails. + :type: bool + """ + self._is_flex_data_store = is_flex_data_store + + @property + def is_silent_error(self): + """ + Gets the is_silent_error of this DataEntityFromDataStoreEntityDetails. + It shows whether the extraction of this datastore will stop on error + + + :return: The is_silent_error of this DataEntityFromDataStoreEntityDetails. + :rtype: bool + """ + return self._is_silent_error + + @is_silent_error.setter + def is_silent_error(self, is_silent_error): + """ + Sets the is_silent_error of this DataEntityFromDataStoreEntityDetails. + It shows whether the extraction of this datastore will stop on error + + + :param is_silent_error: The is_silent_error of this DataEntityFromDataStoreEntityDetails. + :type: bool + """ + self._is_silent_error = is_silent_error + + @property + def supports_incremental(self): + """ + Gets the supports_incremental of this DataEntityFromDataStoreEntityDetails. + It shows whether the datastore supports Incremental Extract or not. + + + :return: The supports_incremental of this DataEntityFromDataStoreEntityDetails. + :rtype: bool + """ + return self._supports_incremental + + @supports_incremental.setter + def supports_incremental(self, supports_incremental): + """ + Sets the supports_incremental of this DataEntityFromDataStoreEntityDetails. + It shows whether the datastore supports Incremental Extract or not. + + + :param supports_incremental: The supports_incremental of this DataEntityFromDataStoreEntityDetails. + :type: bool + """ + self._supports_incremental = supports_incremental + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_file.py b/src/oci/data_connectivity/models/data_entity_from_file.py new file mode 100644 index 0000000000..46d7379268 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_file.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity import DataEntity +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromFile(DataEntity): + """ + The file data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromFile object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromFile.model_type` attribute + of this class is ``FILE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromFile. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntityFromFile. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntityFromFile. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromFile. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromFile. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromFile. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromFile. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromFile. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromFile. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromFile. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromFile. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromFile. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromFile. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromFile. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromFile. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromFile. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this DataEntityFromFile. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this DataEntityFromFile. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromFile. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'FILE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromFile. + The object key. + + + :return: The key of this DataEntityFromFile. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromFile. + The object key. + + + :param key: The key of this DataEntityFromFile. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromFile. + The object's model version. + + + :return: The model_version of this DataEntityFromFile. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromFile. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromFile. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromFile. + + :return: The parent_ref of this DataEntityFromFile. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromFile. + + :param parent_ref: The parent_ref of this DataEntityFromFile. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromFile. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromFile. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromFile. + Detailed description for the object. + + + :return: The description of this DataEntityFromFile. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromFile. + Detailed description for the object. + + + :param description: The description of this DataEntityFromFile. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromFile. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromFile. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromFile. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromFile. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromFile. + The external key for the object. + + + :return: The external_key of this DataEntityFromFile. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromFile. + The external key for the object. + + + :param external_key: The external_key of this DataEntityFromFile. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromFile. + + :return: The shape of this DataEntityFromFile. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromFile. + + :param shape: The shape of this DataEntityFromFile. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromFile. + The shape ID. + + + :return: The shape_id of this DataEntityFromFile. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromFile. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromFile. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromFile. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntityFromFile. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromFile. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromFile. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromFile. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromFile. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromFile. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromFile. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromFile. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromFile. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromFile. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromFile. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromFile. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromFile. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromFile. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromFile. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromFile. + The resource name. + + + :return: The resource_name of this DataEntityFromFile. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromFile. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromFile. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this DataEntityFromFile. + + :return: The data_format of this DataEntityFromFile. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this DataEntityFromFile. + + :param data_format: The data_format of this DataEntityFromFile. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromFile. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromFile. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromFile. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromFile. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromFile. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromFile. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_file_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_file_entity_details.py new file mode 100644 index 0000000000..b1ea92bd55 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_file_entity_details.py @@ -0,0 +1,593 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_details import DataEntityDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromFileEntityDetails(DataEntityDetails): + """ + The file data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromFileEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromFileEntityDetails.model_type` attribute + of this class is ``FILE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromFileEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromFileEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromFileEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromFileEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromFileEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromFileEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromFileEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromFileEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromFileEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromFileEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromFileEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromFileEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromFileEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromFileEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromFileEntityDetails. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this DataEntityFromFileEntityDetails. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this DataEntityFromFileEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromFileEntityDetails. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'FILE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromFileEntityDetails. + The object key. + + + :return: The key of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromFileEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromFileEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromFileEntityDetails. + The object's model version. + + + :return: The model_version of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromFileEntityDetails. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromFileEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromFileEntityDetails. + + :return: The parent_ref of this DataEntityFromFileEntityDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromFileEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromFileEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromFileEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromFileEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromFileEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromFileEntityDetails. + Detailed description for the object. + + + :return: The description of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromFileEntityDetails. + Detailed description for the object. + + + :param description: The description of this DataEntityFromFileEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromFileEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromFileEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromFileEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromFileEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromFileEntityDetails. + The external key for the object. + + + :return: The external_key of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromFileEntityDetails. + The external key for the object. + + + :param external_key: The external_key of this DataEntityFromFileEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromFileEntityDetails. + + :return: The shape of this DataEntityFromFileEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromFileEntityDetails. + + :param shape: The shape of this DataEntityFromFileEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromFileEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromFileEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromFileEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromFileEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + + + :return: The entity_type of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromFileEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromFileEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromFileEntityDetails. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromFileEntityDetails. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromFileEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromFileEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromFileEntityDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromFileEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromFileEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromFileEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromFileEntityDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromFileEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromFileEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromFileEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromFileEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromFileEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this DataEntityFromFileEntityDetails. + + :return: The data_format of this DataEntityFromFileEntityDetails. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this DataEntityFromFileEntityDetails. + + :param data_format: The data_format of this DataEntityFromFileEntityDetails. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromFileEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromFileEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromFileEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromFileEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromFileEntityDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromFileEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromFileEntityDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromFileEntityDetails. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_sql.py b/src/oci/data_connectivity/models/data_entity_from_sql.py new file mode 100644 index 0000000000..ac581afaa5 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_sql.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity import DataEntity +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromSql(DataEntity): + """ + The sql entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromSql object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromSql.model_type` attribute + of this class is ``SQL_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromSql. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntityFromSql. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntityFromSql. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromSql. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromSql. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromSql. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromSql. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromSql. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromSql. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromSql. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromSql. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromSql. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromSql. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromSql. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromSql. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromSql. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromSql. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromSql. + :type identifier: str + + :param sql_query: + The value to assign to the sql_query property of this DataEntityFromSql. + :type sql_query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'sql_query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'sql_query': 'sqlQuery' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._sql_query = None + self._model_type = 'SQL_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromSql. + The object key. + + + :return: The key of this DataEntityFromSql. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromSql. + The object key. + + + :param key: The key of this DataEntityFromSql. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromSql. + The object's model version. + + + :return: The model_version of this DataEntityFromSql. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromSql. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromSql. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromSql. + + :return: The parent_ref of this DataEntityFromSql. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromSql. + + :param parent_ref: The parent_ref of this DataEntityFromSql. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromSql. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromSql. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromSql. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromSql. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromSql. + Detailed description for the object. + + + :return: The description of this DataEntityFromSql. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromSql. + Detailed description for the object. + + + :param description: The description of this DataEntityFromSql. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromSql. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromSql. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromSql. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromSql. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromSql. + The external key for the object + + + :return: The external_key of this DataEntityFromSql. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromSql. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromSql. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromSql. + + :return: The shape of this DataEntityFromSql. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromSql. + + :param shape: The shape of this DataEntityFromSql. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromSql. + The shape ID. + + + :return: The shape_id of this DataEntityFromSql. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromSql. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromSql. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromSql. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntityFromSql. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromSql. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromSql. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromSql. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromSql. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromSql. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromSql. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromSql. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromSql. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromSql. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromSql. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromSql. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromSql. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromSql. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromSql. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromSql. + The resource name. + + + :return: The resource_name of this DataEntityFromSql. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromSql. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromSql. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromSql. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromSql. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromSql. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromSql. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromSql. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromSql. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromSql. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromSql. + :type: str + """ + self._identifier = identifier + + @property + def sql_query(self): + """ + Gets the sql_query of this DataEntityFromSql. + sqlQuery + + + :return: The sql_query of this DataEntityFromSql. + :rtype: str + """ + return self._sql_query + + @sql_query.setter + def sql_query(self, sql_query): + """ + Sets the sql_query of this DataEntityFromSql. + sqlQuery + + + :param sql_query: The sql_query of this DataEntityFromSql. + :type: str + """ + self._sql_query = sql_query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_sql_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_sql_entity_details.py new file mode 100644 index 0000000000..aa0b85824f --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_sql_entity_details.py @@ -0,0 +1,593 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_details import DataEntityDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromSqlEntityDetails(DataEntityDetails): + """ + The sql entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromSqlEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromSqlEntityDetails.model_type` attribute + of this class is ``SQL_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromSqlEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromSqlEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromSqlEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromSqlEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromSqlEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromSqlEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromSqlEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromSqlEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromSqlEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromSqlEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromSqlEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromSqlEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromSqlEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromSqlEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromSqlEntityDetails. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromSqlEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromSqlEntityDetails. + :type identifier: str + + :param sql_query: + The value to assign to the sql_query property of this DataEntityFromSqlEntityDetails. + :type sql_query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'sql_query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'sql_query': 'sqlQuery' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._sql_query = None + self._model_type = 'SQL_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromSqlEntityDetails. + The object key. + + + :return: The key of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromSqlEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromSqlEntityDetails. + The object's model version. + + + :return: The model_version of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromSqlEntityDetails. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromSqlEntityDetails. + + :return: The parent_ref of this DataEntityFromSqlEntityDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromSqlEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromSqlEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromSqlEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromSqlEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromSqlEntityDetails. + Detailed description for the object. + + + :return: The description of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromSqlEntityDetails. + Detailed description for the object. + + + :param description: The description of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromSqlEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromSqlEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromSqlEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromSqlEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromSqlEntityDetails. + The external key for the object + + + :return: The external_key of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromSqlEntityDetails. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromSqlEntityDetails. + + :return: The shape of this DataEntityFromSqlEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromSqlEntityDetails. + + :param shape: The shape of this DataEntityFromSqlEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromSqlEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromSqlEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromSqlEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + + + :return: The entity_type of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromSqlEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromSqlEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromSqlEntityDetails. + Specifies other type labels. + + + :return: The other_type_label of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromSqlEntityDetails. + Specifies other type labels. + + + :param other_type_label: The other_type_label of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromSqlEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromSqlEntityDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromSqlEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromSqlEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromSqlEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromSqlEntityDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromSqlEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromSqlEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromSqlEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromSqlEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromSqlEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromSqlEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromSqlEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromSqlEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromSqlEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromSqlEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._identifier = identifier + + @property + def sql_query(self): + """ + Gets the sql_query of this DataEntityFromSqlEntityDetails. + sqlQuery + + + :return: The sql_query of this DataEntityFromSqlEntityDetails. + :rtype: str + """ + return self._sql_query + + @sql_query.setter + def sql_query(self, sql_query): + """ + Sets the sql_query of this DataEntityFromSqlEntityDetails. + sqlQuery + + + :param sql_query: The sql_query of this DataEntityFromSqlEntityDetails. + :type: str + """ + self._sql_query = sql_query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_table.py b/src/oci/data_connectivity/models/data_entity_from_table.py new file mode 100644 index 0000000000..214203228f --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_table.py @@ -0,0 +1,573 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity import DataEntity +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromTable(DataEntity): + """ + The table entity data entity. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromTable object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromTable.model_type` attribute + of this class is ``TABLE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromTable. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntityFromTable. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntityFromTable. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromTable. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromTable. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromTable. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromTable. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromTable. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromTable. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromTable. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromTable. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromTable. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromTable. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromTable. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromTable. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromTable. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromTable. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromTable. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'TABLE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromTable. + The object key. + + + :return: The key of this DataEntityFromTable. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromTable. + The object key. + + + :param key: The key of this DataEntityFromTable. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromTable. + The object's model version. + + + :return: The model_version of this DataEntityFromTable. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromTable. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromTable. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromTable. + + :return: The parent_ref of this DataEntityFromTable. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromTable. + + :param parent_ref: The parent_ref of this DataEntityFromTable. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromTable. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromTable. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromTable. + Detailed description for the object. + + + :return: The description of this DataEntityFromTable. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromTable. + Detailed description for the object. + + + :param description: The description of this DataEntityFromTable. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromTable. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromTable. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromTable. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromTable. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromTable. + The external key for the object. + + + :return: The external_key of this DataEntityFromTable. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromTable. + The external key for the object. + + + :param external_key: The external_key of this DataEntityFromTable. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromTable. + + :return: The shape of this DataEntityFromTable. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromTable. + + :param shape: The shape of this DataEntityFromTable. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromTable. + The shape ID. + + + :return: The shape_id of this DataEntityFromTable. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromTable. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromTable. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromTable. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntityFromTable. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromTable. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromTable. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromTable. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromTable. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromTable. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromTable. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromTable. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromTable. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromTable. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromTable. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromTable. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromTable. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromTable. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromTable. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromTable. + The resource name. + + + :return: The resource_name of this DataEntityFromTable. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromTable. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromTable. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromTable. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromTable. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromTable. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromTable. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromTable. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromTable. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_table_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_table_entity_details.py new file mode 100644 index 0000000000..b54ea018d0 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_table_entity_details.py @@ -0,0 +1,566 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_details import DataEntityDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromTableEntityDetails(DataEntityDetails): + """ + The table entity data entity. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromTableEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromTableEntityDetails.model_type` attribute + of this class is ``TABLE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromTableEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromTableEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromTableEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromTableEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromTableEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromTableEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromTableEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromTableEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromTableEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromTableEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromTableEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromTableEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromTableEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromTableEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromTableEntityDetails. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromTableEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromTableEntityDetails. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'TABLE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromTableEntityDetails. + The object key. + + + :return: The key of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromTableEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromTableEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromTableEntityDetails. + The object's model version. + + + :return: The model_version of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromTableEntityDetails. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromTableEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromTableEntityDetails. + + :return: The parent_ref of this DataEntityFromTableEntityDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromTableEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromTableEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromTableEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromTableEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromTableEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromTableEntityDetails. + Detailed description for the object. + + + :return: The description of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromTableEntityDetails. + Detailed description for the object. + + + :param description: The description of this DataEntityFromTableEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromTableEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromTableEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromTableEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromTableEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromTableEntityDetails. + The external key for the object. + + + :return: The external_key of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromTableEntityDetails. + The external key for the object. + + + :param external_key: The external_key of this DataEntityFromTableEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromTableEntityDetails. + + :return: The shape of this DataEntityFromTableEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromTableEntityDetails. + + :param shape: The shape of this DataEntityFromTableEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromTableEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromTableEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromTableEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromTableEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + + + :return: The entity_type of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromTableEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromTableEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromTableEntityDetails. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromTableEntityDetails. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromTableEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromTableEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromTableEntityDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromTableEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromTableEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromTableEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromTableEntityDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromTableEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromTableEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromTableEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromTableEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromTableEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromTableEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromTableEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromTableEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromTableEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromTableEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromTableEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromTableEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromTableEntityDetails. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_view.py b/src/oci/data_connectivity/models/data_entity_from_view.py new file mode 100644 index 0000000000..81c0ed68a3 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_view.py @@ -0,0 +1,573 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity import DataEntity +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromView(DataEntity): + """ + The view entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromView object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromView.model_type` attribute + of this class is ``VIEW_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromView. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntityFromView. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntityFromView. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromView. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromView. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromView. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromView. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromView. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromView. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromView. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromView. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromView. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromView. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromView. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromView. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromView. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromView. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromView. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'VIEW_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromView. + The object key. + + + :return: The key of this DataEntityFromView. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromView. + The object key. + + + :param key: The key of this DataEntityFromView. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromView. + The object's model version. + + + :return: The model_version of this DataEntityFromView. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromView. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromView. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromView. + + :return: The parent_ref of this DataEntityFromView. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromView. + + :param parent_ref: The parent_ref of this DataEntityFromView. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromView. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromView. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromView. + Detailed description for the object. + + + :return: The description of this DataEntityFromView. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromView. + Detailed description for the object. + + + :param description: The description of this DataEntityFromView. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromView. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromView. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromView. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromView. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromView. + The external key for the object + + + :return: The external_key of this DataEntityFromView. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromView. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromView. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromView. + + :return: The shape of this DataEntityFromView. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromView. + + :param shape: The shape of this DataEntityFromView. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromView. + The shape ID. + + + :return: The shape_id of this DataEntityFromView. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromView. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromView. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromView. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntityFromView. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromView. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromView. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromView. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromView. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromView. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromView. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromView. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromView. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromView. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromView. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromView. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromView. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromView. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromView. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromView. + The resource name. + + + :return: The resource_name of this DataEntityFromView. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromView. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromView. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromView. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromView. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromView. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromView. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_from_view_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_view_entity_details.py new file mode 100644 index 0000000000..623d96e839 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_view_entity_details.py @@ -0,0 +1,566 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_details import DataEntityDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntityFromViewEntityDetails(DataEntityDetails): + """ + The view entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromViewEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromViewEntityDetails.model_type` attribute + of this class is ``VIEW_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntityFromViewEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromViewEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromViewEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromViewEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromViewEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromViewEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromViewEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromViewEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromViewEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromViewEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromViewEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromViewEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromViewEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromViewEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromViewEntityDetails. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntityFromViewEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromViewEntityDetails. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'VIEW_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromViewEntityDetails. + The object key. + + + :return: The key of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromViewEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromViewEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromViewEntityDetails. + The object's model version. + + + :return: The model_version of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromViewEntityDetails. + The object's model version. + + + :param model_version: The model_version of this DataEntityFromViewEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromViewEntityDetails. + + :return: The parent_ref of this DataEntityFromViewEntityDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntityFromViewEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromViewEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntityFromViewEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromViewEntityDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromViewEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromViewEntityDetails. + Detailed description for the object. + + + :return: The description of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromViewEntityDetails. + Detailed description for the object. + + + :param description: The description of this DataEntityFromViewEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromViewEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromViewEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromViewEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromViewEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromViewEntityDetails. + The external key for the object + + + :return: The external_key of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromViewEntityDetails. + The external key for the object + + + :param external_key: The external_key of this DataEntityFromViewEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromViewEntityDetails. + + :return: The shape of this DataEntityFromViewEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromViewEntityDetails. + + :param shape: The shape of this DataEntityFromViewEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromViewEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromViewEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromViewEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromViewEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE" + + + :return: The entity_type of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromViewEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromViewEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + raise ValueError( + "Invalid value for `entity_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntityFromViewEntityDetails. + Specifies other type labels. + + + :return: The other_type_label of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntityFromViewEntityDetails. + Specifies other type labels. + + + :param other_type_label: The other_type_label of this DataEntityFromViewEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromViewEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromViewEntityDetails. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntityFromViewEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromViewEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromViewEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromViewEntityDetails. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntityFromViewEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromViewEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntityFromViewEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromViewEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromViewEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromViewEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntityFromViewEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromViewEntityDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntityFromViewEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromViewEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromViewEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromViewEntityDetails. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromViewEntityDetails. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary.py b/src/oci/data_connectivity/models/data_entity_summary.py new file mode 100644 index 0000000000..3dc55f7287 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary.py @@ -0,0 +1,158 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummary(object): + """ + The data entity summary object. + """ + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "VIEW_ENTITY" + MODEL_TYPE_VIEW_ENTITY = "VIEW_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "TABLE_ENTITY" + MODEL_TYPE_TABLE_ENTITY = "TABLE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "FILE_ENTITY" + MODEL_TYPE_FILE_ENTITY = "FILE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "DATA_STORE_ENTITY" + MODEL_TYPE_DATA_STORE_ENTITY = "DATA_STORE_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "SQL_ENTITY" + MODEL_TYPE_SQL_ENTITY = "SQL_ENTITY" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DataEntitySummaryFromFile` + * :class:`~oci.data_connectivity.models.DataEntitySummaryFromTable` + * :class:`~oci.data_connectivity.models.DataEntitySummaryFromDataStore` + * :class:`~oci.data_connectivity.models.DataEntitySummaryFromSql` + * :class:`~oci.data_connectivity.models.DataEntitySummaryFromView` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummary. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata' + } + + self._model_type = None + self._metadata = 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['modelType'] + + if type == 'FILE_ENTITY': + return 'DataEntitySummaryFromFile' + + if type == 'TABLE_ENTITY': + return 'DataEntitySummaryFromTable' + + if type == 'DATA_STORE_ENTITY': + return 'DataEntitySummaryFromDataStore' + + if type == 'SQL_ENTITY': + return 'DataEntitySummaryFromSql' + + if type == 'VIEW_ENTITY': + return 'DataEntitySummaryFromView' + else: + return 'DataEntitySummary' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DataEntitySummary. + The data entity type. + + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this DataEntitySummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DataEntitySummary. + The data entity type. + + + :param model_type: The model_type of this DataEntitySummary. + :type: str + """ + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def metadata(self): + """ + Gets the metadata of this DataEntitySummary. + + :return: The metadata of this DataEntitySummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this DataEntitySummary. + + :param metadata: The metadata of this DataEntitySummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_collection.py b/src/oci/data_connectivity/models/data_entity_summary_collection.py new file mode 100644 index 0000000000..d212b9ba24 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryCollection(object): + """ + This is the collection of data entity summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryCollection 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 DataEntitySummaryCollection. + :type items: list[oci.data_connectivity.models.DataEntitySummary] + + """ + self.swagger_types = { + 'items': 'list[DataEntitySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DataEntitySummaryCollection. + The array of data entity summaries. + + + :return: The items of this DataEntitySummaryCollection. + :rtype: list[oci.data_connectivity.models.DataEntitySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DataEntitySummaryCollection. + The array of data entity summaries. + + + :param items: The items of this DataEntitySummaryCollection. + :type: list[oci.data_connectivity.models.DataEntitySummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_from_data_store.py b/src/oci/data_connectivity/models/data_entity_summary_from_data_store.py new file mode 100644 index 0000000000..a0da1fd3ec --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_from_data_store.py @@ -0,0 +1,728 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_summary import DataEntitySummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryFromDataStore(DataEntitySummary): + """ + The view entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryFromDataStore object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntitySummaryFromDataStore.model_type` attribute + of this class is ``DATA_STORE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummaryFromDataStore. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummaryFromDataStore. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntitySummaryFromDataStore. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntitySummaryFromDataStore. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntitySummaryFromDataStore. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntitySummaryFromDataStore. + :type name: str + + :param description: + The value to assign to the description property of this DataEntitySummaryFromDataStore. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntitySummaryFromDataStore. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntitySummaryFromDataStore. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntitySummaryFromDataStore. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntitySummaryFromDataStore. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntitySummaryFromDataStore. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntitySummaryFromDataStore. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntitySummaryFromDataStore. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntitySummaryFromDataStore. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntitySummaryFromDataStore. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntitySummaryFromDataStore. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntitySummaryFromDataStore. + :type identifier: str + + :param filters: + The value to assign to the filters property of this DataEntitySummaryFromDataStore. + :type filters: str + + :param is_effective_date_disabled: + The value to assign to the is_effective_date_disabled property of this DataEntitySummaryFromDataStore. + :type is_effective_date_disabled: bool + + :param is_flex_data_store: + The value to assign to the is_flex_data_store property of this DataEntitySummaryFromDataStore. + :type is_flex_data_store: bool + + :param is_silent_error: + The value to assign to the is_silent_error property of this DataEntitySummaryFromDataStore. + :type is_silent_error: bool + + :param supports_incremental: + The value to assign to the supports_incremental property of this DataEntitySummaryFromDataStore. + :type supports_incremental: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'filters': 'str', + 'is_effective_date_disabled': 'bool', + 'is_flex_data_store': 'bool', + 'is_silent_error': 'bool', + 'supports_incremental': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'filters': 'filters', + 'is_effective_date_disabled': 'isEffectiveDateDisabled', + 'is_flex_data_store': 'isFlexDataStore', + 'is_silent_error': 'isSilentError', + 'supports_incremental': 'supportsIncremental' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._filters = None + self._is_effective_date_disabled = None + self._is_flex_data_store = None + self._is_silent_error = None + self._supports_incremental = None + self._model_type = 'DATA_STORE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntitySummaryFromDataStore. + The object key. + + + :return: The key of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntitySummaryFromDataStore. + The object key. + + + :param key: The key of this DataEntitySummaryFromDataStore. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntitySummaryFromDataStore. + The object's model version. + + + :return: The model_version of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntitySummaryFromDataStore. + The object's model version. + + + :param model_version: The model_version of this DataEntitySummaryFromDataStore. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntitySummaryFromDataStore. + + :return: The parent_ref of this DataEntitySummaryFromDataStore. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntitySummaryFromDataStore. + + :param parent_ref: The parent_ref of this DataEntitySummaryFromDataStore. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntitySummaryFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntitySummaryFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntitySummaryFromDataStore. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntitySummaryFromDataStore. + Detailed description for the object. + + + :return: The description of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntitySummaryFromDataStore. + Detailed description for the object. + + + :param description: The description of this DataEntitySummaryFromDataStore. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntitySummaryFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntitySummaryFromDataStore. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntitySummaryFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntitySummaryFromDataStore. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntitySummaryFromDataStore. + The external key for the object + + + :return: The external_key of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntitySummaryFromDataStore. + The external key for the object + + + :param external_key: The external_key of this DataEntitySummaryFromDataStore. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntitySummaryFromDataStore. + + :return: The shape of this DataEntitySummaryFromDataStore. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntitySummaryFromDataStore. + + :param shape: The shape of this DataEntitySummaryFromDataStore. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntitySummaryFromDataStore. + The shape ID. + + + :return: The shape_id of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntitySummaryFromDataStore. + The shape ID. + + + :param shape_id: The shape_id of this DataEntitySummaryFromDataStore. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntitySummaryFromDataStore. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntitySummaryFromDataStore. + The entity type. + + + :param entity_type: The entity_type of this DataEntitySummaryFromDataStore. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntitySummaryFromDataStore. + Specifies other type label. + + + :return: The other_type_label of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntitySummaryFromDataStore. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntitySummaryFromDataStore. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntitySummaryFromDataStore. + An array of unique keys. + + + :return: The unique_keys of this DataEntitySummaryFromDataStore. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntitySummaryFromDataStore. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntitySummaryFromDataStore. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntitySummaryFromDataStore. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntitySummaryFromDataStore. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntitySummaryFromDataStore. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntitySummaryFromDataStore. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntitySummaryFromDataStore. + The resource name. + + + :return: The resource_name of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntitySummaryFromDataStore. + The resource name. + + + :param resource_name: The resource_name of this DataEntitySummaryFromDataStore. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntitySummaryFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntitySummaryFromDataStore. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntitySummaryFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntitySummaryFromDataStore. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntitySummaryFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntitySummaryFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntitySummaryFromDataStore. + :type: str + """ + self._identifier = identifier + + @property + def filters(self): + """ + Gets the filters of this DataEntitySummaryFromDataStore. + Query filter for the extract. It can be Null. + + + :return: The filters of this DataEntitySummaryFromDataStore. + :rtype: str + """ + return self._filters + + @filters.setter + def filters(self, filters): + """ + Sets the filters of this DataEntitySummaryFromDataStore. + Query filter for the extract. It can be Null. + + + :param filters: The filters of this DataEntitySummaryFromDataStore. + :type: str + """ + self._filters = filters + + @property + def is_effective_date_disabled(self): + """ + Gets the is_effective_date_disabled of this DataEntitySummaryFromDataStore. + It shows whether or not effective date is disabled + + + :return: The is_effective_date_disabled of this DataEntitySummaryFromDataStore. + :rtype: bool + """ + return self._is_effective_date_disabled + + @is_effective_date_disabled.setter + def is_effective_date_disabled(self, is_effective_date_disabled): + """ + Sets the is_effective_date_disabled of this DataEntitySummaryFromDataStore. + It shows whether or not effective date is disabled + + + :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntitySummaryFromDataStore. + :type: bool + """ + self._is_effective_date_disabled = is_effective_date_disabled + + @property + def is_flex_data_store(self): + """ + Gets the is_flex_data_store of this DataEntitySummaryFromDataStore. + Is Flex data store. Metadata csv will be generated for flex data store + + + :return: The is_flex_data_store of this DataEntitySummaryFromDataStore. + :rtype: bool + """ + return self._is_flex_data_store + + @is_flex_data_store.setter + def is_flex_data_store(self, is_flex_data_store): + """ + Sets the is_flex_data_store of this DataEntitySummaryFromDataStore. + Is Flex data store. Metadata csv will be generated for flex data store + + + :param is_flex_data_store: The is_flex_data_store of this DataEntitySummaryFromDataStore. + :type: bool + """ + self._is_flex_data_store = is_flex_data_store + + @property + def is_silent_error(self): + """ + Gets the is_silent_error of this DataEntitySummaryFromDataStore. + Should the VO failure fail the whole batch? + + + :return: The is_silent_error of this DataEntitySummaryFromDataStore. + :rtype: bool + """ + return self._is_silent_error + + @is_silent_error.setter + def is_silent_error(self, is_silent_error): + """ + Sets the is_silent_error of this DataEntitySummaryFromDataStore. + Should the VO failure fail the whole batch? + + + :param is_silent_error: The is_silent_error of this DataEntitySummaryFromDataStore. + :type: bool + """ + self._is_silent_error = is_silent_error + + @property + def supports_incremental(self): + """ + Gets the supports_incremental of this DataEntitySummaryFromDataStore. + It shows whether the datastore supports Incremental Extract or not. + + + :return: The supports_incremental of this DataEntitySummaryFromDataStore. + :rtype: bool + """ + return self._supports_incremental + + @supports_incremental.setter + def supports_incremental(self, supports_incremental): + """ + Sets the supports_incremental of this DataEntitySummaryFromDataStore. + It shows whether the datastore supports Incremental Extract or not. + + + :param supports_incremental: The supports_incremental of this DataEntitySummaryFromDataStore. + :type: bool + """ + self._supports_incremental = supports_incremental + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_from_file.py b/src/oci/data_connectivity/models/data_entity_summary_from_file.py new file mode 100644 index 0000000000..2ac6929ce9 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_from_file.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_summary import DataEntitySummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryFromFile(DataEntitySummary): + """ + The file data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryFromFile object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntitySummaryFromFile.model_type` attribute + of this class is ``FILE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummaryFromFile. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummaryFromFile. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntitySummaryFromFile. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntitySummaryFromFile. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntitySummaryFromFile. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntitySummaryFromFile. + :type name: str + + :param description: + The value to assign to the description property of this DataEntitySummaryFromFile. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntitySummaryFromFile. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntitySummaryFromFile. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntitySummaryFromFile. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntitySummaryFromFile. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntitySummaryFromFile. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntitySummaryFromFile. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntitySummaryFromFile. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntitySummaryFromFile. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntitySummaryFromFile. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this DataEntitySummaryFromFile. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this DataEntitySummaryFromFile. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntitySummaryFromFile. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'FILE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntitySummaryFromFile. + The object key. + + + :return: The key of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntitySummaryFromFile. + The object key. + + + :param key: The key of this DataEntitySummaryFromFile. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntitySummaryFromFile. + The object's model version. + + + :return: The model_version of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntitySummaryFromFile. + The object's model version. + + + :param model_version: The model_version of this DataEntitySummaryFromFile. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntitySummaryFromFile. + + :return: The parent_ref of this DataEntitySummaryFromFile. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntitySummaryFromFile. + + :param parent_ref: The parent_ref of this DataEntitySummaryFromFile. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntitySummaryFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntitySummaryFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntitySummaryFromFile. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntitySummaryFromFile. + Detailed description for the object. + + + :return: The description of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntitySummaryFromFile. + Detailed description for the object. + + + :param description: The description of this DataEntitySummaryFromFile. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntitySummaryFromFile. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntitySummaryFromFile. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntitySummaryFromFile. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntitySummaryFromFile. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntitySummaryFromFile. + The external key for the object. + + + :return: The external_key of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntitySummaryFromFile. + The external key for the object. + + + :param external_key: The external_key of this DataEntitySummaryFromFile. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntitySummaryFromFile. + + :return: The shape of this DataEntitySummaryFromFile. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntitySummaryFromFile. + + :param shape: The shape of this DataEntitySummaryFromFile. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntitySummaryFromFile. + The shape ID. + + + :return: The shape_id of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntitySummaryFromFile. + The shape ID. + + + :param shape_id: The shape_id of this DataEntitySummaryFromFile. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntitySummaryFromFile. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntitySummaryFromFile. + The entity type. + + + :param entity_type: The entity_type of this DataEntitySummaryFromFile. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntitySummaryFromFile. + Specifies other type label. + + + :return: The other_type_label of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntitySummaryFromFile. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntitySummaryFromFile. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntitySummaryFromFile. + An array of unique keys. + + + :return: The unique_keys of this DataEntitySummaryFromFile. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntitySummaryFromFile. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntitySummaryFromFile. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntitySummaryFromFile. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntitySummaryFromFile. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntitySummaryFromFile. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntitySummaryFromFile. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntitySummaryFromFile. + The resource name. + + + :return: The resource_name of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntitySummaryFromFile. + The resource name. + + + :param resource_name: The resource_name of this DataEntitySummaryFromFile. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this DataEntitySummaryFromFile. + + :return: The data_format of this DataEntitySummaryFromFile. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this DataEntitySummaryFromFile. + + :param data_format: The data_format of this DataEntitySummaryFromFile. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this DataEntitySummaryFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntitySummaryFromFile. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntitySummaryFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntitySummaryFromFile. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntitySummaryFromFile. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntitySummaryFromFile. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntitySummaryFromFile. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntitySummaryFromFile. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_from_sql.py b/src/oci/data_connectivity/models/data_entity_summary_from_sql.py new file mode 100644 index 0000000000..d8db004501 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_from_sql.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_summary import DataEntitySummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryFromSql(DataEntitySummary): + """ + The sql entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryFromSql object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntitySummaryFromSql.model_type` attribute + of this class is ``SQL_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummaryFromSql. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummaryFromSql. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntitySummaryFromSql. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntitySummaryFromSql. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntitySummaryFromSql. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntitySummaryFromSql. + :type name: str + + :param description: + The value to assign to the description property of this DataEntitySummaryFromSql. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntitySummaryFromSql. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntitySummaryFromSql. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntitySummaryFromSql. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntitySummaryFromSql. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntitySummaryFromSql. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntitySummaryFromSql. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntitySummaryFromSql. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntitySummaryFromSql. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntitySummaryFromSql. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntitySummaryFromSql. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntitySummaryFromSql. + :type identifier: str + + :param sql_query: + The value to assign to the sql_query property of this DataEntitySummaryFromSql. + :type sql_query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'sql_query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'sql_query': 'sqlQuery' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._sql_query = None + self._model_type = 'SQL_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntitySummaryFromSql. + The object key. + + + :return: The key of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntitySummaryFromSql. + The object key. + + + :param key: The key of this DataEntitySummaryFromSql. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntitySummaryFromSql. + The object's model version. + + + :return: The model_version of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntitySummaryFromSql. + The object's model version. + + + :param model_version: The model_version of this DataEntitySummaryFromSql. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntitySummaryFromSql. + + :return: The parent_ref of this DataEntitySummaryFromSql. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntitySummaryFromSql. + + :param parent_ref: The parent_ref of this DataEntitySummaryFromSql. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntitySummaryFromSql. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntitySummaryFromSql. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntitySummaryFromSql. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntitySummaryFromSql. + Detailed description for the object. + + + :return: The description of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntitySummaryFromSql. + Detailed description for the object. + + + :param description: The description of this DataEntitySummaryFromSql. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntitySummaryFromSql. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntitySummaryFromSql. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntitySummaryFromSql. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntitySummaryFromSql. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntitySummaryFromSql. + The external key for the object + + + :return: The external_key of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntitySummaryFromSql. + The external key for the object + + + :param external_key: The external_key of this DataEntitySummaryFromSql. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntitySummaryFromSql. + + :return: The shape of this DataEntitySummaryFromSql. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntitySummaryFromSql. + + :param shape: The shape of this DataEntitySummaryFromSql. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntitySummaryFromSql. + The shape ID. + + + :return: The shape_id of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntitySummaryFromSql. + The shape ID. + + + :param shape_id: The shape_id of this DataEntitySummaryFromSql. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntitySummaryFromSql. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntitySummaryFromSql. + The entity type. + + + :param entity_type: The entity_type of this DataEntitySummaryFromSql. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntitySummaryFromSql. + Specifies other type label. + + + :return: The other_type_label of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntitySummaryFromSql. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntitySummaryFromSql. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntitySummaryFromSql. + An array of unique keys. + + + :return: The unique_keys of this DataEntitySummaryFromSql. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntitySummaryFromSql. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntitySummaryFromSql. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntitySummaryFromSql. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntitySummaryFromSql. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntitySummaryFromSql. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntitySummaryFromSql. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntitySummaryFromSql. + The resource name. + + + :return: The resource_name of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntitySummaryFromSql. + The resource name. + + + :param resource_name: The resource_name of this DataEntitySummaryFromSql. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntitySummaryFromSql. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntitySummaryFromSql. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntitySummaryFromSql. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntitySummaryFromSql. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntitySummaryFromSql. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntitySummaryFromSql. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntitySummaryFromSql. + :type: str + """ + self._identifier = identifier + + @property + def sql_query(self): + """ + Gets the sql_query of this DataEntitySummaryFromSql. + sqlQuery + + + :return: The sql_query of this DataEntitySummaryFromSql. + :rtype: str + """ + return self._sql_query + + @sql_query.setter + def sql_query(self, sql_query): + """ + Sets the sql_query of this DataEntitySummaryFromSql. + sqlQuery + + + :param sql_query: The sql_query of this DataEntitySummaryFromSql. + :type: str + """ + self._sql_query = sql_query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_from_table.py b/src/oci/data_connectivity/models/data_entity_summary_from_table.py new file mode 100644 index 0000000000..4b48532c9f --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_from_table.py @@ -0,0 +1,573 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_summary import DataEntitySummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryFromTable(DataEntitySummary): + """ + The table entity data entity. + """ + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryFromTable object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntitySummaryFromTable.model_type` attribute + of this class is ``TABLE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummaryFromTable. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummaryFromTable. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntitySummaryFromTable. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntitySummaryFromTable. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntitySummaryFromTable. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntitySummaryFromTable. + :type name: str + + :param description: + The value to assign to the description property of this DataEntitySummaryFromTable. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntitySummaryFromTable. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntitySummaryFromTable. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntitySummaryFromTable. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntitySummaryFromTable. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntitySummaryFromTable. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntitySummaryFromTable. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntitySummaryFromTable. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntitySummaryFromTable. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntitySummaryFromTable. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntitySummaryFromTable. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntitySummaryFromTable. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'TABLE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntitySummaryFromTable. + The object key. + + + :return: The key of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntitySummaryFromTable. + The object key. + + + :param key: The key of this DataEntitySummaryFromTable. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntitySummaryFromTable. + The object's model version. + + + :return: The model_version of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntitySummaryFromTable. + The object's model version. + + + :param model_version: The model_version of this DataEntitySummaryFromTable. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntitySummaryFromTable. + + :return: The parent_ref of this DataEntitySummaryFromTable. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntitySummaryFromTable. + + :param parent_ref: The parent_ref of this DataEntitySummaryFromTable. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntitySummaryFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntitySummaryFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntitySummaryFromTable. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntitySummaryFromTable. + Detailed description for the object. + + + :return: The description of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntitySummaryFromTable. + Detailed description for the object. + + + :param description: The description of this DataEntitySummaryFromTable. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntitySummaryFromTable. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntitySummaryFromTable. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntitySummaryFromTable. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntitySummaryFromTable. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntitySummaryFromTable. + The external key for the object. + + + :return: The external_key of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntitySummaryFromTable. + The external key for the object. + + + :param external_key: The external_key of this DataEntitySummaryFromTable. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntitySummaryFromTable. + + :return: The shape of this DataEntitySummaryFromTable. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntitySummaryFromTable. + + :param shape: The shape of this DataEntitySummaryFromTable. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntitySummaryFromTable. + The shape ID. + + + :return: The shape_id of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntitySummaryFromTable. + The shape ID. + + + :param shape_id: The shape_id of this DataEntitySummaryFromTable. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntitySummaryFromTable. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntitySummaryFromTable. + The entity type. + + + :param entity_type: The entity_type of this DataEntitySummaryFromTable. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntitySummaryFromTable. + Specifies other type label. + + + :return: The other_type_label of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntitySummaryFromTable. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntitySummaryFromTable. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntitySummaryFromTable. + An array of unique keys. + + + :return: The unique_keys of this DataEntitySummaryFromTable. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntitySummaryFromTable. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntitySummaryFromTable. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntitySummaryFromTable. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntitySummaryFromTable. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntitySummaryFromTable. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntitySummaryFromTable. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntitySummaryFromTable. + The resource name. + + + :return: The resource_name of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntitySummaryFromTable. + The resource name. + + + :param resource_name: The resource_name of this DataEntitySummaryFromTable. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntitySummaryFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntitySummaryFromTable. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntitySummaryFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntitySummaryFromTable. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntitySummaryFromTable. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntitySummaryFromTable. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntitySummaryFromTable. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntitySummaryFromTable. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_entity_summary_from_view.py b/src/oci/data_connectivity/models/data_entity_summary_from_view.py new file mode 100644 index 0000000000..dfbb299217 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_summary_from_view.py @@ -0,0 +1,573 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .data_entity_summary import DataEntitySummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataEntitySummaryFromView(DataEntitySummary): + """ + The view entity data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntitySummaryFromView object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntitySummaryFromView.model_type` attribute + of this class is ``VIEW_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataEntitySummaryFromView. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this DataEntitySummaryFromView. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DataEntitySummaryFromView. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntitySummaryFromView. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntitySummaryFromView. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntitySummaryFromView. + :type name: str + + :param description: + The value to assign to the description property of this DataEntitySummaryFromView. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntitySummaryFromView. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntitySummaryFromView. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntitySummaryFromView. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntitySummaryFromView. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntitySummaryFromView. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntitySummaryFromView. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntitySummaryFromView. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntitySummaryFromView. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntitySummaryFromView. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DataEntitySummaryFromView. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntitySummaryFromView. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._model_type = 'VIEW_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntitySummaryFromView. + The object key. + + + :return: The key of this DataEntitySummaryFromView. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntitySummaryFromView. + The object key. + + + :param key: The key of this DataEntitySummaryFromView. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntitySummaryFromView. + The object's model version. + + + :return: The model_version of this DataEntitySummaryFromView. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntitySummaryFromView. + The object's model version. + + + :param model_version: The model_version of this DataEntitySummaryFromView. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntitySummaryFromView. + + :return: The parent_ref of this DataEntitySummaryFromView. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DataEntitySummaryFromView. + + :param parent_ref: The parent_ref of this DataEntitySummaryFromView. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DataEntitySummaryFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DataEntitySummaryFromView. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntitySummaryFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntitySummaryFromView. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntitySummaryFromView. + Detailed description for the object. + + + :return: The description of this DataEntitySummaryFromView. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntitySummaryFromView. + Detailed description for the object. + + + :param description: The description of this DataEntitySummaryFromView. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntitySummaryFromView. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntitySummaryFromView. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntitySummaryFromView. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntitySummaryFromView. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntitySummaryFromView. + The external key for the object + + + :return: The external_key of this DataEntitySummaryFromView. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntitySummaryFromView. + The external key for the object + + + :param external_key: The external_key of this DataEntitySummaryFromView. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntitySummaryFromView. + + :return: The shape of this DataEntitySummaryFromView. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntitySummaryFromView. + + :param shape: The shape of this DataEntitySummaryFromView. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntitySummaryFromView. + The shape ID. + + + :return: The shape_id of this DataEntitySummaryFromView. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntitySummaryFromView. + The shape ID. + + + :param shape_id: The shape_id of this DataEntitySummaryFromView. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntitySummaryFromView. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this DataEntitySummaryFromView. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntitySummaryFromView. + The entity type. + + + :param entity_type: The entity_type of this DataEntitySummaryFromView. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this DataEntitySummaryFromView. + Specifies other type label. + + + :return: The other_type_label of this DataEntitySummaryFromView. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this DataEntitySummaryFromView. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntitySummaryFromView. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntitySummaryFromView. + An array of unique keys. + + + :return: The unique_keys of this DataEntitySummaryFromView. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this DataEntitySummaryFromView. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntitySummaryFromView. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntitySummaryFromView. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntitySummaryFromView. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this DataEntitySummaryFromView. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntitySummaryFromView. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this DataEntitySummaryFromView. + The resource name. + + + :return: The resource_name of this DataEntitySummaryFromView. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntitySummaryFromView. + The resource name. + + + :param resource_name: The resource_name of this DataEntitySummaryFromView. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DataEntitySummaryFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DataEntitySummaryFromView. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntitySummaryFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DataEntitySummaryFromView. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntitySummaryFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntitySummaryFromView. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntitySummaryFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntitySummaryFromView. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_format.py b/src/oci/data_connectivity/models/data_format.py new file mode 100644 index 0000000000..ac62754603 --- /dev/null +++ b/src/oci/data_connectivity/models/data_format.py @@ -0,0 +1,148 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataFormat(object): + """ + The data format object. + """ + + #: A constant which can be used with the type property of a DataFormat. + #: This constant has a value of "JSON" + TYPE_JSON = "JSON" + + #: A constant which can be used with the type property of a DataFormat. + #: This constant has a value of "CSV" + TYPE_CSV = "CSV" + + #: A constant which can be used with the type property of a DataFormat. + #: This constant has a value of "PARQUET" + TYPE_PARQUET = "PARQUET" + + #: A constant which can be used with the type property of a DataFormat. + #: This constant has a value of "AVRO" + TYPE_AVRO = "AVRO" + + def __init__(self, **kwargs): + """ + Initializes a new DataFormat object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param format_attribute: + The value to assign to the format_attribute property of this DataFormat. + :type format_attribute: oci.data_connectivity.models.AbstractFormatAttribute + + :param type: + The value to assign to the type property of this DataFormat. + Allowed values for this property are: "JSON", "CSV", "PARQUET", "AVRO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param compression_config: + The value to assign to the compression_config property of this DataFormat. + :type compression_config: oci.data_connectivity.models.Compression + + """ + self.swagger_types = { + 'format_attribute': 'AbstractFormatAttribute', + 'type': 'str', + 'compression_config': 'Compression' + } + + self.attribute_map = { + 'format_attribute': 'formatAttribute', + 'type': 'type', + 'compression_config': 'compressionConfig' + } + + self._format_attribute = None + self._type = None + self._compression_config = None + + @property + def format_attribute(self): + """ + Gets the format_attribute of this DataFormat. + + :return: The format_attribute of this DataFormat. + :rtype: oci.data_connectivity.models.AbstractFormatAttribute + """ + return self._format_attribute + + @format_attribute.setter + def format_attribute(self, format_attribute): + """ + Sets the format_attribute of this DataFormat. + + :param format_attribute: The format_attribute of this DataFormat. + :type: oci.data_connectivity.models.AbstractFormatAttribute + """ + self._format_attribute = format_attribute + + @property + def type(self): + """ + **[Required]** Gets the type of this DataFormat. + type + + Allowed values for this property are: "JSON", "CSV", "PARQUET", "AVRO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this DataFormat. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this DataFormat. + type + + + :param type: The type of this DataFormat. + :type: str + """ + allowed_values = ["JSON", "CSV", "PARQUET", "AVRO"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def compression_config(self): + """ + Gets the compression_config of this DataFormat. + + :return: The compression_config of this DataFormat. + :rtype: oci.data_connectivity.models.Compression + """ + return self._compression_config + + @compression_config.setter + def compression_config(self, compression_config): + """ + Sets the compression_config of this DataFormat. + + :param compression_config: The compression_config of this DataFormat. + :type: oci.data_connectivity.models.Compression + """ + self._compression_config = compression_config + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_preview.py b/src/oci/data_connectivity/models/data_preview.py new file mode 100644 index 0000000000..cb06c768b0 --- /dev/null +++ b/src/oci/data_connectivity/models/data_preview.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataPreview(object): + """ + The data preview response. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataPreview object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_name: + The value to assign to the entity_name property of this DataPreview. + :type entity_name: str + + :param sample_rows_count: + The value to assign to the sample_rows_count property of this DataPreview. + :type sample_rows_count: int + + :param columns: + The value to assign to the columns property of this DataPreview. + :type columns: list[oci.data_connectivity.models.Column] + + :param rows: + The value to assign to the rows property of this DataPreview. + :type rows: list[oci.data_connectivity.models.Row] + + """ + self.swagger_types = { + 'entity_name': 'str', + 'sample_rows_count': 'int', + 'columns': 'list[Column]', + 'rows': 'list[Row]' + } + + self.attribute_map = { + 'entity_name': 'entityName', + 'sample_rows_count': 'sampleRowsCount', + 'columns': 'columns', + 'rows': 'rows' + } + + self._entity_name = None + self._sample_rows_count = None + self._columns = None + self._rows = None + + @property + def entity_name(self): + """ + **[Required]** Gets the entity_name of this DataPreview. + Name of the entity for which data preview was requested + + + :return: The entity_name of this DataPreview. + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """ + Sets the entity_name of this DataPreview. + Name of the entity for which data preview was requested + + + :param entity_name: The entity_name of this DataPreview. + :type: str + """ + self._entity_name = entity_name + + @property + def sample_rows_count(self): + """ + Gets the sample_rows_count of this DataPreview. + Total number of rows taken for sampling + + + :return: The sample_rows_count of this DataPreview. + :rtype: int + """ + return self._sample_rows_count + + @sample_rows_count.setter + def sample_rows_count(self, sample_rows_count): + """ + Sets the sample_rows_count of this DataPreview. + Total number of rows taken for sampling + + + :param sample_rows_count: The sample_rows_count of this DataPreview. + :type: int + """ + self._sample_rows_count = sample_rows_count + + @property + def columns(self): + """ + Gets the columns of this DataPreview. + Array of column definition for the preview result + + + :return: The columns of this DataPreview. + :rtype: list[oci.data_connectivity.models.Column] + """ + return self._columns + + @columns.setter + def columns(self, columns): + """ + Sets the columns of this DataPreview. + Array of column definition for the preview result + + + :param columns: The columns of this DataPreview. + :type: list[oci.data_connectivity.models.Column] + """ + self._columns = columns + + @property + def rows(self): + """ + Gets the rows of this DataPreview. + Array of rows values for the preview result + + + :return: The rows of this DataPreview. + :rtype: list[oci.data_connectivity.models.Row] + """ + return self._rows + + @rows.setter + def rows(self, rows): + """ + Sets the rows of this DataPreview. + Array of rows values for the preview result + + + :param rows: The rows of this DataPreview. + :type: list[oci.data_connectivity.models.Row] + """ + self._rows = rows + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_profile.py b/src/oci/data_connectivity/models/data_profile.py new file mode 100644 index 0000000000..f29ec828df --- /dev/null +++ b/src/oci/data_connectivity/models/data_profile.py @@ -0,0 +1,128 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataProfile(object): + """ + The data profile response. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataProfile object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_name: + The value to assign to the entity_name property of this DataProfile. + :type entity_name: str + + :param entity_profile_result: + The value to assign to the entity_profile_result property of this DataProfile. + :type entity_profile_result: oci.data_connectivity.models.EntityProfileResult + + :param attribute_profile_results: + The value to assign to the attribute_profile_results property of this DataProfile. + :type attribute_profile_results: list[oci.data_connectivity.models.AttributeProfileResult] + + """ + self.swagger_types = { + 'entity_name': 'str', + 'entity_profile_result': 'EntityProfileResult', + 'attribute_profile_results': 'list[AttributeProfileResult]' + } + + self.attribute_map = { + 'entity_name': 'entityName', + 'entity_profile_result': 'entityProfileResult', + 'attribute_profile_results': 'attributeProfileResults' + } + + self._entity_name = None + self._entity_profile_result = None + self._attribute_profile_results = None + + @property + def entity_name(self): + """ + **[Required]** Gets the entity_name of this DataProfile. + Entity name for which prodilig is requested. + + + :return: The entity_name of this DataProfile. + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """ + Sets the entity_name of this DataProfile. + Entity name for which prodilig is requested. + + + :param entity_name: The entity_name of this DataProfile. + :type: str + """ + self._entity_name = entity_name + + @property + def entity_profile_result(self): + """ + Gets the entity_profile_result of this DataProfile. + + :return: The entity_profile_result of this DataProfile. + :rtype: oci.data_connectivity.models.EntityProfileResult + """ + return self._entity_profile_result + + @entity_profile_result.setter + def entity_profile_result(self, entity_profile_result): + """ + Sets the entity_profile_result of this DataProfile. + + :param entity_profile_result: The entity_profile_result of this DataProfile. + :type: oci.data_connectivity.models.EntityProfileResult + """ + self._entity_profile_result = entity_profile_result + + @property + def attribute_profile_results(self): + """ + Gets the attribute_profile_results of this DataProfile. + Array of profiling results + + + :return: The attribute_profile_results of this DataProfile. + :rtype: list[oci.data_connectivity.models.AttributeProfileResult] + """ + return self._attribute_profile_results + + @attribute_profile_results.setter + def attribute_profile_results(self, attribute_profile_results): + """ + Sets the attribute_profile_results of this DataProfile. + Array of profiling results + + + :param attribute_profile_results: The attribute_profile_results of this DataProfile. + :type: list[oci.data_connectivity.models.AttributeProfileResult] + """ + self._attribute_profile_results = attribute_profile_results + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_type.py b/src/oci/data_connectivity/models/data_type.py new file mode 100644 index 0000000000..27b4578ea0 --- /dev/null +++ b/src/oci/data_connectivity/models/data_type.py @@ -0,0 +1,197 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .base_type import BaseType +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataType(BaseType): + """ + A `DataType` object is a simple primitive type that describes the type of a single atomic unit of data. For example, `INT`, `VARCHAR`, `NUMBER`, and so on. + """ + + #: A constant which can be used with the dt_type property of a DataType. + #: This constant has a value of "PRIMITIVE" + DT_TYPE_PRIMITIVE = "PRIMITIVE" + + #: A constant which can be used with the dt_type property of a DataType. + #: This constant has a value of "STRUCTURED" + DT_TYPE_STRUCTURED = "STRUCTURED" + + def __init__(self, **kwargs): + """ + Initializes a new DataType object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataType.model_type` attribute + of this class is ``DATA_TYPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DataType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this DataType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this DataType. + :type object_status: int + + :param description: + The value to assign to the description property of this DataType. + :type description: str + + :param dt_type: + The value to assign to the dt_type property of this DataType. + Allowed values for this property are: "PRIMITIVE", "STRUCTURED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type dt_type: str + + :param type_system_name: + The value to assign to the type_system_name property of this DataType. + :type type_system_name: str + + :param config_definition: + The value to assign to the config_definition property of this DataType. + :type config_definition: oci.data_connectivity.models.ConfigDefinition + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str', + 'dt_type': 'str', + 'type_system_name': 'str', + 'config_definition': 'ConfigDefinition' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description', + 'dt_type': 'dtType', + 'type_system_name': 'typeSystemName', + 'config_definition': 'configDefinition' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + self._dt_type = None + self._type_system_name = None + self._config_definition = None + self._model_type = 'DATA_TYPE' + + @property + def dt_type(self): + """ + Gets the dt_type of this DataType. + The data type. + + Allowed values for this property are: "PRIMITIVE", "STRUCTURED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The dt_type of this DataType. + :rtype: str + """ + return self._dt_type + + @dt_type.setter + def dt_type(self, dt_type): + """ + Sets the dt_type of this DataType. + The data type. + + + :param dt_type: The dt_type of this DataType. + :type: str + """ + allowed_values = ["PRIMITIVE", "STRUCTURED"] + if not value_allowed_none_or_none_sentinel(dt_type, allowed_values): + dt_type = 'UNKNOWN_ENUM_VALUE' + self._dt_type = dt_type + + @property + def type_system_name(self): + """ + Gets the type_system_name of this DataType. + The data type system name. + + + :return: The type_system_name of this DataType. + :rtype: str + """ + return self._type_system_name + + @type_system_name.setter + def type_system_name(self, type_system_name): + """ + Sets the type_system_name of this DataType. + The data type system name. + + + :param type_system_name: The type_system_name of this DataType. + :type: str + """ + self._type_system_name = type_system_name + + @property + def config_definition(self): + """ + Gets the config_definition of this DataType. + + :return: The config_definition of this DataType. + :rtype: oci.data_connectivity.models.ConfigDefinition + """ + return self._config_definition + + @config_definition.setter + def config_definition(self, config_definition): + """ + Sets the config_definition of this DataType. + + :param config_definition: The config_definition of this DataType. + :type: oci.data_connectivity.models.ConfigDefinition + """ + self._config_definition = config_definition + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/data_type_stat.py b/src/oci/data_connectivity/models/data_type_stat.py new file mode 100644 index 0000000000..5cfa5d9e89 --- /dev/null +++ b/src/oci/data_connectivity/models/data_type_stat.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DataTypeStat(object): + """ + Statistical data in profiling results + """ + + def __init__(self, **kwargs): + """ + Initializes a new DataTypeStat object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param value: + The value to assign to the value property of this DataTypeStat. + :type value: str + + :param confidence: + The value to assign to the confidence property of this DataTypeStat. + :type confidence: int + + :param freq: + The value to assign to the freq property of this DataTypeStat. + :type freq: int + + :param freq_percentage: + The value to assign to the freq_percentage property of this DataTypeStat. + :type freq_percentage: float + + """ + self.swagger_types = { + 'value': 'str', + 'confidence': 'int', + 'freq': 'int', + 'freq_percentage': 'float' + } + + self.attribute_map = { + 'value': 'value', + 'confidence': 'confidence', + 'freq': 'freq', + 'freq_percentage': 'freqPercentage' + } + + self._value = None + self._confidence = None + self._freq = None + self._freq_percentage = None + + @property + def value(self): + """ + Gets the value of this DataTypeStat. + Value of the confidence of the profile result + + + :return: The value of this DataTypeStat. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this DataTypeStat. + Value of the confidence of the profile result + + + :param value: The value of this DataTypeStat. + :type: str + """ + self._value = value + + @property + def confidence(self): + """ + Gets the confidence of this DataTypeStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :return: The confidence of this DataTypeStat. + :rtype: int + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this DataTypeStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :param confidence: The confidence of this DataTypeStat. + :type: int + """ + self._confidence = confidence + + @property + def freq(self): + """ + Gets the freq of this DataTypeStat. + How many times that value occurred. + + + :return: The freq of this DataTypeStat. + :rtype: int + """ + return self._freq + + @freq.setter + def freq(self, freq): + """ + Sets the freq of this DataTypeStat. + How many times that value occurred. + + + :param freq: The freq of this DataTypeStat. + :type: int + """ + self._freq = freq + + @property + def freq_percentage(self): + """ + Gets the freq_percentage of this DataTypeStat. + Frequency percentage across the sampled row counts (excluding nulls). + + + :return: The freq_percentage of this DataTypeStat. + :rtype: float + """ + return self._freq_percentage + + @freq_percentage.setter + def freq_percentage(self, freq_percentage): + """ + Sets the freq_percentage of this DataTypeStat. + Frequency percentage across the sampled row counts (excluding nulls). + + + :param freq_percentage: The freq_percentage of this DataTypeStat. + :type: float + """ + self._freq_percentage = freq_percentage + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/date_attribute.py b/src/oci/data_connectivity/models/date_attribute.py new file mode 100644 index 0000000000..d44091e943 --- /dev/null +++ b/src/oci/data_connectivity/models/date_attribute.py @@ -0,0 +1,104 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .attribute_profile_result import AttributeProfileResult +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DateAttribute(AttributeProfileResult): + """ + A summary of profiling results of a specefic attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DateAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DateAttribute.type` attribute + of this class is ``DATE_TIME`` 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 DateAttribute. + :type type: object + + :param name: + The value to assign to the name property of this DateAttribute. + :type name: str + + :param min: + The value to assign to the min property of this DateAttribute. + :type min: oci.data_connectivity.models.ProfileStat + + :param max: + The value to assign to the max property of this DateAttribute. + :type max: oci.data_connectivity.models.ProfileStat + + :param null_count: + The value to assign to the null_count property of this DateAttribute. + :type null_count: oci.data_connectivity.models.ProfileStat + + :param distinct_count: + The value to assign to the distinct_count property of this DateAttribute. + :type distinct_count: oci.data_connectivity.models.ProfileStat + + :param unique_count: + The value to assign to the unique_count property of this DateAttribute. + :type unique_count: oci.data_connectivity.models.ProfileStat + + :param duplicate_count: + The value to assign to the duplicate_count property of this DateAttribute. + :type duplicate_count: oci.data_connectivity.models.ProfileStat + + :param value_frequencies: + The value to assign to the value_frequencies property of this DateAttribute. + :type value_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + """ + self.swagger_types = { + 'type': 'object', + 'name': 'str', + 'min': 'ProfileStat', + 'max': 'ProfileStat', + 'null_count': 'ProfileStat', + 'distinct_count': 'ProfileStat', + 'unique_count': 'ProfileStat', + 'duplicate_count': 'ProfileStat', + 'value_frequencies': 'list[ObjectFreqStat]' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name', + 'min': 'min', + 'max': 'max', + 'null_count': 'nullCount', + 'distinct_count': 'distinctCount', + 'unique_count': 'uniqueCount', + 'duplicate_count': 'duplicateCount', + 'value_frequencies': 'valueFrequencies' + } + + self._type = None + self._name = None + self._min = None + self._max = None + self._null_count = None + self._distinct_count = None + self._unique_count = None + self._duplicate_count = None + self._value_frequencies = None + self._type = 'DATE_TIME' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/de_reference_info.py b/src/oci/data_connectivity/models/de_reference_info.py new file mode 100644 index 0000000000..c3ef0acbc7 --- /dev/null +++ b/src/oci/data_connectivity/models/de_reference_info.py @@ -0,0 +1,434 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DeReferenceInfo(object): + """ + Represents de-reference details of a dcms artifact. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeReferenceInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DeReferenceInfo. + :type model_type: str + + :param key: + The value to assign to the key property of this DeReferenceInfo. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DeReferenceInfo. + :type model_version: str + + :param name: + The value to assign to the name property of this DeReferenceInfo. + :type name: str + + :param description: + The value to assign to the description property of this DeReferenceInfo. + :type description: str + + :param object_status: + The value to assign to the object_status property of this DeReferenceInfo. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this DeReferenceInfo. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this DeReferenceInfo. + :type identifier: str + + :param dcms_artifact_id: + The value to assign to the dcms_artifact_id property of this DeReferenceInfo. + :type dcms_artifact_id: str + + :param service_artifact_id: + The value to assign to the service_artifact_id property of this DeReferenceInfo. + :type service_artifact_id: str + + :param reference_count: + The value to assign to the reference_count property of this DeReferenceInfo. + :type reference_count: int + + :param registry_metadata: + The value to assign to the registry_metadata property of this DeReferenceInfo. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this DeReferenceInfo. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'dcms_artifact_id': 'str', + 'service_artifact_id': 'str', + 'reference_count': 'int', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'dcms_artifact_id': 'dcmsArtifactId', + 'service_artifact_id': 'serviceArtifactId', + 'reference_count': 'referenceCount', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata' + } + + self._model_type = None + self._key = None + self._model_version = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._dcms_artifact_id = None + self._service_artifact_id = None + self._reference_count = None + self._registry_metadata = None + self._metadata = None + + @property + def model_type(self): + """ + Gets the model_type of this DeReferenceInfo. + The type of the ReferenceInfo. + + + :return: The model_type of this DeReferenceInfo. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DeReferenceInfo. + The type of the ReferenceInfo. + + + :param model_type: The model_type of this DeReferenceInfo. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this DeReferenceInfo. + Generated key that can be used in API calls to identify referenceinfo. + + + :return: The key of this DeReferenceInfo. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DeReferenceInfo. + Generated key that can be used in API calls to identify referenceinfo. + + + :param key: The key of this DeReferenceInfo. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DeReferenceInfo. + The model version of an object. + + + :return: The model_version of this DeReferenceInfo. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DeReferenceInfo. + The model version of an object. + + + :param model_version: The model_version of this DeReferenceInfo. + :type: str + """ + self._model_version = model_version + + @property + def name(self): + """ + Gets the name of this DeReferenceInfo. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DeReferenceInfo. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DeReferenceInfo. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DeReferenceInfo. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DeReferenceInfo. + User-defined description of the referenceInfo. + + + :return: The description of this DeReferenceInfo. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DeReferenceInfo. + User-defined description of the referenceInfo. + + + :param description: The description of this DeReferenceInfo. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this DeReferenceInfo. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DeReferenceInfo. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DeReferenceInfo. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DeReferenceInfo. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this DeReferenceInfo. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DeReferenceInfo. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DeReferenceInfo. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DeReferenceInfo. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this DeReferenceInfo. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DeReferenceInfo. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DeReferenceInfo. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DeReferenceInfo. + :type: str + """ + self._identifier = identifier + + @property + def dcms_artifact_id(self): + """ + **[Required]** Gets the dcms_artifact_id of this DeReferenceInfo. + unique id of dcms artifact that is getting referenced. + + + :return: The dcms_artifact_id of this DeReferenceInfo. + :rtype: str + """ + return self._dcms_artifact_id + + @dcms_artifact_id.setter + def dcms_artifact_id(self, dcms_artifact_id): + """ + Sets the dcms_artifact_id of this DeReferenceInfo. + unique id of dcms artifact that is getting referenced. + + + :param dcms_artifact_id: The dcms_artifact_id of this DeReferenceInfo. + :type: str + """ + self._dcms_artifact_id = dcms_artifact_id + + @property + def service_artifact_id(self): + """ + **[Required]** Gets the service_artifact_id of this DeReferenceInfo. + unique id of service which is referencing dcms artifact. + + + :return: The service_artifact_id of this DeReferenceInfo. + :rtype: str + """ + return self._service_artifact_id + + @service_artifact_id.setter + def service_artifact_id(self, service_artifact_id): + """ + Sets the service_artifact_id of this DeReferenceInfo. + unique id of service which is referencing dcms artifact. + + + :param service_artifact_id: The service_artifact_id of this DeReferenceInfo. + :type: str + """ + self._service_artifact_id = service_artifact_id + + @property + def reference_count(self): + """ + Gets the reference_count of this DeReferenceInfo. + count of how many times a dcms artifact has been registered by a service. + + + :return: The reference_count of this DeReferenceInfo. + :rtype: int + """ + return self._reference_count + + @reference_count.setter + def reference_count(self, reference_count): + """ + Sets the reference_count of this DeReferenceInfo. + count of how many times a dcms artifact has been registered by a service. + + + :param reference_count: The reference_count of this DeReferenceInfo. + :type: int + """ + self._reference_count = reference_count + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this DeReferenceInfo. + + :return: The registry_metadata of this DeReferenceInfo. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this DeReferenceInfo. + + :param registry_metadata: The registry_metadata of this DeReferenceInfo. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this DeReferenceInfo. + + :return: The metadata of this DeReferenceInfo. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this DeReferenceInfo. + + :param metadata: The metadata of this DeReferenceInfo. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/derived_type.py b/src/oci/data_connectivity/models/derived_type.py new file mode 100644 index 0000000000..ebd6f21c3d --- /dev/null +++ b/src/oci/data_connectivity/models/derived_type.py @@ -0,0 +1,91 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .base_type import BaseType +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DerivedType(BaseType): + """ + A `DerivedType` object represents a more complex type that is derived from a set of simple types, for example an `Address` or `SSN` data type. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DerivedType object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DerivedType.model_type` attribute + of this class is ``DERIVED_TYPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DerivedType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE" + :type model_type: str + + :param key: + The value to assign to the key property of this DerivedType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DerivedType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DerivedType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DerivedType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this DerivedType. + :type object_status: int + + :param description: + The value to assign to the description property of this DerivedType. + :type description: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + self._model_type = 'DERIVED_TYPE' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/detach_data_asset_info.py b/src/oci/data_connectivity/models/detach_data_asset_info.py new file mode 100644 index 0000000000..5a9d48c1c1 --- /dev/null +++ b/src/oci/data_connectivity/models/detach_data_asset_info.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DetachDataAssetInfo(object): + """ + The detach DataAsset response. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DetachDataAssetInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param reference_info: + The value to assign to the reference_info property of this DetachDataAssetInfo. + :type reference_info: dict(str, ValidationResult) + + """ + self.swagger_types = { + 'reference_info': 'dict(str, ValidationResult)' + } + + self.attribute_map = { + 'reference_info': 'referenceInfo' + } + + self._reference_info = None + + @property + def reference_info(self): + """ + **[Required]** Gets the reference_info of this DetachDataAssetInfo. + Map of DataAsset name as key and results as value + + + :return: The reference_info of this DetachDataAssetInfo. + :rtype: dict(str, ValidationResult) + """ + return self._reference_info + + @reference_info.setter + def reference_info(self, reference_info): + """ + Sets the reference_info of this DetachDataAssetInfo. + Map of DataAsset name as key and results as value + + + :param reference_info: The reference_info of this DetachDataAssetInfo. + :type: dict(str, ValidationResult) + """ + self._reference_info = reference_info + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint.py b/src/oci/data_connectivity/models/dp_endpoint.py new file mode 100644 index 0000000000..6d7285fa74 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint.py @@ -0,0 +1,382 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpoint(object): + """ + The endpoint for a data asset. + """ + + #: A constant which can be used with the model_type property of a DpEndpoint. + #: This constant has a value of "PRIVATE_END_POINT" + MODEL_TYPE_PRIVATE_END_POINT = "PRIVATE_END_POINT" + + #: A constant which can be used with the model_type property of a DpEndpoint. + #: This constant has a value of "PUBLIC_END_POINT" + MODEL_TYPE_PUBLIC_END_POINT = "PUBLIC_END_POINT" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpoint object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DpEndpointFromPrivate` + * :class:`~oci.data_connectivity.models.DpEndpointFromPublic` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpoint. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpoint. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpoint. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpoint. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpoint. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpoint. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpoint. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpoint. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpoint. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpoint. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = 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['modelType'] + + if type == 'PRIVATE_END_POINT': + return 'DpEndpointFromPrivate' + + if type == 'PUBLIC_END_POINT': + return 'DpEndpointFromPublic' + else: + return 'DpEndpoint' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DpEndpoint. + The type of the endpoint. + + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this DpEndpoint. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DpEndpoint. + The type of the endpoint. + + + :param model_type: The model_type of this DpEndpoint. + :type: str + """ + allowed_values = ["PRIVATE_END_POINT", "PUBLIC_END_POINT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this DpEndpoint. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :return: The key of this DpEndpoint. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DpEndpoint. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :param key: The key of this DpEndpoint. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DpEndpoint. + The model version of an object. + + + :return: The model_version of this DpEndpoint. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DpEndpoint. + The model version of an object. + + + :param model_version: The model_version of this DpEndpoint. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DpEndpoint. + + :return: The parent_ref of this DpEndpoint. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DpEndpoint. + + :param parent_ref: The parent_ref of this DpEndpoint. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DpEndpoint. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DpEndpoint. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DpEndpoint. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DpEndpoint. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DpEndpoint. + User-defined description for the endpoint. + + + :return: The description of this DpEndpoint. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DpEndpoint. + User-defined description for the endpoint. + + + :param description: The description of this DpEndpoint. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DpEndpoint. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DpEndpoint. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DpEndpoint. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DpEndpoint. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this DpEndpoint. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DpEndpoint. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DpEndpoint. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DpEndpoint. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DpEndpoint. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DpEndpoint. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DpEndpoint. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DpEndpoint. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this DpEndpoint. + List of data assets which belongs to this endpoint + + + :return: The data_assets of this DpEndpoint. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this DpEndpoint. + List of data assets which belongs to this endpoint + + + :param data_assets: The data_assets of this DpEndpoint. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint_details.py b/src/oci/data_connectivity/models/dp_endpoint_details.py new file mode 100644 index 0000000000..cc2ca0edfb --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_details.py @@ -0,0 +1,383 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointDetails(object): + """ + The endpoint details. + """ + + #: A constant which can be used with the model_type property of a DpEndpointDetails. + #: This constant has a value of "PRIVATE_END_POINT" + MODEL_TYPE_PRIVATE_END_POINT = "PRIVATE_END_POINT" + + #: A constant which can be used with the model_type property of a DpEndpointDetails. + #: This constant has a value of "PUBLIC_END_POINT" + MODEL_TYPE_PUBLIC_END_POINT = "PUBLIC_END_POINT" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DpEndpointFromPrivateDetails` + * :class:`~oci.data_connectivity.models.DpEndpointFromPublicDetails` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointDetails. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointDetails. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = 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['modelType'] + + if type == 'PRIVATE_END_POINT': + return 'DpEndpointFromPrivateDetails' + + if type == 'PUBLIC_END_POINT': + return 'DpEndpointFromPublicDetails' + else: + return 'DpEndpointDetails' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DpEndpointDetails. + The type of the endpoint. + + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + + + :return: The model_type of this DpEndpointDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DpEndpointDetails. + The type of the endpoint. + + + :param model_type: The model_type of this DpEndpointDetails. + :type: str + """ + allowed_values = ["PRIVATE_END_POINT", "PUBLIC_END_POINT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this DpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :return: The key of this DpEndpointDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :param key: The key of this DpEndpointDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DpEndpointDetails. + The model version of an object. + + + :return: The model_version of this DpEndpointDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DpEndpointDetails. + The model version of an object. + + + :param model_version: The model_version of this DpEndpointDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DpEndpointDetails. + + :return: The parent_ref of this DpEndpointDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DpEndpointDetails. + + :param parent_ref: The parent_ref of this DpEndpointDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DpEndpointDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DpEndpointDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DpEndpointDetails. + User-defined description for the endpoint. + + + :return: The description of this DpEndpointDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DpEndpointDetails. + User-defined description for the endpoint. + + + :param description: The description of this DpEndpointDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DpEndpointDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DpEndpointDetails. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this DpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DpEndpointDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DpEndpointDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DpEndpointDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DpEndpointDetails. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this DpEndpointDetails. + List of data assets which belongs to this endpoint + + + :return: The data_assets of this DpEndpointDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this DpEndpointDetails. + List of data assets which belongs to this endpoint + + + :param data_assets: The data_assets of this DpEndpointDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint_from_private.py b/src/oci/data_connectivity/models/dp_endpoint_from_private.py new file mode 100644 index 0000000000..8f8c188533 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_from_private.py @@ -0,0 +1,346 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint import DpEndpoint +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointFromPrivate(DpEndpoint): + """ + The endpoint details for a private endpoint. + """ + + #: A constant which can be used with the state property of a DpEndpointFromPrivate. + #: This constant has a value of "ACTIVE" + STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the state property of a DpEndpointFromPrivate. + #: This constant has a value of "INACTIVE" + STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointFromPrivate object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointFromPrivate.model_type` attribute + of this class is ``PRIVATE_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointFromPrivate. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointFromPrivate. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointFromPrivate. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointFromPrivate. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointFromPrivate. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointFromPrivate. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointFromPrivate. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointFromPrivate. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointFromPrivate. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointFromPrivate. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + :param dcms_endpoint_id: + The value to assign to the dcms_endpoint_id property of this DpEndpointFromPrivate. + :type dcms_endpoint_id: str + + :param pe_id: + The value to assign to the pe_id property of this DpEndpointFromPrivate. + :type pe_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this DpEndpointFromPrivate. + :type compartment_id: str + + :param dns_proxy_ip: + The value to assign to the dns_proxy_ip property of this DpEndpointFromPrivate. + :type dns_proxy_ip: str + + :param private_endpoint_ip: + The value to assign to the private_endpoint_ip property of this DpEndpointFromPrivate. + :type private_endpoint_ip: str + + :param dns_zones: + The value to assign to the dns_zones property of this DpEndpointFromPrivate. + :type dns_zones: list[str] + + :param state: + The value to assign to the state property of this DpEndpointFromPrivate. + Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type state: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]', + 'dcms_endpoint_id': 'str', + 'pe_id': 'str', + 'compartment_id': 'str', + 'dns_proxy_ip': 'str', + 'private_endpoint_ip': 'str', + 'dns_zones': 'list[str]', + 'state': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets', + 'dcms_endpoint_id': 'dcmsEndpointId', + 'pe_id': 'peId', + 'compartment_id': 'compartmentId', + 'dns_proxy_ip': 'dnsProxyIp', + 'private_endpoint_ip': 'privateEndpointIp', + 'dns_zones': 'dnsZones', + 'state': 'state' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._dcms_endpoint_id = None + self._pe_id = None + self._compartment_id = None + self._dns_proxy_ip = None + self._private_endpoint_ip = None + self._dns_zones = None + self._state = None + self._model_type = 'PRIVATE_END_POINT' + + @property + def dcms_endpoint_id(self): + """ + **[Required]** Gets the dcms_endpoint_id of this DpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :return: The dcms_endpoint_id of this DpEndpointFromPrivate. + :rtype: str + """ + return self._dcms_endpoint_id + + @dcms_endpoint_id.setter + def dcms_endpoint_id(self, dcms_endpoint_id): + """ + Sets the dcms_endpoint_id of this DpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :param dcms_endpoint_id: The dcms_endpoint_id of this DpEndpointFromPrivate. + :type: str + """ + self._dcms_endpoint_id = dcms_endpoint_id + + @property + def pe_id(self): + """ + Gets the pe_id of this DpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The pe_id of this DpEndpointFromPrivate. + :rtype: str + """ + return self._pe_id + + @pe_id.setter + def pe_id(self, pe_id): + """ + Sets the pe_id of this DpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param pe_id: The pe_id of this DpEndpointFromPrivate. + :type: str + """ + self._pe_id = pe_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :return: The compartment_id of this DpEndpointFromPrivate. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :param compartment_id: The compartment_id of this DpEndpointFromPrivate. + :type: str + """ + self._compartment_id = compartment_id + + @property + def dns_proxy_ip(self): + """ + Gets the dns_proxy_ip of this DpEndpointFromPrivate. + The IP address of dns proxy. + + + :return: The dns_proxy_ip of this DpEndpointFromPrivate. + :rtype: str + """ + return self._dns_proxy_ip + + @dns_proxy_ip.setter + def dns_proxy_ip(self, dns_proxy_ip): + """ + Sets the dns_proxy_ip of this DpEndpointFromPrivate. + The IP address of dns proxy. + + + :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointFromPrivate. + :type: str + """ + self._dns_proxy_ip = dns_proxy_ip + + @property + def private_endpoint_ip(self): + """ + Gets the private_endpoint_ip of this DpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The private_endpoint_ip of this DpEndpointFromPrivate. + :rtype: str + """ + return self._private_endpoint_ip + + @private_endpoint_ip.setter + def private_endpoint_ip(self, private_endpoint_ip): + """ + Sets the private_endpoint_ip of this DpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointFromPrivate. + :type: str + """ + self._private_endpoint_ip = private_endpoint_ip + + @property + def dns_zones(self): + """ + Gets the dns_zones of this DpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :return: The dns_zones of this DpEndpointFromPrivate. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this DpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :param dns_zones: The dns_zones of this DpEndpointFromPrivate. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def state(self): + """ + Gets the state of this DpEndpointFromPrivate. + Specifies the private endpoint state. + + Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The state of this DpEndpointFromPrivate. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this DpEndpointFromPrivate. + Specifies the private endpoint state. + + + :param state: The state of this DpEndpointFromPrivate. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + state = 'UNKNOWN_ENUM_VALUE' + self._state = 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/data_connectivity/models/dp_endpoint_from_private_details.py b/src/oci/data_connectivity/models/dp_endpoint_from_private_details.py new file mode 100644 index 0000000000..eecabe7820 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_from_private_details.py @@ -0,0 +1,346 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint_details import DpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointFromPrivateDetails(DpEndpointDetails): + """ + The endpoint details for a private endpoint. + """ + + #: A constant which can be used with the state property of a DpEndpointFromPrivateDetails. + #: This constant has a value of "ACTIVE" + STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the state property of a DpEndpointFromPrivateDetails. + #: This constant has a value of "INACTIVE" + STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointFromPrivateDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointFromPrivateDetails.model_type` attribute + of this class is ``PRIVATE_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointFromPrivateDetails. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointFromPrivateDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointFromPrivateDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointFromPrivateDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointFromPrivateDetails. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointFromPrivateDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointFromPrivateDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointFromPrivateDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointFromPrivateDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointFromPrivateDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + :param dcms_endpoint_id: + The value to assign to the dcms_endpoint_id property of this DpEndpointFromPrivateDetails. + :type dcms_endpoint_id: str + + :param pe_id: + The value to assign to the pe_id property of this DpEndpointFromPrivateDetails. + :type pe_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this DpEndpointFromPrivateDetails. + :type compartment_id: str + + :param dns_proxy_ip: + The value to assign to the dns_proxy_ip property of this DpEndpointFromPrivateDetails. + :type dns_proxy_ip: str + + :param private_endpoint_ip: + The value to assign to the private_endpoint_ip property of this DpEndpointFromPrivateDetails. + :type private_endpoint_ip: str + + :param dns_zones: + The value to assign to the dns_zones property of this DpEndpointFromPrivateDetails. + :type dns_zones: list[str] + + :param state: + The value to assign to the state property of this DpEndpointFromPrivateDetails. + Allowed values for this property are: "ACTIVE", "INACTIVE" + :type state: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]', + 'dcms_endpoint_id': 'str', + 'pe_id': 'str', + 'compartment_id': 'str', + 'dns_proxy_ip': 'str', + 'private_endpoint_ip': 'str', + 'dns_zones': 'list[str]', + 'state': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets', + 'dcms_endpoint_id': 'dcmsEndpointId', + 'pe_id': 'peId', + 'compartment_id': 'compartmentId', + 'dns_proxy_ip': 'dnsProxyIp', + 'private_endpoint_ip': 'privateEndpointIp', + 'dns_zones': 'dnsZones', + 'state': 'state' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._dcms_endpoint_id = None + self._pe_id = None + self._compartment_id = None + self._dns_proxy_ip = None + self._private_endpoint_ip = None + self._dns_zones = None + self._state = None + self._model_type = 'PRIVATE_END_POINT' + + @property + def dcms_endpoint_id(self): + """ + **[Required]** Gets the dcms_endpoint_id of this DpEndpointFromPrivateDetails. + The endpoint ID provided by control plane. + + + :return: The dcms_endpoint_id of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._dcms_endpoint_id + + @dcms_endpoint_id.setter + def dcms_endpoint_id(self, dcms_endpoint_id): + """ + Sets the dcms_endpoint_id of this DpEndpointFromPrivateDetails. + The endpoint ID provided by control plane. + + + :param dcms_endpoint_id: The dcms_endpoint_id of this DpEndpointFromPrivateDetails. + :type: str + """ + self._dcms_endpoint_id = dcms_endpoint_id + + @property + def pe_id(self): + """ + Gets the pe_id of this DpEndpointFromPrivateDetails. + The ocid of private endpoint resource. + + + :return: The pe_id of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._pe_id + + @pe_id.setter + def pe_id(self, pe_id): + """ + Sets the pe_id of this DpEndpointFromPrivateDetails. + The ocid of private endpoint resource. + + + :param pe_id: The pe_id of this DpEndpointFromPrivateDetails. + :type: str + """ + self._pe_id = pe_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DpEndpointFromPrivateDetails. + The compartmentId of private endpoint resource. + + + :return: The compartment_id of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DpEndpointFromPrivateDetails. + The compartmentId of private endpoint resource. + + + :param compartment_id: The compartment_id of this DpEndpointFromPrivateDetails. + :type: str + """ + self._compartment_id = compartment_id + + @property + def dns_proxy_ip(self): + """ + Gets the dns_proxy_ip of this DpEndpointFromPrivateDetails. + The IP address of dns proxy. + + + :return: The dns_proxy_ip of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._dns_proxy_ip + + @dns_proxy_ip.setter + def dns_proxy_ip(self, dns_proxy_ip): + """ + Sets the dns_proxy_ip of this DpEndpointFromPrivateDetails. + The IP address of dns proxy. + + + :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointFromPrivateDetails. + :type: str + """ + self._dns_proxy_ip = dns_proxy_ip + + @property + def private_endpoint_ip(self): + """ + Gets the private_endpoint_ip of this DpEndpointFromPrivateDetails. + The ocid of private endpoint resource. + + + :return: The private_endpoint_ip of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._private_endpoint_ip + + @private_endpoint_ip.setter + def private_endpoint_ip(self, private_endpoint_ip): + """ + Sets the private_endpoint_ip of this DpEndpointFromPrivateDetails. + The ocid of private endpoint resource. + + + :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointFromPrivateDetails. + :type: str + """ + self._private_endpoint_ip = private_endpoint_ip + + @property + def dns_zones(self): + """ + Gets the dns_zones of this DpEndpointFromPrivateDetails. + Array of dns zones to be use during private endpoint resolution. + + + :return: The dns_zones of this DpEndpointFromPrivateDetails. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this DpEndpointFromPrivateDetails. + Array of dns zones to be use during private endpoint resolution. + + + :param dns_zones: The dns_zones of this DpEndpointFromPrivateDetails. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def state(self): + """ + Gets the state of this DpEndpointFromPrivateDetails. + Specifies the private endpoint state. + + Allowed values for this property are: "ACTIVE", "INACTIVE" + + + :return: The state of this DpEndpointFromPrivateDetails. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this DpEndpointFromPrivateDetails. + Specifies the private endpoint state. + + + :param state: The state of this DpEndpointFromPrivateDetails. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + raise ValueError( + "Invalid value for `state`, must be None or one of {0}" + .format(allowed_values) + ) + self._state = 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/data_connectivity/models/dp_endpoint_from_public.py b/src/oci/data_connectivity/models/dp_endpoint_from_public.py new file mode 100644 index 0000000000..6133f3fb1c --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_from_public.py @@ -0,0 +1,112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint import DpEndpoint +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointFromPublic(DpEndpoint): + """ + The endpoint details for a public endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointFromPublic object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointFromPublic.model_type` attribute + of this class is ``PUBLIC_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointFromPublic. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointFromPublic. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointFromPublic. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointFromPublic. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointFromPublic. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointFromPublic. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointFromPublic. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointFromPublic. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointFromPublic. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointFromPublic. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._model_type = 'PUBLIC_END_POINT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint_from_public_details.py b/src/oci/data_connectivity/models/dp_endpoint_from_public_details.py new file mode 100644 index 0000000000..6bceef9846 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_from_public_details.py @@ -0,0 +1,112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint_details import DpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointFromPublicDetails(DpEndpointDetails): + """ + The endpoint details for a public endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointFromPublicDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointFromPublicDetails.model_type` attribute + of this class is ``PUBLIC_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointFromPublicDetails. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointFromPublicDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointFromPublicDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointFromPublicDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointFromPublicDetails. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointFromPublicDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointFromPublicDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointFromPublicDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointFromPublicDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointFromPublicDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._model_type = 'PUBLIC_END_POINT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint_summary.py b/src/oci/data_connectivity/models/dp_endpoint_summary.py new file mode 100644 index 0000000000..f4a4b48537 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_summary.py @@ -0,0 +1,383 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointSummary(object): + """ + The endpoint summary object. + """ + + #: A constant which can be used with the model_type property of a DpEndpointSummary. + #: This constant has a value of "PRIVATE_END_POINT" + MODEL_TYPE_PRIVATE_END_POINT = "PRIVATE_END_POINT" + + #: A constant which can be used with the model_type property of a DpEndpointSummary. + #: This constant has a value of "PUBLIC_END_POINT" + MODEL_TYPE_PUBLIC_END_POINT = "PUBLIC_END_POINT" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.DpEndpointSummaryFromPublic` + * :class:`~oci.data_connectivity.models.DpEndpointSummaryFromPrivate` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointSummary. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointSummary. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointSummary. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointSummary. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointSummary. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointSummary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointSummary. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointSummary. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointSummary. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointSummary. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = 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['modelType'] + + if type == 'PUBLIC_END_POINT': + return 'DpEndpointSummaryFromPublic' + + if type == 'PRIVATE_END_POINT': + return 'DpEndpointSummaryFromPrivate' + else: + return 'DpEndpointSummary' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DpEndpointSummary. + The type of the endpoint. + + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + + + :return: The model_type of this DpEndpointSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DpEndpointSummary. + The type of the endpoint. + + + :param model_type: The model_type of this DpEndpointSummary. + :type: str + """ + allowed_values = ["PRIVATE_END_POINT", "PUBLIC_END_POINT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this DpEndpointSummary. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :return: The key of this DpEndpointSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DpEndpointSummary. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :param key: The key of this DpEndpointSummary. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DpEndpointSummary. + The model version of an object. + + + :return: The model_version of this DpEndpointSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DpEndpointSummary. + The model version of an object. + + + :param model_version: The model_version of this DpEndpointSummary. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DpEndpointSummary. + + :return: The parent_ref of this DpEndpointSummary. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this DpEndpointSummary. + + :param parent_ref: The parent_ref of this DpEndpointSummary. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this DpEndpointSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this DpEndpointSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DpEndpointSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this DpEndpointSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DpEndpointSummary. + User-defined description for the endpoint. + + + :return: The description of this DpEndpointSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DpEndpointSummary. + User-defined description for the endpoint. + + + :param description: The description of this DpEndpointSummary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DpEndpointSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DpEndpointSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DpEndpointSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DpEndpointSummary. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this DpEndpointSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this DpEndpointSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DpEndpointSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this DpEndpointSummary. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DpEndpointSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DpEndpointSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DpEndpointSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DpEndpointSummary. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this DpEndpointSummary. + List of data assets which belongs to this endpoint + + + :return: The data_assets of this DpEndpointSummary. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this DpEndpointSummary. + List of data assets which belongs to this endpoint + + + :param data_assets: The data_assets of this DpEndpointSummary. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/dp_endpoint_summary_from_private.py b/src/oci/data_connectivity/models/dp_endpoint_summary_from_private.py new file mode 100644 index 0000000000..cac1ed194f --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_summary_from_private.py @@ -0,0 +1,346 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint_summary import DpEndpointSummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointSummaryFromPrivate(DpEndpointSummary): + """ + The endpoint summary details for a private endpoint. + """ + + #: A constant which can be used with the state property of a DpEndpointSummaryFromPrivate. + #: This constant has a value of "ACTIVE" + STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the state property of a DpEndpointSummaryFromPrivate. + #: This constant has a value of "INACTIVE" + STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointSummaryFromPrivate object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointSummaryFromPrivate.model_type` attribute + of this class is ``PRIVATE_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointSummaryFromPrivate. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointSummaryFromPrivate. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointSummaryFromPrivate. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointSummaryFromPrivate. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointSummaryFromPrivate. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointSummaryFromPrivate. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointSummaryFromPrivate. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointSummaryFromPrivate. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointSummaryFromPrivate. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointSummaryFromPrivate. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + :param dcms_endpoint_id: + The value to assign to the dcms_endpoint_id property of this DpEndpointSummaryFromPrivate. + :type dcms_endpoint_id: str + + :param pe_id: + The value to assign to the pe_id property of this DpEndpointSummaryFromPrivate. + :type pe_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this DpEndpointSummaryFromPrivate. + :type compartment_id: str + + :param dns_proxy_ip: + The value to assign to the dns_proxy_ip property of this DpEndpointSummaryFromPrivate. + :type dns_proxy_ip: str + + :param private_endpoint_ip: + The value to assign to the private_endpoint_ip property of this DpEndpointSummaryFromPrivate. + :type private_endpoint_ip: str + + :param dns_zones: + The value to assign to the dns_zones property of this DpEndpointSummaryFromPrivate. + :type dns_zones: list[str] + + :param state: + The value to assign to the state property of this DpEndpointSummaryFromPrivate. + Allowed values for this property are: "ACTIVE", "INACTIVE" + :type state: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]', + 'dcms_endpoint_id': 'str', + 'pe_id': 'str', + 'compartment_id': 'str', + 'dns_proxy_ip': 'str', + 'private_endpoint_ip': 'str', + 'dns_zones': 'list[str]', + 'state': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets', + 'dcms_endpoint_id': 'dcmsEndpointId', + 'pe_id': 'peId', + 'compartment_id': 'compartmentId', + 'dns_proxy_ip': 'dnsProxyIp', + 'private_endpoint_ip': 'privateEndpointIp', + 'dns_zones': 'dnsZones', + 'state': 'state' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._dcms_endpoint_id = None + self._pe_id = None + self._compartment_id = None + self._dns_proxy_ip = None + self._private_endpoint_ip = None + self._dns_zones = None + self._state = None + self._model_type = 'PRIVATE_END_POINT' + + @property + def dcms_endpoint_id(self): + """ + **[Required]** Gets the dcms_endpoint_id of this DpEndpointSummaryFromPrivate. + The endpoint ID provided by control plane. + + + :return: The dcms_endpoint_id of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._dcms_endpoint_id + + @dcms_endpoint_id.setter + def dcms_endpoint_id(self, dcms_endpoint_id): + """ + Sets the dcms_endpoint_id of this DpEndpointSummaryFromPrivate. + The endpoint ID provided by control plane. + + + :param dcms_endpoint_id: The dcms_endpoint_id of this DpEndpointSummaryFromPrivate. + :type: str + """ + self._dcms_endpoint_id = dcms_endpoint_id + + @property + def pe_id(self): + """ + Gets the pe_id of this DpEndpointSummaryFromPrivate. + The ocid of private endpoint resource. + + + :return: The pe_id of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._pe_id + + @pe_id.setter + def pe_id(self, pe_id): + """ + Sets the pe_id of this DpEndpointSummaryFromPrivate. + The ocid of private endpoint resource. + + + :param pe_id: The pe_id of this DpEndpointSummaryFromPrivate. + :type: str + """ + self._pe_id = pe_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this DpEndpointSummaryFromPrivate. + The compartmentId of private endpoint resource. + + + :return: The compartment_id of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this DpEndpointSummaryFromPrivate. + The compartmentId of private endpoint resource. + + + :param compartment_id: The compartment_id of this DpEndpointSummaryFromPrivate. + :type: str + """ + self._compartment_id = compartment_id + + @property + def dns_proxy_ip(self): + """ + Gets the dns_proxy_ip of this DpEndpointSummaryFromPrivate. + The IP address of dns proxy. + + + :return: The dns_proxy_ip of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._dns_proxy_ip + + @dns_proxy_ip.setter + def dns_proxy_ip(self, dns_proxy_ip): + """ + Sets the dns_proxy_ip of this DpEndpointSummaryFromPrivate. + The IP address of dns proxy. + + + :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointSummaryFromPrivate. + :type: str + """ + self._dns_proxy_ip = dns_proxy_ip + + @property + def private_endpoint_ip(self): + """ + Gets the private_endpoint_ip of this DpEndpointSummaryFromPrivate. + The ocid of private endpoint resource. + + + :return: The private_endpoint_ip of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._private_endpoint_ip + + @private_endpoint_ip.setter + def private_endpoint_ip(self, private_endpoint_ip): + """ + Sets the private_endpoint_ip of this DpEndpointSummaryFromPrivate. + The ocid of private endpoint resource. + + + :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointSummaryFromPrivate. + :type: str + """ + self._private_endpoint_ip = private_endpoint_ip + + @property + def dns_zones(self): + """ + Gets the dns_zones of this DpEndpointSummaryFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :return: The dns_zones of this DpEndpointSummaryFromPrivate. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this DpEndpointSummaryFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :param dns_zones: The dns_zones of this DpEndpointSummaryFromPrivate. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def state(self): + """ + Gets the state of this DpEndpointSummaryFromPrivate. + Specifies the private endpoint state. + + Allowed values for this property are: "ACTIVE", "INACTIVE" + + + :return: The state of this DpEndpointSummaryFromPrivate. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this DpEndpointSummaryFromPrivate. + Specifies the private endpoint state. + + + :param state: The state of this DpEndpointSummaryFromPrivate. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + raise ValueError( + "Invalid value for `state`, must be None or one of {0}" + .format(allowed_values) + ) + self._state = 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/data_connectivity/models/dp_endpoint_summary_from_public.py b/src/oci/data_connectivity/models/dp_endpoint_summary_from_public.py new file mode 100644 index 0000000000..264a146943 --- /dev/null +++ b/src/oci/data_connectivity/models/dp_endpoint_summary_from_public.py @@ -0,0 +1,112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .dp_endpoint_summary import DpEndpointSummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DpEndpointSummaryFromPublic(DpEndpointSummary): + """ + The endpoint summary details for a public endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DpEndpointSummaryFromPublic object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DpEndpointSummaryFromPublic.model_type` attribute + of this class is ``PUBLIC_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this DpEndpointSummaryFromPublic. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this DpEndpointSummaryFromPublic. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DpEndpointSummaryFromPublic. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DpEndpointSummaryFromPublic. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DpEndpointSummaryFromPublic. + :type name: str + + :param description: + The value to assign to the description property of this DpEndpointSummaryFromPublic. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DpEndpointSummaryFromPublic. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this DpEndpointSummaryFromPublic. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DpEndpointSummaryFromPublic. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this DpEndpointSummaryFromPublic. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + self._model_type = 'PUBLIC_END_POINT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/endpoint.py b/src/oci/data_connectivity/models/endpoint.py new file mode 100644 index 0000000000..c2eafac3c5 --- /dev/null +++ b/src/oci/data_connectivity/models/endpoint.py @@ -0,0 +1,562 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Endpoint(object): + """ + An Endpoint is an organizational construct to keep multiple data Connectivity Management solutions and their resources (pe-id, dnsProxyIp, dnsZones, and so on) separate from each other, helping you to stay organized. For example, you could have separate registries for development, testing, and production. + """ + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Endpoint. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new Endpoint object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param vcn_id: + The value to assign to the vcn_id property of this Endpoint. + :type vcn_id: str + + :param subnet_id: + The value to assign to the subnet_id property of this Endpoint. + :type subnet_id: str + + :param dns_zones: + The value to assign to the dns_zones property of this Endpoint. + :type dns_zones: list[str] + + :param freeform_tags: + The value to assign to the freeform_tags property of this Endpoint. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Endpoint. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this Endpoint. + :type description: str + + :param display_name: + The value to assign to the display_name property of this Endpoint. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this Endpoint. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this Endpoint. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Endpoint. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Endpoint. + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param state_message: + The value to assign to the state_message property of this Endpoint. + :type state_message: str + + :param id: + The value to assign to the id property of this Endpoint. + :type id: str + + :param endpoint_size: + The value to assign to the endpoint_size property of this Endpoint. + :type endpoint_size: int + + :param nsg_ids: + The value to assign to the nsg_ids property of this Endpoint. + :type nsg_ids: list[str] + + """ + self.swagger_types = { + 'vcn_id': 'str', + 'subnet_id': 'str', + 'dns_zones': 'list[str]', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'state_message': 'str', + 'id': 'str', + 'endpoint_size': 'int', + 'nsg_ids': 'list[str]' + } + + self.attribute_map = { + 'vcn_id': 'vcnId', + 'subnet_id': 'subnetId', + 'dns_zones': 'dnsZones', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'state_message': 'stateMessage', + 'id': 'id', + 'endpoint_size': 'endpointSize', + 'nsg_ids': 'nsgIds' + } + + self._vcn_id = None + self._subnet_id = None + self._dns_zones = None + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._state_message = None + self._id = None + self._endpoint_size = None + self._nsg_ids = None + + @property + def vcn_id(self): + """ + **[Required]** Gets the vcn_id of this Endpoint. + VCN OCID where the subnet resides. + + + :return: The vcn_id of this Endpoint. + :rtype: str + """ + return self._vcn_id + + @vcn_id.setter + def vcn_id(self, vcn_id): + """ + Sets the vcn_id of this Endpoint. + VCN OCID where the subnet resides. + + + :param vcn_id: The vcn_id of this Endpoint. + :type: str + """ + self._vcn_id = vcn_id + + @property + def subnet_id(self): + """ + **[Required]** Gets the subnet_id of this Endpoint. + Subnet OCID for the customer connected network where databases for example reside. + + + :return: The subnet_id of this Endpoint. + :rtype: str + """ + return self._subnet_id + + @subnet_id.setter + def subnet_id(self, subnet_id): + """ + Sets the subnet_id of this Endpoint. + Subnet OCID for the customer connected network where databases for example reside. + + + :param subnet_id: The subnet_id of this Endpoint. + :type: str + """ + self._subnet_id = subnet_id + + @property + def dns_zones(self): + """ + Gets the dns_zones of this Endpoint. + List of DNS zones to be used by the data assets to be harvested. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :return: The dns_zones of this Endpoint. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this Endpoint. + List of DNS zones to be used by the data assets to be harvested. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :param dns_zones: The dns_zones of this Endpoint. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this Endpoint. + 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 Endpoint. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Endpoint. + 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 Endpoint. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this Endpoint. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this Endpoint. + :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 Endpoint. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this Endpoint. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this Endpoint. + Registry description + + + :return: The description of this Endpoint. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Endpoint. + Registry description + + + :param description: The description of this Endpoint. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this Endpoint. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this Endpoint. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Endpoint. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this Endpoint. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this Endpoint. + Compartment Identifier + + + :return: The compartment_id of this Endpoint. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Endpoint. + Compartment Identifier + + + :param compartment_id: The compartment_id of this Endpoint. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this Endpoint. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :return: The time_created of this Endpoint. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Endpoint. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this Endpoint. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this Endpoint. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this Endpoint. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Endpoint. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this Endpoint. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this Endpoint. + Lifecycle states for registries in Data Connectivity Management Service + CREATING - The resource is being created and may not be usable until the entire metadata is defined + UPDATING - The resource is being updated and may not be usable until all changes are commited + DELETING - The resource is being deleted and might require deep cleanup of children. + ACTIVE - The resource is valid and available for access + INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for + administrative reasons + DELETED - The resource has been deleted and isn't available + FAILED - The resource is in a failed state due to validation or other errors + + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this Endpoint. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Endpoint. + Lifecycle states for registries in Data Connectivity Management Service + CREATING - The resource is being created and may not be usable until the entire metadata is defined + UPDATING - The resource is being updated and may not be usable until all changes are commited + DELETING - The resource is being deleted and might require deep cleanup of children. + ACTIVE - The resource is valid and available for access + INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for + administrative reasons + DELETED - The resource has been deleted and isn't available + FAILED - The resource is in a failed state due to validation or other errors + + + :param lifecycle_state: The lifecycle_state of this Endpoint. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def state_message(self): + """ + Gets the state_message of this Endpoint. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The state_message of this Endpoint. + :rtype: str + """ + return self._state_message + + @state_message.setter + def state_message(self, state_message): + """ + Sets the state_message of this Endpoint. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param state_message: The state_message of this Endpoint. + :type: str + """ + self._state_message = state_message + + @property + def id(self): + """ + **[Required]** Gets the id of this Endpoint. + Unique identifier that is immutable on creation + + + :return: The id of this Endpoint. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Endpoint. + Unique identifier that is immutable on creation + + + :param id: The id of this Endpoint. + :type: str + """ + self._id = id + + @property + def endpoint_size(self): + """ + Gets the endpoint_size of this Endpoint. + Endpoint size for reverse connection capacity. + + + :return: The endpoint_size of this Endpoint. + :rtype: int + """ + return self._endpoint_size + + @endpoint_size.setter + def endpoint_size(self, endpoint_size): + """ + Sets the endpoint_size of this Endpoint. + Endpoint size for reverse connection capacity. + + + :param endpoint_size: The endpoint_size of this Endpoint. + :type: int + """ + self._endpoint_size = endpoint_size + + @property + def nsg_ids(self): + """ + Gets the nsg_ids of this Endpoint. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :return: The nsg_ids of this Endpoint. + :rtype: list[str] + """ + return self._nsg_ids + + @nsg_ids.setter + def nsg_ids(self, nsg_ids): + """ + Sets the nsg_ids of this Endpoint. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :param nsg_ids: The nsg_ids of this Endpoint. + :type: list[str] + """ + self._nsg_ids = nsg_ids + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/endpoint_summary.py b/src/oci/data_connectivity/models/endpoint_summary.py new file mode 100644 index 0000000000..0f93f03aca --- /dev/null +++ b/src/oci/data_connectivity/models/endpoint_summary.py @@ -0,0 +1,353 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EndpointSummary(object): + """ + Summary of a Endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EndpointSummary 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 EndpointSummary. + :type id: str + + :param description: + The value to assign to the description property of this EndpointSummary. + :type description: str + + :param display_name: + The value to assign to the display_name property of this EndpointSummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this EndpointSummary. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this EndpointSummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this EndpointSummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this EndpointSummary. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this EndpointSummary. + :type defined_tags: dict(str, dict(str, object)) + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this EndpointSummary. + :type lifecycle_state: str + + :param state_message: + The value to assign to the state_message property of this EndpointSummary. + :type state_message: str + + """ + self.swagger_types = { + 'id': 'str', + 'description': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'lifecycle_state': 'str', + 'state_message': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'description': 'description', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'lifecycle_state': 'lifecycleState', + 'state_message': 'stateMessage' + } + + self._id = None + self._description = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._defined_tags = None + self._lifecycle_state = None + self._state_message = None + + @property + def id(self): + """ + **[Required]** Gets the id of this EndpointSummary. + Unique identifier that is immutable on creation + + + :return: The id of this EndpointSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this EndpointSummary. + Unique identifier that is immutable on creation + + + :param id: The id of this EndpointSummary. + :type: str + """ + self._id = id + + @property + def description(self): + """ + Gets the description of this EndpointSummary. + Registry description + + + :return: The description of this EndpointSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EndpointSummary. + Registry description + + + :param description: The description of this EndpointSummary. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this EndpointSummary. + Data Connectivity Management Endpoint display name, Endpoints can be renamed + + + :return: The display_name of this EndpointSummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this EndpointSummary. + Data Connectivity Management Endpoint display name, Endpoints can be renamed + + + :param display_name: The display_name of this EndpointSummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this EndpointSummary. + Compartment Identifier + + + :return: The compartment_id of this EndpointSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this EndpointSummary. + Compartment Identifier + + + :param compartment_id: The compartment_id of this EndpointSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this EndpointSummary. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :return: The time_created of this EndpointSummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this EndpointSummary. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this EndpointSummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this EndpointSummary. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this EndpointSummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this EndpointSummary. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this EndpointSummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this EndpointSummary. + 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 EndpointSummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this EndpointSummary. + 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 EndpointSummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this EndpointSummary. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this EndpointSummary. + :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 EndpointSummary. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this EndpointSummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this EndpointSummary. + The current state of the endpoint. + + + :return: The lifecycle_state of this EndpointSummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this EndpointSummary. + The current state of the endpoint. + + + :param lifecycle_state: The lifecycle_state of this EndpointSummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def state_message(self): + """ + Gets the state_message of this EndpointSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The state_message of this EndpointSummary. + :rtype: str + """ + return self._state_message + + @state_message.setter + def state_message(self, state_message): + """ + Sets the state_message of this EndpointSummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param state_message: The state_message of this EndpointSummary. + :type: str + """ + self._state_message = state_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/endpoint_summary_collection.py b/src/oci/data_connectivity/models/endpoint_summary_collection.py new file mode 100644 index 0000000000..99a2ca69f4 --- /dev/null +++ b/src/oci/data_connectivity/models/endpoint_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EndpointSummaryCollection(object): + """ + List of endpoint summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EndpointSummaryCollection 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 EndpointSummaryCollection. + :type items: list[oci.data_connectivity.models.EndpointSummary] + + """ + self.swagger_types = { + 'items': 'list[EndpointSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this EndpointSummaryCollection. + The array of endpoint summariess + + + :return: The items of this EndpointSummaryCollection. + :rtype: list[oci.data_connectivity.models.EndpointSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this EndpointSummaryCollection. + The array of endpoint summariess + + + :param items: The items of this EndpointSummaryCollection. + :type: list[oci.data_connectivity.models.EndpointSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_profile_result.py b/src/oci/data_connectivity/models/entity_profile_result.py new file mode 100644 index 0000000000..b7a61dbb27 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_profile_result.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityProfileResult(object): + """ + A metadata details of a profiling entity result. + """ + + def __init__(self, **kwargs): + """ + Initializes a new EntityProfileResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attribute_count: + The value to assign to the attribute_count property of this EntityProfileResult. + :type attribute_count: int + + :param sampled_row_count: + The value to assign to the sampled_row_count property of this EntityProfileResult. + :type sampled_row_count: int + + :param estimated_row_count: + The value to assign to the estimated_row_count property of this EntityProfileResult. + :type estimated_row_count: int + + """ + self.swagger_types = { + 'attribute_count': 'int', + 'sampled_row_count': 'int', + 'estimated_row_count': 'int' + } + + self.attribute_map = { + 'attribute_count': 'attributeCount', + 'sampled_row_count': 'sampledRowCount', + 'estimated_row_count': 'estimatedRowCount' + } + + self._attribute_count = None + self._sampled_row_count = None + self._estimated_row_count = None + + @property + def attribute_count(self): + """ + Gets the attribute_count of this EntityProfileResult. + Number of columns in the DataFrame (arrow buffer) sent from Java layer. This value is not impacted by the List of attributes to profile as being passed via configuration. + + + :return: The attribute_count of this EntityProfileResult. + :rtype: int + """ + return self._attribute_count + + @attribute_count.setter + def attribute_count(self, attribute_count): + """ + Sets the attribute_count of this EntityProfileResult. + Number of columns in the DataFrame (arrow buffer) sent from Java layer. This value is not impacted by the List of attributes to profile as being passed via configuration. + + + :param attribute_count: The attribute_count of this EntityProfileResult. + :type: int + """ + self._attribute_count = attribute_count + + @property + def sampled_row_count(self): + """ + Gets the sampled_row_count of this EntityProfileResult. + Number of rows were that were sampled + + + :return: The sampled_row_count of this EntityProfileResult. + :rtype: int + """ + return self._sampled_row_count + + @sampled_row_count.setter + def sampled_row_count(self, sampled_row_count): + """ + Sets the sampled_row_count of this EntityProfileResult. + Number of rows were that were sampled + + + :param sampled_row_count: The sampled_row_count of this EntityProfileResult. + :type: int + """ + self._sampled_row_count = sampled_row_count + + @property + def estimated_row_count(self): + """ + Gets the estimated_row_count of this EntityProfileResult. + The estimated row count in the source. + + + :return: The estimated_row_count of this EntityProfileResult. + :rtype: int + """ + return self._estimated_row_count + + @estimated_row_count.setter + def estimated_row_count(self, estimated_row_count): + """ + Sets the estimated_row_count of this EntityProfileResult. + The estimated row count in the source. + + + :param estimated_row_count: The estimated_row_count of this EntityProfileResult. + :type: int + """ + self._estimated_row_count = estimated_row_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/data_connectivity/models/entity_shape.py b/src/oci/data_connectivity/models/entity_shape.py new file mode 100644 index 0000000000..f8cbe114c2 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape.py @@ -0,0 +1,158 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShape(object): + """ + The data entity shape object. + """ + + #: A constant which can be used with the model_type property of a EntityShape. + #: This constant has a value of "VIEW_ENTITY" + MODEL_TYPE_VIEW_ENTITY = "VIEW_ENTITY" + + #: A constant which can be used with the model_type property of a EntityShape. + #: This constant has a value of "TABLE_ENTITY" + MODEL_TYPE_TABLE_ENTITY = "TABLE_ENTITY" + + #: A constant which can be used with the model_type property of a EntityShape. + #: This constant has a value of "FILE_ENTITY" + MODEL_TYPE_FILE_ENTITY = "FILE_ENTITY" + + #: A constant which can be used with the model_type property of a EntityShape. + #: This constant has a value of "SQL_ENTITY" + MODEL_TYPE_SQL_ENTITY = "SQL_ENTITY" + + #: A constant which can be used with the model_type property of a EntityShape. + #: This constant has a value of "DATA_STORE_ENTITY" + MODEL_TYPE_DATA_STORE_ENTITY = "DATA_STORE_ENTITY" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShape object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.EntityShapeFromDataStore` + * :class:`~oci.data_connectivity.models.EntityShapeFromTable` + * :class:`~oci.data_connectivity.models.EntityShapeFromSQL` + * :class:`~oci.data_connectivity.models.EntityShapeFromView` + * :class:`~oci.data_connectivity.models.EntityShapeFromFile` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShape. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShape. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata' + } + + self._model_type = None + self._metadata = 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['modelType'] + + if type == 'DATA_STORE_ENTITY': + return 'EntityShapeFromDataStore' + + if type == 'TABLE_ENTITY': + return 'EntityShapeFromTable' + + if type == 'SQL_ENTITY': + return 'EntityShapeFromSQL' + + if type == 'VIEW_ENTITY': + return 'EntityShapeFromView' + + if type == 'FILE_ENTITY': + return 'EntityShapeFromFile' + else: + return 'EntityShape' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this EntityShape. + The data entity type. + + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this EntityShape. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this EntityShape. + The data entity type. + + + :param model_type: The model_type of this EntityShape. + :type: str + """ + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def metadata(self): + """ + Gets the metadata of this EntityShape. + + :return: The metadata of this EntityShape. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this EntityShape. + + :param metadata: The metadata of this EntityShape. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_shape_from_data_store.py b/src/oci/data_connectivity/models/entity_shape_from_data_store.py new file mode 100644 index 0000000000..9bb5ec5456 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_data_store.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .entity_shape import EntityShape +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShapeFromDataStore(EntityShape): + """ + The data store entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromDataStore object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromDataStore.model_type` attribute + of this class is ``DATA_STORE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShapeFromDataStore. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShapeFromDataStore. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromDataStore. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromDataStore. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromDataStore. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromDataStore. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromDataStore. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromDataStore. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromDataStore. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromDataStore. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromDataStore. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromDataStore. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this EntityShapeFromDataStore. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromDataStore. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromDataStore. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromDataStore. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromDataStore. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromDataStore. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromDataStore. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'DATA_STORE_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromDataStore. + The object key. + + + :return: The key of this EntityShapeFromDataStore. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromDataStore. + The object key. + + + :param key: The key of this EntityShapeFromDataStore. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromDataStore. + The object's model version. + + + :return: The model_version of this EntityShapeFromDataStore. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromDataStore. + The object's model version. + + + :param model_version: The model_version of this EntityShapeFromDataStore. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromDataStore. + + :return: The parent_ref of this EntityShapeFromDataStore. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this EntityShapeFromDataStore. + + :param parent_ref: The parent_ref of this EntityShapeFromDataStore. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this EntityShapeFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromDataStore. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromDataStore. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromDataStore. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromDataStore. + Detailed description for the object. + + + :return: The description of this EntityShapeFromDataStore. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromDataStore. + Detailed description for the object. + + + :param description: The description of this EntityShapeFromDataStore. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromDataStore. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromDataStore. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromDataStore. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromDataStore. + The external key for the object. + + + :return: The external_key of this EntityShapeFromDataStore. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromDataStore. + The external key for the object. + + + :param external_key: The external_key of this EntityShapeFromDataStore. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromDataStore. + + :return: The shape of this EntityShapeFromDataStore. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromDataStore. + + :param shape: The shape of this EntityShapeFromDataStore. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromDataStore. + The shape ID. + + + :return: The shape_id of this EntityShapeFromDataStore. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromDataStore. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromDataStore. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromDataStore. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromDataStore. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromDataStore. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromDataStore. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this EntityShapeFromDataStore. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromDataStore. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this EntityShapeFromDataStore. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromDataStore. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromDataStore. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromDataStore. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this EntityShapeFromDataStore. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromDataStore. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromDataStore. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromDataStore. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this EntityShapeFromDataStore. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromDataStore. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this EntityShapeFromDataStore. + The resource name. + + + :return: The resource_name of this EntityShapeFromDataStore. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromDataStore. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromDataStore. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromDataStore. + + :return: The data_format of this EntityShapeFromDataStore. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this EntityShapeFromDataStore. + + :param data_format: The data_format of this EntityShapeFromDataStore. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this EntityShapeFromDataStore. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromDataStore. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this EntityShapeFromDataStore. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromDataStore. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromDataStore. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromDataStore. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_shape_from_file.py b/src/oci/data_connectivity/models/entity_shape_from_file.py new file mode 100644 index 0000000000..dcea4626b5 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_file.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .entity_shape import EntityShape +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShapeFromFile(EntityShape): + """ + The file data entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromFile object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromFile.model_type` attribute + of this class is ``FILE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShapeFromFile. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShapeFromFile. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromFile. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromFile. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromFile. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromFile. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromFile. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromFile. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromFile. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromFile. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromFile. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromFile. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this EntityShapeFromFile. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromFile. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromFile. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromFile. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromFile. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromFile. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromFile. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'FILE_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromFile. + The object key. + + + :return: The key of this EntityShapeFromFile. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromFile. + The object key. + + + :param key: The key of this EntityShapeFromFile. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromFile. + The object's model version. + + + :return: The model_version of this EntityShapeFromFile. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromFile. + The object's model version. + + + :param model_version: The model_version of this EntityShapeFromFile. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromFile. + + :return: The parent_ref of this EntityShapeFromFile. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this EntityShapeFromFile. + + :param parent_ref: The parent_ref of this EntityShapeFromFile. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this EntityShapeFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromFile. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromFile. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromFile. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromFile. + Detailed description for the object. + + + :return: The description of this EntityShapeFromFile. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromFile. + Detailed description for the object. + + + :param description: The description of this EntityShapeFromFile. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromFile. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromFile. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromFile. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromFile. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromFile. + The external key for the object. + + + :return: The external_key of this EntityShapeFromFile. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromFile. + The external key for the object. + + + :param external_key: The external_key of this EntityShapeFromFile. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromFile. + + :return: The shape of this EntityShapeFromFile. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromFile. + + :param shape: The shape of this EntityShapeFromFile. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromFile. + The shape ID. + + + :return: The shape_id of this EntityShapeFromFile. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromFile. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromFile. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromFile. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromFile. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromFile. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromFile. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this EntityShapeFromFile. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromFile. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this EntityShapeFromFile. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromFile. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromFile. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromFile. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this EntityShapeFromFile. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromFile. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromFile. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromFile. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this EntityShapeFromFile. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromFile. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this EntityShapeFromFile. + The resource name. + + + :return: The resource_name of this EntityShapeFromFile. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromFile. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromFile. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromFile. + + :return: The data_format of this EntityShapeFromFile. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this EntityShapeFromFile. + + :param data_format: The data_format of this EntityShapeFromFile. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this EntityShapeFromFile. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromFile. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this EntityShapeFromFile. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromFile. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromFile. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromFile. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromFile. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_shape_from_sql.py b/src/oci/data_connectivity/models/entity_shape_from_sql.py new file mode 100644 index 0000000000..83fab40ed2 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_sql.py @@ -0,0 +1,627 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .entity_shape import EntityShape +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShapeFromSQL(EntityShape): + """ + The SQL entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromSQL object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromSQL.model_type` attribute + of this class is ``SQL_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShapeFromSQL. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShapeFromSQL. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromSQL. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromSQL. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromSQL. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromSQL. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromSQL. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromSQL. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromSQL. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromSQL. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromSQL. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromSQL. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this EntityShapeFromSQL. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromSQL. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromSQL. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromSQL. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromSQL. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromSQL. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromSQL. + :type identifier: str + + :param sql_query: + The value to assign to the sql_query property of this EntityShapeFromSQL. + :type sql_query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str', + 'sql_query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'sql_query': 'sqlQuery' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._sql_query = None + self._model_type = 'SQL_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromSQL. + The object key. + + + :return: The key of this EntityShapeFromSQL. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromSQL. + The object key. + + + :param key: The key of this EntityShapeFromSQL. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromSQL. + The object's model version. + + + :return: The model_version of this EntityShapeFromSQL. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromSQL. + The object's model version. + + + :param model_version: The model_version of this EntityShapeFromSQL. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromSQL. + + :return: The parent_ref of this EntityShapeFromSQL. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this EntityShapeFromSQL. + + :param parent_ref: The parent_ref of this EntityShapeFromSQL. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this EntityShapeFromSQL. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromSQL. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromSQL. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromSQL. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromSQL. + Detailed description for the object. + + + :return: The description of this EntityShapeFromSQL. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromSQL. + Detailed description for the object. + + + :param description: The description of this EntityShapeFromSQL. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromSQL. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromSQL. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromSQL. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromSQL. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromSQL. + The external key for the object. + + + :return: The external_key of this EntityShapeFromSQL. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromSQL. + The external key for the object. + + + :param external_key: The external_key of this EntityShapeFromSQL. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromSQL. + + :return: The shape of this EntityShapeFromSQL. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromSQL. + + :param shape: The shape of this EntityShapeFromSQL. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromSQL. + The shape ID. + + + :return: The shape_id of this EntityShapeFromSQL. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromSQL. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromSQL. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromSQL. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromSQL. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromSQL. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromSQL. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this EntityShapeFromSQL. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromSQL. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this EntityShapeFromSQL. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromSQL. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromSQL. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromSQL. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this EntityShapeFromSQL. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromSQL. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromSQL. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromSQL. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this EntityShapeFromSQL. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromSQL. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this EntityShapeFromSQL. + The resource name. + + + :return: The resource_name of this EntityShapeFromSQL. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromSQL. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromSQL. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromSQL. + + :return: The data_format of this EntityShapeFromSQL. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this EntityShapeFromSQL. + + :param data_format: The data_format of this EntityShapeFromSQL. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromSQL. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this EntityShapeFromSQL. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromSQL. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this EntityShapeFromSQL. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromSQL. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromSQL. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromSQL. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromSQL. + :type: str + """ + self._identifier = identifier + + @property + def sql_query(self): + """ + Gets the sql_query of this EntityShapeFromSQL. + sqlQuery + + + :return: The sql_query of this EntityShapeFromSQL. + :rtype: str + """ + return self._sql_query + + @sql_query.setter + def sql_query(self, sql_query): + """ + Sets the sql_query of this EntityShapeFromSQL. + sqlQuery + + + :param sql_query: The sql_query of this EntityShapeFromSQL. + :type: str + """ + self._sql_query = sql_query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_shape_from_table.py b/src/oci/data_connectivity/models/entity_shape_from_table.py new file mode 100644 index 0000000000..9ae8eb033d --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_table.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .entity_shape import EntityShape +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShapeFromTable(EntityShape): + """ + The table data entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromTable object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromTable.model_type` attribute + of this class is ``TABLE_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShapeFromTable. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShapeFromTable. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromTable. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromTable. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromTable. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromTable. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromTable. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromTable. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromTable. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromTable. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromTable. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromTable. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this EntityShapeFromTable. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromTable. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromTable. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromTable. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromTable. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromTable. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromTable. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'TABLE_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromTable. + The object key. + + + :return: The key of this EntityShapeFromTable. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromTable. + The object key. + + + :param key: The key of this EntityShapeFromTable. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromTable. + The object's model version. + + + :return: The model_version of this EntityShapeFromTable. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromTable. + The object's model version. + + + :param model_version: The model_version of this EntityShapeFromTable. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromTable. + + :return: The parent_ref of this EntityShapeFromTable. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this EntityShapeFromTable. + + :param parent_ref: The parent_ref of this EntityShapeFromTable. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this EntityShapeFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromTable. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromTable. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromTable. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromTable. + Detailed description for the object. + + + :return: The description of this EntityShapeFromTable. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromTable. + Detailed description for the object. + + + :param description: The description of this EntityShapeFromTable. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromTable. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromTable. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromTable. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromTable. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromTable. + The external key for the object. + + + :return: The external_key of this EntityShapeFromTable. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromTable. + The external key for the object. + + + :param external_key: The external_key of this EntityShapeFromTable. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromTable. + + :return: The shape of this EntityShapeFromTable. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromTable. + + :param shape: The shape of this EntityShapeFromTable. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromTable. + The shape ID. + + + :return: The shape_id of this EntityShapeFromTable. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromTable. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromTable. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromTable. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromTable. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromTable. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromTable. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this EntityShapeFromTable. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromTable. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this EntityShapeFromTable. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromTable. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromTable. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromTable. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this EntityShapeFromTable. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromTable. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromTable. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromTable. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this EntityShapeFromTable. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromTable. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this EntityShapeFromTable. + The resource name. + + + :return: The resource_name of this EntityShapeFromTable. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromTable. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromTable. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromTable. + + :return: The data_format of this EntityShapeFromTable. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this EntityShapeFromTable. + + :param data_format: The data_format of this EntityShapeFromTable. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this EntityShapeFromTable. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromTable. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this EntityShapeFromTable. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromTable. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromTable. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromTable. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromTable. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/entity_shape_from_view.py b/src/oci/data_connectivity/models/entity_shape_from_view.py new file mode 100644 index 0000000000..b09c795901 --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_view.py @@ -0,0 +1,600 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .entity_shape import EntityShape +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityShapeFromView(EntityShape): + """ + The view data entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromView object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromView.model_type` attribute + of this class is ``VIEW_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this EntityShapeFromView. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this EntityShapeFromView. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromView. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromView. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromView. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromView. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromView. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromView. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromView. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromView. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromView. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromView. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this EntityShapeFromView. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromView. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromView. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromView. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromView. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromView. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromView. + :type identifier: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'shape': 'Shape', + 'shape_id': 'str', + 'entity_type': 'str', + 'other_type_label': 'str', + 'unique_keys': 'list[UniqueKey]', + 'foreign_keys': 'list[ForeignKey]', + 'resource_name': 'str', + 'data_format': 'DataFormat', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'entity_type': 'entityType', + 'other_type_label': 'otherTypeLabel', + 'unique_keys': 'uniqueKeys', + 'foreign_keys': 'foreignKeys', + 'resource_name': 'resourceName', + 'data_format': 'dataFormat', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._external_key = None + self._shape = None + self._shape_id = None + self._entity_type = None + self._other_type_label = None + self._unique_keys = None + self._foreign_keys = None + self._resource_name = None + self._data_format = None + self._object_status = None + self._identifier = None + self._model_type = 'VIEW_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromView. + The object key. + + + :return: The key of this EntityShapeFromView. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromView. + The object key. + + + :param key: The key of this EntityShapeFromView. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromView. + The object's model version. + + + :return: The model_version of this EntityShapeFromView. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromView. + The object's model version. + + + :param model_version: The model_version of this EntityShapeFromView. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromView. + + :return: The parent_ref of this EntityShapeFromView. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this EntityShapeFromView. + + :param parent_ref: The parent_ref of this EntityShapeFromView. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this EntityShapeFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromView. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromView. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromView. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromView. + Detailed description for the object. + + + :return: The description of this EntityShapeFromView. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromView. + Detailed description for the object. + + + :param description: The description of this EntityShapeFromView. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromView. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromView. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromView. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromView. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromView. + The external key for the object. + + + :return: The external_key of this EntityShapeFromView. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromView. + The external key for the object. + + + :param external_key: The external_key of this EntityShapeFromView. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromView. + + :return: The shape of this EntityShapeFromView. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromView. + + :param shape: The shape of this EntityShapeFromView. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromView. + The shape ID. + + + :return: The shape_id of this EntityShapeFromView. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromView. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromView. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromView. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromView. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromView. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromView. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): + entity_type = 'UNKNOWN_ENUM_VALUE' + self._entity_type = entity_type + + @property + def other_type_label(self): + """ + Gets the other_type_label of this EntityShapeFromView. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromView. + :rtype: str + """ + return self._other_type_label + + @other_type_label.setter + def other_type_label(self, other_type_label): + """ + Sets the other_type_label of this EntityShapeFromView. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromView. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromView. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromView. + :rtype: list[oci.data_connectivity.models.UniqueKey] + """ + return self._unique_keys + + @unique_keys.setter + def unique_keys(self, unique_keys): + """ + Sets the unique_keys of this EntityShapeFromView. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromView. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromView. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromView. + :rtype: list[oci.data_connectivity.models.ForeignKey] + """ + return self._foreign_keys + + @foreign_keys.setter + def foreign_keys(self, foreign_keys): + """ + Sets the foreign_keys of this EntityShapeFromView. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromView. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + Gets the resource_name of this EntityShapeFromView. + The resource name. + + + :return: The resource_name of this EntityShapeFromView. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromView. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromView. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromView. + + :return: The data_format of this EntityShapeFromView. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this EntityShapeFromView. + + :param data_format: The data_format of this EntityShapeFromView. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this EntityShapeFromView. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromView. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this EntityShapeFromView. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromView. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromView. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromView. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/error_details.py b/src/oci/data_connectivity/models/error_details.py new file mode 100644 index 0000000000..827cab8ec2 --- /dev/null +++ b/src/oci/data_connectivity/models/error_details.py @@ -0,0 +1,107 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ErrorDetails(object): + """ + The details of an error that occured. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ErrorDetails 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 ErrorDetails. + :type code: str + + :param message: + The value to assign to the message property of this ErrorDetails. + :type message: str + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message' + } + + self._code = None + self._message = None + + @property + def code(self): + """ + **[Required]** Gets the code of this ErrorDetails. + A short error code that defines the error, meant for programmatic parsing. See + `API Errors`__. + + __ https://docs.cloud.oracle.com/Content/API/References/apierrors.htm + + + :return: The code of this ErrorDetails. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this ErrorDetails. + A short error code that defines the error, meant for programmatic parsing. See + `API Errors`__. + + __ https://docs.cloud.oracle.com/Content/API/References/apierrors.htm + + + :param code: The code of this ErrorDetails. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this ErrorDetails. + A user-friendly error message. + + + :return: The message of this ErrorDetails. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this ErrorDetails. + A user-friendly error message. + + + :param message: The message of this ErrorDetails. + :type: str + """ + self._message = message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/execute_operation_job.py b/src/oci/data_connectivity/models/execute_operation_job.py new file mode 100644 index 0000000000..b49dae80bc --- /dev/null +++ b/src/oci/data_connectivity/models/execute_operation_job.py @@ -0,0 +1,194 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ExecuteOperationJob(object): + """ + Response of executeOperationJob. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ExecuteOperationJob object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_status: + The value to assign to the operation_status property of this ExecuteOperationJob. + :type operation_status: str + + :param error_message: + The value to assign to the error_message property of this ExecuteOperationJob. + :type error_message: str + + :param operation_name: + The value to assign to the operation_name property of this ExecuteOperationJob. + :type operation_name: str + + :param out_params: + The value to assign to the out_params property of this ExecuteOperationJob. + :type out_params: list[str] + + :param operation_result: + The value to assign to the operation_result property of this ExecuteOperationJob. + :type operation_result: list[oci.data_connectivity.models.OperationExecResult] + + """ + self.swagger_types = { + 'operation_status': 'str', + 'error_message': 'str', + 'operation_name': 'str', + 'out_params': 'list[str]', + 'operation_result': 'list[OperationExecResult]' + } + + self.attribute_map = { + 'operation_status': 'operationStatus', + 'error_message': 'errorMessage', + 'operation_name': 'operationName', + 'out_params': 'outParams', + 'operation_result': 'operationResult' + } + + self._operation_status = None + self._error_message = None + self._operation_name = None + self._out_params = None + self._operation_result = None + + @property + def operation_status(self): + """ + **[Required]** Gets the operation_status of this ExecuteOperationJob. + Status of the operation job for all sets of input. + + + :return: The operation_status of this ExecuteOperationJob. + :rtype: str + """ + return self._operation_status + + @operation_status.setter + def operation_status(self, operation_status): + """ + Sets the operation_status of this ExecuteOperationJob. + Status of the operation job for all sets of input. + + + :param operation_status: The operation_status of this ExecuteOperationJob. + :type: str + """ + self._operation_status = operation_status + + @property + def error_message(self): + """ + Gets the error_message of this ExecuteOperationJob. + Error message, if whole operation is failed. + + + :return: The error_message of this ExecuteOperationJob. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this ExecuteOperationJob. + Error message, if whole operation is failed. + + + :param error_message: The error_message of this ExecuteOperationJob. + :type: str + """ + self._error_message = error_message + + @property + def operation_name(self): + """ + Gets the operation_name of this ExecuteOperationJob. + Name of the operation. + + + :return: The operation_name of this ExecuteOperationJob. + :rtype: str + """ + return self._operation_name + + @operation_name.setter + def operation_name(self, operation_name): + """ + Sets the operation_name of this ExecuteOperationJob. + Name of the operation. + + + :param operation_name: The operation_name of this ExecuteOperationJob. + :type: str + """ + self._operation_name = operation_name + + @property + def out_params(self): + """ + Gets the out_params of this ExecuteOperationJob. + List of names of OUT/INOUT params. + + + :return: The out_params of this ExecuteOperationJob. + :rtype: list[str] + """ + return self._out_params + + @out_params.setter + def out_params(self, out_params): + """ + Sets the out_params of this ExecuteOperationJob. + List of names of OUT/INOUT params. + + + :param out_params: The out_params of this ExecuteOperationJob. + :type: list[str] + """ + self._out_params = out_params + + @property + def operation_result(self): + """ + **[Required]** Gets the operation_result of this ExecuteOperationJob. + List of operation execution result for each input set. + + + :return: The operation_result of this ExecuteOperationJob. + :rtype: list[oci.data_connectivity.models.OperationExecResult] + """ + return self._operation_result + + @operation_result.setter + def operation_result(self, operation_result): + """ + Sets the operation_result of this ExecuteOperationJob. + List of operation execution result for each input set. + + + :param operation_result: The operation_result of this ExecuteOperationJob. + :type: list[oci.data_connectivity.models.OperationExecResult] + """ + self._operation_result = operation_result + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/execute_operation_job_details.py b/src/oci/data_connectivity/models/execute_operation_job_details.py new file mode 100644 index 0000000000..c7ec5a467c --- /dev/null +++ b/src/oci/data_connectivity/models/execute_operation_job_details.py @@ -0,0 +1,148 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ExecuteOperationJobDetails(object): + """ + Contains details of executeOperationJob. + """ + + #: A constant which can be used with the status property of a ExecuteOperationJobDetails. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a ExecuteOperationJobDetails. + #: This constant has a value of "SUCCESS" + STATUS_SUCCESS = "SUCCESS" + + def __init__(self, **kwargs): + """ + Initializes a new ExecuteOperationJobDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param execute_operation_job_id: + The value to assign to the execute_operation_job_id property of this ExecuteOperationJobDetails. + :type execute_operation_job_id: str + + :param status: + The value to assign to the status property of this ExecuteOperationJobDetails. + Allowed values for this property are: "FAILED", "SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param error_message: + The value to assign to the error_message property of this ExecuteOperationJobDetails. + :type error_message: str + + """ + self.swagger_types = { + 'execute_operation_job_id': 'str', + 'status': 'str', + 'error_message': 'str' + } + + self.attribute_map = { + 'execute_operation_job_id': 'executeOperationJobId', + 'status': 'status', + 'error_message': 'errorMessage' + } + + self._execute_operation_job_id = None + self._status = None + self._error_message = None + + @property + def execute_operation_job_id(self): + """ + **[Required]** Gets the execute_operation_job_id of this ExecuteOperationJobDetails. + Job id to track job status. + + + :return: The execute_operation_job_id of this ExecuteOperationJobDetails. + :rtype: str + """ + return self._execute_operation_job_id + + @execute_operation_job_id.setter + def execute_operation_job_id(self, execute_operation_job_id): + """ + Sets the execute_operation_job_id of this ExecuteOperationJobDetails. + Job id to track job status. + + + :param execute_operation_job_id: The execute_operation_job_id of this ExecuteOperationJobDetails. + :type: str + """ + self._execute_operation_job_id = execute_operation_job_id + + @property + def status(self): + """ + **[Required]** Gets the status of this ExecuteOperationJobDetails. + The status of job + + Allowed values for this property are: "FAILED", "SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this ExecuteOperationJobDetails. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this ExecuteOperationJobDetails. + The status of job + + + :param status: The status of this ExecuteOperationJobDetails. + :type: str + """ + allowed_values = ["FAILED", "SUCCESS"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def error_message(self): + """ + Gets the error_message of this ExecuteOperationJobDetails. + Error message if job creation is failed. + + + :return: The error_message of this ExecuteOperationJobDetails. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this ExecuteOperationJobDetails. + Error message if job creation is failed. + + + :param error_message: The error_message of this ExecuteOperationJobDetails. + :type: str + """ + self._error_message = error_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/external_storage.py b/src/oci/data_connectivity/models/external_storage.py new file mode 100644 index 0000000000..86192133c9 --- /dev/null +++ b/src/oci/data_connectivity/models/external_storage.py @@ -0,0 +1,235 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .connector_attribute import ConnectorAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ExternalStorage(ConnectorAttribute): + """ + BICC Connector Attribute.Object Storage as External storage where the BICC extracted files are written + """ + + def __init__(self, **kwargs): + """ + Initializes a new ExternalStorage object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ExternalStorage.model_type` attribute + of this class is ``EXTERNAL_STORAGE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ExternalStorage. + Allowed values for this property are: "EXTERNAL_STORAGE" + :type model_type: str + + :param storage_id: + The value to assign to the storage_id property of this ExternalStorage. + :type storage_id: str + + :param storage_name: + The value to assign to the storage_name property of this ExternalStorage. + :type storage_name: str + + :param host: + The value to assign to the host property of this ExternalStorage. + :type host: str + + :param tenancy_id: + The value to assign to the tenancy_id property of this ExternalStorage. + :type tenancy_id: str + + :param namespace: + The value to assign to the namespace property of this ExternalStorage. + :type namespace: str + + :param bucket: + The value to assign to the bucket property of this ExternalStorage. + :type bucket: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'storage_id': 'str', + 'storage_name': 'str', + 'host': 'str', + 'tenancy_id': 'str', + 'namespace': 'str', + 'bucket': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'storage_id': 'storageId', + 'storage_name': 'storageName', + 'host': 'host', + 'tenancy_id': 'tenancyId', + 'namespace': 'namespace', + 'bucket': 'bucket' + } + + self._model_type = None + self._storage_id = None + self._storage_name = None + self._host = None + self._tenancy_id = None + self._namespace = None + self._bucket = None + self._model_type = 'EXTERNAL_STORAGE' + + @property + def storage_id(self): + """ + Gets the storage_id of this ExternalStorage. + Id of the external stoarge configured in BICC console. Usually its numeric. + + + :return: The storage_id of this ExternalStorage. + :rtype: str + """ + return self._storage_id + + @storage_id.setter + def storage_id(self, storage_id): + """ + Sets the storage_id of this ExternalStorage. + Id of the external stoarge configured in BICC console. Usually its numeric. + + + :param storage_id: The storage_id of this ExternalStorage. + :type: str + """ + self._storage_id = storage_id + + @property + def storage_name(self): + """ + Gets the storage_name of this ExternalStorage. + Name of the external storage configured in BICC console + + + :return: The storage_name of this ExternalStorage. + :rtype: str + """ + return self._storage_name + + @storage_name.setter + def storage_name(self, storage_name): + """ + Sets the storage_name of this ExternalStorage. + Name of the external storage configured in BICC console + + + :param storage_name: The storage_name of this ExternalStorage. + :type: str + """ + self._storage_name = storage_name + + @property + def host(self): + """ + Gets the host of this ExternalStorage. + Object Storage host Url. DO not give http/https. + + + :return: The host of this ExternalStorage. + :rtype: str + """ + return self._host + + @host.setter + def host(self, host): + """ + Sets the host of this ExternalStorage. + Object Storage host Url. DO not give http/https. + + + :param host: The host of this ExternalStorage. + :type: str + """ + self._host = host + + @property + def tenancy_id(self): + """ + Gets the tenancy_id of this ExternalStorage. + Tenancy OCID for the OOS bucket + + + :return: The tenancy_id of this ExternalStorage. + :rtype: str + """ + return self._tenancy_id + + @tenancy_id.setter + def tenancy_id(self, tenancy_id): + """ + Sets the tenancy_id of this ExternalStorage. + Tenancy OCID for the OOS bucket + + + :param tenancy_id: The tenancy_id of this ExternalStorage. + :type: str + """ + self._tenancy_id = tenancy_id + + @property + def namespace(self): + """ + Gets the namespace of this ExternalStorage. + Namespace for the OOS bucket + + + :return: The namespace of this ExternalStorage. + :rtype: str + """ + return self._namespace + + @namespace.setter + def namespace(self, namespace): + """ + Sets the namespace of this ExternalStorage. + Namespace for the OOS bucket + + + :param namespace: The namespace of this ExternalStorage. + :type: str + """ + self._namespace = namespace + + @property + def bucket(self): + """ + Gets the bucket of this ExternalStorage. + Bucket Name where BICC extracts stores the files + + + :return: The bucket of this ExternalStorage. + :rtype: str + """ + return self._bucket + + @bucket.setter + def bucket(self, bucket): + """ + Sets the bucket of this ExternalStorage. + Bucket Name where BICC extracts stores the files + + + :param bucket: The bucket of this ExternalStorage. + :type: str + """ + self._bucket = bucket + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/filter_push.py b/src/oci/data_connectivity/models/filter_push.py new file mode 100644 index 0000000000..26693db33f --- /dev/null +++ b/src/oci/data_connectivity/models/filter_push.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .push_down_operation import PushDownOperation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FilterPush(PushDownOperation): + """ + The information about a filter operator. The filter operator lets you select certain attributes from the inbound port to continue downstream to the outbound port. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FilterPush object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.FilterPush.model_type` attribute + of this class is ``FILTER`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this FilterPush. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + :param filter_condition: + The value to assign to the filter_condition property of this FilterPush. + :type filter_condition: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'filter_condition': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'filter_condition': 'filterCondition' + } + + self._model_type = None + self._filter_condition = None + self._model_type = 'FILTER' + + @property + def filter_condition(self): + """ + Gets the filter_condition of this FilterPush. + The filter condition. + + + :return: The filter_condition of this FilterPush. + :rtype: str + """ + return self._filter_condition + + @filter_condition.setter + def filter_condition(self, filter_condition): + """ + Sets the filter_condition of this FilterPush. + The filter condition. + + + :param filter_condition: The filter_condition of this FilterPush. + :type: str + """ + self._filter_condition = filter_condition + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/folder.py b/src/oci/data_connectivity/models/folder.py new file mode 100644 index 0000000000..210bda114a --- /dev/null +++ b/src/oci/data_connectivity/models/folder.py @@ -0,0 +1,345 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Folder(object): + """ + The folder for a data asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Folder object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Folder. + :type model_type: str + + :param key: + The value to assign to the key property of this Folder. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Folder. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Folder. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this Folder. + :type name: str + + :param description: + The value to assign to the description property of this Folder. + :type description: str + + :param object_version: + The value to assign to the object_version property of this Folder. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this Folder. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this Folder. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this Folder. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this Folder. + The type of the folder. + + + :return: The model_type of this Folder. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this Folder. + The type of the folder. + + + :param model_type: The model_type of this Folder. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this Folder. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :return: The key of this Folder. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this Folder. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :param key: The key of this Folder. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this Folder. + The model version of an object. + + + :return: The model_version of this Folder. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this Folder. + The model version of an object. + + + :param model_version: The model_version of this Folder. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this Folder. + + :return: The parent_ref of this Folder. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this Folder. + + :param parent_ref: The parent_ref of this Folder. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this Folder. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this Folder. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Folder. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this Folder. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this Folder. + User-defined description for the folder. + + + :return: The description of this Folder. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Folder. + User-defined description for the folder. + + + :param description: The description of this Folder. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this Folder. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this Folder. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this Folder. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this Folder. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this Folder. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this Folder. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this Folder. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this Folder. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this Folder. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this Folder. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this Folder. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this Folder. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this Folder. + List of data assets which belongs to this folder + + + :return: The data_assets of this Folder. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this Folder. + List of data assets which belongs to this folder + + + :param data_assets: The data_assets of this Folder. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/folder_summary.py b/src/oci/data_connectivity/models/folder_summary.py new file mode 100644 index 0000000000..be7c64dfc2 --- /dev/null +++ b/src/oci/data_connectivity/models/folder_summary.py @@ -0,0 +1,345 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FolderSummary(object): + """ + The folder summary object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FolderSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this FolderSummary. + :type model_type: str + + :param key: + The value to assign to the key property of this FolderSummary. + :type key: str + + :param model_version: + The value to assign to the model_version property of this FolderSummary. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this FolderSummary. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this FolderSummary. + :type name: str + + :param description: + The value to assign to the description property of this FolderSummary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this FolderSummary. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this FolderSummary. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this FolderSummary. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this FolderSummary. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._data_assets = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this FolderSummary. + The type of the folder. + + + :return: The model_type of this FolderSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this FolderSummary. + The type of the folder. + + + :param model_type: The model_type of this FolderSummary. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this FolderSummary. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :return: The key of this FolderSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this FolderSummary. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :param key: The key of this FolderSummary. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this FolderSummary. + The model version of an object. + + + :return: The model_version of this FolderSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this FolderSummary. + The model version of an object. + + + :param model_version: The model_version of this FolderSummary. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this FolderSummary. + + :return: The parent_ref of this FolderSummary. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this FolderSummary. + + :param parent_ref: The parent_ref of this FolderSummary. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this FolderSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this FolderSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FolderSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this FolderSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this FolderSummary. + User-defined description for the folder. + + + :return: The description of this FolderSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this FolderSummary. + User-defined description for the folder. + + + :param description: The description of this FolderSummary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this FolderSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this FolderSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this FolderSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this FolderSummary. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this FolderSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this FolderSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this FolderSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this FolderSummary. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this FolderSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this FolderSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this FolderSummary. + Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this FolderSummary. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this FolderSummary. + List of data assets which belongs to this folder + + + :return: The data_assets of this FolderSummary. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this FolderSummary. + List of data assets which belongs to this folder + + + :param data_assets: The data_assets of this FolderSummary. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/folder_summary_collection.py b/src/oci/data_connectivity/models/folder_summary_collection.py new file mode 100644 index 0000000000..d125d13d27 --- /dev/null +++ b/src/oci/data_connectivity/models/folder_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FolderSummaryCollection(object): + """ + This is the collection of folder summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new FolderSummaryCollection 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 FolderSummaryCollection. + :type items: list[oci.data_connectivity.models.FolderSummary] + + """ + self.swagger_types = { + 'items': 'list[FolderSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this FolderSummaryCollection. + The array of folder summaries. + + + :return: The items of this FolderSummaryCollection. + :rtype: list[oci.data_connectivity.models.FolderSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this FolderSummaryCollection. + The array of folder summaries. + + + :param items: The items of this FolderSummaryCollection. + :type: list[oci.data_connectivity.models.FolderSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/foreign_key.py b/src/oci/data_connectivity/models/foreign_key.py new file mode 100644 index 0000000000..5508cb24f1 --- /dev/null +++ b/src/oci/data_connectivity/models/foreign_key.py @@ -0,0 +1,321 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .key import Key +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ForeignKey(Key): + """ + The foreign key object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ForeignKey object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ForeignKey.model_type` attribute + of this class is ``FOREIGN_KEY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ForeignKey. + Allowed values for this property are: "FOREIGN_KEY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this ForeignKey. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ForeignKey. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ForeignKey. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ForeignKey. + :type name: str + + :param attribute_refs: + The value to assign to the attribute_refs property of this ForeignKey. + :type attribute_refs: list[oci.data_connectivity.models.KeyAttribute] + + :param update_rule: + The value to assign to the update_rule property of this ForeignKey. + :type update_rule: int + + :param delete_rule: + The value to assign to the delete_rule property of this ForeignKey. + :type delete_rule: int + + :param reference_unique_key: + The value to assign to the reference_unique_key property of this ForeignKey. + :type reference_unique_key: oci.data_connectivity.models.UniqueKey + + :param object_status: + The value to assign to the object_status property of this ForeignKey. + :type object_status: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'attribute_refs': 'list[KeyAttribute]', + 'update_rule': 'int', + 'delete_rule': 'int', + 'reference_unique_key': 'UniqueKey', + 'object_status': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'attribute_refs': 'attributeRefs', + 'update_rule': 'updateRule', + 'delete_rule': 'deleteRule', + 'reference_unique_key': 'referenceUniqueKey', + 'object_status': 'objectStatus' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._attribute_refs = None + self._update_rule = None + self._delete_rule = None + self._reference_unique_key = None + self._object_status = None + self._model_type = 'FOREIGN_KEY' + + @property + def key(self): + """ + Gets the key of this ForeignKey. + The object key. + + + :return: The key of this ForeignKey. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ForeignKey. + The object key. + + + :param key: The key of this ForeignKey. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this ForeignKey. + The object's model version. + + + :return: The model_version of this ForeignKey. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ForeignKey. + The object's model version. + + + :param model_version: The model_version of this ForeignKey. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ForeignKey. + + :return: The parent_ref of this ForeignKey. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ForeignKey. + + :param parent_ref: The parent_ref of this ForeignKey. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this ForeignKey. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ForeignKey. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ForeignKey. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ForeignKey. + :type: str + """ + self._name = name + + @property + def attribute_refs(self): + """ + Gets the attribute_refs of this ForeignKey. + An array of attribute references. + + + :return: The attribute_refs of this ForeignKey. + :rtype: list[oci.data_connectivity.models.KeyAttribute] + """ + return self._attribute_refs + + @attribute_refs.setter + def attribute_refs(self, attribute_refs): + """ + Sets the attribute_refs of this ForeignKey. + An array of attribute references. + + + :param attribute_refs: The attribute_refs of this ForeignKey. + :type: list[oci.data_connectivity.models.KeyAttribute] + """ + self._attribute_refs = attribute_refs + + @property + def update_rule(self): + """ + Gets the update_rule of this ForeignKey. + The update rule. + + + :return: The update_rule of this ForeignKey. + :rtype: int + """ + return self._update_rule + + @update_rule.setter + def update_rule(self, update_rule): + """ + Sets the update_rule of this ForeignKey. + The update rule. + + + :param update_rule: The update_rule of this ForeignKey. + :type: int + """ + self._update_rule = update_rule + + @property + def delete_rule(self): + """ + Gets the delete_rule of this ForeignKey. + The delete rule. + + + :return: The delete_rule of this ForeignKey. + :rtype: int + """ + return self._delete_rule + + @delete_rule.setter + def delete_rule(self, delete_rule): + """ + Sets the delete_rule of this ForeignKey. + The delete rule. + + + :param delete_rule: The delete_rule of this ForeignKey. + :type: int + """ + self._delete_rule = delete_rule + + @property + def reference_unique_key(self): + """ + Gets the reference_unique_key of this ForeignKey. + + :return: The reference_unique_key of this ForeignKey. + :rtype: oci.data_connectivity.models.UniqueKey + """ + return self._reference_unique_key + + @reference_unique_key.setter + def reference_unique_key(self, reference_unique_key): + """ + Sets the reference_unique_key of this ForeignKey. + + :param reference_unique_key: The reference_unique_key of this ForeignKey. + :type: oci.data_connectivity.models.UniqueKey + """ + self._reference_unique_key = reference_unique_key + + @property + def object_status(self): + """ + Gets the object_status of this ForeignKey. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ForeignKey. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ForeignKey. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ForeignKey. + :type: int + """ + self._object_status = object_status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/full_push_down_task_response.py b/src/oci/data_connectivity/models/full_push_down_task_response.py new file mode 100644 index 0000000000..fa6fa45333 --- /dev/null +++ b/src/oci/data_connectivity/models/full_push_down_task_response.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FullPushDownTaskResponse(object): + """ + The full pushdown task + """ + + def __init__(self, **kwargs): + """ + Initializes a new FullPushDownTaskResponse object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this FullPushDownTaskResponse. + :type model_type: str + + :param error_message: + The value to assign to the error_message property of this FullPushDownTaskResponse. + :type error_message: str + + :param status: + The value to assign to the status property of this FullPushDownTaskResponse. + :type status: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'error_message': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'error_message': 'errorMessage', + 'status': 'status' + } + + self._model_type = None + self._error_message = None + self._status = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this FullPushDownTaskResponse. + The type of of FullPushDownTask Response. + + + :return: The model_type of this FullPushDownTaskResponse. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this FullPushDownTaskResponse. + The type of of FullPushDownTask Response. + + + :param model_type: The model_type of this FullPushDownTaskResponse. + :type: str + """ + self._model_type = model_type + + @property + def error_message(self): + """ + Gets the error_message of this FullPushDownTaskResponse. + The error message in response object. + + + :return: The error_message of this FullPushDownTaskResponse. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this FullPushDownTaskResponse. + The error message in response object. + + + :param error_message: The error_message of this FullPushDownTaskResponse. + :type: str + """ + self._error_message = error_message + + @property + def status(self): + """ + Gets the status of this FullPushDownTaskResponse. + The status of FullPushDownTask. + + + :return: The status of this FullPushDownTaskResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this FullPushDownTaskResponse. + The status of FullPushDownTask. + + + :param status: The status of this FullPushDownTaskResponse. + :type: str + """ + self._status = status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/hdfs_write_attributes.py b/src/oci/data_connectivity/models/hdfs_write_attributes.py new file mode 100644 index 0000000000..9623a2784f --- /dev/null +++ b/src/oci/data_connectivity/models/hdfs_write_attributes.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_write_attribute import AbstractWriteAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class HdfsWriteAttributes(AbstractWriteAttribute): + """ + Properties to configure writing to HDFS. + """ + + def __init__(self, **kwargs): + """ + Initializes a new HdfsWriteAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.HdfsWriteAttributes.model_type` attribute + of this class is ``HDFS_WRITE_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this HdfsWriteAttributes. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + :param write_to_single_file: + The value to assign to the write_to_single_file property of this HdfsWriteAttributes. + :type write_to_single_file: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'write_to_single_file': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'write_to_single_file': 'writeToSingleFile' + } + + self._model_type = None + self._write_to_single_file = None + self._model_type = 'HDFS_WRITE_ATTRIBUTE' + + @property + def write_to_single_file(self): + """ + Gets the write_to_single_file of this HdfsWriteAttributes. + Specifies whether to write output to single-file or not. + + + :return: The write_to_single_file of this HdfsWriteAttributes. + :rtype: bool + """ + return self._write_to_single_file + + @write_to_single_file.setter + def write_to_single_file(self, write_to_single_file): + """ + Sets the write_to_single_file of this HdfsWriteAttributes. + Specifies whether to write output to single-file or not. + + + :param write_to_single_file: The write_to_single_file of this HdfsWriteAttributes. + :type: bool + """ + self._write_to_single_file = write_to_single_file + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/histogram.py b/src/oci/data_connectivity/models/histogram.py new file mode 100644 index 0000000000..29201cc7d5 --- /dev/null +++ b/src/oci/data_connectivity/models/histogram.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Histogram(object): + """ + To capture all the histograms data related to profiling + """ + + def __init__(self, **kwargs): + """ + Initializes a new Histogram object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param ranges: + The value to assign to the ranges property of this Histogram. + :type ranges: list[str] + + :param counts: + The value to assign to the counts property of this Histogram. + :type counts: list[int] + + """ + self.swagger_types = { + 'ranges': 'list[str]', + 'counts': 'list[int]' + } + + self.attribute_map = { + 'ranges': 'ranges', + 'counts': 'counts' + } + + self._ranges = None + self._counts = None + + @property + def ranges(self): + """ + Gets the ranges of this Histogram. + Range of values + + + :return: The ranges of this Histogram. + :rtype: list[str] + """ + return self._ranges + + @ranges.setter + def ranges(self, ranges): + """ + Sets the ranges of this Histogram. + Range of values + + + :param ranges: The ranges of this Histogram. + :type: list[str] + """ + self._ranges = ranges + + @property + def counts(self): + """ + Gets the counts of this Histogram. + Count of each ranges. + + + :return: The counts of this Histogram. + :rtype: list[int] + """ + return self._counts + + @counts.setter + def counts(self, counts): + """ + Sets the counts of this Histogram. + Count of each ranges. + + + :param counts: The counts of this Histogram. + :type: list[int] + """ + self._counts = counts + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/input_port.py b/src/oci/data_connectivity/models/input_port.py new file mode 100644 index 0000000000..c5d7e44511 --- /dev/null +++ b/src/oci/data_connectivity/models/input_port.py @@ -0,0 +1,181 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class InputPort(TypedObject): + """ + The input port details. + """ + + #: A constant which can be used with the port_type property of a InputPort. + #: This constant has a value of "DATA" + PORT_TYPE_DATA = "DATA" + + #: A constant which can be used with the port_type property of a InputPort. + #: This constant has a value of "CONTROL" + PORT_TYPE_CONTROL = "CONTROL" + + #: A constant which can be used with the port_type property of a InputPort. + #: This constant has a value of "MODEL" + PORT_TYPE_MODEL = "MODEL" + + def __init__(self, **kwargs): + """ + Initializes a new InputPort object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.InputPort.model_type` attribute + of this class is ``INPUT_PORT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this InputPort. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this InputPort. + :type key: str + + :param model_version: + The value to assign to the model_version property of this InputPort. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this InputPort. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this InputPort. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this InputPort. + :type object_status: int + + :param name: + The value to assign to the name property of this InputPort. + :type name: str + + :param description: + The value to assign to the description property of this InputPort. + :type description: str + + :param port_type: + The value to assign to the port_type property of this InputPort. + Allowed values for this property are: "DATA", "CONTROL", "MODEL" + :type port_type: str + + :param fields: + The value to assign to the fields property of this InputPort. + :type fields: list[oci.data_connectivity.models.TypedObject] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'port_type': 'str', + 'fields': 'list[TypedObject]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'port_type': 'portType', + 'fields': 'fields' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._port_type = None + self._fields = None + self._model_type = 'INPUT_PORT' + + @property + def port_type(self): + """ + Gets the port_type of this InputPort. + The port details for the data asset.Type. + + Allowed values for this property are: "DATA", "CONTROL", "MODEL" + + + :return: The port_type of this InputPort. + :rtype: str + """ + return self._port_type + + @port_type.setter + def port_type(self, port_type): + """ + Sets the port_type of this InputPort. + The port details for the data asset.Type. + + + :param port_type: The port_type of this InputPort. + :type: str + """ + allowed_values = ["DATA", "CONTROL", "MODEL"] + if not value_allowed_none_or_none_sentinel(port_type, allowed_values): + raise ValueError( + "Invalid value for `port_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._port_type = port_type + + @property + def fields(self): + """ + Gets the fields of this InputPort. + An array of fields. + + + :return: The fields of this InputPort. + :rtype: list[oci.data_connectivity.models.TypedObject] + """ + return self._fields + + @fields.setter + def fields(self, fields): + """ + Sets the fields of this InputPort. + An array of fields. + + + :param fields: The fields of this InputPort. + :type: list[oci.data_connectivity.models.TypedObject] + """ + self._fields = fields + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/join.py b/src/oci/data_connectivity/models/join.py new file mode 100644 index 0000000000..ab767d55f2 --- /dev/null +++ b/src/oci/data_connectivity/models/join.py @@ -0,0 +1,136 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .push_down_operation import PushDownOperation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Join(PushDownOperation): + """ + The information about the join operator. The join operator links data from multiple inbound sources. + """ + + #: A constant which can be used with the policy property of a Join. + #: This constant has a value of "INNER_JOIN" + POLICY_INNER_JOIN = "INNER_JOIN" + + #: A constant which can be used with the policy property of a Join. + #: This constant has a value of "LEFT_JOIN" + POLICY_LEFT_JOIN = "LEFT_JOIN" + + #: A constant which can be used with the policy property of a Join. + #: This constant has a value of "RIGHT_JOIN" + POLICY_RIGHT_JOIN = "RIGHT_JOIN" + + #: A constant which can be used with the policy property of a Join. + #: This constant has a value of "FULL_JOIN" + POLICY_FULL_JOIN = "FULL_JOIN" + + def __init__(self, **kwargs): + """ + Initializes a new Join object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Join.model_type` attribute + of this class is ``JOIN`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Join. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + :param condition: + The value to assign to the condition property of this Join. + :type condition: str + + :param policy: + The value to assign to the policy property of this Join. + Allowed values for this property are: "INNER_JOIN", "LEFT_JOIN", "RIGHT_JOIN", "FULL_JOIN" + :type policy: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'condition': 'str', + 'policy': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'condition': 'condition', + 'policy': 'policy' + } + + self._model_type = None + self._condition = None + self._policy = None + self._model_type = 'JOIN' + + @property + def condition(self): + """ + **[Required]** Gets the condition of this Join. + The join condition. + + + :return: The condition of this Join. + :rtype: str + """ + return self._condition + + @condition.setter + def condition(self, condition): + """ + Sets the condition of this Join. + The join condition. + + + :param condition: The condition of this Join. + :type: str + """ + self._condition = condition + + @property + def policy(self): + """ + **[Required]** Gets the policy of this Join. + The type of join. + + Allowed values for this property are: "INNER_JOIN", "LEFT_JOIN", "RIGHT_JOIN", "FULL_JOIN" + + + :return: The policy of this Join. + :rtype: str + """ + return self._policy + + @policy.setter + def policy(self, policy): + """ + Sets the policy of this Join. + The type of join. + + + :param policy: The policy of this Join. + :type: str + """ + allowed_values = ["INNER_JOIN", "LEFT_JOIN", "RIGHT_JOIN", "FULL_JOIN"] + if not value_allowed_none_or_none_sentinel(policy, allowed_values): + raise ValueError( + "Invalid value for `policy`, must be None or one of {0}" + .format(allowed_values) + ) + self._policy = policy + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/json_format_attribute.py b/src/oci/data_connectivity/models/json_format_attribute.py new file mode 100644 index 0000000000..c058ab2f46 --- /dev/null +++ b/src/oci/data_connectivity/models/json_format_attribute.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_format_attribute import AbstractFormatAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class JsonFormatAttribute(AbstractFormatAttribute): + """ + The JSON file format attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new JsonFormatAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.JsonFormatAttribute.model_type` attribute + of this class is ``JSON_FORMAT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this JsonFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT" + :type model_type: str + + :param encoding: + The value to assign to the encoding property of this JsonFormatAttribute. + :type encoding: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'encoding': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'encoding': 'encoding' + } + + self._model_type = None + self._encoding = None + self._model_type = 'JSON_FORMAT' + + @property + def encoding(self): + """ + Gets the encoding of this JsonFormatAttribute. + The encoding for the file. + + + :return: The encoding of this JsonFormatAttribute. + :rtype: str + """ + return self._encoding + + @encoding.setter + def encoding(self, encoding): + """ + Sets the encoding of this JsonFormatAttribute. + The encoding for the file. + + + :param encoding: The encoding of this JsonFormatAttribute. + :type: str + """ + self._encoding = encoding + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/key.py b/src/oci/data_connectivity/models/key.py new file mode 100644 index 0000000000..d3d0340552 --- /dev/null +++ b/src/oci/data_connectivity/models/key.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Key(object): + """ + The key object. + """ + + #: A constant which can be used with the model_type property of a Key. + #: This constant has a value of "FOREIGN_KEY" + MODEL_TYPE_FOREIGN_KEY = "FOREIGN_KEY" + + def __init__(self, **kwargs): + """ + Initializes a new Key object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.ForeignKey` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Key. + Allowed values for this property are: "FOREIGN_KEY" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'FOREIGN_KEY': + return 'ForeignKey' + else: + return 'Key' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this Key. + The key type. + + Allowed values for this property are: "FOREIGN_KEY" + + + :return: The model_type of this Key. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this Key. + The key type. + + + :param model_type: The model_type of this Key. + :type: str + """ + allowed_values = ["FOREIGN_KEY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/key_attribute.py b/src/oci/data_connectivity/models/key_attribute.py new file mode 100644 index 0000000000..6131cb4bdd --- /dev/null +++ b/src/oci/data_connectivity/models/key_attribute.py @@ -0,0 +1,97 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KeyAttribute(object): + """ + An attribute within a key. + """ + + def __init__(self, **kwargs): + """ + Initializes a new KeyAttribute object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param position: + The value to assign to the position property of this KeyAttribute. + :type position: int + + :param attribute: + The value to assign to the attribute property of this KeyAttribute. + :type attribute: oci.data_connectivity.models.ShapeField + + """ + self.swagger_types = { + 'position': 'int', + 'attribute': 'ShapeField' + } + + self.attribute_map = { + 'position': 'position', + 'attribute': 'attribute' + } + + self._position = None + self._attribute = None + + @property + def position(self): + """ + Gets the position of this KeyAttribute. + The position of the attribute. + + + :return: The position of this KeyAttribute. + :rtype: int + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this KeyAttribute. + The position of the attribute. + + + :param position: The position of this KeyAttribute. + :type: int + """ + self._position = position + + @property + def attribute(self): + """ + Gets the attribute of this KeyAttribute. + + :return: The attribute of this KeyAttribute. + :rtype: oci.data_connectivity.models.ShapeField + """ + return self._attribute + + @attribute.setter + def attribute(self, attribute): + """ + Sets the attribute of this KeyAttribute. + + :param attribute: The attribute of this KeyAttribute. + :type: oci.data_connectivity.models.ShapeField + """ + self._attribute = attribute + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/key_range.py b/src/oci/data_connectivity/models/key_range.py new file mode 100644 index 0000000000..a70ce6dfc6 --- /dev/null +++ b/src/oci/data_connectivity/models/key_range.py @@ -0,0 +1,97 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KeyRange(object): + """ + The information about key range. + """ + + def __init__(self, **kwargs): + """ + Initializes a new KeyRange object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this KeyRange. + :type key: oci.data_connectivity.models.ShapeField + + :param range: + The value to assign to the range property of this KeyRange. + :type range: list[str] + + """ + self.swagger_types = { + 'key': 'ShapeField', + 'range': 'list[str]' + } + + self.attribute_map = { + 'key': 'key', + 'range': 'range' + } + + self._key = None + self._range = None + + @property + def key(self): + """ + Gets the key of this KeyRange. + + :return: The key of this KeyRange. + :rtype: oci.data_connectivity.models.ShapeField + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this KeyRange. + + :param key: The key of this KeyRange. + :type: oci.data_connectivity.models.ShapeField + """ + self._key = key + + @property + def range(self): + """ + Gets the range of this KeyRange. + The key range. + + + :return: The range of this KeyRange. + :rtype: list[str] + """ + return self._range + + @range.setter + def range(self, range): + """ + Sets the range of this KeyRange. + The key range. + + + :param range: The range of this KeyRange. + :type: list[str] + """ + self._range = range + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/key_range_partition_config.py b/src/oci/data_connectivity/models/key_range_partition_config.py new file mode 100644 index 0000000000..87c1767102 --- /dev/null +++ b/src/oci/data_connectivity/models/key_range_partition_config.py @@ -0,0 +1,107 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .partition_config import PartitionConfig +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class KeyRangePartitionConfig(PartitionConfig): + """ + The information about key range. + """ + + def __init__(self, **kwargs): + """ + Initializes a new KeyRangePartitionConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.KeyRangePartitionConfig.model_type` attribute + of this class is ``KEYRANGEPARTITIONCONFIG`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this KeyRangePartitionConfig. + Allowed values for this property are: "KEYRANGEPARTITIONCONFIG" + :type model_type: str + + :param partition_number: + The value to assign to the partition_number property of this KeyRangePartitionConfig. + :type partition_number: int + + :param key_range: + The value to assign to the key_range property of this KeyRangePartitionConfig. + :type key_range: oci.data_connectivity.models.KeyRange + + """ + self.swagger_types = { + 'model_type': 'str', + 'partition_number': 'int', + 'key_range': 'KeyRange' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'partition_number': 'partitionNumber', + 'key_range': 'keyRange' + } + + self._model_type = None + self._partition_number = None + self._key_range = None + self._model_type = 'KEYRANGEPARTITIONCONFIG' + + @property + def partition_number(self): + """ + Gets the partition_number of this KeyRangePartitionConfig. + The partition number for the key range. + + + :return: The partition_number of this KeyRangePartitionConfig. + :rtype: int + """ + return self._partition_number + + @partition_number.setter + def partition_number(self, partition_number): + """ + Sets the partition_number of this KeyRangePartitionConfig. + The partition number for the key range. + + + :param partition_number: The partition_number of this KeyRangePartitionConfig. + :type: int + """ + self._partition_number = partition_number + + @property + def key_range(self): + """ + Gets the key_range of this KeyRangePartitionConfig. + + :return: The key_range of this KeyRangePartitionConfig. + :rtype: oci.data_connectivity.models.KeyRange + """ + return self._key_range + + @key_range.setter + def key_range(self, key_range): + """ + Sets the key_range of this KeyRangePartitionConfig. + + :param key_range: The key_range of this KeyRangePartitionConfig. + :type: oci.data_connectivity.models.KeyRange + """ + self._key_range = key_range + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/message.py b/src/oci/data_connectivity/models/message.py new file mode 100644 index 0000000000..bb79b212c8 --- /dev/null +++ b/src/oci/data_connectivity/models/message.py @@ -0,0 +1,152 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Message(object): + """ + The details of a message. + """ + + #: A constant which can be used with the type property of a Message. + #: This constant has a value of "ERROR" + TYPE_ERROR = "ERROR" + + #: A constant which can be used with the type property of a Message. + #: This constant has a value of "WARNING" + TYPE_WARNING = "WARNING" + + #: A constant which can be used with the type property of a Message. + #: This constant has a value of "INFO" + TYPE_INFO = "INFO" + + def __init__(self, **kwargs): + """ + Initializes a new Message object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param type: + The value to assign to the type property of this Message. + Allowed values for this property are: "ERROR", "WARNING", "INFO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param code: + The value to assign to the code property of this Message. + :type code: str + + :param message: + The value to assign to the message property of this Message. + :type message: str + + """ + self.swagger_types = { + 'type': 'str', + 'code': 'str', + 'message': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'code': 'code', + 'message': 'message' + } + + self._type = None + self._code = None + self._message = None + + @property + def type(self): + """ + **[Required]** Gets the type of this Message. + The type of message (error, warning, or info). + + Allowed values for this property are: "ERROR", "WARNING", "INFO", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this Message. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Message. + The type of message (error, warning, or info). + + + :param type: The type of this Message. + :type: str + """ + allowed_values = ["ERROR", "WARNING", "INFO"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def code(self): + """ + **[Required]** Gets the code of this Message. + The message code. + + + :return: The code of this Message. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this Message. + The message code. + + + :param code: The code of this Message. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this Message. + The message text. + + + :return: The message of this Message. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this Message. + The message text. + + + :param message: The message of this Message. + :type: str + """ + self._message = message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/native_shape_field.py b/src/oci/data_connectivity/models/native_shape_field.py new file mode 100644 index 0000000000..a6f712e164 --- /dev/null +++ b/src/oci/data_connectivity/models/native_shape_field.py @@ -0,0 +1,222 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NativeShapeField(TypedObject): + """ + The native shape field object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NativeShapeField object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.NativeShapeField.model_type` attribute + of this class is ``NATIVE_SHAPE_FIELD`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this NativeShapeField. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this NativeShapeField. + :type key: str + + :param model_version: + The value to assign to the model_version property of this NativeShapeField. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this NativeShapeField. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this NativeShapeField. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this NativeShapeField. + :type object_status: int + + :param name: + The value to assign to the name property of this NativeShapeField. + :type name: str + + :param description: + The value to assign to the description property of this NativeShapeField. + :type description: str + + :param type: + The value to assign to the type property of this NativeShapeField. + :type type: object + + :param position: + The value to assign to the position property of this NativeShapeField. + :type position: int + + :param default_value_string: + The value to assign to the default_value_string property of this NativeShapeField. + :type default_value_string: str + + :param is_mandatory: + The value to assign to the is_mandatory property of this NativeShapeField. + :type is_mandatory: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'type': 'object', + 'position': 'int', + 'default_value_string': 'str', + 'is_mandatory': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'type': 'type', + 'position': 'position', + 'default_value_string': 'defaultValueString', + 'is_mandatory': 'isMandatory' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._type = None + self._position = None + self._default_value_string = None + self._is_mandatory = None + self._model_type = 'NATIVE_SHAPE_FIELD' + + @property + def type(self): + """ + **[Required]** Gets the type of this NativeShapeField. + The type reference. + + + :return: The type of this NativeShapeField. + :rtype: object + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this NativeShapeField. + The type reference. + + + :param type: The type of this NativeShapeField. + :type: object + """ + self._type = type + + @property + def position(self): + """ + Gets the position of this NativeShapeField. + The position of the attribute. + + + :return: The position of this NativeShapeField. + :rtype: int + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this NativeShapeField. + The position of the attribute. + + + :param position: The position of this NativeShapeField. + :type: int + """ + self._position = position + + @property + def default_value_string(self): + """ + Gets the default_value_string of this NativeShapeField. + The default value. + + + :return: The default_value_string of this NativeShapeField. + :rtype: str + """ + return self._default_value_string + + @default_value_string.setter + def default_value_string(self, default_value_string): + """ + Sets the default_value_string of this NativeShapeField. + The default value. + + + :param default_value_string: The default_value_string of this NativeShapeField. + :type: str + """ + self._default_value_string = default_value_string + + @property + def is_mandatory(self): + """ + Gets the is_mandatory of this NativeShapeField. + Specifies whether the field is mandatory. + + + :return: The is_mandatory of this NativeShapeField. + :rtype: bool + """ + return self._is_mandatory + + @is_mandatory.setter + def is_mandatory(self, is_mandatory): + """ + Sets the is_mandatory of this NativeShapeField. + Specifies whether the field is mandatory. + + + :param is_mandatory: The is_mandatory of this NativeShapeField. + :type: bool + """ + self._is_mandatory = is_mandatory + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/network_connectivity_status.py b/src/oci/data_connectivity/models/network_connectivity_status.py new file mode 100644 index 0000000000..8996b3131c --- /dev/null +++ b/src/oci/data_connectivity/models/network_connectivity_status.py @@ -0,0 +1,214 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NetworkConnectivityStatus(object): + """ + The network validation status for a Private Endpoint - Data Asset pair. + """ + + #: A constant which can be used with the network_validation_status_enum property of a NetworkConnectivityStatus. + #: This constant has a value of "REACHABLE" + NETWORK_VALIDATION_STATUS_ENUM_REACHABLE = "REACHABLE" + + #: A constant which can be used with the network_validation_status_enum property of a NetworkConnectivityStatus. + #: This constant has a value of "NOT_REACHABLE" + NETWORK_VALIDATION_STATUS_ENUM_NOT_REACHABLE = "NOT_REACHABLE" + + #: A constant which can be used with the network_validation_status_enum property of a NetworkConnectivityStatus. + #: This constant has a value of "ERROR" + NETWORK_VALIDATION_STATUS_ENUM_ERROR = "ERROR" + + def __init__(self, **kwargs): + """ + Initializes a new NetworkConnectivityStatus object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_asset_key: + The value to assign to the data_asset_key property of this NetworkConnectivityStatus. + :type data_asset_key: str + + :param private_end_point_key: + The value to assign to the private_end_point_key property of this NetworkConnectivityStatus. + :type private_end_point_key: str + + :param error_message: + The value to assign to the error_message property of this NetworkConnectivityStatus. + :type error_message: str + + :param time_last_updated: + The value to assign to the time_last_updated property of this NetworkConnectivityStatus. + :type time_last_updated: datetime + + :param network_validation_status_enum: + The value to assign to the network_validation_status_enum property of this NetworkConnectivityStatus. + Allowed values for this property are: "REACHABLE", "NOT_REACHABLE", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type network_validation_status_enum: str + + """ + self.swagger_types = { + 'data_asset_key': 'str', + 'private_end_point_key': 'str', + 'error_message': 'str', + 'time_last_updated': 'datetime', + 'network_validation_status_enum': 'str' + } + + self.attribute_map = { + 'data_asset_key': 'dataAssetKey', + 'private_end_point_key': 'privateEndPointKey', + 'error_message': 'errorMessage', + 'time_last_updated': 'timeLastUpdated', + 'network_validation_status_enum': 'networkValidationStatusEnum' + } + + self._data_asset_key = None + self._private_end_point_key = None + self._error_message = None + self._time_last_updated = None + self._network_validation_status_enum = None + + @property + def data_asset_key(self): + """ + **[Required]** Gets the data_asset_key of this NetworkConnectivityStatus. + DataAsset key to which the NetworkValidationStatus belongs to. + + + :return: The data_asset_key of this NetworkConnectivityStatus. + :rtype: str + """ + return self._data_asset_key + + @data_asset_key.setter + def data_asset_key(self, data_asset_key): + """ + Sets the data_asset_key of this NetworkConnectivityStatus. + DataAsset key to which the NetworkValidationStatus belongs to. + + + :param data_asset_key: The data_asset_key of this NetworkConnectivityStatus. + :type: str + """ + self._data_asset_key = data_asset_key + + @property + def private_end_point_key(self): + """ + Gets the private_end_point_key of this NetworkConnectivityStatus. + PrivateEndpoint key, if any, to which the NetworkValidationStatus belongs to. + + + :return: The private_end_point_key of this NetworkConnectivityStatus. + :rtype: str + """ + return self._private_end_point_key + + @private_end_point_key.setter + def private_end_point_key(self, private_end_point_key): + """ + Sets the private_end_point_key of this NetworkConnectivityStatus. + PrivateEndpoint key, if any, to which the NetworkValidationStatus belongs to. + + + :param private_end_point_key: The private_end_point_key of this NetworkConnectivityStatus. + :type: str + """ + self._private_end_point_key = private_end_point_key + + @property + def error_message(self): + """ + Gets the error_message of this NetworkConnectivityStatus. + Exception or error message encountered while testing network reachability for the data asset. + + + :return: The error_message of this NetworkConnectivityStatus. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this NetworkConnectivityStatus. + Exception or error message encountered while testing network reachability for the data asset. + + + :param error_message: The error_message of this NetworkConnectivityStatus. + :type: str + """ + self._error_message = error_message + + @property + def time_last_updated(self): + """ + Gets the time_last_updated of this NetworkConnectivityStatus. + Instant when the network validation was last done for the given DataAsset-PrivateEndpoint pair.. + + + :return: The time_last_updated of this NetworkConnectivityStatus. + :rtype: datetime + """ + return self._time_last_updated + + @time_last_updated.setter + def time_last_updated(self, time_last_updated): + """ + Sets the time_last_updated of this NetworkConnectivityStatus. + Instant when the network validation was last done for the given DataAsset-PrivateEndpoint pair.. + + + :param time_last_updated: The time_last_updated of this NetworkConnectivityStatus. + :type: datetime + """ + self._time_last_updated = time_last_updated + + @property + def network_validation_status_enum(self): + """ + Gets the network_validation_status_enum of this NetworkConnectivityStatus. + Exception or error message encountered while testing network reachability for the data asset. + + Allowed values for this property are: "REACHABLE", "NOT_REACHABLE", "ERROR", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The network_validation_status_enum of this NetworkConnectivityStatus. + :rtype: str + """ + return self._network_validation_status_enum + + @network_validation_status_enum.setter + def network_validation_status_enum(self, network_validation_status_enum): + """ + Sets the network_validation_status_enum of this NetworkConnectivityStatus. + Exception or error message encountered while testing network reachability for the data asset. + + + :param network_validation_status_enum: The network_validation_status_enum of this NetworkConnectivityStatus. + :type: str + """ + allowed_values = ["REACHABLE", "NOT_REACHABLE", "ERROR"] + if not value_allowed_none_or_none_sentinel(network_validation_status_enum, allowed_values): + network_validation_status_enum = 'UNKNOWN_ENUM_VALUE' + self._network_validation_status_enum = network_validation_status_enum + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/network_connectivity_status_collection.py b/src/oci/data_connectivity/models/network_connectivity_status_collection.py new file mode 100644 index 0000000000..2bd240e1fd --- /dev/null +++ b/src/oci/data_connectivity/models/network_connectivity_status_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NetworkConnectivityStatusCollection(object): + """ + This is a collection of NetworkConnectivityStatus. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NetworkConnectivityStatusCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param network_connectivity_status_list: + The value to assign to the network_connectivity_status_list property of this NetworkConnectivityStatusCollection. + :type network_connectivity_status_list: list[oci.data_connectivity.models.NetworkConnectivityStatus] + + """ + self.swagger_types = { + 'network_connectivity_status_list': 'list[NetworkConnectivityStatus]' + } + + self.attribute_map = { + 'network_connectivity_status_list': 'networkConnectivityStatusList' + } + + self._network_connectivity_status_list = None + + @property + def network_connectivity_status_list(self): + """ + **[Required]** Gets the network_connectivity_status_list of this NetworkConnectivityStatusCollection. + The array of NetworkConnectivityStatus. + + + :return: The network_connectivity_status_list of this NetworkConnectivityStatusCollection. + :rtype: list[oci.data_connectivity.models.NetworkConnectivityStatus] + """ + return self._network_connectivity_status_list + + @network_connectivity_status_list.setter + def network_connectivity_status_list(self, network_connectivity_status_list): + """ + Sets the network_connectivity_status_list of this NetworkConnectivityStatusCollection. + The array of NetworkConnectivityStatus. + + + :param network_connectivity_status_list: The network_connectivity_status_list of this NetworkConnectivityStatusCollection. + :type: list[oci.data_connectivity.models.NetworkConnectivityStatus] + """ + self._network_connectivity_status_list = network_connectivity_status_list + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/numeric_attribute.py b/src/oci/data_connectivity/models/numeric_attribute.py new file mode 100644 index 0000000000..fa5a13ad67 --- /dev/null +++ b/src/oci/data_connectivity/models/numeric_attribute.py @@ -0,0 +1,297 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .attribute_profile_result import AttributeProfileResult +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class NumericAttribute(AttributeProfileResult): + """ + A summary of profiling results of a specefic attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new NumericAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.NumericAttribute.type` attribute + of this class is ``NUMERIC`` 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 NumericAttribute. + :type type: object + + :param name: + The value to assign to the name property of this NumericAttribute. + :type name: str + + :param min: + The value to assign to the min property of this NumericAttribute. + :type min: oci.data_connectivity.models.ProfileStat + + :param max: + The value to assign to the max property of this NumericAttribute. + :type max: oci.data_connectivity.models.ProfileStat + + :param null_count: + The value to assign to the null_count property of this NumericAttribute. + :type null_count: oci.data_connectivity.models.ProfileStat + + :param distinct_count: + The value to assign to the distinct_count property of this NumericAttribute. + :type distinct_count: oci.data_connectivity.models.ProfileStat + + :param unique_count: + The value to assign to the unique_count property of this NumericAttribute. + :type unique_count: oci.data_connectivity.models.ProfileStat + + :param duplicate_count: + The value to assign to the duplicate_count property of this NumericAttribute. + :type duplicate_count: oci.data_connectivity.models.ProfileStat + + :param value_frequencies: + The value to assign to the value_frequencies property of this NumericAttribute. + :type value_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + :param mean: + The value to assign to the mean property of this NumericAttribute. + :type mean: oci.data_connectivity.models.ProfileStat + + :param median: + The value to assign to the median property of this NumericAttribute. + :type median: oci.data_connectivity.models.ProfileStat + + :param standard_deviation: + The value to assign to the standard_deviation property of this NumericAttribute. + :type standard_deviation: oci.data_connectivity.models.ProfileStat + + :param variance: + The value to assign to the variance property of this NumericAttribute. + :type variance: oci.data_connectivity.models.ProfileStat + + :param outlier: + The value to assign to the outlier property of this NumericAttribute. + :type outlier: oci.data_connectivity.models.Outlier + + :param histogram: + The value to assign to the histogram property of this NumericAttribute. + :type histogram: oci.data_connectivity.models.Histogram + + :param pattern_frequencies: + The value to assign to the pattern_frequencies property of this NumericAttribute. + :type pattern_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + """ + self.swagger_types = { + 'type': 'object', + 'name': 'str', + 'min': 'ProfileStat', + 'max': 'ProfileStat', + 'null_count': 'ProfileStat', + 'distinct_count': 'ProfileStat', + 'unique_count': 'ProfileStat', + 'duplicate_count': 'ProfileStat', + 'value_frequencies': 'list[ObjectFreqStat]', + 'mean': 'ProfileStat', + 'median': 'ProfileStat', + 'standard_deviation': 'ProfileStat', + 'variance': 'ProfileStat', + 'outlier': 'Outlier', + 'histogram': 'Histogram', + 'pattern_frequencies': 'list[ObjectFreqStat]' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name', + 'min': 'min', + 'max': 'max', + 'null_count': 'nullCount', + 'distinct_count': 'distinctCount', + 'unique_count': 'uniqueCount', + 'duplicate_count': 'duplicateCount', + 'value_frequencies': 'valueFrequencies', + 'mean': 'mean', + 'median': 'median', + 'standard_deviation': 'standardDeviation', + 'variance': 'variance', + 'outlier': 'outlier', + 'histogram': 'histogram', + 'pattern_frequencies': 'patternFrequencies' + } + + self._type = None + self._name = None + self._min = None + self._max = None + self._null_count = None + self._distinct_count = None + self._unique_count = None + self._duplicate_count = None + self._value_frequencies = None + self._mean = None + self._median = None + self._standard_deviation = None + self._variance = None + self._outlier = None + self._histogram = None + self._pattern_frequencies = None + self._type = 'NUMERIC' + + @property + def mean(self): + """ + Gets the mean of this NumericAttribute. + + :return: The mean of this NumericAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._mean + + @mean.setter + def mean(self, mean): + """ + Sets the mean of this NumericAttribute. + + :param mean: The mean of this NumericAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._mean = mean + + @property + def median(self): + """ + Gets the median of this NumericAttribute. + + :return: The median of this NumericAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._median + + @median.setter + def median(self, median): + """ + Sets the median of this NumericAttribute. + + :param median: The median of this NumericAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._median = median + + @property + def standard_deviation(self): + """ + Gets the standard_deviation of this NumericAttribute. + + :return: The standard_deviation of this NumericAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._standard_deviation + + @standard_deviation.setter + def standard_deviation(self, standard_deviation): + """ + Sets the standard_deviation of this NumericAttribute. + + :param standard_deviation: The standard_deviation of this NumericAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._standard_deviation = standard_deviation + + @property + def variance(self): + """ + Gets the variance of this NumericAttribute. + + :return: The variance of this NumericAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._variance + + @variance.setter + def variance(self, variance): + """ + Sets the variance of this NumericAttribute. + + :param variance: The variance of this NumericAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._variance = variance + + @property + def outlier(self): + """ + Gets the outlier of this NumericAttribute. + + :return: The outlier of this NumericAttribute. + :rtype: oci.data_connectivity.models.Outlier + """ + return self._outlier + + @outlier.setter + def outlier(self, outlier): + """ + Sets the outlier of this NumericAttribute. + + :param outlier: The outlier of this NumericAttribute. + :type: oci.data_connectivity.models.Outlier + """ + self._outlier = outlier + + @property + def histogram(self): + """ + Gets the histogram of this NumericAttribute. + + :return: The histogram of this NumericAttribute. + :rtype: oci.data_connectivity.models.Histogram + """ + return self._histogram + + @histogram.setter + def histogram(self, histogram): + """ + Sets the histogram of this NumericAttribute. + + :param histogram: The histogram of this NumericAttribute. + :type: oci.data_connectivity.models.Histogram + """ + self._histogram = histogram + + @property + def pattern_frequencies(self): + """ + Gets the pattern_frequencies of this NumericAttribute. + Pattern frequencies for the column as described already in profile config. + + + :return: The pattern_frequencies of this NumericAttribute. + :rtype: list[oci.data_connectivity.models.ObjectFreqStat] + """ + return self._pattern_frequencies + + @pattern_frequencies.setter + def pattern_frequencies(self, pattern_frequencies): + """ + Sets the pattern_frequencies of this NumericAttribute. + Pattern frequencies for the column as described already in profile config. + + + :param pattern_frequencies: The pattern_frequencies of this NumericAttribute. + :type: list[oci.data_connectivity.models.ObjectFreqStat] + """ + self._pattern_frequencies = pattern_frequencies + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/object_freq_stat.py b/src/oci/data_connectivity/models/object_freq_stat.py new file mode 100644 index 0000000000..7d827d1b2a --- /dev/null +++ b/src/oci/data_connectivity/models/object_freq_stat.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectFreqStat(object): + """ + One specific element. Its meaning changes in the context i.e. For ValueFrequency, the value represents a column value. For Patterns the value represents a pattern. For DataType the value represents a data type. For DataType formats (pertaining to date time) the value represent a format. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectFreqStat object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param value: + The value to assign to the value property of this ObjectFreqStat. + :type value: str + + :param confidence: + The value to assign to the confidence property of this ObjectFreqStat. + :type confidence: int + + :param freq: + The value to assign to the freq property of this ObjectFreqStat. + :type freq: int + + :param freq_percentage: + The value to assign to the freq_percentage property of this ObjectFreqStat. + :type freq_percentage: float + + """ + self.swagger_types = { + 'value': 'str', + 'confidence': 'int', + 'freq': 'int', + 'freq_percentage': 'float' + } + + self.attribute_map = { + 'value': 'value', + 'confidence': 'confidence', + 'freq': 'freq', + 'freq_percentage': 'freqPercentage' + } + + self._value = None + self._confidence = None + self._freq = None + self._freq_percentage = None + + @property + def value(self): + """ + Gets the value of this ObjectFreqStat. + Value of the confidence of the profile result + + + :return: The value of this ObjectFreqStat. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ObjectFreqStat. + Value of the confidence of the profile result + + + :param value: The value of this ObjectFreqStat. + :type: str + """ + self._value = value + + @property + def confidence(self): + """ + Gets the confidence of this ObjectFreqStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :return: The confidence of this ObjectFreqStat. + :rtype: int + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this ObjectFreqStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :param confidence: The confidence of this ObjectFreqStat. + :type: int + """ + self._confidence = confidence + + @property + def freq(self): + """ + Gets the freq of this ObjectFreqStat. + How many times that value occurred. + + + :return: The freq of this ObjectFreqStat. + :rtype: int + """ + return self._freq + + @freq.setter + def freq(self, freq): + """ + Sets the freq of this ObjectFreqStat. + How many times that value occurred. + + + :param freq: The freq of this ObjectFreqStat. + :type: int + """ + self._freq = freq + + @property + def freq_percentage(self): + """ + Gets the freq_percentage of this ObjectFreqStat. + Frequency percentage across the sampled row counts (excluding nulls). + + + :return: The freq_percentage of this ObjectFreqStat. + :rtype: float + """ + return self._freq_percentage + + @freq_percentage.setter + def freq_percentage(self, freq_percentage): + """ + Sets the freq_percentage of this ObjectFreqStat. + Frequency percentage across the sampled row counts (excluding nulls). + + + :param freq_percentage: The freq_percentage of this ObjectFreqStat. + :type: float + """ + self._freq_percentage = freq_percentage + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/object_metadata.py b/src/oci/data_connectivity/models/object_metadata.py new file mode 100644 index 0000000000..c115e7e1db --- /dev/null +++ b/src/oci/data_connectivity/models/object_metadata.py @@ -0,0 +1,438 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectMetadata(object): + """ + A summary type containing information about the object including its key, name and when/who created/updated it. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectMetadata object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param created_by: + The value to assign to the created_by property of this ObjectMetadata. + :type created_by: str + + :param created_by_name: + The value to assign to the created_by_name property of this ObjectMetadata. + :type created_by_name: str + + :param updated_by: + The value to assign to the updated_by property of this ObjectMetadata. + :type updated_by: str + + :param updated_by_name: + The value to assign to the updated_by_name property of this ObjectMetadata. + :type updated_by_name: str + + :param time_created: + The value to assign to the time_created property of this ObjectMetadata. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this ObjectMetadata. + :type time_updated: datetime + + :param aggregator_key: + The value to assign to the aggregator_key property of this ObjectMetadata. + :type aggregator_key: str + + :param aggregator: + The value to assign to the aggregator property of this ObjectMetadata. + :type aggregator: oci.data_connectivity.models.AggregatorSummary + + :param identifier_path: + The value to assign to the identifier_path property of this ObjectMetadata. + :type identifier_path: str + + :param info_fields: + The value to assign to the info_fields property of this ObjectMetadata. + :type info_fields: dict(str, str) + + :param registry_version: + The value to assign to the registry_version property of this ObjectMetadata. + :type registry_version: int + + :param labels: + The value to assign to the labels property of this ObjectMetadata. + :type labels: list[str] + + :param is_favorite: + The value to assign to the is_favorite property of this ObjectMetadata. + :type is_favorite: bool + + """ + self.swagger_types = { + 'created_by': 'str', + 'created_by_name': 'str', + 'updated_by': 'str', + 'updated_by_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'aggregator_key': 'str', + 'aggregator': 'AggregatorSummary', + 'identifier_path': 'str', + 'info_fields': 'dict(str, str)', + 'registry_version': 'int', + 'labels': 'list[str]', + 'is_favorite': 'bool' + } + + self.attribute_map = { + 'created_by': 'createdBy', + 'created_by_name': 'createdByName', + 'updated_by': 'updatedBy', + 'updated_by_name': 'updatedByName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'aggregator_key': 'aggregatorKey', + 'aggregator': 'aggregator', + 'identifier_path': 'identifierPath', + 'info_fields': 'infoFields', + 'registry_version': 'registryVersion', + 'labels': 'labels', + 'is_favorite': 'isFavorite' + } + + self._created_by = None + self._created_by_name = None + self._updated_by = None + self._updated_by_name = None + self._time_created = None + self._time_updated = None + self._aggregator_key = None + self._aggregator = None + self._identifier_path = None + self._info_fields = None + self._registry_version = None + self._labels = None + self._is_favorite = None + + @property + def created_by(self): + """ + Gets the created_by of this ObjectMetadata. + The user that created the object. + + + :return: The created_by of this ObjectMetadata. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this ObjectMetadata. + The user that created the object. + + + :param created_by: The created_by of this ObjectMetadata. + :type: str + """ + self._created_by = created_by + + @property + def created_by_name(self): + """ + Gets the created_by_name of this ObjectMetadata. + The user that created the object. + + + :return: The created_by_name of this ObjectMetadata. + :rtype: str + """ + return self._created_by_name + + @created_by_name.setter + def created_by_name(self, created_by_name): + """ + Sets the created_by_name of this ObjectMetadata. + The user that created the object. + + + :param created_by_name: The created_by_name of this ObjectMetadata. + :type: str + """ + self._created_by_name = created_by_name + + @property + def updated_by(self): + """ + Gets the updated_by of this ObjectMetadata. + The user that updated the object. + + + :return: The updated_by of this ObjectMetadata. + :rtype: str + """ + return self._updated_by + + @updated_by.setter + def updated_by(self, updated_by): + """ + Sets the updated_by of this ObjectMetadata. + The user that updated the object. + + + :param updated_by: The updated_by of this ObjectMetadata. + :type: str + """ + self._updated_by = updated_by + + @property + def updated_by_name(self): + """ + Gets the updated_by_name of this ObjectMetadata. + The user that updated the object. + + + :return: The updated_by_name of this ObjectMetadata. + :rtype: str + """ + return self._updated_by_name + + @updated_by_name.setter + def updated_by_name(self, updated_by_name): + """ + Sets the updated_by_name of this ObjectMetadata. + The user that updated the object. + + + :param updated_by_name: The updated_by_name of this ObjectMetadata. + :type: str + """ + self._updated_by_name = updated_by_name + + @property + def time_created(self): + """ + Gets the time_created of this ObjectMetadata. + The date and time that the object was created. + + + :return: The time_created of this ObjectMetadata. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this ObjectMetadata. + The date and time that the object was created. + + + :param time_created: The time_created of this ObjectMetadata. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this ObjectMetadata. + The date and time that the object was updated. + + + :return: The time_updated of this ObjectMetadata. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this ObjectMetadata. + The date and time that the object was updated. + + + :param time_updated: The time_updated of this ObjectMetadata. + :type: datetime + """ + self._time_updated = time_updated + + @property + def aggregator_key(self): + """ + Gets the aggregator_key of this ObjectMetadata. + The owning object key for this object. + + + :return: The aggregator_key of this ObjectMetadata. + :rtype: str + """ + return self._aggregator_key + + @aggregator_key.setter + def aggregator_key(self, aggregator_key): + """ + Sets the aggregator_key of this ObjectMetadata. + The owning object key for this object. + + + :param aggregator_key: The aggregator_key of this ObjectMetadata. + :type: str + """ + self._aggregator_key = aggregator_key + + @property + def aggregator(self): + """ + Gets the aggregator of this ObjectMetadata. + + :return: The aggregator of this ObjectMetadata. + :rtype: oci.data_connectivity.models.AggregatorSummary + """ + return self._aggregator + + @aggregator.setter + def aggregator(self, aggregator): + """ + Sets the aggregator of this ObjectMetadata. + + :param aggregator: The aggregator of this ObjectMetadata. + :type: oci.data_connectivity.models.AggregatorSummary + """ + self._aggregator = aggregator + + @property + def identifier_path(self): + """ + Gets the identifier_path of this ObjectMetadata. + The full path to identify this object. + + + :return: The identifier_path of this ObjectMetadata. + :rtype: str + """ + return self._identifier_path + + @identifier_path.setter + def identifier_path(self, identifier_path): + """ + Sets the identifier_path of this ObjectMetadata. + The full path to identify this object. + + + :param identifier_path: The identifier_path of this ObjectMetadata. + :type: str + """ + self._identifier_path = identifier_path + + @property + def info_fields(self): + """ + Gets the info_fields of this ObjectMetadata. + Information property fields. + + + :return: The info_fields of this ObjectMetadata. + :rtype: dict(str, str) + """ + return self._info_fields + + @info_fields.setter + def info_fields(self, info_fields): + """ + Sets the info_fields of this ObjectMetadata. + Information property fields. + + + :param info_fields: The info_fields of this ObjectMetadata. + :type: dict(str, str) + """ + self._info_fields = info_fields + + @property + def registry_version(self): + """ + Gets the registry_version of this ObjectMetadata. + The registry version of the object. + + + :return: The registry_version of this ObjectMetadata. + :rtype: int + """ + return self._registry_version + + @registry_version.setter + def registry_version(self, registry_version): + """ + Sets the registry_version of this ObjectMetadata. + The registry version of the object. + + + :param registry_version: The registry_version of this ObjectMetadata. + :type: int + """ + self._registry_version = registry_version + + @property + def labels(self): + """ + Gets the labels of this ObjectMetadata. + Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. + + + :return: The labels of this ObjectMetadata. + :rtype: list[str] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this ObjectMetadata. + Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. + + + :param labels: The labels of this ObjectMetadata. + :type: list[str] + """ + self._labels = labels + + @property + def is_favorite(self): + """ + Gets the is_favorite of this ObjectMetadata. + Specifies whether this object is a favorite or not. + + + :return: The is_favorite of this ObjectMetadata. + :rtype: bool + """ + return self._is_favorite + + @is_favorite.setter + def is_favorite(self, is_favorite): + """ + Sets the is_favorite of this ObjectMetadata. + Specifies whether this object is a favorite or not. + + + :param is_favorite: The is_favorite of this ObjectMetadata. + :type: bool + """ + self._is_favorite = is_favorite + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/object_storage_write_attributes.py b/src/oci/data_connectivity/models/object_storage_write_attributes.py new file mode 100644 index 0000000000..fa2d81be5b --- /dev/null +++ b/src/oci/data_connectivity/models/object_storage_write_attributes.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_write_attribute import AbstractWriteAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectStorageWriteAttributes(AbstractWriteAttribute): + """ + Properties to configure writing to Object Storage. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectStorageWriteAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ObjectStorageWriteAttributes.model_type` attribute + of this class is ``OBJECT_STORAGE_WRITE_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ObjectStorageWriteAttributes. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + :param write_to_single_file: + The value to assign to the write_to_single_file property of this ObjectStorageWriteAttributes. + :type write_to_single_file: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'write_to_single_file': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'write_to_single_file': 'writeToSingleFile' + } + + self._model_type = None + self._write_to_single_file = None + self._model_type = 'OBJECT_STORAGE_WRITE_ATTRIBUTE' + + @property + def write_to_single_file(self): + """ + Gets the write_to_single_file of this ObjectStorageWriteAttributes. + Specifies whether to write output to single-file or not. + + + :return: The write_to_single_file of this ObjectStorageWriteAttributes. + :rtype: bool + """ + return self._write_to_single_file + + @write_to_single_file.setter + def write_to_single_file(self, write_to_single_file): + """ + Sets the write_to_single_file of this ObjectStorageWriteAttributes. + Specifies whether to write output to single-file or not. + + + :param write_to_single_file: The write_to_single_file of this ObjectStorageWriteAttributes. + :type: bool + """ + self._write_to_single_file = write_to_single_file + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation.py b/src/oci/data_connectivity/models/operation.py new file mode 100644 index 0000000000..a1103a38c1 --- /dev/null +++ b/src/oci/data_connectivity/models/operation.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Operation(object): + """ + The operation object. + """ + + #: A constant which can be used with the model_type property of a Operation. + #: This constant has a value of "PROCEDURE" + MODEL_TYPE_PROCEDURE = "PROCEDURE" + + def __init__(self, **kwargs): + """ + Initializes a new Operation object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.OperationFromProcedure` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Operation. + Allowed values for this property are: "PROCEDURE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this Operation. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata' + } + + self._model_type = None + self._metadata = 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['modelType'] + + if type == 'PROCEDURE': + return 'OperationFromProcedure' + else: + return 'Operation' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this Operation. + The operation type. + + Allowed values for this property are: "PROCEDURE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this Operation. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this Operation. + The operation type. + + + :param model_type: The model_type of this Operation. + :type: str + """ + allowed_values = ["PROCEDURE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def metadata(self): + """ + Gets the metadata of this Operation. + + :return: The metadata of this Operation. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this Operation. + + :param metadata: The metadata of this Operation. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_exec_result.py b/src/oci/data_connectivity/models/operation_exec_result.py new file mode 100644 index 0000000000..6755e52fd8 --- /dev/null +++ b/src/oci/data_connectivity/models/operation_exec_result.py @@ -0,0 +1,218 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationExecResult(object): + """ + Operation execution result for a single input set. + """ + + #: A constant which can be used with the execution_status property of a OperationExecResult. + #: This constant has a value of "FAILED" + EXECUTION_STATUS_FAILED = "FAILED" + + #: A constant which can be used with the execution_status property of a OperationExecResult. + #: This constant has a value of "SUCCESS" + EXECUTION_STATUS_SUCCESS = "SUCCESS" + + #: A constant which can be used with the execution_status property of a OperationExecResult. + #: This constant has a value of "QUEUED" + EXECUTION_STATUS_QUEUED = "QUEUED" + + #: A constant which can be used with the execution_status property of a OperationExecResult. + #: This constant has a value of "RUNNING" + EXECUTION_STATUS_RUNNING = "RUNNING" + + def __init__(self, **kwargs): + """ + Initializes a new OperationExecResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param execution_status: + The value to assign to the execution_status property of this OperationExecResult. + Allowed values for this property are: "FAILED", "SUCCESS", "QUEUED", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type execution_status: str + + :param error_message: + The value to assign to the error_message property of this OperationExecResult. + :type error_message: str + + :param metrics: + The value to assign to the metrics property of this OperationExecResult. + :type metrics: object + + :param output_values: + The value to assign to the output_values property of this OperationExecResult. + :type output_values: list[list[object]] + + :param is_whitelisted_error_message: + The value to assign to the is_whitelisted_error_message property of this OperationExecResult. + :type is_whitelisted_error_message: bool + + """ + self.swagger_types = { + 'execution_status': 'str', + 'error_message': 'str', + 'metrics': 'object', + 'output_values': 'list[list[object]]', + 'is_whitelisted_error_message': 'bool' + } + + self.attribute_map = { + 'execution_status': 'executionStatus', + 'error_message': 'errorMessage', + 'metrics': 'metrics', + 'output_values': 'outputValues', + 'is_whitelisted_error_message': 'isWhitelistedErrorMessage' + } + + self._execution_status = None + self._error_message = None + self._metrics = None + self._output_values = None + self._is_whitelisted_error_message = None + + @property + def execution_status(self): + """ + Gets the execution_status of this OperationExecResult. + Status of the operation job for particular set of input. + + Allowed values for this property are: "FAILED", "SUCCESS", "QUEUED", "RUNNING", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The execution_status of this OperationExecResult. + :rtype: str + """ + return self._execution_status + + @execution_status.setter + def execution_status(self, execution_status): + """ + Sets the execution_status of this OperationExecResult. + Status of the operation job for particular set of input. + + + :param execution_status: The execution_status of this OperationExecResult. + :type: str + """ + allowed_values = ["FAILED", "SUCCESS", "QUEUED", "RUNNING"] + if not value_allowed_none_or_none_sentinel(execution_status, allowed_values): + execution_status = 'UNKNOWN_ENUM_VALUE' + self._execution_status = execution_status + + @property + def error_message(self): + """ + Gets the error_message of this OperationExecResult. + Error message if execution of operation is failed. + + + :return: The error_message of this OperationExecResult. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this OperationExecResult. + Error message if execution of operation is failed. + + + :param error_message: The error_message of this OperationExecResult. + :type: str + """ + self._error_message = error_message + + @property + def metrics(self): + """ + Gets the metrics of this OperationExecResult. + Metrics of operation execution job. + + + :return: The metrics of this OperationExecResult. + :rtype: object + """ + return self._metrics + + @metrics.setter + def metrics(self, metrics): + """ + Sets the metrics of this OperationExecResult. + Metrics of operation execution job. + + + :param metrics: The metrics of this OperationExecResult. + :type: object + """ + self._metrics = metrics + + @property + def output_values(self): + """ + Gets the output_values of this OperationExecResult. + List of emitted rows for each OUT/INOUT param. + + + :return: The output_values of this OperationExecResult. + :rtype: list[list[object]] + """ + return self._output_values + + @output_values.setter + def output_values(self, output_values): + """ + Sets the output_values of this OperationExecResult. + List of emitted rows for each OUT/INOUT param. + + + :param output_values: The output_values of this OperationExecResult. + :type: list[list[object]] + """ + self._output_values = output_values + + @property + def is_whitelisted_error_message(self): + """ + Gets the is_whitelisted_error_message of this OperationExecResult. + True, if error message should be displayed on UI. + + + :return: The is_whitelisted_error_message of this OperationExecResult. + :rtype: bool + """ + return self._is_whitelisted_error_message + + @is_whitelisted_error_message.setter + def is_whitelisted_error_message(self, is_whitelisted_error_message): + """ + Sets the is_whitelisted_error_message of this OperationExecResult. + True, if error message should be displayed on UI. + + + :param is_whitelisted_error_message: The is_whitelisted_error_message of this OperationExecResult. + :type: bool + """ + self._is_whitelisted_error_message = is_whitelisted_error_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_from_procedure.py b/src/oci/data_connectivity/models/operation_from_procedure.py new file mode 100644 index 0000000000..94ad264333 --- /dev/null +++ b/src/oci/data_connectivity/models/operation_from_procedure.py @@ -0,0 +1,327 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .operation import Operation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationFromProcedure(Operation): + """ + The operation object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationFromProcedure object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OperationFromProcedure.model_type` attribute + of this class is ``PROCEDURE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OperationFromProcedure. + Allowed values for this property are: "PROCEDURE" + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this OperationFromProcedure. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this OperationFromProcedure. + :type key: str + + :param model_version: + The value to assign to the model_version property of this OperationFromProcedure. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this OperationFromProcedure. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param shape: + The value to assign to the shape property of this OperationFromProcedure. + :type shape: oci.data_connectivity.models.Shape + + :param name: + The value to assign to the name property of this OperationFromProcedure. + :type name: str + + :param object_version: + The value to assign to the object_version property of this OperationFromProcedure. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this OperationFromProcedure. + :type external_key: str + + :param resource_name: + The value to assign to the resource_name property of this OperationFromProcedure. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this OperationFromProcedure. + :type object_status: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'shape': 'Shape', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'resource_name': 'str', + 'object_status': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'shape': 'shape', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._shape = None + self._name = None + self._object_version = None + self._external_key = None + self._resource_name = None + self._object_status = None + self._model_type = 'PROCEDURE' + + @property + def key(self): + """ + Gets the key of this OperationFromProcedure. + The object key. + + + :return: The key of this OperationFromProcedure. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this OperationFromProcedure. + The object key. + + + :param key: The key of this OperationFromProcedure. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this OperationFromProcedure. + The model version of the object. + + + :return: The model_version of this OperationFromProcedure. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this OperationFromProcedure. + The model version of the object. + + + :param model_version: The model_version of this OperationFromProcedure. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this OperationFromProcedure. + + :return: The parent_ref of this OperationFromProcedure. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this OperationFromProcedure. + + :param parent_ref: The parent_ref of this OperationFromProcedure. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def shape(self): + """ + Gets the shape of this OperationFromProcedure. + + :return: The shape of this OperationFromProcedure. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this OperationFromProcedure. + + :param shape: The shape of this OperationFromProcedure. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def name(self): + """ + Gets the name of this OperationFromProcedure. + The operation name. + + + :return: The name of this OperationFromProcedure. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this OperationFromProcedure. + The operation name. + + + :param name: The name of this OperationFromProcedure. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this OperationFromProcedure. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this OperationFromProcedure. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this OperationFromProcedure. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this OperationFromProcedure. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this OperationFromProcedure. + The external key for the object. + + + :return: The external_key of this OperationFromProcedure. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this OperationFromProcedure. + The external key for the object. + + + :param external_key: The external_key of this OperationFromProcedure. + :type: str + """ + self._external_key = external_key + + @property + def resource_name(self): + """ + Gets the resource_name of this OperationFromProcedure. + The resource name. + + + :return: The resource_name of this OperationFromProcedure. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this OperationFromProcedure. + The resource name. + + + :param resource_name: The resource_name of this OperationFromProcedure. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this OperationFromProcedure. + The status of an object that can be set to value 1 for shallow reference across objects, other values reserved. + + + :return: The object_status of this OperationFromProcedure. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this OperationFromProcedure. + The status of an object that can be set to value 1 for shallow reference across objects, other values reserved. + + + :param object_status: The object_status of this OperationFromProcedure. + :type: int + """ + self._object_status = object_status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_input_record.py b/src/oci/data_connectivity/models/operation_input_record.py new file mode 100644 index 0000000000..c16c09ccec --- /dev/null +++ b/src/oci/data_connectivity/models/operation_input_record.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationInputRecord(object): + """ + Holder for IN/INOUT params' values. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationInputRecord object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param field_values: + The value to assign to the field_values property of this OperationInputRecord. + :type field_values: list[object] + + """ + self.swagger_types = { + 'field_values': 'list[object]' + } + + self.attribute_map = { + 'field_values': 'fieldValues' + } + + self._field_values = None + + @property + def field_values(self): + """ + Gets the field_values of this OperationInputRecord. + values of IN/INOUT params. + + + :return: The field_values of this OperationInputRecord. + :rtype: list[object] + """ + return self._field_values + + @field_values.setter + def field_values(self, field_values): + """ + Sets the field_values of this OperationInputRecord. + values of IN/INOUT params. + + + :param field_values: The field_values of this OperationInputRecord. + :type: list[object] + """ + self._field_values = field_values + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_summary.py b/src/oci/data_connectivity/models/operation_summary.py new file mode 100644 index 0000000000..67bd8e87ef --- /dev/null +++ b/src/oci/data_connectivity/models/operation_summary.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationSummary(object): + """ + The operation summary object + """ + + #: A constant which can be used with the model_type property of a OperationSummary. + #: This constant has a value of "PROCEDURE" + MODEL_TYPE_PROCEDURE = "PROCEDURE" + + def __init__(self, **kwargs): + """ + Initializes a new OperationSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.OperationSummaryFromProcedure` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OperationSummary. + Allowed values for this property are: "PROCEDURE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this OperationSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata' + } + + self._model_type = None + self._metadata = 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['modelType'] + + if type == 'PROCEDURE': + return 'OperationSummaryFromProcedure' + else: + return 'OperationSummary' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this OperationSummary. + The operation type + + Allowed values for this property are: "PROCEDURE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this OperationSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this OperationSummary. + The operation type + + + :param model_type: The model_type of this OperationSummary. + :type: str + """ + allowed_values = ["PROCEDURE"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def metadata(self): + """ + Gets the metadata of this OperationSummary. + + :return: The metadata of this OperationSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this OperationSummary. + + :param metadata: The metadata of this OperationSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_summary_collection.py b/src/oci/data_connectivity/models/operation_summary_collection.py new file mode 100644 index 0000000000..360f071d3d --- /dev/null +++ b/src/oci/data_connectivity/models/operation_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationSummaryCollection(object): + """ + This is the collection of operation summaries, it will contain very shallow details of an operation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationSummaryCollection 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 OperationSummaryCollection. + :type items: list[oci.data_connectivity.models.OperationSummary] + + """ + self.swagger_types = { + 'items': 'list[OperationSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this OperationSummaryCollection. + The array of operation summary + + + :return: The items of this OperationSummaryCollection. + :rtype: list[oci.data_connectivity.models.OperationSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this OperationSummaryCollection. + The array of operation summary + + + :param items: The items of this OperationSummaryCollection. + :type: list[oci.data_connectivity.models.OperationSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/operation_summary_from_procedure.py b/src/oci/data_connectivity/models/operation_summary_from_procedure.py new file mode 100644 index 0000000000..18b2c4fe57 --- /dev/null +++ b/src/oci/data_connectivity/models/operation_summary_from_procedure.py @@ -0,0 +1,300 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .operation_summary import OperationSummary +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OperationSummaryFromProcedure(OperationSummary): + """ + The operation object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationSummaryFromProcedure object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OperationSummaryFromProcedure.model_type` attribute + of this class is ``PROCEDURE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OperationSummaryFromProcedure. + Allowed values for this property are: "PROCEDURE" + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this OperationSummaryFromProcedure. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this OperationSummaryFromProcedure. + :type key: str + + :param model_version: + The value to assign to the model_version property of this OperationSummaryFromProcedure. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this OperationSummaryFromProcedure. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this OperationSummaryFromProcedure. + :type name: str + + :param object_version: + The value to assign to the object_version property of this OperationSummaryFromProcedure. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this OperationSummaryFromProcedure. + :type external_key: str + + :param resource_name: + The value to assign to the resource_name property of this OperationSummaryFromProcedure. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this OperationSummaryFromProcedure. + :type object_status: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'resource_name': 'str', + 'object_status': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus' + } + + self._model_type = None + self._metadata = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._external_key = None + self._resource_name = None + self._object_status = None + self._model_type = 'PROCEDURE' + + @property + def key(self): + """ + Gets the key of this OperationSummaryFromProcedure. + The object key. + + + :return: The key of this OperationSummaryFromProcedure. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this OperationSummaryFromProcedure. + The object key. + + + :param key: The key of this OperationSummaryFromProcedure. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this OperationSummaryFromProcedure. + The model version of the object. + + + :return: The model_version of this OperationSummaryFromProcedure. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this OperationSummaryFromProcedure. + The model version of the object. + + + :param model_version: The model_version of this OperationSummaryFromProcedure. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this OperationSummaryFromProcedure. + + :return: The parent_ref of this OperationSummaryFromProcedure. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this OperationSummaryFromProcedure. + + :param parent_ref: The parent_ref of this OperationSummaryFromProcedure. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this OperationSummaryFromProcedure. + The operation name. + + + :return: The name of this OperationSummaryFromProcedure. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this OperationSummaryFromProcedure. + The operation name. + + + :param name: The name of this OperationSummaryFromProcedure. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this OperationSummaryFromProcedure. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this OperationSummaryFromProcedure. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this OperationSummaryFromProcedure. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this OperationSummaryFromProcedure. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this OperationSummaryFromProcedure. + The external key for the object. + + + :return: The external_key of this OperationSummaryFromProcedure. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this OperationSummaryFromProcedure. + The external key for the object. + + + :param external_key: The external_key of this OperationSummaryFromProcedure. + :type: str + """ + self._external_key = external_key + + @property + def resource_name(self): + """ + Gets the resource_name of this OperationSummaryFromProcedure. + The resource name. + + + :return: The resource_name of this OperationSummaryFromProcedure. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this OperationSummaryFromProcedure. + The resource name. + + + :param resource_name: The resource_name of this OperationSummaryFromProcedure. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this OperationSummaryFromProcedure. + The status of an object that can be set to value 1 for shallow reference across objects, other values reserved. + + + :return: The object_status of this OperationSummaryFromProcedure. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this OperationSummaryFromProcedure. + The status of an object that can be set to value 1 for shallow reference across objects, other values reserved. + + + :param object_status: The object_status of this OperationSummaryFromProcedure. + :type: int + """ + self._object_status = object_status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/oracle_adwc_write_attributes.py b/src/oci/data_connectivity/models/oracle_adwc_write_attributes.py new file mode 100644 index 0000000000..8030c696db --- /dev/null +++ b/src/oci/data_connectivity/models/oracle_adwc_write_attributes.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_write_attribute import AbstractWriteAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OracleAdwcWriteAttributes(AbstractWriteAttribute): + """ + Properties to configure when writing to Oracle Autonomous Data Warehouse Cloud. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OracleAdwcWriteAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OracleAdwcWriteAttributes.model_type` attribute + of this class is ``ORACLE_ADWC_WRITE_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OracleAdwcWriteAttributes. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + :param bucket_schema: + The value to assign to the bucket_schema property of this OracleAdwcWriteAttributes. + :type bucket_schema: oci.data_connectivity.models.Schema + + :param staging_file_name: + The value to assign to the staging_file_name property of this OracleAdwcWriteAttributes. + :type staging_file_name: str + + :param staging_data_asset: + The value to assign to the staging_data_asset property of this OracleAdwcWriteAttributes. + :type staging_data_asset: oci.data_connectivity.models.DataAsset + + :param staging_connection: + The value to assign to the staging_connection property of this OracleAdwcWriteAttributes. + :type staging_connection: oci.data_connectivity.models.Connection + + """ + self.swagger_types = { + 'model_type': 'str', + 'bucket_schema': 'Schema', + 'staging_file_name': 'str', + 'staging_data_asset': 'DataAsset', + 'staging_connection': 'Connection' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'bucket_schema': 'bucketSchema', + 'staging_file_name': 'stagingFileName', + 'staging_data_asset': 'stagingDataAsset', + 'staging_connection': 'stagingConnection' + } + + self._model_type = None + self._bucket_schema = None + self._staging_file_name = None + self._staging_data_asset = None + self._staging_connection = None + self._model_type = 'ORACLE_ADWC_WRITE_ATTRIBUTE' + + @property + def bucket_schema(self): + """ + Gets the bucket_schema of this OracleAdwcWriteAttributes. + + :return: The bucket_schema of this OracleAdwcWriteAttributes. + :rtype: oci.data_connectivity.models.Schema + """ + return self._bucket_schema + + @bucket_schema.setter + def bucket_schema(self, bucket_schema): + """ + Sets the bucket_schema of this OracleAdwcWriteAttributes. + + :param bucket_schema: The bucket_schema of this OracleAdwcWriteAttributes. + :type: oci.data_connectivity.models.Schema + """ + self._bucket_schema = bucket_schema + + @property + def staging_file_name(self): + """ + Gets the staging_file_name of this OracleAdwcWriteAttributes. + The file name for the attribute. + + + :return: The staging_file_name of this OracleAdwcWriteAttributes. + :rtype: str + """ + return self._staging_file_name + + @staging_file_name.setter + def staging_file_name(self, staging_file_name): + """ + Sets the staging_file_name of this OracleAdwcWriteAttributes. + The file name for the attribute. + + + :param staging_file_name: The staging_file_name of this OracleAdwcWriteAttributes. + :type: str + """ + self._staging_file_name = staging_file_name + + @property + def staging_data_asset(self): + """ + Gets the staging_data_asset of this OracleAdwcWriteAttributes. + + :return: The staging_data_asset of this OracleAdwcWriteAttributes. + :rtype: oci.data_connectivity.models.DataAsset + """ + return self._staging_data_asset + + @staging_data_asset.setter + def staging_data_asset(self, staging_data_asset): + """ + Sets the staging_data_asset of this OracleAdwcWriteAttributes. + + :param staging_data_asset: The staging_data_asset of this OracleAdwcWriteAttributes. + :type: oci.data_connectivity.models.DataAsset + """ + self._staging_data_asset = staging_data_asset + + @property + def staging_connection(self): + """ + Gets the staging_connection of this OracleAdwcWriteAttributes. + + :return: The staging_connection of this OracleAdwcWriteAttributes. + :rtype: oci.data_connectivity.models.Connection + """ + return self._staging_connection + + @staging_connection.setter + def staging_connection(self, staging_connection): + """ + Sets the staging_connection of this OracleAdwcWriteAttributes. + + :param staging_connection: The staging_connection of this OracleAdwcWriteAttributes. + :type: oci.data_connectivity.models.Connection + """ + self._staging_connection = staging_connection + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/oracle_atp_write_attributes.py b/src/oci/data_connectivity/models/oracle_atp_write_attributes.py new file mode 100644 index 0000000000..0c5bd29a8f --- /dev/null +++ b/src/oci/data_connectivity/models/oracle_atp_write_attributes.py @@ -0,0 +1,161 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_write_attribute import AbstractWriteAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OracleAtpWriteAttributes(AbstractWriteAttribute): + """ + Properties to configure when writing to Oracle Autonomous Data Warehouse Cloud. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OracleAtpWriteAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OracleAtpWriteAttributes.model_type` attribute + of this class is ``ORACLE_ATP_WRITE_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OracleAtpWriteAttributes. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + :param bucket_schema: + The value to assign to the bucket_schema property of this OracleAtpWriteAttributes. + :type bucket_schema: oci.data_connectivity.models.Schema + + :param staging_file_name: + The value to assign to the staging_file_name property of this OracleAtpWriteAttributes. + :type staging_file_name: str + + :param staging_data_asset: + The value to assign to the staging_data_asset property of this OracleAtpWriteAttributes. + :type staging_data_asset: oci.data_connectivity.models.DataAsset + + :param staging_connection: + The value to assign to the staging_connection property of this OracleAtpWriteAttributes. + :type staging_connection: oci.data_connectivity.models.Connection + + """ + self.swagger_types = { + 'model_type': 'str', + 'bucket_schema': 'Schema', + 'staging_file_name': 'str', + 'staging_data_asset': 'DataAsset', + 'staging_connection': 'Connection' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'bucket_schema': 'bucketSchema', + 'staging_file_name': 'stagingFileName', + 'staging_data_asset': 'stagingDataAsset', + 'staging_connection': 'stagingConnection' + } + + self._model_type = None + self._bucket_schema = None + self._staging_file_name = None + self._staging_data_asset = None + self._staging_connection = None + self._model_type = 'ORACLE_ATP_WRITE_ATTRIBUTE' + + @property + def bucket_schema(self): + """ + Gets the bucket_schema of this OracleAtpWriteAttributes. + + :return: The bucket_schema of this OracleAtpWriteAttributes. + :rtype: oci.data_connectivity.models.Schema + """ + return self._bucket_schema + + @bucket_schema.setter + def bucket_schema(self, bucket_schema): + """ + Sets the bucket_schema of this OracleAtpWriteAttributes. + + :param bucket_schema: The bucket_schema of this OracleAtpWriteAttributes. + :type: oci.data_connectivity.models.Schema + """ + self._bucket_schema = bucket_schema + + @property + def staging_file_name(self): + """ + Gets the staging_file_name of this OracleAtpWriteAttributes. + The file name for the attribute. + + + :return: The staging_file_name of this OracleAtpWriteAttributes. + :rtype: str + """ + return self._staging_file_name + + @staging_file_name.setter + def staging_file_name(self, staging_file_name): + """ + Sets the staging_file_name of this OracleAtpWriteAttributes. + The file name for the attribute. + + + :param staging_file_name: The staging_file_name of this OracleAtpWriteAttributes. + :type: str + """ + self._staging_file_name = staging_file_name + + @property + def staging_data_asset(self): + """ + Gets the staging_data_asset of this OracleAtpWriteAttributes. + + :return: The staging_data_asset of this OracleAtpWriteAttributes. + :rtype: oci.data_connectivity.models.DataAsset + """ + return self._staging_data_asset + + @staging_data_asset.setter + def staging_data_asset(self, staging_data_asset): + """ + Sets the staging_data_asset of this OracleAtpWriteAttributes. + + :param staging_data_asset: The staging_data_asset of this OracleAtpWriteAttributes. + :type: oci.data_connectivity.models.DataAsset + """ + self._staging_data_asset = staging_data_asset + + @property + def staging_connection(self): + """ + Gets the staging_connection of this OracleAtpWriteAttributes. + + :return: The staging_connection of this OracleAtpWriteAttributes. + :rtype: oci.data_connectivity.models.Connection + """ + return self._staging_connection + + @staging_connection.setter + def staging_connection(self, staging_connection): + """ + Sets the staging_connection of this OracleAtpWriteAttributes. + + :param staging_connection: The staging_connection of this OracleAtpWriteAttributes. + :type: oci.data_connectivity.models.Connection + """ + self._staging_connection = staging_connection + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/oracle_read_attribute.py b/src/oci/data_connectivity/models/oracle_read_attribute.py new file mode 100644 index 0000000000..e9469a246d --- /dev/null +++ b/src/oci/data_connectivity/models/oracle_read_attribute.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_read_attribute import AbstractReadAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OracleReadAttribute(AbstractReadAttribute): + """ + The Oracle read attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OracleReadAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OracleReadAttribute.model_type` attribute + of this class is ``ORACLEREADATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OracleReadAttribute. + Allowed values for this property are: "ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE" + :type model_type: str + + :param fetch_size: + The value to assign to the fetch_size property of this OracleReadAttribute. + :type fetch_size: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'fetch_size': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'fetch_size': 'fetchSize' + } + + self._model_type = None + self._fetch_size = None + self._model_type = 'ORACLEREADATTRIBUTE' + + @property + def fetch_size(self): + """ + Gets the fetch_size of this OracleReadAttribute. + The fetch size for reading. + + + :return: The fetch_size of this OracleReadAttribute. + :rtype: int + """ + return self._fetch_size + + @fetch_size.setter + def fetch_size(self, fetch_size): + """ + Sets the fetch_size of this OracleReadAttribute. + The fetch size for reading. + + + :param fetch_size: The fetch_size of this OracleReadAttribute. + :type: int + """ + self._fetch_size = fetch_size + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/oracle_read_attributes.py b/src/oci/data_connectivity/models/oracle_read_attributes.py new file mode 100644 index 0000000000..2accc59d06 --- /dev/null +++ b/src/oci/data_connectivity/models/oracle_read_attributes.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_read_attribute import AbstractReadAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OracleReadAttributes(AbstractReadAttribute): + """ + Properties to configure reading from an Oracle Database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OracleReadAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OracleReadAttributes.model_type` attribute + of this class is ``ORACLE_READ_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OracleReadAttributes. + Allowed values for this property are: "ORACLEREADATTRIBUTE", "ORACLE_READ_ATTRIBUTE", "BICC_READ_ATTRIBUTE" + :type model_type: str + + :param fetch_size: + The value to assign to the fetch_size property of this OracleReadAttributes. + :type fetch_size: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'fetch_size': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'fetch_size': 'fetchSize' + } + + self._model_type = None + self._fetch_size = None + self._model_type = 'ORACLE_READ_ATTRIBUTE' + + @property + def fetch_size(self): + """ + Gets the fetch_size of this OracleReadAttributes. + The fetch size for reading. + + + :return: The fetch_size of this OracleReadAttributes. + :rtype: int + """ + return self._fetch_size + + @fetch_size.setter + def fetch_size(self, fetch_size): + """ + Sets the fetch_size of this OracleReadAttributes. + The fetch size for reading. + + + :param fetch_size: The fetch_size of this OracleReadAttributes. + :type: int + """ + self._fetch_size = fetch_size + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/oracle_write_attributes.py b/src/oci/data_connectivity/models/oracle_write_attributes.py new file mode 100644 index 0000000000..24c5aa46ef --- /dev/null +++ b/src/oci/data_connectivity/models/oracle_write_attributes.py @@ -0,0 +1,142 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_write_attribute import AbstractWriteAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OracleWriteAttributes(AbstractWriteAttribute): + """ + Properties to configure when writing to an Oracle Database. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OracleWriteAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OracleWriteAttributes.model_type` attribute + of this class is ``ORACLE_WRITE_ATTRIBUTE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OracleWriteAttributes. + Allowed values for this property are: "ORACLE_WRITE_ATTRIBUTE", "ORACLE_ATP_WRITE_ATTRIBUTE", "ORACLE_ADWC_WRITE_ATTRIBUTE", "OBJECT_STORAGE_WRITE_ATTRIBUTE", "HDFS_WRITE_ATTRIBUTE" + :type model_type: str + + :param batch_size: + The value to assign to the batch_size property of this OracleWriteAttributes. + :type batch_size: int + + :param is_truncate: + The value to assign to the is_truncate property of this OracleWriteAttributes. + :type is_truncate: bool + + :param isolation_level: + The value to assign to the isolation_level property of this OracleWriteAttributes. + :type isolation_level: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'batch_size': 'int', + 'is_truncate': 'bool', + 'isolation_level': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'batch_size': 'batchSize', + 'is_truncate': 'isTruncate', + 'isolation_level': 'isolationLevel' + } + + self._model_type = None + self._batch_size = None + self._is_truncate = None + self._isolation_level = None + self._model_type = 'ORACLE_WRITE_ATTRIBUTE' + + @property + def batch_size(self): + """ + Gets the batch_size of this OracleWriteAttributes. + The batch size for writing. + + + :return: The batch_size of this OracleWriteAttributes. + :rtype: int + """ + return self._batch_size + + @batch_size.setter + def batch_size(self, batch_size): + """ + Sets the batch_size of this OracleWriteAttributes. + The batch size for writing. + + + :param batch_size: The batch_size of this OracleWriteAttributes. + :type: int + """ + self._batch_size = batch_size + + @property + def is_truncate(self): + """ + Gets the is_truncate of this OracleWriteAttributes. + Specifies whether to truncate. + + + :return: The is_truncate of this OracleWriteAttributes. + :rtype: bool + """ + return self._is_truncate + + @is_truncate.setter + def is_truncate(self, is_truncate): + """ + Sets the is_truncate of this OracleWriteAttributes. + Specifies whether to truncate. + + + :param is_truncate: The is_truncate of this OracleWriteAttributes. + :type: bool + """ + self._is_truncate = is_truncate + + @property + def isolation_level(self): + """ + Gets the isolation_level of this OracleWriteAttributes. + Specifies the isolation level. + + + :return: The isolation_level of this OracleWriteAttributes. + :rtype: str + """ + return self._isolation_level + + @isolation_level.setter + def isolation_level(self, isolation_level): + """ + Sets the isolation_level of this OracleWriteAttributes. + Specifies the isolation level. + + + :param isolation_level: The isolation_level of this OracleWriteAttributes. + :type: str + """ + self._isolation_level = isolation_level + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/outlier.py b/src/oci/data_connectivity/models/outlier.py new file mode 100644 index 0000000000..ae6991fad2 --- /dev/null +++ b/src/oci/data_connectivity/models/outlier.py @@ -0,0 +1,163 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Outlier(object): + """ + To capture all the Outlier details related to profiling + """ + + def __init__(self, **kwargs): + """ + Initializes a new Outlier object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param low: + The value to assign to the low property of this Outlier. + :type low: str + + :param high: + The value to assign to the high property of this Outlier. + :type high: str + + :param low_count: + The value to assign to the low_count property of this Outlier. + :type low_count: str + + :param high_count: + The value to assign to the high_count property of this Outlier. + :type high_count: str + + """ + self.swagger_types = { + 'low': 'str', + 'high': 'str', + 'low_count': 'str', + 'high_count': 'str' + } + + self.attribute_map = { + 'low': 'low', + 'high': 'high', + 'low_count': 'lowCount', + 'high_count': 'highCount' + } + + self._low = None + self._high = None + self._low_count = None + self._high_count = None + + @property + def low(self): + """ + Gets the low of this Outlier. + low value of outlier + + + :return: The low of this Outlier. + :rtype: str + """ + return self._low + + @low.setter + def low(self, low): + """ + Sets the low of this Outlier. + low value of outlier + + + :param low: The low of this Outlier. + :type: str + """ + self._low = low + + @property + def high(self): + """ + Gets the high of this Outlier. + high value of outlier + + + :return: The high of this Outlier. + :rtype: str + """ + return self._high + + @high.setter + def high(self, high): + """ + Sets the high of this Outlier. + high value of outlier + + + :param high: The high of this Outlier. + :type: str + """ + self._high = high + + @property + def low_count(self): + """ + Gets the low_count of this Outlier. + lowCount value of outlier + + + :return: The low_count of this Outlier. + :rtype: str + """ + return self._low_count + + @low_count.setter + def low_count(self, low_count): + """ + Sets the low_count of this Outlier. + lowCount value of outlier + + + :param low_count: The low_count of this Outlier. + :type: str + """ + self._low_count = low_count + + @property + def high_count(self): + """ + Gets the high_count of this Outlier. + highCount value of outlier + + + :return: The high_count of this Outlier. + :rtype: str + """ + return self._high_count + + @high_count.setter + def high_count(self, high_count): + """ + Sets the high_count of this Outlier. + highCount value of outlier + + + :param high_count: The high_count of this Outlier. + :type: str + """ + self._high_count = high_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/data_connectivity/models/output_port.py b/src/oci/data_connectivity/models/output_port.py new file mode 100644 index 0000000000..18d3ffa05c --- /dev/null +++ b/src/oci/data_connectivity/models/output_port.py @@ -0,0 +1,181 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class OutputPort(TypedObject): + """ + The output port details. + """ + + #: A constant which can be used with the port_type property of a OutputPort. + #: This constant has a value of "DATA" + PORT_TYPE_DATA = "DATA" + + #: A constant which can be used with the port_type property of a OutputPort. + #: This constant has a value of "CONTROL" + PORT_TYPE_CONTROL = "CONTROL" + + #: A constant which can be used with the port_type property of a OutputPort. + #: This constant has a value of "MODEL" + PORT_TYPE_MODEL = "MODEL" + + def __init__(self, **kwargs): + """ + Initializes a new OutputPort object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OutputPort.model_type` attribute + of this class is ``OUTPUT_PORT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this OutputPort. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this OutputPort. + :type key: str + + :param model_version: + The value to assign to the model_version property of this OutputPort. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this OutputPort. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this OutputPort. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this OutputPort. + :type object_status: int + + :param name: + The value to assign to the name property of this OutputPort. + :type name: str + + :param description: + The value to assign to the description property of this OutputPort. + :type description: str + + :param port_type: + The value to assign to the port_type property of this OutputPort. + Allowed values for this property are: "DATA", "CONTROL", "MODEL" + :type port_type: str + + :param fields: + The value to assign to the fields property of this OutputPort. + :type fields: list[oci.data_connectivity.models.TypedObject] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'port_type': 'str', + 'fields': 'list[TypedObject]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'port_type': 'portType', + 'fields': 'fields' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._port_type = None + self._fields = None + self._model_type = 'OUTPUT_PORT' + + @property + def port_type(self): + """ + Gets the port_type of this OutputPort. + The port details for the data asset.Type. + + Allowed values for this property are: "DATA", "CONTROL", "MODEL" + + + :return: The port_type of this OutputPort. + :rtype: str + """ + return self._port_type + + @port_type.setter + def port_type(self, port_type): + """ + Sets the port_type of this OutputPort. + The port details for the data asset.Type. + + + :param port_type: The port_type of this OutputPort. + :type: str + """ + allowed_values = ["DATA", "CONTROL", "MODEL"] + if not value_allowed_none_or_none_sentinel(port_type, allowed_values): + raise ValueError( + "Invalid value for `port_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._port_type = port_type + + @property + def fields(self): + """ + Gets the fields of this OutputPort. + An array of fields. + + + :return: The fields of this OutputPort. + :rtype: list[oci.data_connectivity.models.TypedObject] + """ + return self._fields + + @fields.setter + def fields(self, fields): + """ + Sets the fields of this OutputPort. + An array of fields. + + + :param fields: The fields of this OutputPort. + :type: list[oci.data_connectivity.models.TypedObject] + """ + self._fields = fields + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/parameter.py b/src/oci/data_connectivity/models/parameter.py new file mode 100644 index 0000000000..358d31e0de --- /dev/null +++ b/src/oci/data_connectivity/models/parameter.py @@ -0,0 +1,336 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Parameter(TypedObject): + """ + Parameters are created and assigned values that can be configured for each integration task. + """ + + #: A constant which can be used with the output_aggregation_type property of a Parameter. + #: This constant has a value of "MIN" + OUTPUT_AGGREGATION_TYPE_MIN = "MIN" + + #: A constant which can be used with the output_aggregation_type property of a Parameter. + #: This constant has a value of "MAX" + OUTPUT_AGGREGATION_TYPE_MAX = "MAX" + + #: A constant which can be used with the output_aggregation_type property of a Parameter. + #: This constant has a value of "COUNT" + OUTPUT_AGGREGATION_TYPE_COUNT = "COUNT" + + #: A constant which can be used with the output_aggregation_type property of a Parameter. + #: This constant has a value of "SUM" + OUTPUT_AGGREGATION_TYPE_SUM = "SUM" + + def __init__(self, **kwargs): + """ + Initializes a new Parameter object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Parameter.model_type` attribute + of this class is ``PARAMETER`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Parameter. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this Parameter. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Parameter. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Parameter. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this Parameter. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this Parameter. + :type object_status: int + + :param name: + The value to assign to the name property of this Parameter. + :type name: str + + :param description: + The value to assign to the description property of this Parameter. + :type description: str + + :param type: + The value to assign to the type property of this Parameter. + :type type: oci.data_connectivity.models.BaseType + + :param default_value: + The value to assign to the default_value property of this Parameter. + :type default_value: object + + :param root_object_default_value: + The value to assign to the root_object_default_value property of this Parameter. + :type root_object_default_value: object + + :param is_input: + The value to assign to the is_input property of this Parameter. + :type is_input: bool + + :param is_output: + The value to assign to the is_output property of this Parameter. + :type is_output: bool + + :param output_aggregation_type: + The value to assign to the output_aggregation_type property of this Parameter. + Allowed values for this property are: "MIN", "MAX", "COUNT", "SUM" + :type output_aggregation_type: str + + :param type_name: + The value to assign to the type_name property of this Parameter. + :type type_name: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'type': 'BaseType', + 'default_value': 'object', + 'root_object_default_value': 'object', + 'is_input': 'bool', + 'is_output': 'bool', + 'output_aggregation_type': 'str', + 'type_name': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'type': 'type', + 'default_value': 'defaultValue', + 'root_object_default_value': 'rootObjectDefaultValue', + 'is_input': 'isInput', + 'is_output': 'isOutput', + 'output_aggregation_type': 'outputAggregationType', + 'type_name': 'typeName' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._type = None + self._default_value = None + self._root_object_default_value = None + self._is_input = None + self._is_output = None + self._output_aggregation_type = None + self._type_name = None + self._model_type = 'PARAMETER' + + @property + def type(self): + """ + Gets the type of this Parameter. + + :return: The type of this Parameter. + :rtype: oci.data_connectivity.models.BaseType + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Parameter. + + :param type: The type of this Parameter. + :type: oci.data_connectivity.models.BaseType + """ + self._type = type + + @property + def default_value(self): + """ + Gets the default_value of this Parameter. + The default value of the parameter. + + + :return: The default_value of this Parameter. + :rtype: object + """ + return self._default_value + + @default_value.setter + def default_value(self, default_value): + """ + Sets the default_value of this Parameter. + The default value of the parameter. + + + :param default_value: The default_value of this Parameter. + :type: object + """ + self._default_value = default_value + + @property + def root_object_default_value(self): + """ + Gets the root_object_default_value of this Parameter. + The default value of the parameter which can be an object in DIS, such as a data entity. + + + :return: The root_object_default_value of this Parameter. + :rtype: object + """ + return self._root_object_default_value + + @root_object_default_value.setter + def root_object_default_value(self, root_object_default_value): + """ + Sets the root_object_default_value of this Parameter. + The default value of the parameter which can be an object in DIS, such as a data entity. + + + :param root_object_default_value: The root_object_default_value of this Parameter. + :type: object + """ + self._root_object_default_value = root_object_default_value + + @property + def is_input(self): + """ + Gets the is_input of this Parameter. + Specifies whether the parameter is input value. + + + :return: The is_input of this Parameter. + :rtype: bool + """ + return self._is_input + + @is_input.setter + def is_input(self, is_input): + """ + Sets the is_input of this Parameter. + Specifies whether the parameter is input value. + + + :param is_input: The is_input of this Parameter. + :type: bool + """ + self._is_input = is_input + + @property + def is_output(self): + """ + Gets the is_output of this Parameter. + Specifies whether the parameter is output value. + + + :return: The is_output of this Parameter. + :rtype: bool + """ + return self._is_output + + @is_output.setter + def is_output(self, is_output): + """ + Sets the is_output of this Parameter. + Specifies whether the parameter is output value. + + + :param is_output: The is_output of this Parameter. + :type: bool + """ + self._is_output = is_output + + @property + def output_aggregation_type(self): + """ + Gets the output_aggregation_type of this Parameter. + The output aggregation type. + + Allowed values for this property are: "MIN", "MAX", "COUNT", "SUM" + + + :return: The output_aggregation_type of this Parameter. + :rtype: str + """ + return self._output_aggregation_type + + @output_aggregation_type.setter + def output_aggregation_type(self, output_aggregation_type): + """ + Sets the output_aggregation_type of this Parameter. + The output aggregation type. + + + :param output_aggregation_type: The output_aggregation_type of this Parameter. + :type: str + """ + allowed_values = ["MIN", "MAX", "COUNT", "SUM"] + if not value_allowed_none_or_none_sentinel(output_aggregation_type, allowed_values): + raise ValueError( + "Invalid value for `output_aggregation_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._output_aggregation_type = output_aggregation_type + + @property + def type_name(self): + """ + Gets the type_name of this Parameter. + The type of value the parameter was created for. + + + :return: The type_name of this Parameter. + :rtype: str + """ + return self._type_name + + @type_name.setter + def type_name(self, type_name): + """ + Sets the type_name of this Parameter. + The type of value the parameter was created for. + + + :param type_name: The type_name of this Parameter. + :type: str + """ + self._type_name = type_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/data_connectivity/models/parent_reference.py b/src/oci/data_connectivity/models/parent_reference.py new file mode 100644 index 0000000000..b48183f07d --- /dev/null +++ b/src/oci/data_connectivity/models/parent_reference.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ParentReference(object): + """ + A reference to the object's parent. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ParentReference object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param parent: + The value to assign to the parent property of this ParentReference. + :type parent: str + + """ + self.swagger_types = { + 'parent': 'str' + } + + self.attribute_map = { + 'parent': 'parent' + } + + self._parent = None + + @property + def parent(self): + """ + Gets the parent of this ParentReference. + Key of the parent object. + + + :return: The parent of this ParentReference. + :rtype: str + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this ParentReference. + Key of the parent object. + + + :param parent: The parent of this ParentReference. + :type: str + """ + self._parent = parent + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/parquet_format_attribute.py b/src/oci/data_connectivity/models/parquet_format_attribute.py new file mode 100644 index 0000000000..7668e719ea --- /dev/null +++ b/src/oci/data_connectivity/models/parquet_format_attribute.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_format_attribute import AbstractFormatAttribute +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ParquetFormatAttribute(AbstractFormatAttribute): + """ + The PARQUET format attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ParquetFormatAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ParquetFormatAttribute.model_type` attribute + of this class is ``PARQUET_FORMAT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ParquetFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT" + :type model_type: str + + :param compression: + The value to assign to the compression property of this ParquetFormatAttribute. + :type compression: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'compression': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'compression': 'compression' + } + + self._model_type = None + self._compression = None + self._model_type = 'PARQUET_FORMAT' + + @property + def compression(self): + """ + Gets the compression of this ParquetFormatAttribute. + The compression for the file. + + + :return: The compression of this ParquetFormatAttribute. + :rtype: str + """ + return self._compression + + @compression.setter + def compression(self, compression): + """ + Sets the compression of this ParquetFormatAttribute. + The compression for the file. + + + :param compression: The compression of this ParquetFormatAttribute. + :type: str + """ + self._compression = compression + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/partition_config.py b/src/oci/data_connectivity/models/partition_config.py new file mode 100644 index 0000000000..809582d289 --- /dev/null +++ b/src/oci/data_connectivity/models/partition_config.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PartitionConfig(object): + """ + The information about partition configuration. + """ + + #: A constant which can be used with the model_type property of a PartitionConfig. + #: This constant has a value of "KEYRANGEPARTITIONCONFIG" + MODEL_TYPE_KEYRANGEPARTITIONCONFIG = "KEYRANGEPARTITIONCONFIG" + + def __init__(self, **kwargs): + """ + Initializes a new PartitionConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.KeyRangePartitionConfig` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this PartitionConfig. + Allowed values for this property are: "KEYRANGEPARTITIONCONFIG" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'KEYRANGEPARTITIONCONFIG': + return 'KeyRangePartitionConfig' + else: + return 'PartitionConfig' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this PartitionConfig. + The type of partition configuration. + + Allowed values for this property are: "KEYRANGEPARTITIONCONFIG" + + + :return: The model_type of this PartitionConfig. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this PartitionConfig. + The type of partition configuration. + + + :param model_type: The model_type of this PartitionConfig. + :type: str + """ + allowed_values = ["KEYRANGEPARTITIONCONFIG"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/primary_key.py b/src/oci/data_connectivity/models/primary_key.py new file mode 100644 index 0000000000..a795da75f9 --- /dev/null +++ b/src/oci/data_connectivity/models/primary_key.py @@ -0,0 +1,91 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .unique_key import UniqueKey +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PrimaryKey(UniqueKey): + """ + The primary key object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PrimaryKey object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.PrimaryKey.model_type` attribute + of this class is ``PRIMARY_KEY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this PrimaryKey. + Allowed values for this property are: "PRIMARY_KEY", "UNIQUE_KEY" + :type model_type: str + + :param key: + The value to assign to the key property of this PrimaryKey. + :type key: str + + :param model_version: + The value to assign to the model_version property of this PrimaryKey. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this PrimaryKey. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this PrimaryKey. + :type name: str + + :param attribute_refs: + The value to assign to the attribute_refs property of this PrimaryKey. + :type attribute_refs: list[oci.data_connectivity.models.KeyAttribute] + + :param object_status: + The value to assign to the object_status property of this PrimaryKey. + :type object_status: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'attribute_refs': 'list[KeyAttribute]', + 'object_status': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'attribute_refs': 'attributeRefs', + 'object_status': 'objectStatus' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._attribute_refs = None + self._object_status = None + self._model_type = 'PRIMARY_KEY' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/profile_config.py b/src/oci/data_connectivity/models/profile_config.py new file mode 100644 index 0000000000..d67550885a --- /dev/null +++ b/src/oci/data_connectivity/models/profile_config.py @@ -0,0 +1,286 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProfileConfig(object): + """ + Profiling configuration. + """ + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "ATTRIBUTE_COUNT" + FUNCTIONS_ATTRIBUTE_COUNT = "ATTRIBUTE_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "ROW_COUNT" + FUNCTIONS_ROW_COUNT = "ROW_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "DATA_TYPE" + FUNCTIONS_DATA_TYPE = "DATA_TYPE" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "DISTINCT_COUNT" + FUNCTIONS_DISTINCT_COUNT = "DISTINCT_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "DUPLICATE_COUNT" + FUNCTIONS_DUPLICATE_COUNT = "DUPLICATE_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "HISTOGRAM" + FUNCTIONS_HISTOGRAM = "HISTOGRAM" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MAX" + FUNCTIONS_MAX = "MAX" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MAX_LENGTH" + FUNCTIONS_MAX_LENGTH = "MAX_LENGTH" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MEAN" + FUNCTIONS_MEAN = "MEAN" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MEAN_LENGTH" + FUNCTIONS_MEAN_LENGTH = "MEAN_LENGTH" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MEDIAN" + FUNCTIONS_MEDIAN = "MEDIAN" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MIN" + FUNCTIONS_MIN = "MIN" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "MIN_LENGTH" + FUNCTIONS_MIN_LENGTH = "MIN_LENGTH" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "NULL_COUNT" + FUNCTIONS_NULL_COUNT = "NULL_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "OUTLIER" + FUNCTIONS_OUTLIER = "OUTLIER" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "PATTERN" + FUNCTIONS_PATTERN = "PATTERN" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "STANDARD_DEVIATION" + FUNCTIONS_STANDARD_DEVIATION = "STANDARD_DEVIATION" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "UNIQUE_COUNT" + FUNCTIONS_UNIQUE_COUNT = "UNIQUE_COUNT" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "VARIANCE" + FUNCTIONS_VARIANCE = "VARIANCE" + + #: A constant which can be used with the functions property of a ProfileConfig. + #: This constant has a value of "VALUE_FREQUENCY" + FUNCTIONS_VALUE_FREQUENCY = "VALUE_FREQUENCY" + + def __init__(self, **kwargs): + """ + Initializes a new ProfileConfig object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param attributes: + The value to assign to the attributes property of this ProfileConfig. + :type attributes: list[str] + + :param functions: + The value to assign to the functions property of this ProfileConfig. + Allowed values for items in this list are: "ATTRIBUTE_COUNT", "ROW_COUNT", "DATA_TYPE", "DISTINCT_COUNT", "DUPLICATE_COUNT", "HISTOGRAM", "MAX", "MAX_LENGTH", "MEAN", "MEAN_LENGTH", "MEDIAN", "MIN", "MIN_LENGTH", "NULL_COUNT", "OUTLIER", "PATTERN", "STANDARD_DEVIATION", "UNIQUE_COUNT", "VARIANCE", "VALUE_FREQUENCY" + :type functions: list[str] + + :param top_n_val_freq: + The value to assign to the top_n_val_freq property of this ProfileConfig. + :type top_n_val_freq: int + + :param pattern_threshold: + The value to assign to the pattern_threshold property of this ProfileConfig. + :type pattern_threshold: int + + :param data_type_threshold: + The value to assign to the data_type_threshold property of this ProfileConfig. + :type data_type_threshold: int + + """ + self.swagger_types = { + 'attributes': 'list[str]', + 'functions': 'list[str]', + 'top_n_val_freq': 'int', + 'pattern_threshold': 'int', + 'data_type_threshold': 'int' + } + + self.attribute_map = { + 'attributes': 'attributes', + 'functions': 'functions', + 'top_n_val_freq': 'topNValFreq', + 'pattern_threshold': 'patternThreshold', + 'data_type_threshold': 'dataTypeThreshold' + } + + self._attributes = None + self._functions = None + self._top_n_val_freq = None + self._pattern_threshold = None + self._data_type_threshold = None + + @property + def attributes(self): + """ + Gets the attributes of this ProfileConfig. + Array of column names to profile. If empty all columns in the entity are profiled. + + + :return: The attributes of this ProfileConfig. + :rtype: list[str] + """ + return self._attributes + + @attributes.setter + def attributes(self, attributes): + """ + Sets the attributes of this ProfileConfig. + Array of column names to profile. If empty all columns in the entity are profiled. + + + :param attributes: The attributes of this ProfileConfig. + :type: list[str] + """ + self._attributes = attributes + + @property + def functions(self): + """ + Gets the functions of this ProfileConfig. + Array of enum Strings basically what all profile functions to run. If empty, all supported functions are run. + + Allowed values for items in this list are: "ATTRIBUTE_COUNT", "ROW_COUNT", "DATA_TYPE", "DISTINCT_COUNT", "DUPLICATE_COUNT", "HISTOGRAM", "MAX", "MAX_LENGTH", "MEAN", "MEAN_LENGTH", "MEDIAN", "MIN", "MIN_LENGTH", "NULL_COUNT", "OUTLIER", "PATTERN", "STANDARD_DEVIATION", "UNIQUE_COUNT", "VARIANCE", "VALUE_FREQUENCY" + + + :return: The functions of this ProfileConfig. + :rtype: list[str] + """ + return self._functions + + @functions.setter + def functions(self, functions): + """ + Sets the functions of this ProfileConfig. + Array of enum Strings basically what all profile functions to run. If empty, all supported functions are run. + + + :param functions: The functions of this ProfileConfig. + :type: list[str] + """ + allowed_values = ["ATTRIBUTE_COUNT", "ROW_COUNT", "DATA_TYPE", "DISTINCT_COUNT", "DUPLICATE_COUNT", "HISTOGRAM", "MAX", "MAX_LENGTH", "MEAN", "MEAN_LENGTH", "MEDIAN", "MIN", "MIN_LENGTH", "NULL_COUNT", "OUTLIER", "PATTERN", "STANDARD_DEVIATION", "UNIQUE_COUNT", "VARIANCE", "VALUE_FREQUENCY"] + + if functions and functions is not NONE_SENTINEL: + for value in functions: + if not value_allowed_none_or_none_sentinel(value, allowed_values): + raise ValueError( + "Invalid value for `functions`, must be None or one of {0}" + .format(allowed_values) + ) + self._functions = functions + + @property + def top_n_val_freq(self): + """ + Gets the top_n_val_freq of this ProfileConfig. + The maximum number of value frequencies to return per column. The VFs are sorted descending on frequency and ascending on value and then topN are returned and rest discarded. + + + :return: The top_n_val_freq of this ProfileConfig. + :rtype: int + """ + return self._top_n_val_freq + + @top_n_val_freq.setter + def top_n_val_freq(self, top_n_val_freq): + """ + Sets the top_n_val_freq of this ProfileConfig. + The maximum number of value frequencies to return per column. The VFs are sorted descending on frequency and ascending on value and then topN are returned and rest discarded. + + + :param top_n_val_freq: The top_n_val_freq of this ProfileConfig. + :type: int + """ + self._top_n_val_freq = top_n_val_freq + + @property + def pattern_threshold(self): + """ + Gets the pattern_threshold of this ProfileConfig. + A pattern has to qualify minumum this percentage threshold to be considered a legitimate pattern on its own. All patterns which does not qualify this will be clubbed together into a single 'Others' pattern. + + + :return: The pattern_threshold of this ProfileConfig. + :rtype: int + """ + return self._pattern_threshold + + @pattern_threshold.setter + def pattern_threshold(self, pattern_threshold): + """ + Sets the pattern_threshold of this ProfileConfig. + A pattern has to qualify minumum this percentage threshold to be considered a legitimate pattern on its own. All patterns which does not qualify this will be clubbed together into a single 'Others' pattern. + + + :param pattern_threshold: The pattern_threshold of this ProfileConfig. + :type: int + """ + self._pattern_threshold = pattern_threshold + + @property + def data_type_threshold(self): + """ + Gets the data_type_threshold of this ProfileConfig. + A data type has to qualify minimum this percentage threshold to be considered an infrred data type for a column. + + + :return: The data_type_threshold of this ProfileConfig. + :rtype: int + """ + return self._data_type_threshold + + @data_type_threshold.setter + def data_type_threshold(self, data_type_threshold): + """ + Sets the data_type_threshold of this ProfileConfig. + A data type has to qualify minimum this percentage threshold to be considered an infrred data type for a column. + + + :param data_type_threshold: The data_type_threshold of this ProfileConfig. + :type: int + """ + self._data_type_threshold = data_type_threshold + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/profile_stat.py b/src/oci/data_connectivity/models/profile_stat.py new file mode 100644 index 0000000000..3f8b264529 --- /dev/null +++ b/src/oci/data_connectivity/models/profile_stat.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ProfileStat(object): + """ + To capture all the statistical data related to profiling + """ + + def __init__(self, **kwargs): + """ + Initializes a new ProfileStat object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param confidence: + The value to assign to the confidence property of this ProfileStat. + :type confidence: int + + :param value: + The value to assign to the value property of this ProfileStat. + :type value: str + + """ + self.swagger_types = { + 'confidence': 'int', + 'value': 'str' + } + + self.attribute_map = { + 'confidence': 'confidence', + 'value': 'value' + } + + self._confidence = None + self._value = None + + @property + def confidence(self): + """ + Gets the confidence of this ProfileStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :return: The confidence of this ProfileStat. + :rtype: int + """ + return self._confidence + + @confidence.setter + def confidence(self, confidence): + """ + Sets the confidence of this ProfileStat. + Placeholder for now, in future we will return the confidence of the profile result (because we are using sampled data and not whole data) + + + :param confidence: The confidence of this ProfileStat. + :type: int + """ + self._confidence = confidence + + @property + def value(self): + """ + Gets the value of this ProfileStat. + Value of the confidence of the profile result + + + :return: The value of this ProfileStat. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ProfileStat. + Value of the confidence of the profile result + + + :param value: The value of this ProfileStat. + :type: str + """ + self._value = value + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/push_down_operation.py b/src/oci/data_connectivity/models/push_down_operation.py new file mode 100644 index 0000000000..88cf154c15 --- /dev/null +++ b/src/oci/data_connectivity/models/push_down_operation.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PushDownOperation(object): + """ + The information about a push down operation. + """ + + #: A constant which can be used with the model_type property of a PushDownOperation. + #: This constant has a value of "FILTER" + MODEL_TYPE_FILTER = "FILTER" + + #: A constant which can be used with the model_type property of a PushDownOperation. + #: This constant has a value of "JOIN" + MODEL_TYPE_JOIN = "JOIN" + + #: A constant which can be used with the model_type property of a PushDownOperation. + #: This constant has a value of "SELECT" + MODEL_TYPE_SELECT = "SELECT" + + #: A constant which can be used with the model_type property of a PushDownOperation. + #: This constant has a value of "SORT" + MODEL_TYPE_SORT = "SORT" + + #: A constant which can be used with the model_type property of a PushDownOperation. + #: This constant has a value of "QUERY" + MODEL_TYPE_QUERY = "QUERY" + + def __init__(self, **kwargs): + """ + Initializes a new PushDownOperation object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.Query` + * :class:`~oci.data_connectivity.models.Select` + * :class:`~oci.data_connectivity.models.Join` + * :class:`~oci.data_connectivity.models.Sort` + * :class:`~oci.data_connectivity.models.FilterPush` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this PushDownOperation. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_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['modelType'] + + if type == 'QUERY': + return 'Query' + + if type == 'SELECT': + return 'Select' + + if type == 'JOIN': + return 'Join' + + if type == 'SORT': + return 'Sort' + + if type == 'FILTER': + return 'FilterPush' + else: + return 'PushDownOperation' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this PushDownOperation. + The type of operation. + + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + + + :return: The model_type of this PushDownOperation. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this PushDownOperation. + The type of operation. + + + :param model_type: The model_type of this PushDownOperation. + :type: str + """ + allowed_values = ["FILTER", "JOIN", "SELECT", "SORT", "QUERY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/query.py b/src/oci/data_connectivity/models/query.py new file mode 100644 index 0000000000..78ae408fcc --- /dev/null +++ b/src/oci/data_connectivity/models/query.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .push_down_operation import PushDownOperation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Query(PushDownOperation): + """ + A query object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Query object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Query.model_type` attribute + of this class is ``QUERY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Query. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + :param query: + The value to assign to the query property of this Query. + :type query: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'query': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'query': 'query' + } + + self._model_type = None + self._query = None + self._model_type = 'QUERY' + + @property + def query(self): + """ + **[Required]** Gets the query of this Query. + A query string. + + + :return: The query of this Query. + :rtype: str + """ + return self._query + + @query.setter + def query(self, query): + """ + Sets the query of this Query. + A query string. + + + :param query: The query of this Query. + :type: str + """ + self._query = query + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/read_operation_config.py b/src/oci/data_connectivity/models/read_operation_config.py new file mode 100644 index 0000000000..a28230b8df --- /dev/null +++ b/src/oci/data_connectivity/models/read_operation_config.py @@ -0,0 +1,312 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_data_operation_config import AbstractDataOperationConfig +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReadOperationConfig(AbstractDataOperationConfig): + """ + The information about the read operation. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReadOperationConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ReadOperationConfig.model_type` attribute + of this class is ``READ_OPERATION_CONFIG`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ReadOperationConfig. + Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" + :type model_type: str + + :param key: + The value to assign to the key property of this ReadOperationConfig. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ReadOperationConfig. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ReadOperationConfig. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param operations: + The value to assign to the operations property of this ReadOperationConfig. + :type operations: list[oci.data_connectivity.models.PushDownOperation] + + :param data_format: + The value to assign to the data_format property of this ReadOperationConfig. + :type data_format: oci.data_connectivity.models.DataFormat + + :param partition_config: + The value to assign to the partition_config property of this ReadOperationConfig. + :type partition_config: oci.data_connectivity.models.PartitionConfig + + :param read_attribute: + The value to assign to the read_attribute property of this ReadOperationConfig. + :type read_attribute: oci.data_connectivity.models.AbstractReadAttribute + + :param object_status: + The value to assign to the object_status property of this ReadOperationConfig. + :type object_status: int + + :param read_raw_data: + The value to assign to the read_raw_data property of this ReadOperationConfig. + :type read_raw_data: bool + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'operations': 'list[PushDownOperation]', + 'data_format': 'DataFormat', + 'partition_config': 'PartitionConfig', + 'read_attribute': 'AbstractReadAttribute', + 'object_status': 'int', + 'read_raw_data': 'bool' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'operations': 'operations', + 'data_format': 'dataFormat', + 'partition_config': 'partitionConfig', + 'read_attribute': 'readAttribute', + 'object_status': 'objectStatus', + 'read_raw_data': 'readRawData' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._operations = None + self._data_format = None + self._partition_config = None + self._read_attribute = None + self._object_status = None + self._read_raw_data = None + self._model_type = 'READ_OPERATION_CONFIG' + + @property + def key(self): + """ + Gets the key of this ReadOperationConfig. + The object key. + + + :return: The key of this ReadOperationConfig. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReadOperationConfig. + The object key. + + + :param key: The key of this ReadOperationConfig. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this ReadOperationConfig. + The object's model version. + + + :return: The model_version of this ReadOperationConfig. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ReadOperationConfig. + The object's model version. + + + :param model_version: The model_version of this ReadOperationConfig. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ReadOperationConfig. + + :return: The parent_ref of this ReadOperationConfig. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this ReadOperationConfig. + + :param parent_ref: The parent_ref of this ReadOperationConfig. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def operations(self): + """ + Gets the operations of this ReadOperationConfig. + An array of operations. + + + :return: The operations of this ReadOperationConfig. + :rtype: list[oci.data_connectivity.models.PushDownOperation] + """ + return self._operations + + @operations.setter + def operations(self, operations): + """ + Sets the operations of this ReadOperationConfig. + An array of operations. + + + :param operations: The operations of this ReadOperationConfig. + :type: list[oci.data_connectivity.models.PushDownOperation] + """ + self._operations = operations + + @property + def data_format(self): + """ + Gets the data_format of this ReadOperationConfig. + + :return: The data_format of this ReadOperationConfig. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this ReadOperationConfig. + + :param data_format: The data_format of this ReadOperationConfig. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def partition_config(self): + """ + Gets the partition_config of this ReadOperationConfig. + + :return: The partition_config of this ReadOperationConfig. + :rtype: oci.data_connectivity.models.PartitionConfig + """ + return self._partition_config + + @partition_config.setter + def partition_config(self, partition_config): + """ + Sets the partition_config of this ReadOperationConfig. + + :param partition_config: The partition_config of this ReadOperationConfig. + :type: oci.data_connectivity.models.PartitionConfig + """ + self._partition_config = partition_config + + @property + def read_attribute(self): + """ + Gets the read_attribute of this ReadOperationConfig. + + :return: The read_attribute of this ReadOperationConfig. + :rtype: oci.data_connectivity.models.AbstractReadAttribute + """ + return self._read_attribute + + @read_attribute.setter + def read_attribute(self, read_attribute): + """ + Sets the read_attribute of this ReadOperationConfig. + + :param read_attribute: The read_attribute of this ReadOperationConfig. + :type: oci.data_connectivity.models.AbstractReadAttribute + """ + self._read_attribute = read_attribute + + @property + def object_status(self): + """ + Gets the object_status of this ReadOperationConfig. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ReadOperationConfig. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ReadOperationConfig. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ReadOperationConfig. + :type: int + """ + self._object_status = object_status + + @property + def read_raw_data(self): + """ + Gets the read_raw_data of this ReadOperationConfig. + Specifies if this readOperationConfig operation should trigger raw data preview flow. + + + :return: The read_raw_data of this ReadOperationConfig. + :rtype: bool + """ + return self._read_raw_data + + @read_raw_data.setter + def read_raw_data(self, read_raw_data): + """ + Sets the read_raw_data of this ReadOperationConfig. + Specifies if this readOperationConfig operation should trigger raw data preview flow. + + + :param read_raw_data: The read_raw_data of this ReadOperationConfig. + :type: bool + """ + self._read_raw_data = read_raw_data + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/reference_artifact_summary.py b/src/oci/data_connectivity/models/reference_artifact_summary.py new file mode 100644 index 0000000000..d25b79e69d --- /dev/null +++ b/src/oci/data_connectivity/models/reference_artifact_summary.py @@ -0,0 +1,434 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferenceArtifactSummary(object): + """ + Represents Reference details of a data asset. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferenceArtifactSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ReferenceArtifactSummary. + :type model_type: str + + :param key: + The value to assign to the key property of this ReferenceArtifactSummary. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ReferenceArtifactSummary. + :type model_version: str + + :param name: + The value to assign to the name property of this ReferenceArtifactSummary. + :type name: str + + :param description: + The value to assign to the description property of this ReferenceArtifactSummary. + :type description: str + + :param object_status: + The value to assign to the object_status property of this ReferenceArtifactSummary. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this ReferenceArtifactSummary. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this ReferenceArtifactSummary. + :type identifier: str + + :param dcms_artifact_id: + The value to assign to the dcms_artifact_id property of this ReferenceArtifactSummary. + :type dcms_artifact_id: str + + :param service_artifact_id: + The value to assign to the service_artifact_id property of this ReferenceArtifactSummary. + :type service_artifact_id: str + + :param reference_count: + The value to assign to the reference_count property of this ReferenceArtifactSummary. + :type reference_count: int + + :param registry_metadata: + The value to assign to the registry_metadata property of this ReferenceArtifactSummary. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this ReferenceArtifactSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'dcms_artifact_id': 'str', + 'service_artifact_id': 'str', + 'reference_count': 'int', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'dcms_artifact_id': 'dcmsArtifactId', + 'service_artifact_id': 'serviceArtifactId', + 'reference_count': 'referenceCount', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata' + } + + self._model_type = None + self._key = None + self._model_version = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._dcms_artifact_id = None + self._service_artifact_id = None + self._reference_count = None + self._registry_metadata = None + self._metadata = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this ReferenceArtifactSummary. + The type of the ReferenceInfo. + + + :return: The model_type of this ReferenceArtifactSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ReferenceArtifactSummary. + The type of the ReferenceInfo. + + + :param model_type: The model_type of this ReferenceArtifactSummary. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this ReferenceArtifactSummary. + Generated key that can be used in API calls to identify referenceinfo. + + + :return: The key of this ReferenceArtifactSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferenceArtifactSummary. + Generated key that can be used in API calls to identify referenceinfo. + + + :param key: The key of this ReferenceArtifactSummary. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this ReferenceArtifactSummary. + The model version of an object. + + + :return: The model_version of this ReferenceArtifactSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ReferenceArtifactSummary. + The model version of an object. + + + :param model_version: The model_version of this ReferenceArtifactSummary. + :type: str + """ + self._model_version = model_version + + @property + def name(self): + """ + Gets the name of this ReferenceArtifactSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ReferenceArtifactSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ReferenceArtifactSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ReferenceArtifactSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ReferenceArtifactSummary. + User-defined description of the referenceInfo. + + + :return: The description of this ReferenceArtifactSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ReferenceArtifactSummary. + User-defined description of the referenceInfo. + + + :param description: The description of this ReferenceArtifactSummary. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this ReferenceArtifactSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ReferenceArtifactSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ReferenceArtifactSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ReferenceArtifactSummary. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this ReferenceArtifactSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ReferenceArtifactSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ReferenceArtifactSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ReferenceArtifactSummary. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this ReferenceArtifactSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this ReferenceArtifactSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ReferenceArtifactSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this ReferenceArtifactSummary. + :type: str + """ + self._identifier = identifier + + @property + def dcms_artifact_id(self): + """ + Gets the dcms_artifact_id of this ReferenceArtifactSummary. + unique id of dcms artifact that is getting registered. + + + :return: The dcms_artifact_id of this ReferenceArtifactSummary. + :rtype: str + """ + return self._dcms_artifact_id + + @dcms_artifact_id.setter + def dcms_artifact_id(self, dcms_artifact_id): + """ + Sets the dcms_artifact_id of this ReferenceArtifactSummary. + unique id of dcms artifact that is getting registered. + + + :param dcms_artifact_id: The dcms_artifact_id of this ReferenceArtifactSummary. + :type: str + """ + self._dcms_artifact_id = dcms_artifact_id + + @property + def service_artifact_id(self): + """ + **[Required]** Gets the service_artifact_id of this ReferenceArtifactSummary. + unique id of service which is referencing dcms artifact. + + + :return: The service_artifact_id of this ReferenceArtifactSummary. + :rtype: str + """ + return self._service_artifact_id + + @service_artifact_id.setter + def service_artifact_id(self, service_artifact_id): + """ + Sets the service_artifact_id of this ReferenceArtifactSummary. + unique id of service which is referencing dcms artifact. + + + :param service_artifact_id: The service_artifact_id of this ReferenceArtifactSummary. + :type: str + """ + self._service_artifact_id = service_artifact_id + + @property + def reference_count(self): + """ + Gets the reference_count of this ReferenceArtifactSummary. + count of how many times a dcms artifact has been registered by a service. + + + :return: The reference_count of this ReferenceArtifactSummary. + :rtype: int + """ + return self._reference_count + + @reference_count.setter + def reference_count(self, reference_count): + """ + Sets the reference_count of this ReferenceArtifactSummary. + count of how many times a dcms artifact has been registered by a service. + + + :param reference_count: The reference_count of this ReferenceArtifactSummary. + :type: int + """ + self._reference_count = reference_count + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this ReferenceArtifactSummary. + + :return: The registry_metadata of this ReferenceArtifactSummary. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this ReferenceArtifactSummary. + + :param registry_metadata: The registry_metadata of this ReferenceArtifactSummary. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this ReferenceArtifactSummary. + + :return: The metadata of this ReferenceArtifactSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this ReferenceArtifactSummary. + + :param metadata: The metadata of this ReferenceArtifactSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/reference_artifact_summary_collection.py b/src/oci/data_connectivity/models/reference_artifact_summary_collection.py new file mode 100644 index 0000000000..eeb70f09f2 --- /dev/null +++ b/src/oci/data_connectivity/models/reference_artifact_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferenceArtifactSummaryCollection(object): + """ + This is the collection of Reference details summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferenceArtifactSummaryCollection 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 ReferenceArtifactSummaryCollection. + :type items: list[oci.data_connectivity.models.ReferenceArtifactSummary] + + """ + self.swagger_types = { + 'items': 'list[ReferenceArtifactSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ReferenceArtifactSummaryCollection. + The array of data asset summaries. + + + :return: The items of this ReferenceArtifactSummaryCollection. + :rtype: list[oci.data_connectivity.models.ReferenceArtifactSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ReferenceArtifactSummaryCollection. + The array of data asset summaries. + + + :param items: The items of this ReferenceArtifactSummaryCollection. + :type: list[oci.data_connectivity.models.ReferenceArtifactSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/reference_info.py b/src/oci/data_connectivity/models/reference_info.py new file mode 100644 index 0000000000..6e82171337 --- /dev/null +++ b/src/oci/data_connectivity/models/reference_info.py @@ -0,0 +1,434 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferenceInfo(object): + """ + Represents reference details of a dcms artifact. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferenceInfo object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ReferenceInfo. + :type model_type: str + + :param key: + The value to assign to the key property of this ReferenceInfo. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ReferenceInfo. + :type model_version: str + + :param name: + The value to assign to the name property of this ReferenceInfo. + :type name: str + + :param description: + The value to assign to the description property of this ReferenceInfo. + :type description: str + + :param object_status: + The value to assign to the object_status property of this ReferenceInfo. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this ReferenceInfo. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this ReferenceInfo. + :type identifier: str + + :param dcms_artifact_id: + The value to assign to the dcms_artifact_id property of this ReferenceInfo. + :type dcms_artifact_id: str + + :param service_artifact_id: + The value to assign to the service_artifact_id property of this ReferenceInfo. + :type service_artifact_id: str + + :param reference_count: + The value to assign to the reference_count property of this ReferenceInfo. + :type reference_count: int + + :param registry_metadata: + The value to assign to the registry_metadata property of this ReferenceInfo. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this ReferenceInfo. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'dcms_artifact_id': 'str', + 'service_artifact_id': 'str', + 'reference_count': 'int', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'dcms_artifact_id': 'dcmsArtifactId', + 'service_artifact_id': 'serviceArtifactId', + 'reference_count': 'referenceCount', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata' + } + + self._model_type = None + self._key = None + self._model_version = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._dcms_artifact_id = None + self._service_artifact_id = None + self._reference_count = None + self._registry_metadata = None + self._metadata = None + + @property + def model_type(self): + """ + Gets the model_type of this ReferenceInfo. + The type of the ReferenceInfo. + + + :return: The model_type of this ReferenceInfo. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ReferenceInfo. + The type of the ReferenceInfo. + + + :param model_type: The model_type of this ReferenceInfo. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this ReferenceInfo. + Generated key that can be used in API calls to identify referenceinfo. + + + :return: The key of this ReferenceInfo. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferenceInfo. + Generated key that can be used in API calls to identify referenceinfo. + + + :param key: The key of this ReferenceInfo. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this ReferenceInfo. + The model version of an object. + + + :return: The model_version of this ReferenceInfo. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ReferenceInfo. + The model version of an object. + + + :param model_version: The model_version of this ReferenceInfo. + :type: str + """ + self._model_version = model_version + + @property + def name(self): + """ + Gets the name of this ReferenceInfo. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this ReferenceInfo. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ReferenceInfo. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this ReferenceInfo. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this ReferenceInfo. + User-defined description of the referenceInfo. + + + :return: The description of this ReferenceInfo. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ReferenceInfo. + User-defined description of the referenceInfo. + + + :param description: The description of this ReferenceInfo. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this ReferenceInfo. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this ReferenceInfo. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ReferenceInfo. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this ReferenceInfo. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this ReferenceInfo. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ReferenceInfo. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ReferenceInfo. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ReferenceInfo. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this ReferenceInfo. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this ReferenceInfo. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ReferenceInfo. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this ReferenceInfo. + :type: str + """ + self._identifier = identifier + + @property + def dcms_artifact_id(self): + """ + **[Required]** Gets the dcms_artifact_id of this ReferenceInfo. + unique id of dcms artifact that is getting registered. + + + :return: The dcms_artifact_id of this ReferenceInfo. + :rtype: str + """ + return self._dcms_artifact_id + + @dcms_artifact_id.setter + def dcms_artifact_id(self, dcms_artifact_id): + """ + Sets the dcms_artifact_id of this ReferenceInfo. + unique id of dcms artifact that is getting registered. + + + :param dcms_artifact_id: The dcms_artifact_id of this ReferenceInfo. + :type: str + """ + self._dcms_artifact_id = dcms_artifact_id + + @property + def service_artifact_id(self): + """ + **[Required]** Gets the service_artifact_id of this ReferenceInfo. + unique id of service which is referencing data asset. + + + :return: The service_artifact_id of this ReferenceInfo. + :rtype: str + """ + return self._service_artifact_id + + @service_artifact_id.setter + def service_artifact_id(self, service_artifact_id): + """ + Sets the service_artifact_id of this ReferenceInfo. + unique id of service which is referencing data asset. + + + :param service_artifact_id: The service_artifact_id of this ReferenceInfo. + :type: str + """ + self._service_artifact_id = service_artifact_id + + @property + def reference_count(self): + """ + Gets the reference_count of this ReferenceInfo. + count of how many times a data asset has been registered by a service. + + + :return: The reference_count of this ReferenceInfo. + :rtype: int + """ + return self._reference_count + + @reference_count.setter + def reference_count(self, reference_count): + """ + Sets the reference_count of this ReferenceInfo. + count of how many times a data asset has been registered by a service. + + + :param reference_count: The reference_count of this ReferenceInfo. + :type: int + """ + self._reference_count = reference_count + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this ReferenceInfo. + + :return: The registry_metadata of this ReferenceInfo. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this ReferenceInfo. + + :param registry_metadata: The registry_metadata of this ReferenceInfo. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this ReferenceInfo. + + :return: The metadata of this ReferenceInfo. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this ReferenceInfo. + + :param metadata: The metadata of this ReferenceInfo. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/registry.py b/src/oci/data_connectivity/models/registry.py new file mode 100644 index 0000000000..89e3ddb80a --- /dev/null +++ b/src/oci/data_connectivity/models/registry.py @@ -0,0 +1,436 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Registry(object): + """ + A registry is an organizational construct to keep multiple data Connectivity Management solutions and their resources (data assets, data flows, tasks, and so on) separate from each other, helping you to stay organized. For example, you could have separate registries for development, testing, and production. + """ + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "CREATING" + LIFECYCLE_STATE_CREATING = "CREATING" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "ACTIVE" + LIFECYCLE_STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "INACTIVE" + LIFECYCLE_STATE_INACTIVE = "INACTIVE" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "UPDATING" + LIFECYCLE_STATE_UPDATING = "UPDATING" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "DELETING" + LIFECYCLE_STATE_DELETING = "DELETING" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "DELETED" + LIFECYCLE_STATE_DELETED = "DELETED" + + #: A constant which can be used with the lifecycle_state property of a Registry. + #: This constant has a value of "FAILED" + LIFECYCLE_STATE_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new Registry object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param freeform_tags: + The value to assign to the freeform_tags property of this Registry. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this Registry. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this Registry. + :type description: str + + :param display_name: + The value to assign to the display_name property of this Registry. + :type display_name: str + + :param updated_by: + The value to assign to the updated_by property of this Registry. + :type updated_by: str + + :param compartment_id: + The value to assign to the compartment_id property of this Registry. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this Registry. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this Registry. + :type time_updated: datetime + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this Registry. + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type lifecycle_state: str + + :param state_message: + The value to assign to the state_message property of this Registry. + :type state_message: str + + :param id: + The value to assign to the id property of this Registry. + :type id: str + + """ + self.swagger_types = { + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str', + 'updated_by': 'str', + 'compartment_id': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'lifecycle_state': 'str', + 'state_message': 'str', + 'id': 'str' + } + + self.attribute_map = { + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName', + 'updated_by': 'updatedBy', + 'compartment_id': 'compartmentId', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'lifecycle_state': 'lifecycleState', + 'state_message': 'stateMessage', + 'id': 'id' + } + + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + self._updated_by = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._lifecycle_state = None + self._state_message = None + self._id = None + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this Registry. + 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 Registry. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this Registry. + 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 Registry. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this Registry. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this Registry. + :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 Registry. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this Registry. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this Registry. + Registry description + + + :return: The description of this Registry. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Registry. + Registry description + + + :param description: The description of this Registry. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this Registry. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this Registry. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this Registry. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this Registry. + :type: str + """ + self._display_name = display_name + + @property + def updated_by(self): + """ + Gets the updated_by of this Registry. + Name of the user who updated the DCMS Registry. + + + :return: The updated_by of this Registry. + :rtype: str + """ + return self._updated_by + + @updated_by.setter + def updated_by(self, updated_by): + """ + Sets the updated_by of this Registry. + Name of the user who updated the DCMS Registry. + + + :param updated_by: The updated_by of this Registry. + :type: str + """ + self._updated_by = updated_by + + @property + def compartment_id(self): + """ + Gets the compartment_id of this Registry. + Compartment Identifier + + + :return: The compartment_id of this Registry. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this Registry. + Compartment Identifier + + + :param compartment_id: The compartment_id of this Registry. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this Registry. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :return: The time_created of this Registry. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this Registry. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this Registry. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this Registry. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this Registry. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this Registry. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this Registry. + :type: datetime + """ + self._time_updated = time_updated + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this Registry. + Lifecycle states for registries in Data Connectivity Management Service + CREATING - The resource is being created and may not be usable until the entire metadata is defined + UPDATING - The resource is being updated and may not be usable until all changes are commited + DELETING - The resource is being deleted and might require deep cleanup of children. + ACTIVE - The resource is valid and available for access + INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for + administrative reasons + DELETED - The resource has been deleted and isn't available + FAILED - The resource is in a failed state due to validation or other errors + + Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The lifecycle_state of this Registry. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this Registry. + Lifecycle states for registries in Data Connectivity Management Service + CREATING - The resource is being created and may not be usable until the entire metadata is defined + UPDATING - The resource is being updated and may not be usable until all changes are commited + DELETING - The resource is being deleted and might require deep cleanup of children. + ACTIVE - The resource is valid and available for access + INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for + administrative reasons + DELETED - The resource has been deleted and isn't available + FAILED - The resource is in a failed state due to validation or other errors + + + :param lifecycle_state: The lifecycle_state of this Registry. + :type: str + """ + allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] + if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): + lifecycle_state = 'UNKNOWN_ENUM_VALUE' + self._lifecycle_state = lifecycle_state + + @property + def state_message(self): + """ + Gets the state_message of this Registry. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The state_message of this Registry. + :rtype: str + """ + return self._state_message + + @state_message.setter + def state_message(self, state_message): + """ + Sets the state_message of this Registry. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param state_message: The state_message of this Registry. + :type: str + """ + self._state_message = state_message + + @property + def id(self): + """ + **[Required]** Gets the id of this Registry. + Unique identifier that is immutable on creation + + + :return: The id of this Registry. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Registry. + Unique identifier that is immutable on creation + + + :param id: The id of this Registry. + :type: str + """ + self._id = id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/registry_metadata.py b/src/oci/data_connectivity/models/registry_metadata.py new file mode 100644 index 0000000000..543d2580b4 --- /dev/null +++ b/src/oci/data_connectivity/models/registry_metadata.py @@ -0,0 +1,380 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RegistryMetadata(object): + """ + Information about the object and its parent. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RegistryMetadata object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param aggregator_key: + The value to assign to the aggregator_key property of this RegistryMetadata. + :type aggregator_key: str + + :param labels: + The value to assign to the labels property of this RegistryMetadata. + :type labels: list[str] + + :param registry_version: + The value to assign to the registry_version property of this RegistryMetadata. + :type registry_version: int + + :param key: + The value to assign to the key property of this RegistryMetadata. + :type key: str + + :param is_favorite: + The value to assign to the is_favorite property of this RegistryMetadata. + :type is_favorite: bool + + :param created_by_user_id: + The value to assign to the created_by_user_id property of this RegistryMetadata. + :type created_by_user_id: str + + :param created_by_user_name: + The value to assign to the created_by_user_name property of this RegistryMetadata. + :type created_by_user_name: str + + :param updated_by_user_id: + The value to assign to the updated_by_user_id property of this RegistryMetadata. + :type updated_by_user_id: str + + :param updated_by_user_name: + The value to assign to the updated_by_user_name property of this RegistryMetadata. + :type updated_by_user_name: str + + :param time_created: + The value to assign to the time_created property of this RegistryMetadata. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this RegistryMetadata. + :type time_updated: datetime + + """ + self.swagger_types = { + 'aggregator_key': 'str', + 'labels': 'list[str]', + 'registry_version': 'int', + 'key': 'str', + 'is_favorite': 'bool', + 'created_by_user_id': 'str', + 'created_by_user_name': 'str', + 'updated_by_user_id': 'str', + 'updated_by_user_name': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime' + } + + self.attribute_map = { + 'aggregator_key': 'aggregatorKey', + 'labels': 'labels', + 'registry_version': 'registryVersion', + 'key': 'key', + 'is_favorite': 'isFavorite', + 'created_by_user_id': 'createdByUserId', + 'created_by_user_name': 'createdByUserName', + 'updated_by_user_id': 'updatedByUserId', + 'updated_by_user_name': 'updatedByUserName', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated' + } + + self._aggregator_key = None + self._labels = None + self._registry_version = None + self._key = None + self._is_favorite = None + self._created_by_user_id = None + self._created_by_user_name = None + self._updated_by_user_id = None + self._updated_by_user_name = None + self._time_created = None + self._time_updated = None + + @property + def aggregator_key(self): + """ + Gets the aggregator_key of this RegistryMetadata. + The owning object's key for this object. + + + :return: The aggregator_key of this RegistryMetadata. + :rtype: str + """ + return self._aggregator_key + + @aggregator_key.setter + def aggregator_key(self, aggregator_key): + """ + Sets the aggregator_key of this RegistryMetadata. + The owning object's key for this object. + + + :param aggregator_key: The aggregator_key of this RegistryMetadata. + :type: str + """ + self._aggregator_key = aggregator_key + + @property + def labels(self): + """ + Gets the labels of this RegistryMetadata. + Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. + + + :return: The labels of this RegistryMetadata. + :rtype: list[str] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this RegistryMetadata. + Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. + + + :param labels: The labels of this RegistryMetadata. + :type: list[str] + """ + self._labels = labels + + @property + def registry_version(self): + """ + Gets the registry_version of this RegistryMetadata. + The registry version. + + + :return: The registry_version of this RegistryMetadata. + :rtype: int + """ + return self._registry_version + + @registry_version.setter + def registry_version(self, registry_version): + """ + Sets the registry_version of this RegistryMetadata. + The registry version. + + + :param registry_version: The registry_version of this RegistryMetadata. + :type: int + """ + self._registry_version = registry_version + + @property + def key(self): + """ + Gets the key of this RegistryMetadata. + The identifying key for the object. + + + :return: The key of this RegistryMetadata. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this RegistryMetadata. + The identifying key for the object. + + + :param key: The key of this RegistryMetadata. + :type: str + """ + self._key = key + + @property + def is_favorite(self): + """ + Gets the is_favorite of this RegistryMetadata. + Specifies whether this object is a favorite or not. + + + :return: The is_favorite of this RegistryMetadata. + :rtype: bool + """ + return self._is_favorite + + @is_favorite.setter + def is_favorite(self, is_favorite): + """ + Sets the is_favorite of this RegistryMetadata. + Specifies whether this object is a favorite or not. + + + :param is_favorite: The is_favorite of this RegistryMetadata. + :type: bool + """ + self._is_favorite = is_favorite + + @property + def created_by_user_id(self): + """ + Gets the created_by_user_id of this RegistryMetadata. + The id of the user who created the object. + + + :return: The created_by_user_id of this RegistryMetadata. + :rtype: str + """ + return self._created_by_user_id + + @created_by_user_id.setter + def created_by_user_id(self, created_by_user_id): + """ + Sets the created_by_user_id of this RegistryMetadata. + The id of the user who created the object. + + + :param created_by_user_id: The created_by_user_id of this RegistryMetadata. + :type: str + """ + self._created_by_user_id = created_by_user_id + + @property + def created_by_user_name(self): + """ + Gets the created_by_user_name of this RegistryMetadata. + The name of the user who created the object. + + + :return: The created_by_user_name of this RegistryMetadata. + :rtype: str + """ + return self._created_by_user_name + + @created_by_user_name.setter + def created_by_user_name(self, created_by_user_name): + """ + Sets the created_by_user_name of this RegistryMetadata. + The name of the user who created the object. + + + :param created_by_user_name: The created_by_user_name of this RegistryMetadata. + :type: str + """ + self._created_by_user_name = created_by_user_name + + @property + def updated_by_user_id(self): + """ + Gets the updated_by_user_id of this RegistryMetadata. + The id of the user who updated the object. + + + :return: The updated_by_user_id of this RegistryMetadata. + :rtype: str + """ + return self._updated_by_user_id + + @updated_by_user_id.setter + def updated_by_user_id(self, updated_by_user_id): + """ + Sets the updated_by_user_id of this RegistryMetadata. + The id of the user who updated the object. + + + :param updated_by_user_id: The updated_by_user_id of this RegistryMetadata. + :type: str + """ + self._updated_by_user_id = updated_by_user_id + + @property + def updated_by_user_name(self): + """ + Gets the updated_by_user_name of this RegistryMetadata. + The name of the user who updated the object. + + + :return: The updated_by_user_name of this RegistryMetadata. + :rtype: str + """ + return self._updated_by_user_name + + @updated_by_user_name.setter + def updated_by_user_name(self, updated_by_user_name): + """ + Sets the updated_by_user_name of this RegistryMetadata. + The name of the user who updated the object. + + + :param updated_by_user_name: The updated_by_user_name of this RegistryMetadata. + :type: str + """ + self._updated_by_user_name = updated_by_user_name + + @property + def time_created(self): + """ + Gets the time_created of this RegistryMetadata. + The date and time that the object was created. + + + :return: The time_created of this RegistryMetadata. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this RegistryMetadata. + The date and time that the object was created. + + + :param time_created: The time_created of this RegistryMetadata. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this RegistryMetadata. + The date and time that the object was updated. + + + :return: The time_updated of this RegistryMetadata. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this RegistryMetadata. + The date and time that the object was updated. + + + :param time_updated: The time_updated of this RegistryMetadata. + :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/data_connectivity/models/registry_summary.py b/src/oci/data_connectivity/models/registry_summary.py new file mode 100644 index 0000000000..4a9b559cf9 --- /dev/null +++ b/src/oci/data_connectivity/models/registry_summary.py @@ -0,0 +1,384 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RegistrySummary(object): + """ + Summary of a Registry. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RegistrySummary 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 RegistrySummary. + :type id: str + + :param description: + The value to assign to the description property of this RegistrySummary. + :type description: str + + :param display_name: + The value to assign to the display_name property of this RegistrySummary. + :type display_name: str + + :param compartment_id: + The value to assign to the compartment_id property of this RegistrySummary. + :type compartment_id: str + + :param time_created: + The value to assign to the time_created property of this RegistrySummary. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this RegistrySummary. + :type time_updated: datetime + + :param freeform_tags: + The value to assign to the freeform_tags property of this RegistrySummary. + :type freeform_tags: dict(str, str) + + :param updated_by: + The value to assign to the updated_by property of this RegistrySummary. + :type updated_by: str + + :param defined_tags: + The value to assign to the defined_tags property of this RegistrySummary. + :type defined_tags: dict(str, dict(str, object)) + + :param lifecycle_state: + The value to assign to the lifecycle_state property of this RegistrySummary. + :type lifecycle_state: str + + :param state_message: + The value to assign to the state_message property of this RegistrySummary. + :type state_message: str + + """ + self.swagger_types = { + 'id': 'str', + 'description': 'str', + 'display_name': 'str', + 'compartment_id': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'freeform_tags': 'dict(str, str)', + 'updated_by': 'str', + 'defined_tags': 'dict(str, dict(str, object))', + 'lifecycle_state': 'str', + 'state_message': 'str' + } + + self.attribute_map = { + 'id': 'id', + 'description': 'description', + 'display_name': 'displayName', + 'compartment_id': 'compartmentId', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'freeform_tags': 'freeformTags', + 'updated_by': 'updatedBy', + 'defined_tags': 'definedTags', + 'lifecycle_state': 'lifecycleState', + 'state_message': 'stateMessage' + } + + self._id = None + self._description = None + self._display_name = None + self._compartment_id = None + self._time_created = None + self._time_updated = None + self._freeform_tags = None + self._updated_by = None + self._defined_tags = None + self._lifecycle_state = None + self._state_message = None + + @property + def id(self): + """ + **[Required]** Gets the id of this RegistrySummary. + Unique identifier that is immutable on creation + + + :return: The id of this RegistrySummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RegistrySummary. + Unique identifier that is immutable on creation + + + :param id: The id of this RegistrySummary. + :type: str + """ + self._id = id + + @property + def description(self): + """ + Gets the description of this RegistrySummary. + Registry description + + + :return: The description of this RegistrySummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this RegistrySummary. + Registry description + + + :param description: The description of this RegistrySummary. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + **[Required]** Gets the display_name of this RegistrySummary. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this RegistrySummary. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this RegistrySummary. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this RegistrySummary. + :type: str + """ + self._display_name = display_name + + @property + def compartment_id(self): + """ + Gets the compartment_id of this RegistrySummary. + Compartment Identifier + + + :return: The compartment_id of this RegistrySummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this RegistrySummary. + Compartment Identifier + + + :param compartment_id: The compartment_id of this RegistrySummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def time_created(self): + """ + Gets the time_created of this RegistrySummary. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :return: The time_created of this RegistrySummary. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this RegistrySummary. + The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string + + + :param time_created: The time_created of this RegistrySummary. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this RegistrySummary. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :return: The time_updated of this RegistrySummary. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this RegistrySummary. + The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string + + + :param time_updated: The time_updated of this RegistrySummary. + :type: datetime + """ + self._time_updated = time_updated + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this RegistrySummary. + 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 RegistrySummary. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this RegistrySummary. + 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 RegistrySummary. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def updated_by(self): + """ + Gets the updated_by of this RegistrySummary. + Name of the user who updated the DCMS Registry. + + + :return: The updated_by of this RegistrySummary. + :rtype: str + """ + return self._updated_by + + @updated_by.setter + def updated_by(self, updated_by): + """ + Sets the updated_by of this RegistrySummary. + Name of the user who updated the DCMS Registry. + + + :param updated_by: The updated_by of this RegistrySummary. + :type: str + """ + self._updated_by = updated_by + + @property + def defined_tags(self): + """ + Gets the defined_tags of this RegistrySummary. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this RegistrySummary. + :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 RegistrySummary. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this RegistrySummary. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def lifecycle_state(self): + """ + Gets the lifecycle_state of this RegistrySummary. + The current state of the registry. + + + :return: The lifecycle_state of this RegistrySummary. + :rtype: str + """ + return self._lifecycle_state + + @lifecycle_state.setter + def lifecycle_state(self, lifecycle_state): + """ + Sets the lifecycle_state of this RegistrySummary. + The current state of the registry. + + + :param lifecycle_state: The lifecycle_state of this RegistrySummary. + :type: str + """ + self._lifecycle_state = lifecycle_state + + @property + def state_message(self): + """ + Gets the state_message of this RegistrySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :return: The state_message of this RegistrySummary. + :rtype: str + """ + return self._state_message + + @state_message.setter + def state_message(self, state_message): + """ + Sets the state_message of this RegistrySummary. + A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + + + :param state_message: The state_message of this RegistrySummary. + :type: str + """ + self._state_message = state_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/registry_summary_collection.py b/src/oci/data_connectivity/models/registry_summary_collection.py new file mode 100644 index 0000000000..bc7efedcae --- /dev/null +++ b/src/oci/data_connectivity/models/registry_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RegistrySummaryCollection(object): + """ + List of Registry summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RegistrySummaryCollection 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 RegistrySummaryCollection. + :type items: list[oci.data_connectivity.models.RegistrySummary] + + """ + self.swagger_types = { + 'items': 'list[RegistrySummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this RegistrySummaryCollection. + The array of Registry summariess + + + :return: The items of this RegistrySummaryCollection. + :rtype: list[oci.data_connectivity.models.RegistrySummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this RegistrySummaryCollection. + The array of Registry summariess + + + :param items: The items of this RegistrySummaryCollection. + :type: list[oci.data_connectivity.models.RegistrySummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/row.py b/src/oci/data_connectivity/models/row.py new file mode 100644 index 0000000000..a3b49c895d --- /dev/null +++ b/src/oci/data_connectivity/models/row.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Row(object): + """ + Data preview row calues. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Row object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param values: + The value to assign to the values property of this Row. + :type values: list[str] + + """ + self.swagger_types = { + 'values': 'list[str]' + } + + self.attribute_map = { + 'values': 'values' + } + + self._values = None + + @property + def values(self): + """ + Gets the values of this Row. + Array of all the sampled rows. + + + :return: The values of this Row. + :rtype: list[str] + """ + return self._values + + @values.setter + def values(self, values): + """ + Sets the values of this Row. + Array of all the sampled rows. + + + :param values: The values of this Row. + :type: list[str] + """ + self._values = values + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/schema.py b/src/oci/data_connectivity/models/schema.py new file mode 100644 index 0000000000..36e901261f --- /dev/null +++ b/src/oci/data_connectivity/models/schema.py @@ -0,0 +1,465 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Schema(object): + """ + The schema object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Schema object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this Schema. + :type key: str + + :param model_type: + The value to assign to the model_type property of this Schema. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this Schema. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Schema. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this Schema. + :type name: str + + :param resource_name: + The value to assign to the resource_name property of this Schema. + :type resource_name: str + + :param description: + The value to assign to the description property of this Schema. + :type description: str + + :param object_version: + The value to assign to the object_version property of this Schema. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this Schema. + :type external_key: str + + :param is_has_containers: + The value to assign to the is_has_containers property of this Schema. + :type is_has_containers: bool + + :param default_connection: + The value to assign to the default_connection property of this Schema. + :type default_connection: str + + :param object_status: + The value to assign to the object_status property of this Schema. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this Schema. + :type identifier: str + + :param metadata: + The value to assign to the metadata property of this Schema. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'resource_name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'is_has_containers': 'bool', + 'default_connection': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'resource_name': 'resourceName', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'is_has_containers': 'isHasContainers', + 'default_connection': 'defaultConnection', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'metadata': 'metadata' + } + + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._resource_name = None + self._description = None + self._object_version = None + self._external_key = None + self._is_has_containers = None + self._default_connection = None + self._object_status = None + self._identifier = None + self._metadata = None + + @property + def key(self): + """ + **[Required]** Gets the key of this Schema. + The object key. + + + :return: The key of this Schema. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this Schema. + The object key. + + + :param key: The key of this Schema. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this Schema. + The object's type. + + + :return: The model_type of this Schema. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this Schema. + The object's type. + + + :param model_type: The model_type of this Schema. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this Schema. + The object's model version. + + + :return: The model_version of this Schema. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this Schema. + The object's model version. + + + :param model_version: The model_version of this Schema. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this Schema. + + :return: The parent_ref of this Schema. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this Schema. + + :param parent_ref: The parent_ref of this Schema. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this Schema. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this Schema. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Schema. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this Schema. + :type: str + """ + self._name = name + + @property + def resource_name(self): + """ + Gets the resource_name of this Schema. + A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. + + + :return: The resource_name of this Schema. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this Schema. + A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. + + + :param resource_name: The resource_name of this Schema. + :type: str + """ + self._resource_name = resource_name + + @property + def description(self): + """ + Gets the description of this Schema. + User-defined description for the schema. + + + :return: The description of this Schema. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Schema. + User-defined description for the schema. + + + :param description: The description of this Schema. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this Schema. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this Schema. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this Schema. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this Schema. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this Schema. + The external key for the object. + + + :return: The external_key of this Schema. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this Schema. + The external key for the object. + + + :param external_key: The external_key of this Schema. + :type: str + """ + self._external_key = external_key + + @property + def is_has_containers(self): + """ + Gets the is_has_containers of this Schema. + Specifies whether the schema has containers. + + + :return: The is_has_containers of this Schema. + :rtype: bool + """ + return self._is_has_containers + + @is_has_containers.setter + def is_has_containers(self, is_has_containers): + """ + Sets the is_has_containers of this Schema. + Specifies whether the schema has containers. + + + :param is_has_containers: The is_has_containers of this Schema. + :type: bool + """ + self._is_has_containers = is_has_containers + + @property + def default_connection(self): + """ + Gets the default_connection of this Schema. + The default connection key. + + + :return: The default_connection of this Schema. + :rtype: str + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this Schema. + The default connection key. + + + :param default_connection: The default_connection of this Schema. + :type: str + """ + self._default_connection = default_connection + + @property + def object_status(self): + """ + Gets the object_status of this Schema. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this Schema. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this Schema. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this Schema. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this Schema. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this Schema. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this Schema. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this Schema. + :type: str + """ + self._identifier = identifier + + @property + def metadata(self): + """ + Gets the metadata of this Schema. + + :return: The metadata of this Schema. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this Schema. + + :param metadata: The metadata of this Schema. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/schema_drift_config.py b/src/oci/data_connectivity/models/schema_drift_config.py new file mode 100644 index 0000000000..3fcd7d77bd --- /dev/null +++ b/src/oci/data_connectivity/models/schema_drift_config.py @@ -0,0 +1,226 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SchemaDriftConfig(object): + """ + The configuration for handling schema drift in a Source or Target operator. + """ + + #: A constant which can be used with the extra_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "ALLOW" + EXTRA_COLUMN_HANDLING_ALLOW = "ALLOW" + + #: A constant which can be used with the extra_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "NULL_FILLUP" + EXTRA_COLUMN_HANDLING_NULL_FILLUP = "NULL_FILLUP" + + #: A constant which can be used with the extra_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "DO_NOT_ALLOW" + EXTRA_COLUMN_HANDLING_DO_NOT_ALLOW = "DO_NOT_ALLOW" + + #: A constant which can be used with the missing_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "ALLOW" + MISSING_COLUMN_HANDLING_ALLOW = "ALLOW" + + #: A constant which can be used with the missing_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "NULL_SELECT" + MISSING_COLUMN_HANDLING_NULL_SELECT = "NULL_SELECT" + + #: A constant which can be used with the missing_column_handling property of a SchemaDriftConfig. + #: This constant has a value of "DO_NOT_ALLOW" + MISSING_COLUMN_HANDLING_DO_NOT_ALLOW = "DO_NOT_ALLOW" + + #: A constant which can be used with the data_type_change_handling property of a SchemaDriftConfig. + #: This constant has a value of "ALLOW" + DATA_TYPE_CHANGE_HANDLING_ALLOW = "ALLOW" + + #: A constant which can be used with the data_type_change_handling property of a SchemaDriftConfig. + #: This constant has a value of "DO_CAST_IF_POSSIBLE" + DATA_TYPE_CHANGE_HANDLING_DO_CAST_IF_POSSIBLE = "DO_CAST_IF_POSSIBLE" + + #: A constant which can be used with the data_type_change_handling property of a SchemaDriftConfig. + #: This constant has a value of "DO_NOT_ALLOW" + DATA_TYPE_CHANGE_HANDLING_DO_NOT_ALLOW = "DO_NOT_ALLOW" + + def __init__(self, **kwargs): + """ + Initializes a new SchemaDriftConfig object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param extra_column_handling: + The value to assign to the extra_column_handling property of this SchemaDriftConfig. + Allowed values for this property are: "ALLOW", "NULL_FILLUP", "DO_NOT_ALLOW" + :type extra_column_handling: str + + :param missing_column_handling: + The value to assign to the missing_column_handling property of this SchemaDriftConfig. + Allowed values for this property are: "ALLOW", "NULL_SELECT", "DO_NOT_ALLOW" + :type missing_column_handling: str + + :param data_type_change_handling: + The value to assign to the data_type_change_handling property of this SchemaDriftConfig. + Allowed values for this property are: "ALLOW", "DO_CAST_IF_POSSIBLE", "DO_NOT_ALLOW" + :type data_type_change_handling: str + + :param is_validation_warning_if_allowed: + The value to assign to the is_validation_warning_if_allowed property of this SchemaDriftConfig. + :type is_validation_warning_if_allowed: bool + + """ + self.swagger_types = { + 'extra_column_handling': 'str', + 'missing_column_handling': 'str', + 'data_type_change_handling': 'str', + 'is_validation_warning_if_allowed': 'bool' + } + + self.attribute_map = { + 'extra_column_handling': 'extraColumnHandling', + 'missing_column_handling': 'missingColumnHandling', + 'data_type_change_handling': 'dataTypeChangeHandling', + 'is_validation_warning_if_allowed': 'isValidationWarningIfAllowed' + } + + self._extra_column_handling = None + self._missing_column_handling = None + self._data_type_change_handling = None + self._is_validation_warning_if_allowed = None + + @property + def extra_column_handling(self): + """ + Gets the extra_column_handling of this SchemaDriftConfig. + The setting for how to handle extra columns/fields. NULL_FILLUP means that nulls will be loaded into the target for extra columns. + + Allowed values for this property are: "ALLOW", "NULL_FILLUP", "DO_NOT_ALLOW" + + + :return: The extra_column_handling of this SchemaDriftConfig. + :rtype: str + """ + return self._extra_column_handling + + @extra_column_handling.setter + def extra_column_handling(self, extra_column_handling): + """ + Sets the extra_column_handling of this SchemaDriftConfig. + The setting for how to handle extra columns/fields. NULL_FILLUP means that nulls will be loaded into the target for extra columns. + + + :param extra_column_handling: The extra_column_handling of this SchemaDriftConfig. + :type: str + """ + allowed_values = ["ALLOW", "NULL_FILLUP", "DO_NOT_ALLOW"] + if not value_allowed_none_or_none_sentinel(extra_column_handling, allowed_values): + raise ValueError( + "Invalid value for `extra_column_handling`, must be None or one of {0}" + .format(allowed_values) + ) + self._extra_column_handling = extra_column_handling + + @property + def missing_column_handling(self): + """ + Gets the missing_column_handling of this SchemaDriftConfig. + The setting for how to handle missing columns/fields. NULL_SELECT means that null values will be selected from the source for missing columns. + + Allowed values for this property are: "ALLOW", "NULL_SELECT", "DO_NOT_ALLOW" + + + :return: The missing_column_handling of this SchemaDriftConfig. + :rtype: str + """ + return self._missing_column_handling + + @missing_column_handling.setter + def missing_column_handling(self, missing_column_handling): + """ + Sets the missing_column_handling of this SchemaDriftConfig. + The setting for how to handle missing columns/fields. NULL_SELECT means that null values will be selected from the source for missing columns. + + + :param missing_column_handling: The missing_column_handling of this SchemaDriftConfig. + :type: str + """ + allowed_values = ["ALLOW", "NULL_SELECT", "DO_NOT_ALLOW"] + if not value_allowed_none_or_none_sentinel(missing_column_handling, allowed_values): + raise ValueError( + "Invalid value for `missing_column_handling`, must be None or one of {0}" + .format(allowed_values) + ) + self._missing_column_handling = missing_column_handling + + @property + def data_type_change_handling(self): + """ + Gets the data_type_change_handling of this SchemaDriftConfig. + The setting for how to handle columns/fields with changed data types. + + Allowed values for this property are: "ALLOW", "DO_CAST_IF_POSSIBLE", "DO_NOT_ALLOW" + + + :return: The data_type_change_handling of this SchemaDriftConfig. + :rtype: str + """ + return self._data_type_change_handling + + @data_type_change_handling.setter + def data_type_change_handling(self, data_type_change_handling): + """ + Sets the data_type_change_handling of this SchemaDriftConfig. + The setting for how to handle columns/fields with changed data types. + + + :param data_type_change_handling: The data_type_change_handling of this SchemaDriftConfig. + :type: str + """ + allowed_values = ["ALLOW", "DO_CAST_IF_POSSIBLE", "DO_NOT_ALLOW"] + if not value_allowed_none_or_none_sentinel(data_type_change_handling, allowed_values): + raise ValueError( + "Invalid value for `data_type_change_handling`, must be None or one of {0}" + .format(allowed_values) + ) + self._data_type_change_handling = data_type_change_handling + + @property + def is_validation_warning_if_allowed(self): + """ + Gets the is_validation_warning_if_allowed of this SchemaDriftConfig. + If true, display a validation warning for schema changes, even if they are allowed. + + + :return: The is_validation_warning_if_allowed of this SchemaDriftConfig. + :rtype: bool + """ + return self._is_validation_warning_if_allowed + + @is_validation_warning_if_allowed.setter + def is_validation_warning_if_allowed(self, is_validation_warning_if_allowed): + """ + Sets the is_validation_warning_if_allowed of this SchemaDriftConfig. + If true, display a validation warning for schema changes, even if they are allowed. + + + :param is_validation_warning_if_allowed: The is_validation_warning_if_allowed of this SchemaDriftConfig. + :type: bool + """ + self._is_validation_warning_if_allowed = is_validation_warning_if_allowed + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/schema_summary.py b/src/oci/data_connectivity/models/schema_summary.py new file mode 100644 index 0000000000..9e922e2362 --- /dev/null +++ b/src/oci/data_connectivity/models/schema_summary.py @@ -0,0 +1,465 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SchemaSummary(object): + """ + The schema summary object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SchemaSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this SchemaSummary. + :type key: str + + :param model_type: + The value to assign to the model_type property of this SchemaSummary. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this SchemaSummary. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this SchemaSummary. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this SchemaSummary. + :type name: str + + :param resource_name: + The value to assign to the resource_name property of this SchemaSummary. + :type resource_name: str + + :param description: + The value to assign to the description property of this SchemaSummary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this SchemaSummary. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this SchemaSummary. + :type external_key: str + + :param is_has_containers: + The value to assign to the is_has_containers property of this SchemaSummary. + :type is_has_containers: bool + + :param default_connection: + The value to assign to the default_connection property of this SchemaSummary. + :type default_connection: str + + :param object_status: + The value to assign to the object_status property of this SchemaSummary. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this SchemaSummary. + :type identifier: str + + :param metadata: + The value to assign to the metadata property of this SchemaSummary. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + """ + self.swagger_types = { + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'resource_name': 'str', + 'description': 'str', + 'object_version': 'int', + 'external_key': 'str', + 'is_has_containers': 'bool', + 'default_connection': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'metadata': 'ObjectMetadata' + } + + self.attribute_map = { + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'resource_name': 'resourceName', + 'description': 'description', + 'object_version': 'objectVersion', + 'external_key': 'externalKey', + 'is_has_containers': 'isHasContainers', + 'default_connection': 'defaultConnection', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'metadata': 'metadata' + } + + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._resource_name = None + self._description = None + self._object_version = None + self._external_key = None + self._is_has_containers = None + self._default_connection = None + self._object_status = None + self._identifier = None + self._metadata = None + + @property + def key(self): + """ + **[Required]** Gets the key of this SchemaSummary. + The object key. + + + :return: The key of this SchemaSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this SchemaSummary. + The object key. + + + :param key: The key of this SchemaSummary. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this SchemaSummary. + The object's type. + + + :return: The model_type of this SchemaSummary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this SchemaSummary. + The object's type. + + + :param model_type: The model_type of this SchemaSummary. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this SchemaSummary. + The object's model version. + + + :return: The model_version of this SchemaSummary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this SchemaSummary. + The object's model version. + + + :param model_version: The model_version of this SchemaSummary. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this SchemaSummary. + + :return: The parent_ref of this SchemaSummary. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this SchemaSummary. + + :param parent_ref: The parent_ref of this SchemaSummary. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this SchemaSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this SchemaSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SchemaSummary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this SchemaSummary. + :type: str + """ + self._name = name + + @property + def resource_name(self): + """ + Gets the resource_name of this SchemaSummary. + A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. + + + :return: The resource_name of this SchemaSummary. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this SchemaSummary. + A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. + + + :param resource_name: The resource_name of this SchemaSummary. + :type: str + """ + self._resource_name = resource_name + + @property + def description(self): + """ + Gets the description of this SchemaSummary. + User-defined description for the schema. + + + :return: The description of this SchemaSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SchemaSummary. + User-defined description for the schema. + + + :param description: The description of this SchemaSummary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this SchemaSummary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this SchemaSummary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this SchemaSummary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this SchemaSummary. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this SchemaSummary. + The external key for the object. + + + :return: The external_key of this SchemaSummary. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this SchemaSummary. + The external key for the object. + + + :param external_key: The external_key of this SchemaSummary. + :type: str + """ + self._external_key = external_key + + @property + def is_has_containers(self): + """ + Gets the is_has_containers of this SchemaSummary. + Specifies whether the schema has containers. + + + :return: The is_has_containers of this SchemaSummary. + :rtype: bool + """ + return self._is_has_containers + + @is_has_containers.setter + def is_has_containers(self, is_has_containers): + """ + Sets the is_has_containers of this SchemaSummary. + Specifies whether the schema has containers. + + + :param is_has_containers: The is_has_containers of this SchemaSummary. + :type: bool + """ + self._is_has_containers = is_has_containers + + @property + def default_connection(self): + """ + Gets the default_connection of this SchemaSummary. + The default connection key. + + + :return: The default_connection of this SchemaSummary. + :rtype: str + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this SchemaSummary. + The default connection key. + + + :param default_connection: The default_connection of this SchemaSummary. + :type: str + """ + self._default_connection = default_connection + + @property + def object_status(self): + """ + Gets the object_status of this SchemaSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this SchemaSummary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this SchemaSummary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this SchemaSummary. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this SchemaSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this SchemaSummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this SchemaSummary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this SchemaSummary. + :type: str + """ + self._identifier = identifier + + @property + def metadata(self): + """ + Gets the metadata of this SchemaSummary. + + :return: The metadata of this SchemaSummary. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this SchemaSummary. + + :param metadata: The metadata of this SchemaSummary. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/schema_summary_collection.py b/src/oci/data_connectivity/models/schema_summary_collection.py new file mode 100644 index 0000000000..f97df42fb0 --- /dev/null +++ b/src/oci/data_connectivity/models/schema_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SchemaSummaryCollection(object): + """ + This is the collection of schema summaries, it may be a collection of lightweight details or full definitions. + """ + + def __init__(self, **kwargs): + """ + Initializes a new SchemaSummaryCollection 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 SchemaSummaryCollection. + :type items: list[oci.data_connectivity.models.SchemaSummary] + + """ + self.swagger_types = { + 'items': 'list[SchemaSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this SchemaSummaryCollection. + The array of schema summaries. + + + :return: The items of this SchemaSummaryCollection. + :rtype: list[oci.data_connectivity.models.SchemaSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this SchemaSummaryCollection. + The array of schema summaries. + + + :param items: The items of this SchemaSummaryCollection. + :type: list[oci.data_connectivity.models.SchemaSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/select.py b/src/oci/data_connectivity/models/select.py new file mode 100644 index 0000000000..81cbedaa8c --- /dev/null +++ b/src/oci/data_connectivity/models/select.py @@ -0,0 +1,111 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .push_down_operation import PushDownOperation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Select(PushDownOperation): + """ + The information about the select object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Select object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Select.model_type` attribute + of this class is ``SELECT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Select. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + :param is_distinct: + The value to assign to the is_distinct property of this Select. + :type is_distinct: bool + + :param select_columns: + The value to assign to the select_columns property of this Select. + :type select_columns: list[oci.data_connectivity.models.ShapeField] + + """ + self.swagger_types = { + 'model_type': 'str', + 'is_distinct': 'bool', + 'select_columns': 'list[ShapeField]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'is_distinct': 'isDistinct', + 'select_columns': 'selectColumns' + } + + self._model_type = None + self._is_distinct = None + self._select_columns = None + self._model_type = 'SELECT' + + @property + def is_distinct(self): + """ + Gets the is_distinct of this Select. + Specifies whether the object is distinct. + + + :return: The is_distinct of this Select. + :rtype: bool + """ + return self._is_distinct + + @is_distinct.setter + def is_distinct(self, is_distinct): + """ + Sets the is_distinct of this Select. + Specifies whether the object is distinct. + + + :param is_distinct: The is_distinct of this Select. + :type: bool + """ + self._is_distinct = is_distinct + + @property + def select_columns(self): + """ + **[Required]** Gets the select_columns of this Select. + An array of selected columns. + + + :return: The select_columns of this Select. + :rtype: list[oci.data_connectivity.models.ShapeField] + """ + return self._select_columns + + @select_columns.setter + def select_columns(self, select_columns): + """ + Sets the select_columns of this Select. + An array of selected columns. + + + :param select_columns: The select_columns of this Select. + :type: list[oci.data_connectivity.models.ShapeField] + """ + self._select_columns = select_columns + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/shape.py b/src/oci/data_connectivity/models/shape.py new file mode 100644 index 0000000000..73ef524b8f --- /dev/null +++ b/src/oci/data_connectivity/models/shape.py @@ -0,0 +1,126 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Shape(TypedObject): + """ + The shape object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Shape object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Shape.model_type` attribute + of this class is ``SHAPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Shape. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this Shape. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Shape. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Shape. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this Shape. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this Shape. + :type object_status: int + + :param name: + The value to assign to the name property of this Shape. + :type name: str + + :param description: + The value to assign to the description property of this Shape. + :type description: str + + :param type: + The value to assign to the type property of this Shape. + :type type: oci.data_connectivity.models.BaseType + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'type': 'BaseType' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'type': 'type' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._type = None + self._model_type = 'SHAPE' + + @property + def type(self): + """ + Gets the type of this Shape. + + :return: The type of this Shape. + :rtype: oci.data_connectivity.models.BaseType + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Shape. + + :param type: The type of this Shape. + :type: oci.data_connectivity.models.BaseType + """ + 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/data_connectivity/models/shape_field.py b/src/oci/data_connectivity/models/shape_field.py new file mode 100644 index 0000000000..0898665ad5 --- /dev/null +++ b/src/oci/data_connectivity/models/shape_field.py @@ -0,0 +1,187 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .typed_object import TypedObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ShapeField(TypedObject): + """ + The shape field object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ShapeField object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ShapeField.model_type` attribute + of this class is ``SHAPE_FIELD`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this ShapeField. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this ShapeField. + :type key: str + + :param model_version: + The value to assign to the model_version property of this ShapeField. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ShapeField. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this ShapeField. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this ShapeField. + :type object_status: int + + :param name: + The value to assign to the name property of this ShapeField. + :type name: str + + :param description: + The value to assign to the description property of this ShapeField. + :type description: str + + :param type: + The value to assign to the type property of this ShapeField. + :type type: object + + :param labels: + The value to assign to the labels property of this ShapeField. + :type labels: list[str] + + :param native_shape_field: + The value to assign to the native_shape_field property of this ShapeField. + :type native_shape_field: oci.data_connectivity.models.NativeShapeField + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str', + 'type': 'object', + 'labels': 'list[str]', + 'native_shape_field': 'NativeShapeField' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description', + 'type': 'type', + 'labels': 'labels', + 'native_shape_field': 'nativeShapeField' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + self._type = None + self._labels = None + self._native_shape_field = None + self._model_type = 'SHAPE_FIELD' + + @property + def type(self): + """ + Gets the type of this ShapeField. + The type reference. + + + :return: The type of this ShapeField. + :rtype: object + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ShapeField. + The type reference. + + + :param type: The type of this ShapeField. + :type: object + """ + self._type = type + + @property + def labels(self): + """ + Gets the labels of this ShapeField. + Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. + + + :return: The labels of this ShapeField. + :rtype: list[str] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this ShapeField. + Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. + + + :param labels: The labels of this ShapeField. + :type: list[str] + """ + self._labels = labels + + @property + def native_shape_field(self): + """ + Gets the native_shape_field of this ShapeField. + + :return: The native_shape_field of this ShapeField. + :rtype: oci.data_connectivity.models.NativeShapeField + """ + return self._native_shape_field + + @native_shape_field.setter + def native_shape_field(self, native_shape_field): + """ + Sets the native_shape_field of this ShapeField. + + :param native_shape_field: The native_shape_field of this ShapeField. + :type: oci.data_connectivity.models.NativeShapeField + """ + self._native_shape_field = native_shape_field + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/sort.py b/src/oci/data_connectivity/models/sort.py new file mode 100644 index 0000000000..381f0e5b1a --- /dev/null +++ b/src/oci/data_connectivity/models/sort.py @@ -0,0 +1,80 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .push_down_operation import PushDownOperation +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Sort(PushDownOperation): + """ + The information about the sort object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Sort object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Sort.model_type` attribute + of this class is ``SORT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Sort. + Allowed values for this property are: "FILTER", "JOIN", "SELECT", "SORT", "QUERY" + :type model_type: str + + :param sort_clauses: + The value to assign to the sort_clauses property of this Sort. + :type sort_clauses: list[oci.data_connectivity.models.SortClause] + + """ + self.swagger_types = { + 'model_type': 'str', + 'sort_clauses': 'list[SortClause]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'sort_clauses': 'sortClauses' + } + + self._model_type = None + self._sort_clauses = None + self._model_type = 'SORT' + + @property + def sort_clauses(self): + """ + **[Required]** Gets the sort_clauses of this Sort. + The sort clause. + + + :return: The sort_clauses of this Sort. + :rtype: list[oci.data_connectivity.models.SortClause] + """ + return self._sort_clauses + + @sort_clauses.setter + def sort_clauses(self, sort_clauses): + """ + Sets the sort_clauses of this Sort. + The sort clause. + + + :param sort_clauses: The sort_clauses of this Sort. + :type: list[oci.data_connectivity.models.SortClause] + """ + self._sort_clauses = sort_clauses + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/sort_clause.py b/src/oci/data_connectivity/models/sort_clause.py new file mode 100644 index 0000000000..8f3d3c3efd --- /dev/null +++ b/src/oci/data_connectivity/models/sort_clause.py @@ -0,0 +1,114 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class SortClause(object): + """ + The information about the sort object. + """ + + #: A constant which can be used with the order property of a SortClause. + #: This constant has a value of "ASC" + ORDER_ASC = "ASC" + + #: A constant which can be used with the order property of a SortClause. + #: This constant has a value of "DESC" + ORDER_DESC = "DESC" + + def __init__(self, **kwargs): + """ + Initializes a new SortClause object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param field: + The value to assign to the field property of this SortClause. + :type field: oci.data_connectivity.models.ShapeField + + :param order: + The value to assign to the order property of this SortClause. + Allowed values for this property are: "ASC", "DESC" + :type order: str + + """ + self.swagger_types = { + 'field': 'ShapeField', + 'order': 'str' + } + + self.attribute_map = { + 'field': 'field', + 'order': 'order' + } + + self._field = None + self._order = None + + @property + def field(self): + """ + Gets the field of this SortClause. + + :return: The field of this SortClause. + :rtype: oci.data_connectivity.models.ShapeField + """ + return self._field + + @field.setter + def field(self, field): + """ + Sets the field of this SortClause. + + :param field: The field of this SortClause. + :type: oci.data_connectivity.models.ShapeField + """ + self._field = field + + @property + def order(self): + """ + Gets the order of this SortClause. + The sort order. + + Allowed values for this property are: "ASC", "DESC" + + + :return: The order of this SortClause. + :rtype: str + """ + return self._order + + @order.setter + def order(self, order): + """ + Sets the order of this SortClause. + The sort order. + + + :param order: The order of this SortClause. + :type: str + """ + allowed_values = ["ASC", "DESC"] + if not value_allowed_none_or_none_sentinel(order, allowed_values): + raise ValueError( + "Invalid value for `order`, must be None or one of {0}" + .format(allowed_values) + ) + self._order = order + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/source.py b/src/oci/data_connectivity/models/source.py new file mode 100644 index 0000000000..7fd598c505 --- /dev/null +++ b/src/oci/data_connectivity/models/source.py @@ -0,0 +1,334 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_connectivity_validation_details import CreateConnectivityValidationDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Source(CreateConnectivityValidationDetails): + """ + The information about the source object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new Source object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Source.model_type` attribute + of this class is ``SOURCE_OPERATOR`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Source. + Allowed values for this property are: "SOURCE_OPERATOR", "TARGET_OPERATOR" + :type model_type: str + + :param key: + The value to assign to the key property of this Source. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Source. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Source. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this Source. + :type name: str + + :param description: + The value to assign to the description property of this Source. + :type description: str + + :param object_version: + The value to assign to the object_version property of this Source. + :type object_version: int + + :param input_ports: + The value to assign to the input_ports property of this Source. + :type input_ports: list[oci.data_connectivity.models.InputPort] + + :param output_ports: + The value to assign to the output_ports property of this Source. + :type output_ports: list[oci.data_connectivity.models.OutputPort] + + :param object_status: + The value to assign to the object_status property of this Source. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this Source. + :type identifier: str + + :param parameters: + The value to assign to the parameters property of this Source. + :type parameters: list[oci.data_connectivity.models.Parameter] + + :param op_config_values: + The value to assign to the op_config_values property of this Source. + :type op_config_values: oci.data_connectivity.models.ConfigValues + + :param entity: + The value to assign to the entity property of this Source. + :type entity: oci.data_connectivity.models.DataEntity + + :param is_read_access: + The value to assign to the is_read_access property of this Source. + :type is_read_access: bool + + :param is_copy_fields: + The value to assign to the is_copy_fields property of this Source. + :type is_copy_fields: bool + + :param is_predefined_shape: + The value to assign to the is_predefined_shape property of this Source. + :type is_predefined_shape: bool + + :param schema_drift_config: + The value to assign to the schema_drift_config property of this Source. + :type schema_drift_config: oci.data_connectivity.models.SchemaDriftConfig + + :param fixed_data_shape: + The value to assign to the fixed_data_shape property of this Source. + :type fixed_data_shape: oci.data_connectivity.models.Shape + + :param read_operation_config: + The value to assign to the read_operation_config property of this Source. + :type read_operation_config: oci.data_connectivity.models.ReadOperationConfig + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'input_ports': 'list[InputPort]', + 'output_ports': 'list[OutputPort]', + 'object_status': 'int', + 'identifier': 'str', + 'parameters': 'list[Parameter]', + 'op_config_values': 'ConfigValues', + 'entity': 'DataEntity', + 'is_read_access': 'bool', + 'is_copy_fields': 'bool', + 'is_predefined_shape': 'bool', + 'schema_drift_config': 'SchemaDriftConfig', + 'fixed_data_shape': 'Shape', + 'read_operation_config': 'ReadOperationConfig' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'input_ports': 'inputPorts', + 'output_ports': 'outputPorts', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'parameters': 'parameters', + 'op_config_values': 'opConfigValues', + 'entity': 'entity', + 'is_read_access': 'isReadAccess', + 'is_copy_fields': 'isCopyFields', + 'is_predefined_shape': 'isPredefinedShape', + 'schema_drift_config': 'schemaDriftConfig', + 'fixed_data_shape': 'fixedDataShape', + 'read_operation_config': 'readOperationConfig' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._input_ports = None + self._output_ports = None + self._object_status = None + self._identifier = None + self._parameters = None + self._op_config_values = None + self._entity = None + self._is_read_access = None + self._is_copy_fields = None + self._is_predefined_shape = None + self._schema_drift_config = None + self._fixed_data_shape = None + self._read_operation_config = None + self._model_type = 'SOURCE_OPERATOR' + + @property + def entity(self): + """ + **[Required]** Gets the entity of this Source. + + :return: The entity of this Source. + :rtype: oci.data_connectivity.models.DataEntity + """ + return self._entity + + @entity.setter + def entity(self, entity): + """ + Sets the entity of this Source. + + :param entity: The entity of this Source. + :type: oci.data_connectivity.models.DataEntity + """ + self._entity = entity + + @property + def is_read_access(self): + """ + Gets the is_read_access of this Source. + Specifies the read access. + + + :return: The is_read_access of this Source. + :rtype: bool + """ + return self._is_read_access + + @is_read_access.setter + def is_read_access(self, is_read_access): + """ + Sets the is_read_access of this Source. + Specifies the read access. + + + :param is_read_access: The is_read_access of this Source. + :type: bool + """ + self._is_read_access = is_read_access + + @property + def is_copy_fields(self): + """ + Gets the is_copy_fields of this Source. + Specifies the copy fields. + + + :return: The is_copy_fields of this Source. + :rtype: bool + """ + return self._is_copy_fields + + @is_copy_fields.setter + def is_copy_fields(self, is_copy_fields): + """ + Sets the is_copy_fields of this Source. + Specifies the copy fields. + + + :param is_copy_fields: The is_copy_fields of this Source. + :type: bool + """ + self._is_copy_fields = is_copy_fields + + @property + def is_predefined_shape(self): + """ + Gets the is_predefined_shape of this Source. + Specifies if this uses a predefined shape. + + + :return: The is_predefined_shape of this Source. + :rtype: bool + """ + return self._is_predefined_shape + + @is_predefined_shape.setter + def is_predefined_shape(self, is_predefined_shape): + """ + Sets the is_predefined_shape of this Source. + Specifies if this uses a predefined shape. + + + :param is_predefined_shape: The is_predefined_shape of this Source. + :type: bool + """ + self._is_predefined_shape = is_predefined_shape + + @property + def schema_drift_config(self): + """ + Gets the schema_drift_config of this Source. + + :return: The schema_drift_config of this Source. + :rtype: oci.data_connectivity.models.SchemaDriftConfig + """ + return self._schema_drift_config + + @schema_drift_config.setter + def schema_drift_config(self, schema_drift_config): + """ + Sets the schema_drift_config of this Source. + + :param schema_drift_config: The schema_drift_config of this Source. + :type: oci.data_connectivity.models.SchemaDriftConfig + """ + self._schema_drift_config = schema_drift_config + + @property + def fixed_data_shape(self): + """ + Gets the fixed_data_shape of this Source. + + :return: The fixed_data_shape of this Source. + :rtype: oci.data_connectivity.models.Shape + """ + return self._fixed_data_shape + + @fixed_data_shape.setter + def fixed_data_shape(self, fixed_data_shape): + """ + Sets the fixed_data_shape of this Source. + + :param fixed_data_shape: The fixed_data_shape of this Source. + :type: oci.data_connectivity.models.Shape + """ + self._fixed_data_shape = fixed_data_shape + + @property + def read_operation_config(self): + """ + Gets the read_operation_config of this Source. + + :return: The read_operation_config of this Source. + :rtype: oci.data_connectivity.models.ReadOperationConfig + """ + return self._read_operation_config + + @read_operation_config.setter + def read_operation_config(self, read_operation_config): + """ + Sets the read_operation_config of this Source. + + :param read_operation_config: The read_operation_config of this Source. + :type: oci.data_connectivity.models.ReadOperationConfig + """ + self._read_operation_config = read_operation_config + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/string_attribute.py b/src/oci/data_connectivity/models/string_attribute.py new file mode 100644 index 0000000000..c37d718c1e --- /dev/null +++ b/src/oci/data_connectivity/models/string_attribute.py @@ -0,0 +1,247 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .attribute_profile_result import AttributeProfileResult +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StringAttribute(AttributeProfileResult): + """ + A summary of profiling results of a specefic attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StringAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.StringAttribute.type` attribute + of this class is ``STRING`` 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 StringAttribute. + :type type: object + + :param name: + The value to assign to the name property of this StringAttribute. + :type name: str + + :param min: + The value to assign to the min property of this StringAttribute. + :type min: oci.data_connectivity.models.ProfileStat + + :param max: + The value to assign to the max property of this StringAttribute. + :type max: oci.data_connectivity.models.ProfileStat + + :param null_count: + The value to assign to the null_count property of this StringAttribute. + :type null_count: oci.data_connectivity.models.ProfileStat + + :param distinct_count: + The value to assign to the distinct_count property of this StringAttribute. + :type distinct_count: oci.data_connectivity.models.ProfileStat + + :param unique_count: + The value to assign to the unique_count property of this StringAttribute. + :type unique_count: oci.data_connectivity.models.ProfileStat + + :param duplicate_count: + The value to assign to the duplicate_count property of this StringAttribute. + :type duplicate_count: oci.data_connectivity.models.ProfileStat + + :param value_frequencies: + The value to assign to the value_frequencies property of this StringAttribute. + :type value_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + :param min_length: + The value to assign to the min_length property of this StringAttribute. + :type min_length: oci.data_connectivity.models.ProfileStat + + :param max_length: + The value to assign to the max_length property of this StringAttribute. + :type max_length: oci.data_connectivity.models.ProfileStat + + :param mean_length: + The value to assign to the mean_length property of this StringAttribute. + :type mean_length: oci.data_connectivity.models.ProfileStat + + :param pattern_frequencies: + The value to assign to the pattern_frequencies property of this StringAttribute. + :type pattern_frequencies: list[oci.data_connectivity.models.ObjectFreqStat] + + :param inferred_data_types: + The value to assign to the inferred_data_types property of this StringAttribute. + :type inferred_data_types: list[oci.data_connectivity.models.DataTypeStat] + + """ + self.swagger_types = { + 'type': 'object', + 'name': 'str', + 'min': 'ProfileStat', + 'max': 'ProfileStat', + 'null_count': 'ProfileStat', + 'distinct_count': 'ProfileStat', + 'unique_count': 'ProfileStat', + 'duplicate_count': 'ProfileStat', + 'value_frequencies': 'list[ObjectFreqStat]', + 'min_length': 'ProfileStat', + 'max_length': 'ProfileStat', + 'mean_length': 'ProfileStat', + 'pattern_frequencies': 'list[ObjectFreqStat]', + 'inferred_data_types': 'list[DataTypeStat]' + } + + self.attribute_map = { + 'type': 'type', + 'name': 'name', + 'min': 'min', + 'max': 'max', + 'null_count': 'nullCount', + 'distinct_count': 'distinctCount', + 'unique_count': 'uniqueCount', + 'duplicate_count': 'duplicateCount', + 'value_frequencies': 'valueFrequencies', + 'min_length': 'minLength', + 'max_length': 'maxLength', + 'mean_length': 'meanLength', + 'pattern_frequencies': 'patternFrequencies', + 'inferred_data_types': 'inferredDataTypes' + } + + self._type = None + self._name = None + self._min = None + self._max = None + self._null_count = None + self._distinct_count = None + self._unique_count = None + self._duplicate_count = None + self._value_frequencies = None + self._min_length = None + self._max_length = None + self._mean_length = None + self._pattern_frequencies = None + self._inferred_data_types = None + self._type = 'STRING' + + @property + def min_length(self): + """ + Gets the min_length of this StringAttribute. + + :return: The min_length of this StringAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._min_length + + @min_length.setter + def min_length(self, min_length): + """ + Sets the min_length of this StringAttribute. + + :param min_length: The min_length of this StringAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._min_length = min_length + + @property + def max_length(self): + """ + Gets the max_length of this StringAttribute. + + :return: The max_length of this StringAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._max_length + + @max_length.setter + def max_length(self, max_length): + """ + Sets the max_length of this StringAttribute. + + :param max_length: The max_length of this StringAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._max_length = max_length + + @property + def mean_length(self): + """ + Gets the mean_length of this StringAttribute. + + :return: The mean_length of this StringAttribute. + :rtype: oci.data_connectivity.models.ProfileStat + """ + return self._mean_length + + @mean_length.setter + def mean_length(self, mean_length): + """ + Sets the mean_length of this StringAttribute. + + :param mean_length: The mean_length of this StringAttribute. + :type: oci.data_connectivity.models.ProfileStat + """ + self._mean_length = mean_length + + @property + def pattern_frequencies(self): + """ + Gets the pattern_frequencies of this StringAttribute. + Pattern frequencies for the column as described already in profile config. + + + :return: The pattern_frequencies of this StringAttribute. + :rtype: list[oci.data_connectivity.models.ObjectFreqStat] + """ + return self._pattern_frequencies + + @pattern_frequencies.setter + def pattern_frequencies(self, pattern_frequencies): + """ + Sets the pattern_frequencies of this StringAttribute. + Pattern frequencies for the column as described already in profile config. + + + :param pattern_frequencies: The pattern_frequencies of this StringAttribute. + :type: list[oci.data_connectivity.models.ObjectFreqStat] + """ + self._pattern_frequencies = pattern_frequencies + + @property + def inferred_data_types(self): + """ + Gets the inferred_data_types of this StringAttribute. + Inferred DataType for the column. + + + :return: The inferred_data_types of this StringAttribute. + :rtype: list[oci.data_connectivity.models.DataTypeStat] + """ + return self._inferred_data_types + + @inferred_data_types.setter + def inferred_data_types(self, inferred_data_types): + """ + Sets the inferred_data_types of this StringAttribute. + Inferred DataType for the column. + + + :param inferred_data_types: The inferred_data_types of this StringAttribute. + :type: list[oci.data_connectivity.models.DataTypeStat] + """ + self._inferred_data_types = inferred_data_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/data_connectivity/models/structured_type.py b/src/oci/data_connectivity/models/structured_type.py new file mode 100644 index 0000000000..9b464a0d9c --- /dev/null +++ b/src/oci/data_connectivity/models/structured_type.py @@ -0,0 +1,118 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .base_type import BaseType +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class StructuredType(BaseType): + """ + A `StructuredType` object represents a data type that exists in a physical data asset object such as a table column, but is more complex. For example, an Oracle database `OBJECT` type. It can be composed of multiple `DataType` objects. + """ + + def __init__(self, **kwargs): + """ + Initializes a new StructuredType object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.StructuredType.model_type` attribute + of this class is ``STRUCTURED_TYPE`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this StructuredType. + Allowed values for this property are: "STRUCTURED_TYPE", "DATA_TYPE", "CONFIGURED_TYPE", "COMPOSITE_TYPE", "DERIVED_TYPE" + :type model_type: str + + :param key: + The value to assign to the key property of this StructuredType. + :type key: str + + :param model_version: + The value to assign to the model_version property of this StructuredType. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this StructuredType. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this StructuredType. + :type name: str + + :param object_status: + The value to assign to the object_status property of this StructuredType. + :type object_status: int + + :param description: + The value to assign to the description property of this StructuredType. + :type description: str + + :param schema: + The value to assign to the schema property of this StructuredType. + :type schema: oci.data_connectivity.models.BaseType + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_status': 'int', + 'description': 'str', + 'schema': 'BaseType' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_status': 'objectStatus', + 'description': 'description', + 'schema': 'schema' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_status = None + self._description = None + self._schema = None + self._model_type = 'STRUCTURED_TYPE' + + @property + def schema(self): + """ + Gets the schema of this StructuredType. + + :return: The schema of this StructuredType. + :rtype: oci.data_connectivity.models.BaseType + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this StructuredType. + + :param schema: The schema of this StructuredType. + :type: oci.data_connectivity.models.BaseType + """ + self._schema = schema + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/target.py b/src/oci/data_connectivity/models/target.py new file mode 100644 index 0000000000..f7728be048 --- /dev/null +++ b/src/oci/data_connectivity/models/target.py @@ -0,0 +1,398 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .create_connectivity_validation_details import CreateConnectivityValidationDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Target(CreateConnectivityValidationDetails): + """ + The information about the target operator. The target operator lets you specify the data entity to store the transformed data. + """ + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "TRUNCATE" + DATA_PROPERTY_TRUNCATE = "TRUNCATE" + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "MERGE" + DATA_PROPERTY_MERGE = "MERGE" + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "BACKUP" + DATA_PROPERTY_BACKUP = "BACKUP" + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "OVERWRITE" + DATA_PROPERTY_OVERWRITE = "OVERWRITE" + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "APPEND" + DATA_PROPERTY_APPEND = "APPEND" + + #: A constant which can be used with the data_property property of a Target. + #: This constant has a value of "IGNORE" + DATA_PROPERTY_IGNORE = "IGNORE" + + def __init__(self, **kwargs): + """ + Initializes a new Target object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.Target.model_type` attribute + of this class is ``TARGET_OPERATOR`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this Target. + Allowed values for this property are: "SOURCE_OPERATOR", "TARGET_OPERATOR" + :type model_type: str + + :param key: + The value to assign to the key property of this Target. + :type key: str + + :param model_version: + The value to assign to the model_version property of this Target. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this Target. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this Target. + :type name: str + + :param description: + The value to assign to the description property of this Target. + :type description: str + + :param object_version: + The value to assign to the object_version property of this Target. + :type object_version: int + + :param input_ports: + The value to assign to the input_ports property of this Target. + :type input_ports: list[oci.data_connectivity.models.InputPort] + + :param output_ports: + The value to assign to the output_ports property of this Target. + :type output_ports: list[oci.data_connectivity.models.OutputPort] + + :param object_status: + The value to assign to the object_status property of this Target. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this Target. + :type identifier: str + + :param parameters: + The value to assign to the parameters property of this Target. + :type parameters: list[oci.data_connectivity.models.Parameter] + + :param op_config_values: + The value to assign to the op_config_values property of this Target. + :type op_config_values: oci.data_connectivity.models.ConfigValues + + :param entity: + The value to assign to the entity property of this Target. + :type entity: oci.data_connectivity.models.DataEntity + + :param is_read_access: + The value to assign to the is_read_access property of this Target. + :type is_read_access: bool + + :param is_copy_fields: + The value to assign to the is_copy_fields property of this Target. + :type is_copy_fields: bool + + :param is_predefined_shape: + The value to assign to the is_predefined_shape property of this Target. + :type is_predefined_shape: bool + + :param data_property: + The value to assign to the data_property property of this Target. + Allowed values for this property are: "TRUNCATE", "MERGE", "BACKUP", "OVERWRITE", "APPEND", "IGNORE" + :type data_property: str + + :param schema_drift_config: + The value to assign to the schema_drift_config property of this Target. + :type schema_drift_config: oci.data_connectivity.models.SchemaDriftConfig + + :param fixed_data_shape: + The value to assign to the fixed_data_shape property of this Target. + :type fixed_data_shape: oci.data_connectivity.models.Shape + + :param write_operation_config: + The value to assign to the write_operation_config property of this Target. + :type write_operation_config: oci.data_connectivity.models.WriteOperationConfig + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'input_ports': 'list[InputPort]', + 'output_ports': 'list[OutputPort]', + 'object_status': 'int', + 'identifier': 'str', + 'parameters': 'list[Parameter]', + 'op_config_values': 'ConfigValues', + 'entity': 'DataEntity', + 'is_read_access': 'bool', + 'is_copy_fields': 'bool', + 'is_predefined_shape': 'bool', + 'data_property': 'str', + 'schema_drift_config': 'SchemaDriftConfig', + 'fixed_data_shape': 'Shape', + 'write_operation_config': 'WriteOperationConfig' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'input_ports': 'inputPorts', + 'output_ports': 'outputPorts', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'parameters': 'parameters', + 'op_config_values': 'opConfigValues', + 'entity': 'entity', + 'is_read_access': 'isReadAccess', + 'is_copy_fields': 'isCopyFields', + 'is_predefined_shape': 'isPredefinedShape', + 'data_property': 'dataProperty', + 'schema_drift_config': 'schemaDriftConfig', + 'fixed_data_shape': 'fixedDataShape', + 'write_operation_config': 'writeOperationConfig' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._input_ports = None + self._output_ports = None + self._object_status = None + self._identifier = None + self._parameters = None + self._op_config_values = None + self._entity = None + self._is_read_access = None + self._is_copy_fields = None + self._is_predefined_shape = None + self._data_property = None + self._schema_drift_config = None + self._fixed_data_shape = None + self._write_operation_config = None + self._model_type = 'TARGET_OPERATOR' + + @property + def entity(self): + """ + **[Required]** Gets the entity of this Target. + + :return: The entity of this Target. + :rtype: oci.data_connectivity.models.DataEntity + """ + return self._entity + + @entity.setter + def entity(self, entity): + """ + Sets the entity of this Target. + + :param entity: The entity of this Target. + :type: oci.data_connectivity.models.DataEntity + """ + self._entity = entity + + @property + def is_read_access(self): + """ + Gets the is_read_access of this Target. + Specifies the read access. + + + :return: The is_read_access of this Target. + :rtype: bool + """ + return self._is_read_access + + @is_read_access.setter + def is_read_access(self, is_read_access): + """ + Sets the is_read_access of this Target. + Specifies the read access. + + + :param is_read_access: The is_read_access of this Target. + :type: bool + """ + self._is_read_access = is_read_access + + @property + def is_copy_fields(self): + """ + Gets the is_copy_fields of this Target. + Specifies the copy fields. + + + :return: The is_copy_fields of this Target. + :rtype: bool + """ + return self._is_copy_fields + + @is_copy_fields.setter + def is_copy_fields(self, is_copy_fields): + """ + Sets the is_copy_fields of this Target. + Specifies the copy fields. + + + :param is_copy_fields: The is_copy_fields of this Target. + :type: bool + """ + self._is_copy_fields = is_copy_fields + + @property + def is_predefined_shape(self): + """ + Gets the is_predefined_shape of this Target. + Specifies if this uses a predefined shape. + + + :return: The is_predefined_shape of this Target. + :rtype: bool + """ + return self._is_predefined_shape + + @is_predefined_shape.setter + def is_predefined_shape(self, is_predefined_shape): + """ + Sets the is_predefined_shape of this Target. + Specifies if this uses a predefined shape. + + + :param is_predefined_shape: The is_predefined_shape of this Target. + :type: bool + """ + self._is_predefined_shape = is_predefined_shape + + @property + def data_property(self): + """ + Gets the data_property of this Target. + Specifies the data property. + + Allowed values for this property are: "TRUNCATE", "MERGE", "BACKUP", "OVERWRITE", "APPEND", "IGNORE" + + + :return: The data_property of this Target. + :rtype: str + """ + return self._data_property + + @data_property.setter + def data_property(self, data_property): + """ + Sets the data_property of this Target. + Specifies the data property. + + + :param data_property: The data_property of this Target. + :type: str + """ + allowed_values = ["TRUNCATE", "MERGE", "BACKUP", "OVERWRITE", "APPEND", "IGNORE"] + if not value_allowed_none_or_none_sentinel(data_property, allowed_values): + raise ValueError( + "Invalid value for `data_property`, must be None or one of {0}" + .format(allowed_values) + ) + self._data_property = data_property + + @property + def schema_drift_config(self): + """ + Gets the schema_drift_config of this Target. + + :return: The schema_drift_config of this Target. + :rtype: oci.data_connectivity.models.SchemaDriftConfig + """ + return self._schema_drift_config + + @schema_drift_config.setter + def schema_drift_config(self, schema_drift_config): + """ + Sets the schema_drift_config of this Target. + + :param schema_drift_config: The schema_drift_config of this Target. + :type: oci.data_connectivity.models.SchemaDriftConfig + """ + self._schema_drift_config = schema_drift_config + + @property + def fixed_data_shape(self): + """ + Gets the fixed_data_shape of this Target. + + :return: The fixed_data_shape of this Target. + :rtype: oci.data_connectivity.models.Shape + """ + return self._fixed_data_shape + + @fixed_data_shape.setter + def fixed_data_shape(self, fixed_data_shape): + """ + Sets the fixed_data_shape of this Target. + + :param fixed_data_shape: The fixed_data_shape of this Target. + :type: oci.data_connectivity.models.Shape + """ + self._fixed_data_shape = fixed_data_shape + + @property + def write_operation_config(self): + """ + Gets the write_operation_config of this Target. + + :return: The write_operation_config of this Target. + :rtype: oci.data_connectivity.models.WriteOperationConfig + """ + return self._write_operation_config + + @write_operation_config.setter + def write_operation_config(self, write_operation_config): + """ + Sets the write_operation_config of this Target. + + :param write_operation_config: The write_operation_config of this Target. + :type: oci.data_connectivity.models.WriteOperationConfig + """ + self._write_operation_config = write_operation_config + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/test_network_connectivity.py b/src/oci/data_connectivity/models/test_network_connectivity.py new file mode 100644 index 0000000000..d254ddbac4 --- /dev/null +++ b/src/oci/data_connectivity/models/test_network_connectivity.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestNetworkConnectivity(object): + """ + The network validation response. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TestNetworkConnectivity object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param network_validation_output: + The value to assign to the network_validation_output property of this TestNetworkConnectivity. + :type network_validation_output: str + + :param is_reachable: + The value to assign to the is_reachable property of this TestNetworkConnectivity. + :type is_reachable: bool + + :param exception_message: + The value to assign to the exception_message property of this TestNetworkConnectivity. + :type exception_message: str + + """ + self.swagger_types = { + 'network_validation_output': 'str', + 'is_reachable': 'bool', + 'exception_message': 'str' + } + + self.attribute_map = { + 'network_validation_output': 'networkValidationOutput', + 'is_reachable': 'isReachable', + 'exception_message': 'exceptionMessage' + } + + self._network_validation_output = None + self._is_reachable = None + self._exception_message = None + + @property + def network_validation_output(self): + """ + Gets the network_validation_output of this TestNetworkConnectivity. + Last line from network validation command execution output. + + + :return: The network_validation_output of this TestNetworkConnectivity. + :rtype: str + """ + return self._network_validation_output + + @network_validation_output.setter + def network_validation_output(self, network_validation_output): + """ + Sets the network_validation_output of this TestNetworkConnectivity. + Last line from network validation command execution output. + + + :param network_validation_output: The network_validation_output of this TestNetworkConnectivity. + :type: str + """ + self._network_validation_output = network_validation_output + + @property + def is_reachable(self): + """ + **[Required]** Gets the is_reachable of this TestNetworkConnectivity. + True if the data asset is has a valid network path. + + + :return: The is_reachable of this TestNetworkConnectivity. + :rtype: bool + """ + return self._is_reachable + + @is_reachable.setter + def is_reachable(self, is_reachable): + """ + Sets the is_reachable of this TestNetworkConnectivity. + True if the data asset is has a valid network path. + + + :param is_reachable: The is_reachable of this TestNetworkConnectivity. + :type: bool + """ + self._is_reachable = is_reachable + + @property + def exception_message(self): + """ + Gets the exception_message of this TestNetworkConnectivity. + Exception or error message encountered while testing network reachability for the data asset. + + + :return: The exception_message of this TestNetworkConnectivity. + :rtype: str + """ + return self._exception_message + + @exception_message.setter + def exception_message(self, exception_message): + """ + Sets the exception_message of this TestNetworkConnectivity. + Exception or error message encountered while testing network reachability for the data asset. + + + :param exception_message: The exception_message of this TestNetworkConnectivity. + :type: str + """ + self._exception_message = exception_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/type.py b/src/oci/data_connectivity/models/type.py new file mode 100644 index 0000000000..f0dee36915 --- /dev/null +++ b/src/oci/data_connectivity/models/type.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class Type(object): + """ + DataAsset & Connection Registry Attributes + """ + + def __init__(self, **kwargs): + """ + Initializes a new Type object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param data_asset_attributes: + The value to assign to the data_asset_attributes property of this Type. + :type data_asset_attributes: list[oci.data_connectivity.models.Attribute] + + :param connection_attributes: + The value to assign to the connection_attributes property of this Type. + :type connection_attributes: dict(str, list[Attribute]) + + """ + self.swagger_types = { + 'data_asset_attributes': 'list[Attribute]', + 'connection_attributes': 'dict(str, list[Attribute])' + } + + self.attribute_map = { + 'data_asset_attributes': 'dataAssetAttributes', + 'connection_attributes': 'connectionAttributes' + } + + self._data_asset_attributes = None + self._connection_attributes = None + + @property + def data_asset_attributes(self): + """ + **[Required]** Gets the data_asset_attributes of this Type. + list of attributes for the dataAsset + + + :return: The data_asset_attributes of this Type. + :rtype: list[oci.data_connectivity.models.Attribute] + """ + return self._data_asset_attributes + + @data_asset_attributes.setter + def data_asset_attributes(self, data_asset_attributes): + """ + Sets the data_asset_attributes of this Type. + list of attributes for the dataAsset + + + :param data_asset_attributes: The data_asset_attributes of this Type. + :type: list[oci.data_connectivity.models.Attribute] + """ + self._data_asset_attributes = data_asset_attributes + + @property + def connection_attributes(self): + """ + **[Required]** Gets the connection_attributes of this Type. + Map of connectionType as key and List of attributes as value + + + :return: The connection_attributes of this Type. + :rtype: dict(str, list[Attribute]) + """ + return self._connection_attributes + + @connection_attributes.setter + def connection_attributes(self, connection_attributes): + """ + Sets the connection_attributes of this Type. + Map of connectionType as key and List of attributes as value + + + :param connection_attributes: The connection_attributes of this Type. + :type: dict(str, list[Attribute]) + """ + self._connection_attributes = connection_attributes + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/type_library.py b/src/oci/data_connectivity/models/type_library.py new file mode 100644 index 0000000000..9cfb571a44 --- /dev/null +++ b/src/oci/data_connectivity/models/type_library.py @@ -0,0 +1,345 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TypeLibrary(object): + """ + The Data Integration type library container type. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TypeLibrary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this TypeLibrary. + :type key: str + + :param model_type: + The value to assign to the model_type property of this TypeLibrary. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this TypeLibrary. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this TypeLibrary. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this TypeLibrary. + :type name: str + + :param description: + The value to assign to the description property of this TypeLibrary. + :type description: str + + :param object_version: + The value to assign to the object_version property of this TypeLibrary. + :type object_version: int + + :param types: + The value to assign to the types property of this TypeLibrary. + :type types: dict(str, DerivedType) + + :param object_status: + The value to assign to the object_status property of this TypeLibrary. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this TypeLibrary. + :type identifier: str + + """ + self.swagger_types = { + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'types': 'dict(str, DerivedType)', + 'object_status': 'int', + 'identifier': 'str' + } + + self.attribute_map = { + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'types': 'types', + 'object_status': 'objectStatus', + 'identifier': 'identifier' + } + + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._types = None + self._object_status = None + self._identifier = None + + @property + def key(self): + """ + Gets the key of this TypeLibrary. + The key of the object. + + + :return: The key of this TypeLibrary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this TypeLibrary. + The key of the object. + + + :param key: The key of this TypeLibrary. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + Gets the model_type of this TypeLibrary. + The type of the object. + + + :return: The model_type of this TypeLibrary. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this TypeLibrary. + The type of the object. + + + :param model_type: The model_type of this TypeLibrary. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this TypeLibrary. + The model version of an object. + + + :return: The model_version of this TypeLibrary. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this TypeLibrary. + The model version of an object. + + + :param model_version: The model_version of this TypeLibrary. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this TypeLibrary. + + :return: The parent_ref of this TypeLibrary. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this TypeLibrary. + + :param parent_ref: The parent_ref of this TypeLibrary. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this TypeLibrary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this TypeLibrary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TypeLibrary. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this TypeLibrary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this TypeLibrary. + A user defined description for the object. + + + :return: The description of this TypeLibrary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this TypeLibrary. + A user defined description for the object. + + + :param description: The description of this TypeLibrary. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this TypeLibrary. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this TypeLibrary. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this TypeLibrary. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this TypeLibrary. + :type: int + """ + self._object_version = object_version + + @property + def types(self): + """ + Gets the types of this TypeLibrary. + types + + + :return: The types of this TypeLibrary. + :rtype: dict(str, DerivedType) + """ + return self._types + + @types.setter + def types(self, types): + """ + Sets the types of this TypeLibrary. + types + + + :param types: The types of this TypeLibrary. + :type: dict(str, DerivedType) + """ + self._types = types + + @property + def object_status(self): + """ + Gets the object_status of this TypeLibrary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this TypeLibrary. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this TypeLibrary. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this TypeLibrary. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this TypeLibrary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this TypeLibrary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this TypeLibrary. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this TypeLibrary. + :type: str + """ + self._identifier = identifier + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/type_summary.py b/src/oci/data_connectivity/models/type_summary.py new file mode 100644 index 0000000000..68b6f3555f --- /dev/null +++ b/src/oci/data_connectivity/models/type_summary.py @@ -0,0 +1,132 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TypeSummary(object): + """ + The type object for supported connectors. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TypeSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this TypeSummary. + :type key: str + + :param name: + The value to assign to the name property of this TypeSummary. + :type name: str + + :param description: + The value to assign to the description property of this TypeSummary. + :type description: str + + """ + self.swagger_types = { + 'key': 'str', + 'name': 'str', + 'description': 'str' + } + + self.attribute_map = { + 'key': 'key', + 'name': 'name', + 'description': 'description' + } + + self._key = None + self._name = None + self._description = None + + @property + def key(self): + """ + **[Required]** Gets the key of this TypeSummary. + unique id of specefic data asset type. + + + :return: The key of this TypeSummary. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this TypeSummary. + unique id of specefic data asset type. + + + :param key: The key of this TypeSummary. + :type: str + """ + self._key = key + + @property + def name(self): + """ + **[Required]** Gets the name of this TypeSummary. + Name of the specific data asset type. + + + :return: The name of this TypeSummary. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TypeSummary. + Name of the specific data asset type. + + + :param name: The name of this TypeSummary. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this TypeSummary. + desctription for the specific data asset type. + + + :return: The description of this TypeSummary. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this TypeSummary. + desctription for the specific data asset type. + + + :param description: The description of this TypeSummary. + :type: str + """ + self._description = description + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/type_system.py b/src/oci/data_connectivity/models/type_system.py new file mode 100644 index 0000000000..8ff813fe3f --- /dev/null +++ b/src/oci/data_connectivity/models/type_system.py @@ -0,0 +1,407 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TypeSystem(object): + """ + The type system maps from and to a type. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TypeSystem object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param key: + The value to assign to the key property of this TypeSystem. + :type key: str + + :param model_type: + The value to assign to the model_type property of this TypeSystem. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this TypeSystem. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this TypeSystem. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this TypeSystem. + :type name: str + + :param description: + The value to assign to the description property of this TypeSystem. + :type description: str + + :param object_version: + The value to assign to the object_version property of this TypeSystem. + :type object_version: int + + :param type_mapping_to: + The value to assign to the type_mapping_to property of this TypeSystem. + :type type_mapping_to: dict(str, str) + + :param type_mapping_from: + The value to assign to the type_mapping_from property of this TypeSystem. + :type type_mapping_from: dict(str, str) + + :param object_status: + The value to assign to the object_status property of this TypeSystem. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this TypeSystem. + :type identifier: str + + :param types: + The value to assign to the types property of this TypeSystem. + :type types: list[oci.data_connectivity.models.DataType] + + """ + self.swagger_types = { + 'key': 'str', + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'type_mapping_to': 'dict(str, str)', + 'type_mapping_from': 'dict(str, str)', + 'object_status': 'int', + 'identifier': 'str', + 'types': 'list[DataType]' + } + + self.attribute_map = { + 'key': 'key', + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'type_mapping_to': 'typeMappingTo', + 'type_mapping_from': 'typeMappingFrom', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'types': 'types' + } + + self._key = None + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_version = None + self._type_mapping_to = None + self._type_mapping_from = None + self._object_status = None + self._identifier = None + self._types = None + + @property + def key(self): + """ + Gets the key of this TypeSystem. + The key of the object. + + + :return: The key of this TypeSystem. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this TypeSystem. + The key of the object. + + + :param key: The key of this TypeSystem. + :type: str + """ + self._key = key + + @property + def model_type(self): + """ + Gets the model_type of this TypeSystem. + The type of the object. + + + :return: The model_type of this TypeSystem. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this TypeSystem. + The type of the object. + + + :param model_type: The model_type of this TypeSystem. + :type: str + """ + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this TypeSystem. + The model version of an object. + + + :return: The model_version of this TypeSystem. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this TypeSystem. + The model version of an object. + + + :param model_version: The model_version of this TypeSystem. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this TypeSystem. + + :return: The parent_ref of this TypeSystem. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this TypeSystem. + + :param parent_ref: The parent_ref of this TypeSystem. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this TypeSystem. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this TypeSystem. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TypeSystem. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this TypeSystem. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this TypeSystem. + A user defined description for the object. + + + :return: The description of this TypeSystem. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this TypeSystem. + A user defined description for the object. + + + :param description: The description of this TypeSystem. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this TypeSystem. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this TypeSystem. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this TypeSystem. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this TypeSystem. + :type: int + """ + self._object_version = object_version + + @property + def type_mapping_to(self): + """ + Gets the type_mapping_to of this TypeSystem. + The type system to map to. + + + :return: The type_mapping_to of this TypeSystem. + :rtype: dict(str, str) + """ + return self._type_mapping_to + + @type_mapping_to.setter + def type_mapping_to(self, type_mapping_to): + """ + Sets the type_mapping_to of this TypeSystem. + The type system to map to. + + + :param type_mapping_to: The type_mapping_to of this TypeSystem. + :type: dict(str, str) + """ + self._type_mapping_to = type_mapping_to + + @property + def type_mapping_from(self): + """ + Gets the type_mapping_from of this TypeSystem. + The type system to map from. + + + :return: The type_mapping_from of this TypeSystem. + :rtype: dict(str, str) + """ + return self._type_mapping_from + + @type_mapping_from.setter + def type_mapping_from(self, type_mapping_from): + """ + Sets the type_mapping_from of this TypeSystem. + The type system to map from. + + + :param type_mapping_from: The type_mapping_from of this TypeSystem. + :type: dict(str, str) + """ + self._type_mapping_from = type_mapping_from + + @property + def object_status(self): + """ + Gets the object_status of this TypeSystem. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this TypeSystem. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this TypeSystem. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this TypeSystem. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this TypeSystem. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this TypeSystem. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this TypeSystem. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this TypeSystem. + :type: str + """ + self._identifier = identifier + + @property + def types(self): + """ + Gets the types of this TypeSystem. + An array of types. + + + :return: The types of this TypeSystem. + :rtype: list[oci.data_connectivity.models.DataType] + """ + return self._types + + @types.setter + def types(self, types): + """ + Sets the types of this TypeSystem. + An array of types. + + + :param types: The types of this TypeSystem. + :type: list[oci.data_connectivity.models.DataType] + """ + self._types = 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/data_connectivity/models/typed_object.py b/src/oci/data_connectivity/models/typed_object.py new file mode 100644 index 0000000000..8aa9580d3d --- /dev/null +++ b/src/oci/data_connectivity/models/typed_object.py @@ -0,0 +1,337 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TypedObject(object): + """ + The `TypedObject` class is a base class for any model object that has a type. + """ + + #: A constant which can be used with the model_type property of a TypedObject. + #: This constant has a value of "SHAPE" + MODEL_TYPE_SHAPE = "SHAPE" + + #: A constant which can be used with the model_type property of a TypedObject. + #: This constant has a value of "SHAPE_FIELD" + MODEL_TYPE_SHAPE_FIELD = "SHAPE_FIELD" + + #: A constant which can be used with the model_type property of a TypedObject. + #: This constant has a value of "NATIVE_SHAPE_FIELD" + MODEL_TYPE_NATIVE_SHAPE_FIELD = "NATIVE_SHAPE_FIELD" + + def __init__(self, **kwargs): + """ + Initializes a new TypedObject object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.OutputPort` + * :class:`~oci.data_connectivity.models.Shape` + * :class:`~oci.data_connectivity.models.ShapeField` + * :class:`~oci.data_connectivity.models.InputPort` + * :class:`~oci.data_connectivity.models.Parameter` + * :class:`~oci.data_connectivity.models.NativeShapeField` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this TypedObject. + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + :type model_type: str + + :param key: + The value to assign to the key property of this TypedObject. + :type key: str + + :param model_version: + The value to assign to the model_version property of this TypedObject. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this TypedObject. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param config_values: + The value to assign to the config_values property of this TypedObject. + :type config_values: oci.data_connectivity.models.ConfigValues + + :param object_status: + The value to assign to the object_status property of this TypedObject. + :type object_status: int + + :param name: + The value to assign to the name property of this TypedObject. + :type name: str + + :param description: + The value to assign to the description property of this TypedObject. + :type description: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'config_values': 'ConfigValues', + 'object_status': 'int', + 'name': 'str', + 'description': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'config_values': 'configValues', + 'object_status': 'objectStatus', + 'name': 'name', + 'description': 'description' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._config_values = None + self._object_status = None + self._name = None + self._description = None + + @staticmethod + def get_subtype(object_dictionary): + """ + Given the hash representation of a subtype of this class, + use the info in the hash to return the class of the subtype. + """ + type = object_dictionary['modelType'] + + if type == 'OUTPUT_PORT': + return 'OutputPort' + + if type == 'SHAPE': + return 'Shape' + + if type == 'SHAPE_FIELD': + return 'ShapeField' + + if type == 'INPUT_PORT': + return 'InputPort' + + if type == 'PARAMETER': + return 'Parameter' + + if type == 'NATIVE_SHAPE_FIELD': + return 'NativeShapeField' + else: + return 'TypedObject' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this TypedObject. + The type of the types object. + + Allowed values for this property are: "SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD" + + + :return: The model_type of this TypedObject. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this TypedObject. + The type of the types object. + + + :param model_type: The model_type of this TypedObject. + :type: str + """ + allowed_values = ["SHAPE", "SHAPE_FIELD", "NATIVE_SHAPE_FIELD"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this TypedObject. + The key of the object. + + + :return: The key of this TypedObject. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this TypedObject. + The key of the object. + + + :param key: The key of this TypedObject. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this TypedObject. + The model version of an object. + + + :return: The model_version of this TypedObject. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this TypedObject. + The model version of an object. + + + :param model_version: The model_version of this TypedObject. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this TypedObject. + + :return: The parent_ref of this TypedObject. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this TypedObject. + + :param parent_ref: The parent_ref of this TypedObject. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def config_values(self): + """ + Gets the config_values of this TypedObject. + + :return: The config_values of this TypedObject. + :rtype: oci.data_connectivity.models.ConfigValues + """ + return self._config_values + + @config_values.setter + def config_values(self, config_values): + """ + Sets the config_values of this TypedObject. + + :param config_values: The config_values of this TypedObject. + :type: oci.data_connectivity.models.ConfigValues + """ + self._config_values = config_values + + @property + def object_status(self): + """ + Gets the object_status of this TypedObject. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this TypedObject. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this TypedObject. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this TypedObject. + :type: int + """ + self._object_status = object_status + + @property + def name(self): + """ + Gets the name of this TypedObject. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this TypedObject. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this TypedObject. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this TypedObject. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this TypedObject. + Detailed description for the object. + + + :return: The description of this TypedObject. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this TypedObject. + Detailed description for the object. + + + :param description: The description of this TypedObject. + :type: str + """ + self._description = description + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/types_summary_collection.py b/src/oci/data_connectivity/models/types_summary_collection.py new file mode 100644 index 0000000000..9ff754a9ff --- /dev/null +++ b/src/oci/data_connectivity/models/types_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TypesSummaryCollection(object): + """ + This is the collection of type summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new TypesSummaryCollection 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 TypesSummaryCollection. + :type items: list[oci.data_connectivity.models.TypeSummary] + + """ + self.swagger_types = { + 'items': 'list[TypeSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this TypesSummaryCollection. + The array of Type summaries + + + :return: The items of this TypesSummaryCollection. + :rtype: list[oci.data_connectivity.models.TypeSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this TypesSummaryCollection. + The array of Type summaries + + + :param items: The items of this TypesSummaryCollection. + :type: list[oci.data_connectivity.models.TypeSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/unique_key.py b/src/oci/data_connectivity/models/unique_key.py new file mode 100644 index 0000000000..51de87a2ce --- /dev/null +++ b/src/oci/data_connectivity/models/unique_key.py @@ -0,0 +1,285 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UniqueKey(object): + """ + The unqique key object. + """ + + #: A constant which can be used with the model_type property of a UniqueKey. + #: This constant has a value of "PRIMARY_KEY" + MODEL_TYPE_PRIMARY_KEY = "PRIMARY_KEY" + + #: A constant which can be used with the model_type property of a UniqueKey. + #: This constant has a value of "UNIQUE_KEY" + MODEL_TYPE_UNIQUE_KEY = "UNIQUE_KEY" + + def __init__(self, **kwargs): + """ + Initializes a new UniqueKey object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.PrimaryKey` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this UniqueKey. + Allowed values for this property are: "PRIMARY_KEY", "UNIQUE_KEY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param key: + The value to assign to the key property of this UniqueKey. + :type key: str + + :param model_version: + The value to assign to the model_version property of this UniqueKey. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this UniqueKey. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this UniqueKey. + :type name: str + + :param attribute_refs: + The value to assign to the attribute_refs property of this UniqueKey. + :type attribute_refs: list[oci.data_connectivity.models.KeyAttribute] + + :param object_status: + The value to assign to the object_status property of this UniqueKey. + :type object_status: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'attribute_refs': 'list[KeyAttribute]', + 'object_status': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'attribute_refs': 'attributeRefs', + 'object_status': 'objectStatus' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._attribute_refs = None + self._object_status = 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['modelType'] + + if type == 'PRIMARY_KEY': + return 'PrimaryKey' + else: + return 'UniqueKey' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this UniqueKey. + The key type. + + Allowed values for this property are: "PRIMARY_KEY", "UNIQUE_KEY", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this UniqueKey. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this UniqueKey. + The key type. + + + :param model_type: The model_type of this UniqueKey. + :type: str + """ + allowed_values = ["PRIMARY_KEY", "UNIQUE_KEY"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def key(self): + """ + Gets the key of this UniqueKey. + The object key. + + + :return: The key of this UniqueKey. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this UniqueKey. + The object key. + + + :param key: The key of this UniqueKey. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this UniqueKey. + The object's model version. + + + :return: The model_version of this UniqueKey. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this UniqueKey. + The object's model version. + + + :param model_version: The model_version of this UniqueKey. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this UniqueKey. + + :return: The parent_ref of this UniqueKey. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this UniqueKey. + + :param parent_ref: The parent_ref of this UniqueKey. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this UniqueKey. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this UniqueKey. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UniqueKey. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this UniqueKey. + :type: str + """ + self._name = name + + @property + def attribute_refs(self): + """ + Gets the attribute_refs of this UniqueKey. + An array of attribute references. + + + :return: The attribute_refs of this UniqueKey. + :rtype: list[oci.data_connectivity.models.KeyAttribute] + """ + return self._attribute_refs + + @attribute_refs.setter + def attribute_refs(self, attribute_refs): + """ + Sets the attribute_refs of this UniqueKey. + An array of attribute references. + + + :param attribute_refs: The attribute_refs of this UniqueKey. + :type: list[oci.data_connectivity.models.KeyAttribute] + """ + self._attribute_refs = attribute_refs + + @property + def object_status(self): + """ + Gets the object_status of this UniqueKey. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this UniqueKey. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this UniqueKey. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this UniqueKey. + :type: int + """ + self._object_status = object_status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_connection_details.py b/src/oci/data_connectivity/models/update_connection_details.py new file mode 100644 index 0000000000..13f58fd34c --- /dev/null +++ b/src/oci/data_connectivity/models/update_connection_details.py @@ -0,0 +1,461 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateConnectionDetails(object): + """ + Properties used in connection update operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateConnectionDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_version: + The value to assign to the model_version property of this UpdateConnectionDetails. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this UpdateConnectionDetails. + :type model_type: str + + :param name: + The value to assign to the name property of this UpdateConnectionDetails. + :type name: str + + :param description: + The value to assign to the description property of this UpdateConnectionDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this UpdateConnectionDetails. + :type object_version: int + + :param object_status: + The value to assign to the object_status property of this UpdateConnectionDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this UpdateConnectionDetails. + :type identifier: str + + :param primary_schema: + The value to assign to the primary_schema property of this UpdateConnectionDetails. + :type primary_schema: oci.data_connectivity.models.Schema + + :param connection_properties: + The value to assign to the connection_properties property of this UpdateConnectionDetails. + :type connection_properties: list[oci.data_connectivity.models.ConnectionProperty] + + :param properties: + The value to assign to the properties property of this UpdateConnectionDetails. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this UpdateConnectionDetails. + :type type: str + + :param is_default: + The value to assign to the is_default property of this UpdateConnectionDetails. + :type is_default: bool + + :param metadata: + The value to assign to the metadata property of this UpdateConnectionDetails. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param registry_metadata: + The value to assign to the registry_metadata property of this UpdateConnectionDetails. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + """ + self.swagger_types = { + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_version': 'int', + 'object_status': 'int', + 'identifier': 'str', + 'primary_schema': 'Schema', + 'connection_properties': 'list[ConnectionProperty]', + 'properties': 'dict(str, object)', + 'type': 'str', + 'is_default': 'bool', + 'metadata': 'ObjectMetadata', + 'registry_metadata': 'RegistryMetadata' + } + + self.attribute_map = { + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_version': 'objectVersion', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'primary_schema': 'primarySchema', + 'connection_properties': 'connectionProperties', + 'properties': 'properties', + 'type': 'type', + 'is_default': 'isDefault', + 'metadata': 'metadata', + 'registry_metadata': 'registryMetadata' + } + + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_version = None + self._object_status = None + self._identifier = None + self._primary_schema = None + self._connection_properties = None + self._properties = None + self._type = None + self._is_default = None + self._metadata = None + self._registry_metadata = None + + @property + def model_version(self): + """ + Gets the model_version of this UpdateConnectionDetails. + The model version of an object. + + + :return: The model_version of this UpdateConnectionDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this UpdateConnectionDetails. + The model version of an object. + + + :param model_version: The model_version of this UpdateConnectionDetails. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this UpdateConnectionDetails. + The type of the object. + + + :return: The model_type of this UpdateConnectionDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this UpdateConnectionDetails. + The type of the object. + + + :param model_type: The model_type of this UpdateConnectionDetails. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + Gets the name of this UpdateConnectionDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this UpdateConnectionDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateConnectionDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this UpdateConnectionDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this UpdateConnectionDetails. + User-defined description for the connection. + + + :return: The description of this UpdateConnectionDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateConnectionDetails. + User-defined description for the connection. + + + :param description: The description of this UpdateConnectionDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this UpdateConnectionDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this UpdateConnectionDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this UpdateConnectionDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this UpdateConnectionDetails. + :type: int + """ + self._object_version = object_version + + @property + def object_status(self): + """ + Gets the object_status of this UpdateConnectionDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this UpdateConnectionDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this UpdateConnectionDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this UpdateConnectionDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this UpdateConnectionDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this UpdateConnectionDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this UpdateConnectionDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this UpdateConnectionDetails. + :type: str + """ + self._identifier = identifier + + @property + def primary_schema(self): + """ + Gets the primary_schema of this UpdateConnectionDetails. + + :return: The primary_schema of this UpdateConnectionDetails. + :rtype: oci.data_connectivity.models.Schema + """ + return self._primary_schema + + @primary_schema.setter + def primary_schema(self, primary_schema): + """ + Sets the primary_schema of this UpdateConnectionDetails. + + :param primary_schema: The primary_schema of this UpdateConnectionDetails. + :type: oci.data_connectivity.models.Schema + """ + self._primary_schema = primary_schema + + @property + def connection_properties(self): + """ + Gets the connection_properties of this UpdateConnectionDetails. + The properties for the connection. + + + :return: The connection_properties of this UpdateConnectionDetails. + :rtype: list[oci.data_connectivity.models.ConnectionProperty] + """ + return self._connection_properties + + @connection_properties.setter + def connection_properties(self, connection_properties): + """ + Sets the connection_properties of this UpdateConnectionDetails. + The properties for the connection. + + + :param connection_properties: The connection_properties of this UpdateConnectionDetails. + :type: list[oci.data_connectivity.models.ConnectionProperty] + """ + self._connection_properties = connection_properties + + @property + def properties(self): + """ + **[Required]** Gets the properties of this UpdateConnectionDetails. + All the properties for the connection in a key-value map format. + + + :return: The properties of this UpdateConnectionDetails. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this UpdateConnectionDetails. + All the properties for the connection in a key-value map format. + + + :param properties: The properties of this UpdateConnectionDetails. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + **[Required]** Gets the type of this UpdateConnectionDetails. + Specific Connection Type + + + :return: The type of this UpdateConnectionDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this UpdateConnectionDetails. + Specific Connection Type + + + :param type: The type of this UpdateConnectionDetails. + :type: str + """ + self._type = type + + @property + def is_default(self): + """ + Gets the is_default of this UpdateConnectionDetails. + The default property for the connection. + + + :return: The is_default of this UpdateConnectionDetails. + :rtype: bool + """ + return self._is_default + + @is_default.setter + def is_default(self, is_default): + """ + Sets the is_default of this UpdateConnectionDetails. + The default property for the connection. + + + :param is_default: The is_default of this UpdateConnectionDetails. + :type: bool + """ + self._is_default = is_default + + @property + def metadata(self): + """ + Gets the metadata of this UpdateConnectionDetails. + + :return: The metadata of this UpdateConnectionDetails. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this UpdateConnectionDetails. + + :param metadata: The metadata of this UpdateConnectionDetails. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this UpdateConnectionDetails. + + :return: The registry_metadata of this UpdateConnectionDetails. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this UpdateConnectionDetails. + + :param registry_metadata: The registry_metadata of this UpdateConnectionDetails. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_data_asset_details.py b/src/oci/data_connectivity/models/update_data_asset_details.py new file mode 100644 index 0000000000..8533e5ba07 --- /dev/null +++ b/src/oci/data_connectivity/models/update_data_asset_details.py @@ -0,0 +1,519 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateDataAssetDetails(object): + """ + Properties used in data asset update operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateDataAssetDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_version: + The value to assign to the model_version property of this UpdateDataAssetDetails. + :type model_version: str + + :param model_type: + The value to assign to the model_type property of this UpdateDataAssetDetails. + :type model_type: str + + :param name: + The value to assign to the name property of this UpdateDataAssetDetails. + :type name: str + + :param description: + The value to assign to the description property of this UpdateDataAssetDetails. + :type description: str + + :param object_status: + The value to assign to the object_status property of this UpdateDataAssetDetails. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this UpdateDataAssetDetails. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this UpdateDataAssetDetails. + :type identifier: str + + :param external_key: + The value to assign to the external_key property of this UpdateDataAssetDetails. + :type external_key: str + + :param asset_properties: + The value to assign to the asset_properties property of this UpdateDataAssetDetails. + :type asset_properties: dict(str, str) + + :param properties: + The value to assign to the properties property of this UpdateDataAssetDetails. + :type properties: dict(str, object) + + :param type: + The value to assign to the type property of this UpdateDataAssetDetails. + :type type: str + + :param native_type_system: + The value to assign to the native_type_system property of this UpdateDataAssetDetails. + :type native_type_system: oci.data_connectivity.models.TypeSystem + + :param registry_metadata: + The value to assign to the registry_metadata property of this UpdateDataAssetDetails. + :type registry_metadata: oci.data_connectivity.models.RegistryMetadata + + :param metadata: + The value to assign to the metadata property of this UpdateDataAssetDetails. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param default_connection: + The value to assign to the default_connection property of this UpdateDataAssetDetails. + :type default_connection: oci.data_connectivity.models.Connection + + :param end_points: + The value to assign to the end_points property of this UpdateDataAssetDetails. + :type end_points: list[oci.data_connectivity.models.DpEndpoint] + + """ + self.swagger_types = { + 'model_version': 'str', + 'model_type': 'str', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'external_key': 'str', + 'asset_properties': 'dict(str, str)', + 'properties': 'dict(str, object)', + 'type': 'str', + 'native_type_system': 'TypeSystem', + 'registry_metadata': 'RegistryMetadata', + 'metadata': 'ObjectMetadata', + 'default_connection': 'Connection', + 'end_points': 'list[DpEndpoint]' + } + + self.attribute_map = { + 'model_version': 'modelVersion', + 'model_type': 'modelType', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'external_key': 'externalKey', + 'asset_properties': 'assetProperties', + 'properties': 'properties', + 'type': 'type', + 'native_type_system': 'nativeTypeSystem', + 'registry_metadata': 'registryMetadata', + 'metadata': 'metadata', + 'default_connection': 'defaultConnection', + 'end_points': 'endPoints' + } + + self._model_version = None + self._model_type = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._external_key = None + self._asset_properties = None + self._properties = None + self._type = None + self._native_type_system = None + self._registry_metadata = None + self._metadata = None + self._default_connection = None + self._end_points = None + + @property + def model_version(self): + """ + Gets the model_version of this UpdateDataAssetDetails. + The model version of an object. + + + :return: The model_version of this UpdateDataAssetDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this UpdateDataAssetDetails. + The model version of an object. + + + :param model_version: The model_version of this UpdateDataAssetDetails. + :type: str + """ + self._model_version = model_version + + @property + def model_type(self): + """ + Gets the model_type of this UpdateDataAssetDetails. + The type of the object. + + + :return: The model_type of this UpdateDataAssetDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this UpdateDataAssetDetails. + The type of the object. + + + :param model_type: The model_type of this UpdateDataAssetDetails. + :type: str + """ + self._model_type = model_type + + @property + def name(self): + """ + Gets the name of this UpdateDataAssetDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this UpdateDataAssetDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateDataAssetDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this UpdateDataAssetDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this UpdateDataAssetDetails. + User-defined description of the data asset. + + + :return: The description of this UpdateDataAssetDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateDataAssetDetails. + User-defined description of the data asset. + + + :param description: The description of this UpdateDataAssetDetails. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this UpdateDataAssetDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this UpdateDataAssetDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this UpdateDataAssetDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this UpdateDataAssetDetails. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + Gets the object_version of this UpdateDataAssetDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this UpdateDataAssetDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this UpdateDataAssetDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this UpdateDataAssetDetails. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this UpdateDataAssetDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this UpdateDataAssetDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this UpdateDataAssetDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this UpdateDataAssetDetails. + :type: str + """ + self._identifier = identifier + + @property + def external_key(self): + """ + Gets the external_key of this UpdateDataAssetDetails. + The external key for the object. + + + :return: The external_key of this UpdateDataAssetDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this UpdateDataAssetDetails. + The external key for the object. + + + :param external_key: The external_key of this UpdateDataAssetDetails. + :type: str + """ + self._external_key = external_key + + @property + def asset_properties(self): + """ + Gets the asset_properties of this UpdateDataAssetDetails. + Additional properties for the data asset. + + + :return: The asset_properties of this UpdateDataAssetDetails. + :rtype: dict(str, str) + """ + return self._asset_properties + + @asset_properties.setter + def asset_properties(self, asset_properties): + """ + Sets the asset_properties of this UpdateDataAssetDetails. + Additional properties for the data asset. + + + :param asset_properties: The asset_properties of this UpdateDataAssetDetails. + :type: dict(str, str) + """ + self._asset_properties = asset_properties + + @property + def properties(self): + """ + **[Required]** Gets the properties of this UpdateDataAssetDetails. + All the properties for the data asset in a key-value map format. + + + :return: The properties of this UpdateDataAssetDetails. + :rtype: dict(str, object) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this UpdateDataAssetDetails. + All the properties for the data asset in a key-value map format. + + + :param properties: The properties of this UpdateDataAssetDetails. + :type: dict(str, object) + """ + self._properties = properties + + @property + def type(self): + """ + **[Required]** Gets the type of this UpdateDataAssetDetails. + Specific DataAsset Type + + + :return: The type of this UpdateDataAssetDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this UpdateDataAssetDetails. + Specific DataAsset Type + + + :param type: The type of this UpdateDataAssetDetails. + :type: str + """ + self._type = type + + @property + def native_type_system(self): + """ + Gets the native_type_system of this UpdateDataAssetDetails. + + :return: The native_type_system of this UpdateDataAssetDetails. + :rtype: oci.data_connectivity.models.TypeSystem + """ + return self._native_type_system + + @native_type_system.setter + def native_type_system(self, native_type_system): + """ + Sets the native_type_system of this UpdateDataAssetDetails. + + :param native_type_system: The native_type_system of this UpdateDataAssetDetails. + :type: oci.data_connectivity.models.TypeSystem + """ + self._native_type_system = native_type_system + + @property + def registry_metadata(self): + """ + Gets the registry_metadata of this UpdateDataAssetDetails. + + :return: The registry_metadata of this UpdateDataAssetDetails. + :rtype: oci.data_connectivity.models.RegistryMetadata + """ + return self._registry_metadata + + @registry_metadata.setter + def registry_metadata(self, registry_metadata): + """ + Sets the registry_metadata of this UpdateDataAssetDetails. + + :param registry_metadata: The registry_metadata of this UpdateDataAssetDetails. + :type: oci.data_connectivity.models.RegistryMetadata + """ + self._registry_metadata = registry_metadata + + @property + def metadata(self): + """ + Gets the metadata of this UpdateDataAssetDetails. + + :return: The metadata of this UpdateDataAssetDetails. + :rtype: oci.data_connectivity.models.ObjectMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this UpdateDataAssetDetails. + + :param metadata: The metadata of this UpdateDataAssetDetails. + :type: oci.data_connectivity.models.ObjectMetadata + """ + self._metadata = metadata + + @property + def default_connection(self): + """ + Gets the default_connection of this UpdateDataAssetDetails. + + :return: The default_connection of this UpdateDataAssetDetails. + :rtype: oci.data_connectivity.models.Connection + """ + return self._default_connection + + @default_connection.setter + def default_connection(self, default_connection): + """ + Sets the default_connection of this UpdateDataAssetDetails. + + :param default_connection: The default_connection of this UpdateDataAssetDetails. + :type: oci.data_connectivity.models.Connection + """ + self._default_connection = default_connection + + @property + def end_points(self): + """ + Gets the end_points of this UpdateDataAssetDetails. + The list of endpoints with which this data asset is associated. + + + :return: The end_points of this UpdateDataAssetDetails. + :rtype: list[oci.data_connectivity.models.DpEndpoint] + """ + return self._end_points + + @end_points.setter + def end_points(self, end_points): + """ + Sets the end_points of this UpdateDataAssetDetails. + The list of endpoints with which this data asset is associated. + + + :param end_points: The end_points of this UpdateDataAssetDetails. + :type: list[oci.data_connectivity.models.DpEndpoint] + """ + self._end_points = end_points + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_dp_endpoint_details.py b/src/oci/data_connectivity/models/update_dp_endpoint_details.py new file mode 100644 index 0000000000..955f99c3a9 --- /dev/null +++ b/src/oci/data_connectivity/models/update_dp_endpoint_details.py @@ -0,0 +1,383 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateDpEndpointDetails(object): + """ + Properties used in endpoint update operations. + """ + + #: A constant which can be used with the model_type property of a UpdateDpEndpointDetails. + #: This constant has a value of "PRIVATE_END_POINT" + MODEL_TYPE_PRIVATE_END_POINT = "PRIVATE_END_POINT" + + #: A constant which can be used with the model_type property of a UpdateDpEndpointDetails. + #: This constant has a value of "PUBLIC_END_POINT" + MODEL_TYPE_PUBLIC_END_POINT = "PUBLIC_END_POINT" + + def __init__(self, **kwargs): + """ + Initializes a new UpdateDpEndpointDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.data_connectivity.models.UpdateDpEndpointFromPublic` + * :class:`~oci.data_connectivity.models.UpdateDpEndpointFromPrivate` + + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this UpdateDpEndpointDetails. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this UpdateDpEndpointDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this UpdateDpEndpointDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this UpdateDpEndpointDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this UpdateDpEndpointDetails. + :type name: str + + :param description: + The value to assign to the description property of this UpdateDpEndpointDetails. + :type description: str + + :param object_status: + The value to assign to the object_status property of this UpdateDpEndpointDetails. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this UpdateDpEndpointDetails. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this UpdateDpEndpointDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this UpdateDpEndpointDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = 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['modelType'] + + if type == 'PUBLIC_END_POINT': + return 'UpdateDpEndpointFromPublic' + + if type == 'PRIVATE_END_POINT': + return 'UpdateDpEndpointFromPrivate' + else: + return 'UpdateDpEndpointDetails' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this UpdateDpEndpointDetails. + The type of the endpoint. + + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + + + :return: The model_type of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this UpdateDpEndpointDetails. + The type of the endpoint. + + + :param model_type: The model_type of this UpdateDpEndpointDetails. + :type: str + """ + allowed_values = ["PRIVATE_END_POINT", "PUBLIC_END_POINT"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + raise ValueError( + "Invalid value for `model_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._model_type = model_type + + @property + def key(self): + """ + **[Required]** Gets the key of this UpdateDpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :return: The key of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this UpdateDpEndpointDetails. + Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create. + + + :param key: The key of this UpdateDpEndpointDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this UpdateDpEndpointDetails. + The model version of an object. + + + :return: The model_version of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this UpdateDpEndpointDetails. + The model version of an object. + + + :param model_version: The model_version of this UpdateDpEndpointDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this UpdateDpEndpointDetails. + + :return: The parent_ref of this UpdateDpEndpointDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this UpdateDpEndpointDetails. + + :param parent_ref: The parent_ref of this UpdateDpEndpointDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this UpdateDpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateDpEndpointDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this UpdateDpEndpointDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this UpdateDpEndpointDetails. + User-defined description for the endpoint. + + + :return: The description of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateDpEndpointDetails. + User-defined description for the endpoint. + + + :param description: The description of this UpdateDpEndpointDetails. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this UpdateDpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this UpdateDpEndpointDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this UpdateDpEndpointDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this UpdateDpEndpointDetails. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + **[Required]** Gets the object_version of this UpdateDpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this UpdateDpEndpointDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this UpdateDpEndpointDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this UpdateDpEndpointDetails. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this UpdateDpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this UpdateDpEndpointDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this UpdateDpEndpointDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this UpdateDpEndpointDetails. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this UpdateDpEndpointDetails. + List of data assets which belongs to this endpoint + + + :return: The data_assets of this UpdateDpEndpointDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this UpdateDpEndpointDetails. + List of data assets which belongs to this endpoint + + + :param data_assets: The data_assets of this UpdateDpEndpointDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_dp_endpoint_from_private.py b/src/oci/data_connectivity/models/update_dp_endpoint_from_private.py new file mode 100644 index 0000000000..32e818a6cf --- /dev/null +++ b/src/oci/data_connectivity/models/update_dp_endpoint_from_private.py @@ -0,0 +1,346 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .update_dp_endpoint_details import UpdateDpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateDpEndpointFromPrivate(UpdateDpEndpointDetails): + """ + The details to update a private endpoint. + """ + + #: A constant which can be used with the state property of a UpdateDpEndpointFromPrivate. + #: This constant has a value of "ACTIVE" + STATE_ACTIVE = "ACTIVE" + + #: A constant which can be used with the state property of a UpdateDpEndpointFromPrivate. + #: This constant has a value of "INACTIVE" + STATE_INACTIVE = "INACTIVE" + + def __init__(self, **kwargs): + """ + Initializes a new UpdateDpEndpointFromPrivate object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.UpdateDpEndpointFromPrivate.model_type` attribute + of this class is ``PRIVATE_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this UpdateDpEndpointFromPrivate. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this UpdateDpEndpointFromPrivate. + :type key: str + + :param model_version: + The value to assign to the model_version property of this UpdateDpEndpointFromPrivate. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this UpdateDpEndpointFromPrivate. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this UpdateDpEndpointFromPrivate. + :type name: str + + :param description: + The value to assign to the description property of this UpdateDpEndpointFromPrivate. + :type description: str + + :param object_status: + The value to assign to the object_status property of this UpdateDpEndpointFromPrivate. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this UpdateDpEndpointFromPrivate. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this UpdateDpEndpointFromPrivate. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this UpdateDpEndpointFromPrivate. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + :param dcms_endpoint_id: + The value to assign to the dcms_endpoint_id property of this UpdateDpEndpointFromPrivate. + :type dcms_endpoint_id: str + + :param pe_id: + The value to assign to the pe_id property of this UpdateDpEndpointFromPrivate. + :type pe_id: str + + :param compartment_id: + The value to assign to the compartment_id property of this UpdateDpEndpointFromPrivate. + :type compartment_id: str + + :param dns_proxy_ip: + The value to assign to the dns_proxy_ip property of this UpdateDpEndpointFromPrivate. + :type dns_proxy_ip: str + + :param private_endpoint_ip: + The value to assign to the private_endpoint_ip property of this UpdateDpEndpointFromPrivate. + :type private_endpoint_ip: str + + :param dns_zones: + The value to assign to the dns_zones property of this UpdateDpEndpointFromPrivate. + :type dns_zones: list[str] + + :param state: + The value to assign to the state property of this UpdateDpEndpointFromPrivate. + Allowed values for this property are: "ACTIVE", "INACTIVE" + :type state: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]', + 'dcms_endpoint_id': 'str', + 'pe_id': 'str', + 'compartment_id': 'str', + 'dns_proxy_ip': 'str', + 'private_endpoint_ip': 'str', + 'dns_zones': 'list[str]', + 'state': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets', + 'dcms_endpoint_id': 'dcmsEndpointId', + 'pe_id': 'peId', + 'compartment_id': 'compartmentId', + 'dns_proxy_ip': 'dnsProxyIp', + 'private_endpoint_ip': 'privateEndpointIp', + 'dns_zones': 'dnsZones', + 'state': 'state' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = None + self._dcms_endpoint_id = None + self._pe_id = None + self._compartment_id = None + self._dns_proxy_ip = None + self._private_endpoint_ip = None + self._dns_zones = None + self._state = None + self._model_type = 'PRIVATE_END_POINT' + + @property + def dcms_endpoint_id(self): + """ + **[Required]** Gets the dcms_endpoint_id of this UpdateDpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :return: The dcms_endpoint_id of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._dcms_endpoint_id + + @dcms_endpoint_id.setter + def dcms_endpoint_id(self, dcms_endpoint_id): + """ + Sets the dcms_endpoint_id of this UpdateDpEndpointFromPrivate. + The endpoint ID provided by control plane. + + + :param dcms_endpoint_id: The dcms_endpoint_id of this UpdateDpEndpointFromPrivate. + :type: str + """ + self._dcms_endpoint_id = dcms_endpoint_id + + @property + def pe_id(self): + """ + Gets the pe_id of this UpdateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The pe_id of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._pe_id + + @pe_id.setter + def pe_id(self, pe_id): + """ + Sets the pe_id of this UpdateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param pe_id: The pe_id of this UpdateDpEndpointFromPrivate. + :type: str + """ + self._pe_id = pe_id + + @property + def compartment_id(self): + """ + Gets the compartment_id of this UpdateDpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :return: The compartment_id of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this UpdateDpEndpointFromPrivate. + The compartmentId of private endpoint resource. + + + :param compartment_id: The compartment_id of this UpdateDpEndpointFromPrivate. + :type: str + """ + self._compartment_id = compartment_id + + @property + def dns_proxy_ip(self): + """ + Gets the dns_proxy_ip of this UpdateDpEndpointFromPrivate. + The IP address of dns proxy. + + + :return: The dns_proxy_ip of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._dns_proxy_ip + + @dns_proxy_ip.setter + def dns_proxy_ip(self, dns_proxy_ip): + """ + Sets the dns_proxy_ip of this UpdateDpEndpointFromPrivate. + The IP address of dns proxy. + + + :param dns_proxy_ip: The dns_proxy_ip of this UpdateDpEndpointFromPrivate. + :type: str + """ + self._dns_proxy_ip = dns_proxy_ip + + @property + def private_endpoint_ip(self): + """ + Gets the private_endpoint_ip of this UpdateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :return: The private_endpoint_ip of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._private_endpoint_ip + + @private_endpoint_ip.setter + def private_endpoint_ip(self, private_endpoint_ip): + """ + Sets the private_endpoint_ip of this UpdateDpEndpointFromPrivate. + The ocid of private endpoint resource. + + + :param private_endpoint_ip: The private_endpoint_ip of this UpdateDpEndpointFromPrivate. + :type: str + """ + self._private_endpoint_ip = private_endpoint_ip + + @property + def dns_zones(self): + """ + Gets the dns_zones of this UpdateDpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :return: The dns_zones of this UpdateDpEndpointFromPrivate. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this UpdateDpEndpointFromPrivate. + Array of dns zones to be use during private endpoint resolution. + + + :param dns_zones: The dns_zones of this UpdateDpEndpointFromPrivate. + :type: list[str] + """ + self._dns_zones = dns_zones + + @property + def state(self): + """ + Gets the state of this UpdateDpEndpointFromPrivate. + Specifies the private endpoint state. + + Allowed values for this property are: "ACTIVE", "INACTIVE" + + + :return: The state of this UpdateDpEndpointFromPrivate. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this UpdateDpEndpointFromPrivate. + Specifies the private endpoint state. + + + :param state: The state of this UpdateDpEndpointFromPrivate. + :type: str + """ + allowed_values = ["ACTIVE", "INACTIVE"] + if not value_allowed_none_or_none_sentinel(state, allowed_values): + raise ValueError( + "Invalid value for `state`, must be None or one of {0}" + .format(allowed_values) + ) + self._state = 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/data_connectivity/models/update_dp_endpoint_from_public.py b/src/oci/data_connectivity/models/update_dp_endpoint_from_public.py new file mode 100644 index 0000000000..1abe745b56 --- /dev/null +++ b/src/oci/data_connectivity/models/update_dp_endpoint_from_public.py @@ -0,0 +1,112 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .update_dp_endpoint_details import UpdateDpEndpointDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateDpEndpointFromPublic(UpdateDpEndpointDetails): + """ + The details to update a public endpoint. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateDpEndpointFromPublic object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.UpdateDpEndpointFromPublic.model_type` attribute + of this class is ``PUBLIC_END_POINT`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this UpdateDpEndpointFromPublic. + Allowed values for this property are: "PRIVATE_END_POINT", "PUBLIC_END_POINT" + :type model_type: str + + :param key: + The value to assign to the key property of this UpdateDpEndpointFromPublic. + :type key: str + + :param model_version: + The value to assign to the model_version property of this UpdateDpEndpointFromPublic. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this UpdateDpEndpointFromPublic. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this UpdateDpEndpointFromPublic. + :type name: str + + :param description: + The value to assign to the description property of this UpdateDpEndpointFromPublic. + :type description: str + + :param object_status: + The value to assign to the object_status property of this UpdateDpEndpointFromPublic. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this UpdateDpEndpointFromPublic. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this UpdateDpEndpointFromPublic. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this UpdateDpEndpointFromPublic. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = None + self._model_type = 'PUBLIC_END_POINT' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_endpoint_details.py b/src/oci/data_connectivity/models/update_endpoint_details.py new file mode 100644 index 0000000000..e3a7f1a0be --- /dev/null +++ b/src/oci/data_connectivity/models/update_endpoint_details.py @@ -0,0 +1,229 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateEndpointDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateEndpointDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateEndpointDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateEndpointDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this UpdateEndpointDetails. + :type description: str + + :param display_name: + The value to assign to the display_name property of this UpdateEndpointDetails. + :type display_name: str + + :param endpoint_size: + The value to assign to the endpoint_size property of this UpdateEndpointDetails. + :type endpoint_size: int + + :param nsg_ids: + The value to assign to the nsg_ids property of this UpdateEndpointDetails. + :type nsg_ids: list[str] + + """ + self.swagger_types = { + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str', + 'endpoint_size': 'int', + 'nsg_ids': 'list[str]' + } + + self.attribute_map = { + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName', + 'endpoint_size': 'endpointSize', + 'nsg_ids': 'nsgIds' + } + + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + self._endpoint_size = None + self._nsg_ids = None + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateEndpointDetails. + 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 UpdateEndpointDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateEndpointDetails. + 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 UpdateEndpointDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateEndpointDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateEndpointDetails. + :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 UpdateEndpointDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateEndpointDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this UpdateEndpointDetails. + Data Connectivity Management Registry description + + + :return: The description of this UpdateEndpointDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateEndpointDetails. + Data Connectivity Management Registry description + + + :param description: The description of this UpdateEndpointDetails. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + Gets the display_name of this UpdateEndpointDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this UpdateEndpointDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateEndpointDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this UpdateEndpointDetails. + :type: str + """ + self._display_name = display_name + + @property + def endpoint_size(self): + """ + Gets the endpoint_size of this UpdateEndpointDetails. + Update Endpoint size for reverse connection capacity. + + + :return: The endpoint_size of this UpdateEndpointDetails. + :rtype: int + """ + return self._endpoint_size + + @endpoint_size.setter + def endpoint_size(self, endpoint_size): + """ + Sets the endpoint_size of this UpdateEndpointDetails. + Update Endpoint size for reverse connection capacity. + + + :param endpoint_size: The endpoint_size of this UpdateEndpointDetails. + :type: int + """ + self._endpoint_size = endpoint_size + + @property + def nsg_ids(self): + """ + Gets the nsg_ids of this UpdateEndpointDetails. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :return: The nsg_ids of this UpdateEndpointDetails. + :rtype: list[str] + """ + return self._nsg_ids + + @nsg_ids.setter + def nsg_ids(self, nsg_ids): + """ + Sets the nsg_ids of this UpdateEndpointDetails. + List of NSGs to which the Private Endpoint VNIC must be added. + + + :param nsg_ids: The nsg_ids of this UpdateEndpointDetails. + :type: list[str] + """ + self._nsg_ids = nsg_ids + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_folder_details.py b/src/oci/data_connectivity/models/update_folder_details.py new file mode 100644 index 0000000000..d2d40013e5 --- /dev/null +++ b/src/oci/data_connectivity/models/update_folder_details.py @@ -0,0 +1,345 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateFolderDetails(object): + """ + Properties used in folder update operations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateFolderDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this UpdateFolderDetails. + :type model_type: str + + :param key: + The value to assign to the key property of this UpdateFolderDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this UpdateFolderDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this UpdateFolderDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this UpdateFolderDetails. + :type name: str + + :param description: + The value to assign to the description property of this UpdateFolderDetails. + :type description: str + + :param object_status: + The value to assign to the object_status property of this UpdateFolderDetails. + :type object_status: int + + :param object_version: + The value to assign to the object_version property of this UpdateFolderDetails. + :type object_version: int + + :param identifier: + The value to assign to the identifier property of this UpdateFolderDetails. + :type identifier: str + + :param data_assets: + The value to assign to the data_assets property of this UpdateFolderDetails. + :type data_assets: list[oci.data_connectivity.models.DataAsset] + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'description': 'str', + 'object_status': 'int', + 'object_version': 'int', + 'identifier': 'str', + 'data_assets': 'list[DataAsset]' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'description': 'description', + 'object_status': 'objectStatus', + 'object_version': 'objectVersion', + 'identifier': 'identifier', + 'data_assets': 'dataAssets' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._name = None + self._description = None + self._object_status = None + self._object_version = None + self._identifier = None + self._data_assets = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this UpdateFolderDetails. + The type of the folder. + + + :return: The model_type of this UpdateFolderDetails. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this UpdateFolderDetails. + The type of the folder. + + + :param model_type: The model_type of this UpdateFolderDetails. + :type: str + """ + self._model_type = model_type + + @property + def key(self): + """ + **[Required]** Gets the key of this UpdateFolderDetails. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :return: The key of this UpdateFolderDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this UpdateFolderDetails. + Generated key that can be used in API calls to identify folder. On scenarios where reference to the folder is needed, a value can be passed in create. + + + :param key: The key of this UpdateFolderDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this UpdateFolderDetails. + The model version of an object. + + + :return: The model_version of this UpdateFolderDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this UpdateFolderDetails. + The model version of an object. + + + :param model_version: The model_version of this UpdateFolderDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this UpdateFolderDetails. + + :return: The parent_ref of this UpdateFolderDetails. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this UpdateFolderDetails. + + :param parent_ref: The parent_ref of this UpdateFolderDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this UpdateFolderDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :return: The name of this UpdateFolderDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UpdateFolderDetails. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. + + + :param name: The name of this UpdateFolderDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this UpdateFolderDetails. + User-defined description for the folder. + + + :return: The description of this UpdateFolderDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateFolderDetails. + User-defined description for the folder. + + + :param description: The description of this UpdateFolderDetails. + :type: str + """ + self._description = description + + @property + def object_status(self): + """ + Gets the object_status of this UpdateFolderDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this UpdateFolderDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this UpdateFolderDetails. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this UpdateFolderDetails. + :type: int + """ + self._object_status = object_status + + @property + def object_version(self): + """ + **[Required]** Gets the object_version of this UpdateFolderDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this UpdateFolderDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this UpdateFolderDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this UpdateFolderDetails. + :type: int + """ + self._object_version = object_version + + @property + def identifier(self): + """ + Gets the identifier of this UpdateFolderDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :return: The identifier of this UpdateFolderDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this UpdateFolderDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this UpdateFolderDetails. + :type: str + """ + self._identifier = identifier + + @property + def data_assets(self): + """ + Gets the data_assets of this UpdateFolderDetails. + List of data assets which belongs to this folder + + + :return: The data_assets of this UpdateFolderDetails. + :rtype: list[oci.data_connectivity.models.DataAsset] + """ + return self._data_assets + + @data_assets.setter + def data_assets(self, data_assets): + """ + Sets the data_assets of this UpdateFolderDetails. + List of data assets which belongs to this folder + + + :param data_assets: The data_assets of this UpdateFolderDetails. + :type: list[oci.data_connectivity.models.DataAsset] + """ + self._data_assets = data_assets + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/update_registry_details.py b/src/oci/data_connectivity/models/update_registry_details.py new file mode 100644 index 0000000000..ebe1df626d --- /dev/null +++ b/src/oci/data_connectivity/models/update_registry_details.py @@ -0,0 +1,167 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateRegistryDetails(object): + """ + The information to be updated. + """ + + def __init__(self, **kwargs): + """ + Initializes a new UpdateRegistryDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param freeform_tags: + The value to assign to the freeform_tags property of this UpdateRegistryDetails. + :type freeform_tags: dict(str, str) + + :param defined_tags: + The value to assign to the defined_tags property of this UpdateRegistryDetails. + :type defined_tags: dict(str, dict(str, object)) + + :param description: + The value to assign to the description property of this UpdateRegistryDetails. + :type description: str + + :param display_name: + The value to assign to the display_name property of this UpdateRegistryDetails. + :type display_name: str + + """ + self.swagger_types = { + 'freeform_tags': 'dict(str, str)', + 'defined_tags': 'dict(str, dict(str, object))', + 'description': 'str', + 'display_name': 'str' + } + + self.attribute_map = { + 'freeform_tags': 'freeformTags', + 'defined_tags': 'definedTags', + 'description': 'description', + 'display_name': 'displayName' + } + + self._freeform_tags = None + self._defined_tags = None + self._description = None + self._display_name = None + + @property + def freeform_tags(self): + """ + Gets the freeform_tags of this UpdateRegistryDetails. + 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 UpdateRegistryDetails. + :rtype: dict(str, str) + """ + return self._freeform_tags + + @freeform_tags.setter + def freeform_tags(self, freeform_tags): + """ + Sets the freeform_tags of this UpdateRegistryDetails. + 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 UpdateRegistryDetails. + :type: dict(str, str) + """ + self._freeform_tags = freeform_tags + + @property + def defined_tags(self): + """ + Gets the defined_tags of this UpdateRegistryDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :return: The defined_tags of this UpdateRegistryDetails. + :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 UpdateRegistryDetails. + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` + + + :param defined_tags: The defined_tags of this UpdateRegistryDetails. + :type: dict(str, dict(str, object)) + """ + self._defined_tags = defined_tags + + @property + def description(self): + """ + Gets the description of this UpdateRegistryDetails. + Data Connectivity Management Registry description + + + :return: The description of this UpdateRegistryDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UpdateRegistryDetails. + Data Connectivity Management Registry description + + + :param description: The description of this UpdateRegistryDetails. + :type: str + """ + self._description = description + + @property + def display_name(self): + """ + Gets the display_name of this UpdateRegistryDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :return: The display_name of this UpdateRegistryDetails. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this UpdateRegistryDetails. + Data Connectivity Management Registry display name, registries can be renamed + + + :param display_name: The display_name of this UpdateRegistryDetails. + :type: str + """ + self._display_name = display_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/data_connectivity/models/validation_message.py b/src/oci/data_connectivity/models/validation_message.py new file mode 100644 index 0000000000..9694bee393 --- /dev/null +++ b/src/oci/data_connectivity/models/validation_message.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ValidationMessage(object): + """ + The level and validation message. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ValidationMessage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level: + The value to assign to the level property of this ValidationMessage. + :type level: str + + :param validation_message: + The value to assign to the validation_message property of this ValidationMessage. + :type validation_message: str + + """ + self.swagger_types = { + 'level': 'str', + 'validation_message': 'str' + } + + self.attribute_map = { + 'level': 'level', + 'validation_message': 'validationMessage' + } + + self._level = None + self._validation_message = None + + @property + def level(self): + """ + Gets the level of this ValidationMessage. + level of validation messages + + + :return: The level of this ValidationMessage. + :rtype: str + """ + return self._level + + @level.setter + def level(self, level): + """ + Sets the level of this ValidationMessage. + level of validation messages + + + :param level: The level of this ValidationMessage. + :type: str + """ + self._level = level + + @property + def validation_message(self): + """ + Gets the validation_message of this ValidationMessage. + The message itself. + + + :return: The validation_message of this ValidationMessage. + :rtype: str + """ + return self._validation_message + + @validation_message.setter + def validation_message(self, validation_message): + """ + Sets the validation_message of this ValidationMessage. + The message itself. + + + :param validation_message: The validation_message of this ValidationMessage. + :type: str + """ + self._validation_message = validation_message + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/validation_result.py b/src/oci/data_connectivity/models/validation_result.py new file mode 100644 index 0000000000..43c1bc82f6 --- /dev/null +++ b/src/oci/data_connectivity/models/validation_result.py @@ -0,0 +1,117 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ValidationResult(object): + """ + Validation Result object for a single DataAsset. + """ + + #: A constant which can be used with the status property of a ValidationResult. + #: This constant has a value of "ERROR" + STATUS_ERROR = "ERROR" + + #: A constant which can be used with the status property of a ValidationResult. + #: This constant has a value of "SUCCESS" + STATUS_SUCCESS = "SUCCESS" + + def __init__(self, **kwargs): + """ + Initializes a new ValidationResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param error_msg: + The value to assign to the error_msg property of this ValidationResult. + :type error_msg: str + + :param status: + The value to assign to the status property of this ValidationResult. + Allowed values for this property are: "ERROR", "SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + """ + self.swagger_types = { + 'error_msg': 'str', + 'status': 'str' + } + + self.attribute_map = { + 'error_msg': 'errorMsg', + 'status': 'status' + } + + self._error_msg = None + self._status = None + + @property + def error_msg(self): + """ + Gets the error_msg of this ValidationResult. + Error text for validation failure + + + :return: The error_msg of this ValidationResult. + :rtype: str + """ + return self._error_msg + + @error_msg.setter + def error_msg(self, error_msg): + """ + Sets the error_msg of this ValidationResult. + Error text for validation failure + + + :param error_msg: The error_msg of this ValidationResult. + :type: str + """ + self._error_msg = error_msg + + @property + def status(self): + """ + Gets the status of this ValidationResult. + Status of the validatio result execution + + Allowed values for this property are: "ERROR", "SUCCESS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this ValidationResult. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this ValidationResult. + Status of the validatio result execution + + + :param status: The status of this ValidationResult. + :type: str + """ + allowed_values = ["ERROR", "SUCCESS"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request.py b/src/oci/data_connectivity/models/work_request.py new file mode 100644 index 0000000000..d9cef108c8 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request.py @@ -0,0 +1,396 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequest(object): + """ + A description of workrequest status + """ + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "CREATE" + OPERATION_TYPE_CREATE = "CREATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "UPDATE" + OPERATION_TYPE_UPDATE = "UPDATE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "DELETE" + OPERATION_TYPE_DELETE = "DELETE" + + #: A constant which can be used with the operation_type property of a WorkRequest. + #: This constant has a value of "MOVE" + OPERATION_TYPE_MOVE = "MOVE" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequest. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequest object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequest. + Allowed values for this property are: "CREATE", "UPDATE", "DELETE", "MOVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequest. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequest. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequest. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequest. + :type resources: list[oci.data_connectivity.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequest. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequest. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequest. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequest. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequest. + type of the work request + + Allowed values for this property are: "CREATE", "UPDATE", "DELETE", "MOVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequest. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequest. + type of the work request + + + :param operation_type: The operation_type of this WorkRequest. + :type: str + """ + allowed_values = ["CREATE", "UPDATE", "DELETE", "MOVE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequest. + status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequest. + status of current work request. + + + :param status: The status of this WorkRequest. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequest. + The id of the work request. + + + :return: The id of this WorkRequest. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequest. + The id of the work request. + + + :param id: The id of this WorkRequest. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequest. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequest. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequest. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequest. + The resources affected by this work request. + + + :return: The resources of this WorkRequest. + :rtype: list[oci.data_connectivity.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequest. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequest. + :type: list[oci.data_connectivity.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequest. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequest. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequest. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequest. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequest. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequest. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequest. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequest. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequest. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequest. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequest. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequest. + :type: datetime + """ + self._time_finished = time_finished + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_error.py b/src/oci/data_connectivity/models/work_request_error.py new file mode 100644 index 0000000000..26ac6a8cc9 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_error.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestError(object): + """ + An error encountered while executing a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestError object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param code: + The value to assign to the code property of this WorkRequestError. + :type code: str + + :param message: + The value to assign to the message property of this WorkRequestError. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestError. + :type timestamp: datetime + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._code = None + self._message = None + self._timestamp = None + + @property + def code(self): + """ + **[Required]** Gets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestError. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestError. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :param code: The code of this WorkRequestError. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :return: The message of this WorkRequestError. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestError. + A human readable description of the issue encountered. + + + :param message: The message of this WorkRequestError. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestError. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestError. + The time the error occured. An RFC3339 formatted datetime string. + + + :param timestamp: The timestamp of this WorkRequestError. + :type: datetime + """ + self._timestamp = timestamp + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_error_collection.py b/src/oci/data_connectivity/models/work_request_error_collection.py new file mode 100644 index 0000000000..d78c77c992 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_error_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestErrorCollection(object): + """ + List of WorkRequestError summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this WorkRequestErrorCollection. + :type items: list[oci.data_connectivity.models.WorkRequestError] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestError]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestErrorCollection. + The array of WorkRequestError summariess + + + :return: The items of this WorkRequestErrorCollection. + :rtype: list[oci.data_connectivity.models.WorkRequestError] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestErrorCollection. + The array of WorkRequestError summariess + + + :param items: The items of this WorkRequestErrorCollection. + :type: list[oci.data_connectivity.models.WorkRequestError] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_error_summary.py b/src/oci/data_connectivity/models/work_request_error_summary.py new file mode 100644 index 0000000000..35c15cdf43 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_error_summary.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestErrorSummary(object): + """ + A work request error summary object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestErrorSummary 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 WorkRequestErrorSummary. + :type code: str + + :param message: + The value to assign to the message property of this WorkRequestErrorSummary. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestErrorSummary. + :type timestamp: datetime + + """ + self.swagger_types = { + 'code': 'str', + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'code': 'code', + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._code = None + self._message = None + self._timestamp = None + + @property + def code(self): + """ + **[Required]** Gets the code of this WorkRequestErrorSummary. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :return: The code of this WorkRequestErrorSummary. + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this WorkRequestErrorSummary. + A machine-usable code for the error that occured. Error codes are listed on + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + + + :param code: The code of this WorkRequestErrorSummary. + :type: str + """ + self._code = code + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestErrorSummary. + A human readable description of the issue encountered. + + + :return: The message of this WorkRequestErrorSummary. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestErrorSummary. + A human readable description of the issue encountered. + + + :param message: The message of this WorkRequestErrorSummary. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestErrorSummary. + The time the error occured. An RFC3339 formatted datetime string. + + + :return: The timestamp of this WorkRequestErrorSummary. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestErrorSummary. + The time the error occured. An RFC3339 formatted datetime string. + + + :param timestamp: The timestamp of this WorkRequestErrorSummary. + :type: datetime + """ + self._timestamp = timestamp + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_log.py b/src/oci/data_connectivity/models/work_request_log.py new file mode 100644 index 0000000000..acb6f17af6 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_log.py @@ -0,0 +1,101 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestLog(object): + """ + A log message from the execution of a work request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLog 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 WorkRequestLog. + :type message: str + + :param timestamp: + The value to assign to the timestamp property of this WorkRequestLog. + :type timestamp: datetime + + """ + self.swagger_types = { + 'message': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'message': 'message', + 'timestamp': 'timestamp' + } + + self._message = None + self._timestamp = None + + @property + def message(self): + """ + **[Required]** Gets the message of this WorkRequestLog. + Human-readable log message. + + + :return: The message of this WorkRequestLog. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this WorkRequestLog. + Human-readable log message. + + + :param message: The message of this WorkRequestLog. + :type: str + """ + self._message = message + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this WorkRequestLog. + The time the log message was written. An RFC3339 formatted datetime string + + + :return: The timestamp of this WorkRequestLog. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this WorkRequestLog. + The time the log message was written. An RFC3339 formatted datetime string + + + :param timestamp: The timestamp of this WorkRequestLog. + :type: datetime + """ + self._timestamp = timestamp + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_log_collection.py b/src/oci/data_connectivity/models/work_request_log_collection.py new file mode 100644 index 0000000000..64a5bdae60 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_log_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestLogCollection(object): + """ + List of WorkRequestLog summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestLogCollection 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 WorkRequestLogCollection. + :type items: list[oci.data_connectivity.models.WorkRequestLog] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestLog]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestLogCollection. + The array of WorkRequestLog summariess + + + :return: The items of this WorkRequestLogCollection. + :rtype: list[oci.data_connectivity.models.WorkRequestLog] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestLogCollection. + The array of WorkRequestLog summariess + + + :param items: The items of this WorkRequestLogCollection. + :type: list[oci.data_connectivity.models.WorkRequestLog] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_resource.py b/src/oci/data_connectivity/models/work_request_resource.py new file mode 100644 index 0000000000..3cd505c91c --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_resource.py @@ -0,0 +1,209 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestResource(object): + """ + A resource created or operated on by a work request. + """ + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "CREATED" + ACTION_TYPE_CREATED = "CREATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "UPDATED" + ACTION_TYPE_UPDATED = "UPDATED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "DELETED" + ACTION_TYPE_DELETED = "DELETED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "MOVED" + ACTION_TYPE_MOVED = "MOVED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "IN_PROGRESS" + ACTION_TYPE_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "FAILED" + ACTION_TYPE_FAILED = "FAILED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "STOPPED" + ACTION_TYPE_STOPPED = "STOPPED" + + #: A constant which can be used with the action_type property of a WorkRequestResource. + #: This constant has a value of "STARTED" + ACTION_TYPE_STARTED = "STARTED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestResource object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_type: + The value to assign to the entity_type property of this WorkRequestResource. + :type entity_type: str + + :param action_type: + The value to assign to the action_type property of this WorkRequestResource. + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "MOVED", "IN_PROGRESS", "FAILED", "STOPPED", "STARTED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type action_type: str + + :param identifier: + The value to assign to the identifier property of this WorkRequestResource. + :type identifier: str + + :param entity_uri: + The value to assign to the entity_uri property of this WorkRequestResource. + :type entity_uri: str + + """ + self.swagger_types = { + 'entity_type': 'str', + 'action_type': 'str', + 'identifier': 'str', + 'entity_uri': 'str' + } + + self.attribute_map = { + 'entity_type': 'entityType', + 'action_type': 'actionType', + 'identifier': 'identifier', + 'entity_uri': 'entityUri' + } + + self._entity_type = None + self._action_type = None + self._identifier = None + self._entity_uri = None + + @property + def entity_type(self): + """ + **[Required]** Gets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :return: The entity_type of this WorkRequestResource. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this WorkRequestResource. + The resource type the work request affects. + + + :param entity_type: The entity_type of this WorkRequestResource. + :type: str + """ + self._entity_type = entity_type + + @property + def action_type(self): + """ + **[Required]** Gets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + Allowed values for this property are: "CREATED", "UPDATED", "DELETED", "MOVED", "IN_PROGRESS", "FAILED", "STOPPED", "STARTED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The action_type of this WorkRequestResource. + :rtype: str + """ + return self._action_type + + @action_type.setter + def action_type(self, action_type): + """ + Sets the action_type of this WorkRequestResource. + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + + + :param action_type: The action_type of this WorkRequestResource. + :type: str + """ + allowed_values = ["CREATED", "UPDATED", "DELETED", "MOVED", "IN_PROGRESS", "FAILED", "STOPPED", "STARTED"] + if not value_allowed_none_or_none_sentinel(action_type, allowed_values): + action_type = 'UNKNOWN_ENUM_VALUE' + self._action_type = action_type + + @property + def identifier(self): + """ + **[Required]** Gets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :return: The identifier of this WorkRequestResource. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this WorkRequestResource. + The identifier of the resource the work request affects. + + + :param identifier: The identifier of this WorkRequestResource. + :type: str + """ + self._identifier = identifier + + @property + def entity_uri(self): + """ + Gets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :return: The entity_uri of this WorkRequestResource. + :rtype: str + """ + return self._entity_uri + + @entity_uri.setter + def entity_uri(self, entity_uri): + """ + Sets the entity_uri of this WorkRequestResource. + The URI path that the user can do a GET on to access the resource metadata + + + :param entity_uri: The entity_uri of this WorkRequestResource. + :type: str + """ + self._entity_uri = entity_uri + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_summary.py b/src/oci/data_connectivity/models/work_request_summary.py new file mode 100644 index 0000000000..b6fb8c7727 --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_summary.py @@ -0,0 +1,396 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestSummary(object): + """ + A work request summary object. + """ + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "CREATE" + OPERATION_TYPE_CREATE = "CREATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "UPDATE" + OPERATION_TYPE_UPDATE = "UPDATE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "DELETE" + OPERATION_TYPE_DELETE = "DELETE" + + #: A constant which can be used with the operation_type property of a WorkRequestSummary. + #: This constant has a value of "MOVE" + OPERATION_TYPE_MOVE = "MOVE" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "ACCEPTED" + STATUS_ACCEPTED = "ACCEPTED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "IN_PROGRESS" + STATUS_IN_PROGRESS = "IN_PROGRESS" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELING" + STATUS_CANCELING = "CANCELING" + + #: A constant which can be used with the status property of a WorkRequestSummary. + #: This constant has a value of "CANCELED" + STATUS_CANCELED = "CANCELED" + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_type: + The value to assign to the operation_type property of this WorkRequestSummary. + Allowed values for this property are: "CREATE", "UPDATE", "DELETE", "MOVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type operation_type: str + + :param status: + The value to assign to the status property of this WorkRequestSummary. + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param id: + The value to assign to the id property of this WorkRequestSummary. + :type id: str + + :param compartment_id: + The value to assign to the compartment_id property of this WorkRequestSummary. + :type compartment_id: str + + :param resources: + The value to assign to the resources property of this WorkRequestSummary. + :type resources: list[oci.data_connectivity.models.WorkRequestResource] + + :param percent_complete: + The value to assign to the percent_complete property of this WorkRequestSummary. + :type percent_complete: float + + :param time_accepted: + The value to assign to the time_accepted property of this WorkRequestSummary. + :type time_accepted: datetime + + :param time_started: + The value to assign to the time_started property of this WorkRequestSummary. + :type time_started: datetime + + :param time_finished: + The value to assign to the time_finished property of this WorkRequestSummary. + :type time_finished: datetime + + """ + self.swagger_types = { + 'operation_type': 'str', + 'status': 'str', + 'id': 'str', + 'compartment_id': 'str', + 'resources': 'list[WorkRequestResource]', + 'percent_complete': 'float', + 'time_accepted': 'datetime', + 'time_started': 'datetime', + 'time_finished': 'datetime' + } + + self.attribute_map = { + 'operation_type': 'operationType', + 'status': 'status', + 'id': 'id', + 'compartment_id': 'compartmentId', + 'resources': 'resources', + 'percent_complete': 'percentComplete', + 'time_accepted': 'timeAccepted', + 'time_started': 'timeStarted', + 'time_finished': 'timeFinished' + } + + self._operation_type = None + self._status = None + self._id = None + self._compartment_id = None + self._resources = None + self._percent_complete = None + self._time_accepted = None + self._time_started = None + self._time_finished = None + + @property + def operation_type(self): + """ + **[Required]** Gets the operation_type of this WorkRequestSummary. + type of the work request + + Allowed values for this property are: "CREATE", "UPDATE", "DELETE", "MOVE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The operation_type of this WorkRequestSummary. + :rtype: str + """ + return self._operation_type + + @operation_type.setter + def operation_type(self, operation_type): + """ + Sets the operation_type of this WorkRequestSummary. + type of the work request + + + :param operation_type: The operation_type of this WorkRequestSummary. + :type: str + """ + allowed_values = ["CREATE", "UPDATE", "DELETE", "MOVE"] + if not value_allowed_none_or_none_sentinel(operation_type, allowed_values): + operation_type = 'UNKNOWN_ENUM_VALUE' + self._operation_type = operation_type + + @property + def status(self): + """ + **[Required]** Gets the status of this WorkRequestSummary. + status of current work request. + + Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this WorkRequestSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this WorkRequestSummary. + status of current work request. + + + :param status: The status of this WorkRequestSummary. + :type: str + """ + allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def id(self): + """ + **[Required]** Gets the id of this WorkRequestSummary. + The id of the work request. + + + :return: The id of this WorkRequestSummary. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this WorkRequestSummary. + The id of the work request. + + + :param id: The id of this WorkRequestSummary. + :type: str + """ + self._id = id + + @property + def compartment_id(self): + """ + **[Required]** Gets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :return: The compartment_id of this WorkRequestSummary. + :rtype: str + """ + return self._compartment_id + + @compartment_id.setter + def compartment_id(self, compartment_id): + """ + Sets the compartment_id of this WorkRequestSummary. + The ocid of the compartment that contains the work request. Work requests should be scoped to + the same compartment as the resource the work request affects. If the work request affects multiple resources, + and those resources are not in the same compartment, it is up to the service team to pick the primary + resource whose compartment should be used + + + :param compartment_id: The compartment_id of this WorkRequestSummary. + :type: str + """ + self._compartment_id = compartment_id + + @property + def resources(self): + """ + **[Required]** Gets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :return: The resources of this WorkRequestSummary. + :rtype: list[oci.data_connectivity.models.WorkRequestResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """ + Sets the resources of this WorkRequestSummary. + The resources affected by this work request. + + + :param resources: The resources of this WorkRequestSummary. + :type: list[oci.data_connectivity.models.WorkRequestResource] + """ + self._resources = resources + + @property + def percent_complete(self): + """ + **[Required]** Gets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :return: The percent_complete of this WorkRequestSummary. + :rtype: float + """ + return self._percent_complete + + @percent_complete.setter + def percent_complete(self, percent_complete): + """ + Sets the percent_complete of this WorkRequestSummary. + Percentage of the request completed. + + + :param percent_complete: The percent_complete of this WorkRequestSummary. + :type: float + """ + self._percent_complete = percent_complete + + @property + def time_accepted(self): + """ + **[Required]** Gets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_accepted of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_accepted + + @time_accepted.setter + def time_accepted(self, time_accepted): + """ + Sets the time_accepted of this WorkRequestSummary. + The date and time the request was created, as described in + `RFC 3339`__, section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_accepted: The time_accepted of this WorkRequestSummary. + :type: datetime + """ + self._time_accepted = time_accepted + + @property + def time_started(self): + """ + Gets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_started of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_started + + @time_started.setter + def time_started(self, time_started): + """ + Sets the time_started of this WorkRequestSummary. + The date and time the request was started, as described in `RFC 3339`__, + section 14.29. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_started: The time_started of this WorkRequestSummary. + :type: datetime + """ + self._time_started = time_started + + @property + def time_finished(self): + """ + Gets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The time_finished of this WorkRequestSummary. + :rtype: datetime + """ + return self._time_finished + + @time_finished.setter + def time_finished(self, time_finished): + """ + Sets the time_finished of this WorkRequestSummary. + The date and time the object was finished, as described in `RFC 3339`__. + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param time_finished: The time_finished of this WorkRequestSummary. + :type: datetime + """ + self._time_finished = time_finished + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/work_request_summary_collection.py b/src/oci/data_connectivity/models/work_request_summary_collection.py new file mode 100644 index 0000000000..470fe4132b --- /dev/null +++ b/src/oci/data_connectivity/models/work_request_summary_collection.py @@ -0,0 +1,70 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WorkRequestSummaryCollection(object): + """ + List of WorkRequest summaries. + """ + + def __init__(self, **kwargs): + """ + Initializes a new WorkRequestSummaryCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param items: + The value to assign to the items property of this WorkRequestSummaryCollection. + :type items: list[oci.data_connectivity.models.WorkRequestSummary] + + """ + self.swagger_types = { + 'items': 'list[WorkRequestSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this WorkRequestSummaryCollection. + The array of WorkRequest summariess + + + :return: The items of this WorkRequestSummaryCollection. + :rtype: list[oci.data_connectivity.models.WorkRequestSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this WorkRequestSummaryCollection. + The array of WorkRequest summariess + + + :param items: The items of this WorkRequestSummaryCollection. + :type: list[oci.data_connectivity.models.WorkRequestSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/write_operation_config.py b/src/oci/data_connectivity/models/write_operation_config.py new file mode 100644 index 0000000000..5905c811df --- /dev/null +++ b/src/oci/data_connectivity/models/write_operation_config.py @@ -0,0 +1,399 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .abstract_data_operation_config import AbstractDataOperationConfig +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class WriteOperationConfig(AbstractDataOperationConfig): + """ + The information about the write operation. + """ + + #: A constant which can be used with the write_mode property of a WriteOperationConfig. + #: This constant has a value of "OVERWRITE" + WRITE_MODE_OVERWRITE = "OVERWRITE" + + #: A constant which can be used with the write_mode property of a WriteOperationConfig. + #: This constant has a value of "APPEND" + WRITE_MODE_APPEND = "APPEND" + + #: A constant which can be used with the write_mode property of a WriteOperationConfig. + #: This constant has a value of "MERGE" + WRITE_MODE_MERGE = "MERGE" + + #: A constant which can be used with the write_mode property of a WriteOperationConfig. + #: This constant has a value of "IGNORE" + WRITE_MODE_IGNORE = "IGNORE" + + #: A constant which can be used with the write_mode property of a WriteOperationConfig. + #: This constant has a value of "CREATE" + WRITE_MODE_CREATE = "CREATE" + + def __init__(self, **kwargs): + """ + Initializes a new WriteOperationConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.WriteOperationConfig.model_type` attribute + of this class is ``WRITE_OPERATION_CONFIG`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param model_type: + The value to assign to the model_type property of this WriteOperationConfig. + Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" + :type model_type: str + + :param key: + The value to assign to the key property of this WriteOperationConfig. + :type key: str + + :param model_version: + The value to assign to the model_version property of this WriteOperationConfig. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this WriteOperationConfig. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param operations: + The value to assign to the operations property of this WriteOperationConfig. + :type operations: list[oci.data_connectivity.models.PushDownOperation] + + :param data_format: + The value to assign to the data_format property of this WriteOperationConfig. + :type data_format: oci.data_connectivity.models.DataFormat + + :param partition_config: + The value to assign to the partition_config property of this WriteOperationConfig. + :type partition_config: oci.data_connectivity.models.PartitionConfig + + :param write_attribute: + The value to assign to the write_attribute property of this WriteOperationConfig. + :type write_attribute: oci.data_connectivity.models.AbstractWriteAttribute + + :param write_mode: + The value to assign to the write_mode property of this WriteOperationConfig. + Allowed values for this property are: "OVERWRITE", "APPEND", "MERGE", "IGNORE", "CREATE" + :type write_mode: str + + :param merge_key: + The value to assign to the merge_key property of this WriteOperationConfig. + :type merge_key: oci.data_connectivity.models.UniqueKey + + :param object_status: + The value to assign to the object_status property of this WriteOperationConfig. + :type object_status: int + + :param reject_limit: + The value to assign to the reject_limit property of this WriteOperationConfig. + :type reject_limit: int + + """ + self.swagger_types = { + 'model_type': 'str', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'operations': 'list[PushDownOperation]', + 'data_format': 'DataFormat', + 'partition_config': 'PartitionConfig', + 'write_attribute': 'AbstractWriteAttribute', + 'write_mode': 'str', + 'merge_key': 'UniqueKey', + 'object_status': 'int', + 'reject_limit': 'int' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'operations': 'operations', + 'data_format': 'dataFormat', + 'partition_config': 'partitionConfig', + 'write_attribute': 'writeAttribute', + 'write_mode': 'writeMode', + 'merge_key': 'mergeKey', + 'object_status': 'objectStatus', + 'reject_limit': 'rejectLimit' + } + + self._model_type = None + self._key = None + self._model_version = None + self._parent_ref = None + self._operations = None + self._data_format = None + self._partition_config = None + self._write_attribute = None + self._write_mode = None + self._merge_key = None + self._object_status = None + self._reject_limit = None + self._model_type = 'WRITE_OPERATION_CONFIG' + + @property + def key(self): + """ + Gets the key of this WriteOperationConfig. + The object key. + + + :return: The key of this WriteOperationConfig. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this WriteOperationConfig. + The object key. + + + :param key: The key of this WriteOperationConfig. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this WriteOperationConfig. + The object's model version. + + + :return: The model_version of this WriteOperationConfig. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this WriteOperationConfig. + The object's model version. + + + :param model_version: The model_version of this WriteOperationConfig. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this WriteOperationConfig. + + :return: The parent_ref of this WriteOperationConfig. + :rtype: oci.data_connectivity.models.ParentReference + """ + return self._parent_ref + + @parent_ref.setter + def parent_ref(self, parent_ref): + """ + Sets the parent_ref of this WriteOperationConfig. + + :param parent_ref: The parent_ref of this WriteOperationConfig. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def operations(self): + """ + Gets the operations of this WriteOperationConfig. + An array of operations. + + + :return: The operations of this WriteOperationConfig. + :rtype: list[oci.data_connectivity.models.PushDownOperation] + """ + return self._operations + + @operations.setter + def operations(self, operations): + """ + Sets the operations of this WriteOperationConfig. + An array of operations. + + + :param operations: The operations of this WriteOperationConfig. + :type: list[oci.data_connectivity.models.PushDownOperation] + """ + self._operations = operations + + @property + def data_format(self): + """ + Gets the data_format of this WriteOperationConfig. + + :return: The data_format of this WriteOperationConfig. + :rtype: oci.data_connectivity.models.DataFormat + """ + return self._data_format + + @data_format.setter + def data_format(self, data_format): + """ + Sets the data_format of this WriteOperationConfig. + + :param data_format: The data_format of this WriteOperationConfig. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def partition_config(self): + """ + Gets the partition_config of this WriteOperationConfig. + + :return: The partition_config of this WriteOperationConfig. + :rtype: oci.data_connectivity.models.PartitionConfig + """ + return self._partition_config + + @partition_config.setter + def partition_config(self, partition_config): + """ + Sets the partition_config of this WriteOperationConfig. + + :param partition_config: The partition_config of this WriteOperationConfig. + :type: oci.data_connectivity.models.PartitionConfig + """ + self._partition_config = partition_config + + @property + def write_attribute(self): + """ + Gets the write_attribute of this WriteOperationConfig. + + :return: The write_attribute of this WriteOperationConfig. + :rtype: oci.data_connectivity.models.AbstractWriteAttribute + """ + return self._write_attribute + + @write_attribute.setter + def write_attribute(self, write_attribute): + """ + Sets the write_attribute of this WriteOperationConfig. + + :param write_attribute: The write_attribute of this WriteOperationConfig. + :type: oci.data_connectivity.models.AbstractWriteAttribute + """ + self._write_attribute = write_attribute + + @property + def write_mode(self): + """ + Gets the write_mode of this WriteOperationConfig. + The mode for the write operation. + + Allowed values for this property are: "OVERWRITE", "APPEND", "MERGE", "IGNORE", "CREATE" + + + :return: The write_mode of this WriteOperationConfig. + :rtype: str + """ + return self._write_mode + + @write_mode.setter + def write_mode(self, write_mode): + """ + Sets the write_mode of this WriteOperationConfig. + The mode for the write operation. + + + :param write_mode: The write_mode of this WriteOperationConfig. + :type: str + """ + allowed_values = ["OVERWRITE", "APPEND", "MERGE", "IGNORE", "CREATE"] + if not value_allowed_none_or_none_sentinel(write_mode, allowed_values): + raise ValueError( + "Invalid value for `write_mode`, must be None or one of {0}" + .format(allowed_values) + ) + self._write_mode = write_mode + + @property + def merge_key(self): + """ + Gets the merge_key of this WriteOperationConfig. + + :return: The merge_key of this WriteOperationConfig. + :rtype: oci.data_connectivity.models.UniqueKey + """ + return self._merge_key + + @merge_key.setter + def merge_key(self, merge_key): + """ + Sets the merge_key of this WriteOperationConfig. + + :param merge_key: The merge_key of this WriteOperationConfig. + :type: oci.data_connectivity.models.UniqueKey + """ + self._merge_key = merge_key + + @property + def object_status(self): + """ + Gets the object_status of this WriteOperationConfig. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :return: The object_status of this WriteOperationConfig. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this WriteOperationConfig. + The status of an object that can be set to value 1 for shallow references across objects, other values reserved. + + + :param object_status: The object_status of this WriteOperationConfig. + :type: int + """ + self._object_status = object_status + + @property + def reject_limit(self): + """ + Gets the reject_limit of this WriteOperationConfig. + The number of rows are rejected based on which operation will error out. + + + :return: The reject_limit of this WriteOperationConfig. + :rtype: int + """ + return self._reject_limit + + @reject_limit.setter + def reject_limit(self, reject_limit): + """ + Sets the reject_limit of this WriteOperationConfig. + The number of rows are rejected based on which operation will error out. + + + :param reject_limit: The reject_limit of this WriteOperationConfig. + :type: int + """ + self._reject_limit = reject_limit + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/network_validation_client.py b/src/oci/data_connectivity/network_validation_client.py new file mode 100644 index 0000000000..abc034b3e6 --- /dev/null +++ b/src/oci/data_connectivity/network_validation_client.py @@ -0,0 +1,249 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from __future__ import absolute_import + +from oci._vendor import requests # noqa: F401 +from oci._vendor import six + +from oci import retry, circuit_breaker # noqa: F401 +from oci.base_client import BaseClient +from oci.config import get_config_value_or_default, validate_config +from oci.signer import Signer +from oci.util import Sentinel, get_signer_from_authentication_type, AUTHENTICATION_TYPE_FIELD_NAME +from .models import data_connectivity_type_mapping +missing = Sentinel("Missing") + + +class NetworkValidationClient(object): + """ + Use the DCMS APIs to perform Metadata/Data operations. + """ + + def __init__(self, config, **kwargs): + """ + Creates a new service client + + :param dict config: + Configuration keys and values as per `SDK and Tool Configuration `__. + The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config + the dict using :py:meth:`~oci.config.validate_config` + + :param str service_endpoint: (optional) + The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is + not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit + need to specify a service endpoint. + + :param timeout: (optional) + The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided + as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If + a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. + :type timeout: float or tuple(float, float) + + :param signer: (optional) + The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values + provided in the config parameter. + + One use case for this parameter is for `Instance Principals authentication `__ + by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument + :type signer: :py:class:`~oci.signer.AbstractBaseSigner` + + :param obj retry_strategy: (optional) + A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. + Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. + Any value provided at the operation level will override whatever is specified at the client level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` + is also available. The specifics of the default retry strategy are described `here `__. + + :param obj circuit_breaker_strategy: (optional) + A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). + This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. + The specifics of circuit breaker strategy are described `here `__. + + :param function circuit_breaker_callback: (optional) + Callback function to receive any exceptions triggerred by the circuit breaker. + + :param allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not + allow control characters to be in the response object. + """ + validate_config(config, signer=kwargs.get('signer')) + if 'signer' in kwargs: + signer = kwargs['signer'] + + elif AUTHENTICATION_TYPE_FIELD_NAME in config: + signer = get_signer_from_authentication_type(config) + + else: + signer = Signer( + tenancy=config["tenancy"], + user=config["user"], + fingerprint=config["fingerprint"], + private_key_file_location=config.get("key_file"), + pass_phrase=get_config_value_or_default(config, "pass_phrase"), + private_key_content=config.get("key_content") + ) + + base_client_init_kwargs = { + 'regional_client': True, + 'service_endpoint': kwargs.get('service_endpoint'), + 'base_path': '/20210217', + 'service_endpoint_template': 'https://dataconnectivity.{region}.oci.{secondLevelDomain}', + 'skip_deserialization': kwargs.get('skip_deserialization', False), + 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY) + } + if 'timeout' in kwargs: + base_client_init_kwargs['timeout'] = kwargs.get('timeout') + if base_client_init_kwargs.get('circuit_breaker_strategy') is None: + base_client_init_kwargs['circuit_breaker_strategy'] = circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY + if 'allow_control_chars' in kwargs: + base_client_init_kwargs['allow_control_chars'] = kwargs.get('allow_control_chars') + self.base_client = BaseClient("network_validation", config, signer, data_connectivity_type_mapping, **base_client_init_kwargs) + self.retry_strategy = kwargs.get('retry_strategy') + self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') + + def get_network_connectivity_status_collection(self, registry_id, endpoint_key, **kwargs): + """ + This api is used to get Network Connectivity Status for all the Data Assets attatched to the provided Private endpoint. + + + :param str registry_id: (required) + The registry Ocid. + + :param str endpoint_key: (required) + The endpoint key. + + :param str opc_request_id: (optional) + Unique Oracle-assigned identifier for the request. If + you need to contact Oracle about a particular request, + please provide the request ID. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + + :param str page: (optional) + For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + Sets the maximum number of results per page, or items to return in a paginated `List` call. See `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str sort_by: (optional) + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). + + Allowed values are: "id", "timeCreated", "displayName" + + :param str sort_order: (optional) + Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). + + Allowed values are: "ASC", "DESC" + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.NetworkConnectivityStatusCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_network_connectivity_status_collection API. + """ + resource_path = "/registries/{registryId}/endpoints/{endpointKey}/networkConnectivityStatusCollection" + method = "GET" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token", + "page", + "limit", + "sort_by", + "sort_order" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_network_connectivity_status_collection got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "registryId": registry_id, + "endpointKey": endpoint_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["id", "timeCreated", "displayName"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + + query_params = { + "page": kwargs.get("page", missing), + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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, + query_params=query_params, + header_params=header_params, + response_type="NetworkConnectivityStatusCollection") + 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="NetworkConnectivityStatusCollection") diff --git a/src/oci/data_connectivity/network_validation_client_composite_operations.py b/src/oci/data_connectivity/network_validation_client_composite_operations.py new file mode 100644 index 0000000000..f502c7602f --- /dev/null +++ b/src/oci/data_connectivity/network_validation_client_composite_operations.py @@ -0,0 +1,24 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +import oci # noqa: F401 +from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401 + + +class NetworkValidationClientCompositeOperations(object): + """ + This class provides a wrapper around :py:class:`~oci.data_connectivity.NetworkValidationClient` and offers convenience methods + for operations that would otherwise need to be chained together. For example, instead of performing an action + on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource + to enter a given state, you can call a single method in this class to accomplish the same functionality + """ + + def __init__(self, client, **kwargs): + """ + Creates a new NetworkValidationClientCompositeOperations object + + :param NetworkValidationClient client: + The service client which will be wrapped by this object + """ + self.client = client diff --git a/src/oci/mysql/models/create_db_system_details.py b/src/oci/mysql/models/create_db_system_details.py index f4be4e35a7..685f5d7c8a 100644 --- a/src/oci/mysql/models/create_db_system_details.py +++ b/src/oci/mysql/models/create_db_system_details.py @@ -13,6 +13,14 @@ class CreateDbSystemDetails(object): Details required to create a DB System. """ + #: A constant which can be used with the crash_recovery property of a CreateDbSystemDetails. + #: This constant has a value of "ENABLED" + CRASH_RECOVERY_ENABLED = "ENABLED" + + #: A constant which can be used with the crash_recovery property of a CreateDbSystemDetails. + #: This constant has a value of "DISABLED" + CRASH_RECOVERY_DISABLED = "DISABLED" + def __init__(self, **kwargs): """ Initializes a new CreateDbSystemDetails object with values from keyword arguments. @@ -106,6 +114,11 @@ def __init__(self, **kwargs): The value to assign to the defined_tags property of this CreateDbSystemDetails. :type defined_tags: dict(str, dict(str, object)) + :param crash_recovery: + The value to assign to the crash_recovery property of this CreateDbSystemDetails. + Allowed values for this property are: "ENABLED", "DISABLED" + :type crash_recovery: str + """ self.swagger_types = { 'display_name': 'str', @@ -129,7 +142,8 @@ def __init__(self, **kwargs): 'source': 'CreateDbSystemSourceDetails', 'maintenance': 'CreateMaintenanceDetails', 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' + 'defined_tags': 'dict(str, dict(str, object))', + 'crash_recovery': 'str' } self.attribute_map = { @@ -154,7 +168,8 @@ def __init__(self, **kwargs): 'source': 'source', 'maintenance': 'maintenance', 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' + 'defined_tags': 'definedTags', + 'crash_recovery': 'crashRecovery' } self._display_name = None @@ -179,6 +194,7 @@ def __init__(self, **kwargs): self._maintenance = None self._freeform_tags = None self._defined_tags = None + self._crash_recovery = None @property def display_name(self): @@ -770,6 +786,40 @@ def defined_tags(self, defined_tags): """ self._defined_tags = defined_tags + @property + def crash_recovery(self): + """ + Gets the crash_recovery of this CreateDbSystemDetails. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The crash_recovery of this CreateDbSystemDetails. + :rtype: str + """ + return self._crash_recovery + + @crash_recovery.setter + def crash_recovery(self, crash_recovery): + """ + Sets the crash_recovery of this CreateDbSystemDetails. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + + :param crash_recovery: The crash_recovery of this CreateDbSystemDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(crash_recovery, allowed_values): + raise ValueError( + "Invalid value for `crash_recovery`, must be None or one of {0}" + .format(allowed_values) + ) + self._crash_recovery = crash_recovery + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/db_system.py b/src/oci/mysql/models/db_system.py index a48ab8089b..a7fa74e8f7 100644 --- a/src/oci/mysql/models/db_system.py +++ b/src/oci/mysql/models/db_system.py @@ -41,6 +41,14 @@ class DbSystem(object): #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" + #: A constant which can be used with the crash_recovery property of a DbSystem. + #: This constant has a value of "ENABLED" + CRASH_RECOVERY_ENABLED = "ENABLED" + + #: A constant which can be used with the crash_recovery property of a DbSystem. + #: This constant has a value of "DISABLED" + CRASH_RECOVERY_DISABLED = "DISABLED" + def __init__(self, **kwargs): """ Initializes a new DbSystem object with values from keyword arguments. @@ -176,6 +184,12 @@ def __init__(self, **kwargs): The value to assign to the defined_tags property of this DbSystem. :type defined_tags: dict(str, dict(str, object)) + :param crash_recovery: + The value to assign to the crash_recovery property of this DbSystem. + 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 crash_recovery: str + """ self.swagger_types = { 'id': 'str', @@ -209,7 +223,8 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' + 'defined_tags': 'dict(str, dict(str, object))', + 'crash_recovery': 'str' } self.attribute_map = { @@ -244,7 +259,8 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' + 'defined_tags': 'definedTags', + 'crash_recovery': 'crashRecovery' } self._id = None @@ -279,6 +295,7 @@ def __init__(self, **kwargs): self._time_updated = None self._freeform_tags = None self._defined_tags = None + self._crash_recovery = None @property def id(self): @@ -1082,6 +1099,38 @@ def defined_tags(self, defined_tags): """ self._defined_tags = defined_tags + @property + def crash_recovery(self): + """ + Gets the crash_recovery of this DbSystem. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + 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 crash_recovery of this DbSystem. + :rtype: str + """ + return self._crash_recovery + + @crash_recovery.setter + def crash_recovery(self, crash_recovery): + """ + Sets the crash_recovery of this DbSystem. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + + :param crash_recovery: The crash_recovery of this DbSystem. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(crash_recovery, allowed_values): + crash_recovery = 'UNKNOWN_ENUM_VALUE' + self._crash_recovery = crash_recovery + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/db_system_snapshot.py b/src/oci/mysql/models/db_system_snapshot.py index e494fa6d84..93e6edc1f7 100644 --- a/src/oci/mysql/models/db_system_snapshot.py +++ b/src/oci/mysql/models/db_system_snapshot.py @@ -13,6 +13,14 @@ class DbSystemSnapshot(object): Snapshot of the DbSystem details at the time of the backup """ + #: A constant which can be used with the crash_recovery property of a DbSystemSnapshot. + #: This constant has a value of "ENABLED" + CRASH_RECOVERY_ENABLED = "ENABLED" + + #: A constant which can be used with the crash_recovery property of a DbSystemSnapshot. + #: This constant has a value of "DISABLED" + CRASH_RECOVERY_DISABLED = "DISABLED" + def __init__(self, **kwargs): """ Initializes a new DbSystemSnapshot object with values from keyword arguments. @@ -106,6 +114,12 @@ def __init__(self, **kwargs): The value to assign to the defined_tags property of this DbSystemSnapshot. :type defined_tags: dict(str, dict(str, object)) + :param crash_recovery: + The value to assign to the crash_recovery property of this DbSystemSnapshot. + 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 crash_recovery: str + """ self.swagger_types = { 'id': 'str', @@ -129,7 +143,8 @@ def __init__(self, **kwargs): 'endpoints': 'list[DbSystemEndpoint]', 'maintenance': 'MaintenanceDetails', 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' + 'defined_tags': 'dict(str, dict(str, object))', + 'crash_recovery': 'str' } self.attribute_map = { @@ -154,7 +169,8 @@ def __init__(self, **kwargs): 'endpoints': 'endpoints', 'maintenance': 'maintenance', 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' + 'defined_tags': 'definedTags', + 'crash_recovery': 'crashRecovery' } self._id = None @@ -179,6 +195,7 @@ def __init__(self, **kwargs): self._maintenance = None self._freeform_tags = None self._defined_tags = None + self._crash_recovery = None @property def id(self): @@ -726,6 +743,38 @@ def defined_tags(self, defined_tags): """ self._defined_tags = defined_tags + @property + def crash_recovery(self): + """ + Gets the crash_recovery of this DbSystemSnapshot. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + 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 crash_recovery of this DbSystemSnapshot. + :rtype: str + """ + return self._crash_recovery + + @crash_recovery.setter + def crash_recovery(self, crash_recovery): + """ + Sets the crash_recovery of this DbSystemSnapshot. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + + :param crash_recovery: The crash_recovery of this DbSystemSnapshot. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(crash_recovery, allowed_values): + crash_recovery = 'UNKNOWN_ENUM_VALUE' + self._crash_recovery = crash_recovery + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/db_system_summary.py b/src/oci/mysql/models/db_system_summary.py index 26d5c8da17..c628765ffc 100644 --- a/src/oci/mysql/models/db_system_summary.py +++ b/src/oci/mysql/models/db_system_summary.py @@ -13,6 +13,14 @@ class DbSystemSummary(object): A summary of a DB System. """ + #: A constant which can be used with the crash_recovery property of a DbSystemSummary. + #: This constant has a value of "ENABLED" + CRASH_RECOVERY_ENABLED = "ENABLED" + + #: A constant which can be used with the crash_recovery property of a DbSystemSummary. + #: This constant has a value of "DISABLED" + CRASH_RECOVERY_DISABLED = "DISABLED" + def __init__(self, **kwargs): """ Initializes a new DbSystemSummary object with values from keyword arguments. @@ -94,6 +102,12 @@ def __init__(self, **kwargs): The value to assign to the defined_tags property of this DbSystemSummary. :type defined_tags: dict(str, dict(str, object)) + :param crash_recovery: + The value to assign to the crash_recovery property of this DbSystemSummary. + 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 crash_recovery: str + """ self.swagger_types = { 'id': 'str', @@ -114,7 +128,8 @@ def __init__(self, **kwargs): 'time_created': 'datetime', 'time_updated': 'datetime', 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' + 'defined_tags': 'dict(str, dict(str, object))', + 'crash_recovery': 'str' } self.attribute_map = { @@ -136,7 +151,8 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' + 'defined_tags': 'definedTags', + 'crash_recovery': 'crashRecovery' } self._id = None @@ -158,6 +174,7 @@ def __init__(self, **kwargs): self._time_updated = None self._freeform_tags = None self._defined_tags = None + self._crash_recovery = None @property def id(self): @@ -635,6 +652,38 @@ def defined_tags(self, defined_tags): """ self._defined_tags = defined_tags + @property + def crash_recovery(self): + """ + Gets the crash_recovery of this DbSystemSummary. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + 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 crash_recovery of this DbSystemSummary. + :rtype: str + """ + return self._crash_recovery + + @crash_recovery.setter + def crash_recovery(self, crash_recovery): + """ + Sets the crash_recovery of this DbSystemSummary. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + + :param crash_recovery: The crash_recovery of this DbSystemSummary. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(crash_recovery, allowed_values): + crash_recovery = 'UNKNOWN_ENUM_VALUE' + self._crash_recovery = crash_recovery + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/mysql/models/update_db_system_details.py b/src/oci/mysql/models/update_db_system_details.py index c21803e42b..d071b54fa6 100644 --- a/src/oci/mysql/models/update_db_system_details.py +++ b/src/oci/mysql/models/update_db_system_details.py @@ -13,6 +13,14 @@ class UpdateDbSystemDetails(object): Details required to update a DB System. """ + #: A constant which can be used with the crash_recovery property of a UpdateDbSystemDetails. + #: This constant has a value of "ENABLED" + CRASH_RECOVERY_ENABLED = "ENABLED" + + #: A constant which can be used with the crash_recovery property of a UpdateDbSystemDetails. + #: This constant has a value of "DISABLED" + CRASH_RECOVERY_DISABLED = "DISABLED" + def __init__(self, **kwargs): """ Initializes a new UpdateDbSystemDetails object with values from keyword arguments. @@ -98,6 +106,11 @@ def __init__(self, **kwargs): The value to assign to the defined_tags property of this UpdateDbSystemDetails. :type defined_tags: dict(str, dict(str, object)) + :param crash_recovery: + The value to assign to the crash_recovery property of this UpdateDbSystemDetails. + Allowed values for this property are: "ENABLED", "DISABLED" + :type crash_recovery: str + """ self.swagger_types = { 'display_name': 'str', @@ -119,7 +132,8 @@ def __init__(self, **kwargs): 'backup_policy': 'UpdateBackupPolicyDetails', 'maintenance': 'UpdateMaintenanceDetails', 'freeform_tags': 'dict(str, str)', - 'defined_tags': 'dict(str, dict(str, object))' + 'defined_tags': 'dict(str, dict(str, object))', + 'crash_recovery': 'str' } self.attribute_map = { @@ -142,7 +156,8 @@ def __init__(self, **kwargs): 'backup_policy': 'backupPolicy', 'maintenance': 'maintenance', 'freeform_tags': 'freeformTags', - 'defined_tags': 'definedTags' + 'defined_tags': 'definedTags', + 'crash_recovery': 'crashRecovery' } self._display_name = None @@ -165,6 +180,7 @@ def __init__(self, **kwargs): self._maintenance = None self._freeform_tags = None self._defined_tags = None + self._crash_recovery = None @property def display_name(self): @@ -710,6 +726,40 @@ def defined_tags(self, defined_tags): """ self._defined_tags = defined_tags + @property + def crash_recovery(self): + """ + Gets the crash_recovery of this UpdateDbSystemDetails. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + Allowed values for this property are: "ENABLED", "DISABLED" + + + :return: The crash_recovery of this UpdateDbSystemDetails. + :rtype: str + """ + return self._crash_recovery + + @crash_recovery.setter + def crash_recovery(self, crash_recovery): + """ + Sets the crash_recovery of this UpdateDbSystemDetails. + Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, + and whether to enable or disable syncing of the Binary Logs. + + + :param crash_recovery: The crash_recovery of this UpdateDbSystemDetails. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if not value_allowed_none_or_none_sentinel(crash_recovery, allowed_values): + raise ValueError( + "Invalid value for `crash_recovery`, must be None or one of {0}" + .format(allowed_values) + ) + self._crash_recovery = crash_recovery + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/version.py b/src/oci/version.py index ee11765e7b..2e7153f9fc 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -__version__ = "2.57.0" +__version__ = "2.58.0"