diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8f74364d04..9b0d89829a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,27 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.81.0 - 2022-09-06 +==================== + +Added +----- +* Support for generic REST, OCI Streaming service, and Lake House connectors in the Data Connectivity Management service +* Support for connecting to the Data Catalog service in the Data Connectivity Management service +* Support for Kerberos and SSL for HDFS operations in the Data Connectivity Management service +* Support for excel-formatted data and default columns in the Data Connectivity Management service +* Support for reporting connector usage in the Data Connectivity Management service +* Support for preferred credentials for performing privileged operations in the Database Management service +* Support for passing a content encoding when posting metrics in the Monitoring service + +Breaking +-------- +* Support for retries by default on some operations of the Data Connectivity Management service +* Model `ConnectionValidationSummaryCollection` removed from the Data Connectivity Management service +* Operations `delete_connection_validation` and `list_connection_validations` removed from the `DataConnectivityManagementClient` of the Data Connectivity Management service +* Parameter `resource_id` renamed to `registry_id` in `list_work_requests` operation from the `DataConnectivityManagementClient` of the Data Connectivity Management service + ==================== 2.80.1 - 2022-08-30 ==================== diff --git a/docs/api/data_connectivity.rst b/docs/api/data_connectivity.rst index 1b08911ece..26b5af69d8 100644 --- a/docs/api/data_connectivity.rst +++ b/docs/api/data_connectivity.rst @@ -23,6 +23,7 @@ Data Connectivity oci.data_connectivity.models.AbstractCallAttribute oci.data_connectivity.models.AbstractDataOperationConfig oci.data_connectivity.models.AbstractFormatAttribute + oci.data_connectivity.models.AbstractOperationAttributes oci.data_connectivity.models.AbstractReadAttribute oci.data_connectivity.models.AbstractWriteAttribute oci.data_connectivity.models.AggregatorSummary @@ -40,6 +41,7 @@ Data Connectivity oci.data_connectivity.models.CompositeType oci.data_connectivity.models.Compression oci.data_connectivity.models.ConfigDefinition + oci.data_connectivity.models.ConfigDetails oci.data_connectivity.models.ConfigParameterDefinition oci.data_connectivity.models.ConfigParameterValue oci.data_connectivity.models.ConfigValues @@ -50,7 +52,8 @@ Data Connectivity oci.data_connectivity.models.ConnectionSummaryCollection oci.data_connectivity.models.ConnectionValidation oci.data_connectivity.models.ConnectionValidationSummary - oci.data_connectivity.models.ConnectionValidationSummaryCollection + oci.data_connectivity.models.ConnectivityUsage + oci.data_connectivity.models.ConnectivityUsageDetails oci.data_connectivity.models.ConnectivityValidation oci.data_connectivity.models.ConnectorAttribute oci.data_connectivity.models.CreateAttachDataAssetDetails @@ -69,6 +72,7 @@ Data Connectivity oci.data_connectivity.models.CreateEntityShapeDetails oci.data_connectivity.models.CreateEntityShapeFromDataStore oci.data_connectivity.models.CreateEntityShapeFromFile + oci.data_connectivity.models.CreateEntityShapeFromMessage oci.data_connectivity.models.CreateEntityShapeFromSQL oci.data_connectivity.models.CreateEntityShapeFromTable oci.data_connectivity.models.CreateEntityShapeFromView @@ -88,6 +92,7 @@ Data Connectivity oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails oci.data_connectivity.models.DataEntityFromFile oci.data_connectivity.models.DataEntityFromFileEntityDetails + oci.data_connectivity.models.DataEntityFromMessageEntityDetails oci.data_connectivity.models.DataEntityFromSql oci.data_connectivity.models.DataEntityFromSqlEntityDetails oci.data_connectivity.models.DataEntityFromTable @@ -108,6 +113,10 @@ Data Connectivity oci.data_connectivity.models.DataTypeStat oci.data_connectivity.models.DateAttribute oci.data_connectivity.models.DeReferenceInfo + oci.data_connectivity.models.DeriveEntities + oci.data_connectivity.models.DeriveEntitiesDetails + oci.data_connectivity.models.DeriveEntitiesItem + oci.data_connectivity.models.DerivedEntity oci.data_connectivity.models.DerivedType oci.data_connectivity.models.DetachDataAssetInfo oci.data_connectivity.models.DpEndpoint @@ -126,10 +135,12 @@ Data Connectivity oci.data_connectivity.models.EntityShape oci.data_connectivity.models.EntityShapeFromDataStore oci.data_connectivity.models.EntityShapeFromFile + oci.data_connectivity.models.EntityShapeFromMessage oci.data_connectivity.models.EntityShapeFromSQL oci.data_connectivity.models.EntityShapeFromTable oci.data_connectivity.models.EntityShapeFromView oci.data_connectivity.models.ErrorDetails + oci.data_connectivity.models.ExcelFormatAttribute oci.data_connectivity.models.ExecuteOperationJob oci.data_connectivity.models.ExecuteOperationJobDetails oci.data_connectivity.models.ExternalStorage @@ -139,6 +150,8 @@ Data Connectivity oci.data_connectivity.models.FolderSummaryCollection oci.data_connectivity.models.ForeignKey oci.data_connectivity.models.FullPushDownTaskResponse + oci.data_connectivity.models.GenericRestApiAttributes + oci.data_connectivity.models.GenericRestCallAttribute oci.data_connectivity.models.HdfsWriteAttributes oci.data_connectivity.models.Histogram oci.data_connectivity.models.InputPort @@ -158,10 +171,12 @@ Data Connectivity oci.data_connectivity.models.ObjectStorageWriteAttributes oci.data_connectivity.models.Operation oci.data_connectivity.models.OperationExecResult + oci.data_connectivity.models.OperationFromApi oci.data_connectivity.models.OperationFromProcedure oci.data_connectivity.models.OperationInputRecord oci.data_connectivity.models.OperationSummary oci.data_connectivity.models.OperationSummaryCollection + oci.data_connectivity.models.OperationSummaryFromApi oci.data_connectivity.models.OperationSummaryFromProcedure oci.data_connectivity.models.OracleAdwcWriteAttributes oci.data_connectivity.models.OracleAtpWriteAttributes @@ -183,6 +198,9 @@ Data Connectivity oci.data_connectivity.models.ReferenceArtifactSummary oci.data_connectivity.models.ReferenceArtifactSummaryCollection oci.data_connectivity.models.ReferenceInfo + oci.data_connectivity.models.ReferencedDataObject + oci.data_connectivity.models.ReferencedDataObjectFromAPI + oci.data_connectivity.models.ReferencedDataObjectFromProcedure oci.data_connectivity.models.Registry oci.data_connectivity.models.RegistryMetadata oci.data_connectivity.models.RegistrySummary diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractOperationAttributes.rst similarity index 55% rename from docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst rename to docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractOperationAttributes.rst index 5cdbd37dab..7fdf5a2271 100644 --- a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectionValidationSummaryCollection.rst +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.AbstractOperationAttributes.rst @@ -1,9 +1,9 @@ -ConnectionValidationSummaryCollection -===================================== +AbstractOperationAttributes +=========================== .. currentmodule:: oci.data_connectivity.models -.. autoclass:: ConnectionValidationSummaryCollection +.. autoclass:: AbstractOperationAttributes :show-inheritance: :special-members: __init__ :members: diff --git a/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDetails.rst new file mode 100644 index 0000000000..a74b3a189d --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConfigDetails.rst @@ -0,0 +1,11 @@ +ConfigDetails +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConfigDetails + :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.ConnectivityUsage.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityUsage.rst new file mode 100644 index 0000000000..6332e87f91 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityUsage.rst @@ -0,0 +1,11 @@ +ConnectivityUsage +================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectivityUsage + :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.ConnectivityUsageDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityUsageDetails.rst new file mode 100644 index 0000000000..4333f10413 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ConnectivityUsageDetails.rst @@ -0,0 +1,11 @@ +ConnectivityUsageDetails +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ConnectivityUsageDetails + :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.CreateEntityShapeFromMessage.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromMessage.rst new file mode 100644 index 0000000000..02dc153a9a --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.CreateEntityShapeFromMessage.rst @@ -0,0 +1,11 @@ +CreateEntityShapeFromMessage +============================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: CreateEntityShapeFromMessage + :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.DataEntityFromMessageEntityDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromMessageEntityDetails.rst new file mode 100644 index 0000000000..36e3d66d08 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DataEntityFromMessageEntityDetails.rst @@ -0,0 +1,11 @@ +DataEntityFromMessageEntityDetails +================================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DataEntityFromMessageEntityDetails + :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.DeriveEntities.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntities.rst new file mode 100644 index 0000000000..eef8e14bf1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntities.rst @@ -0,0 +1,11 @@ +DeriveEntities +============== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DeriveEntities + :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.DeriveEntitiesDetails.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntitiesDetails.rst new file mode 100644 index 0000000000..97820b28b1 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntitiesDetails.rst @@ -0,0 +1,11 @@ +DeriveEntitiesDetails +===================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DeriveEntitiesDetails + :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.DeriveEntitiesItem.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntitiesItem.rst new file mode 100644 index 0000000000..c8de412a87 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DeriveEntitiesItem.rst @@ -0,0 +1,11 @@ +DeriveEntitiesItem +================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DeriveEntitiesItem + :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.DerivedEntity.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.DerivedEntity.rst new file mode 100644 index 0000000000..43e7c0eac5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.DerivedEntity.rst @@ -0,0 +1,11 @@ +DerivedEntity +============= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: DerivedEntity + :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.EntityShapeFromMessage.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromMessage.rst new file mode 100644 index 0000000000..e77c7e0c15 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.EntityShapeFromMessage.rst @@ -0,0 +1,11 @@ +EntityShapeFromMessage +====================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: EntityShapeFromMessage + :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.ExcelFormatAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExcelFormatAttribute.rst new file mode 100644 index 0000000000..151f80bd62 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ExcelFormatAttribute.rst @@ -0,0 +1,11 @@ +ExcelFormatAttribute +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ExcelFormatAttribute + :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.GenericRestApiAttributes.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.GenericRestApiAttributes.rst new file mode 100644 index 0000000000..35707576a0 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.GenericRestApiAttributes.rst @@ -0,0 +1,11 @@ +GenericRestApiAttributes +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: GenericRestApiAttributes + :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.GenericRestCallAttribute.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.GenericRestCallAttribute.rst new file mode 100644 index 0000000000..2a0001b43a --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.GenericRestCallAttribute.rst @@ -0,0 +1,11 @@ +GenericRestCallAttribute +======================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: GenericRestCallAttribute + :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.OperationFromApi.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationFromApi.rst new file mode 100644 index 0000000000..31e98043bc --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationFromApi.rst @@ -0,0 +1,11 @@ +OperationFromApi +================ + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationFromApi + :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.OperationSummaryFromApi.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryFromApi.rst new file mode 100644 index 0000000000..1a504a86e5 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.OperationSummaryFromApi.rst @@ -0,0 +1,11 @@ +OperationSummaryFromApi +======================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: OperationSummaryFromApi + :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.ReferencedDataObject.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObject.rst new file mode 100644 index 0000000000..f09ac86423 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObject.rst @@ -0,0 +1,11 @@ +ReferencedDataObject +==================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferencedDataObject + :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.ReferencedDataObjectFromAPI.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObjectFromAPI.rst new file mode 100644 index 0000000000..c244a161d2 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObjectFromAPI.rst @@ -0,0 +1,11 @@ +ReferencedDataObjectFromAPI +=========================== + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferencedDataObjectFromAPI + :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.ReferencedDataObjectFromProcedure.rst b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObjectFromProcedure.rst new file mode 100644 index 0000000000..e3e2c68dd8 --- /dev/null +++ b/docs/api/data_connectivity/models/oci.data_connectivity.models.ReferencedDataObjectFromProcedure.rst @@ -0,0 +1,11 @@ +ReferencedDataObjectFromProcedure +================================= + +.. currentmodule:: oci.data_connectivity.models + +.. autoclass:: ReferencedDataObjectFromProcedure + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management.rst b/docs/api/database_management.rst index 96a3b8b5c7..3689b9b0b2 100644 --- a/docs/api/database_management.rst +++ b/docs/api/database_management.rst @@ -67,6 +67,7 @@ Database Management oci.database_management.models.AwrDbWaitEventCollection oci.database_management.models.AwrDbWaitEventSummary oci.database_management.models.AwrQueryResult + oci.database_management.models.BasicPreferredCredential oci.database_management.models.ChangeDatabaseParameterDetails oci.database_management.models.ChangeDatabaseParametersDetails oci.database_management.models.ChangeDbManagementPrivateEndpointCompartmentDetails @@ -161,6 +162,9 @@ Database Management oci.database_management.models.ParentGroup oci.database_management.models.PdbMetrics oci.database_management.models.PdbStatusDetails + oci.database_management.models.PreferredCredential + oci.database_management.models.PreferredCredentialCollection + oci.database_management.models.PreferredCredentialSummary oci.database_management.models.ProxiedForUserCollection oci.database_management.models.ProxiedForUserSummary oci.database_management.models.ProxyUserCollection @@ -219,12 +223,17 @@ Database Management oci.database_management.models.TablespaceCollection oci.database_management.models.TablespaceStorageSize oci.database_management.models.TablespaceSummary + oci.database_management.models.TestBasicPreferredCredentialDetails + oci.database_management.models.TestPreferredCredentialDetails + oci.database_management.models.TestPreferredCredentialStatus oci.database_management.models.TimeSeriesMetricDataPoint oci.database_management.models.TimeSeriesMetricDefinition + oci.database_management.models.UpdateBasicPreferredCredentialDetails oci.database_management.models.UpdateDatabaseParametersResult oci.database_management.models.UpdateDbManagementPrivateEndpointDetails oci.database_management.models.UpdateJobDetails oci.database_management.models.UpdateManagedDatabaseGroupDetails + oci.database_management.models.UpdatePreferredCredentialDetails oci.database_management.models.UpdateSqlJobDetails oci.database_management.models.UpdateTablespaceDetails oci.database_management.models.User diff --git a/docs/api/database_management/models/oci.database_management.models.BasicPreferredCredential.rst b/docs/api/database_management/models/oci.database_management.models.BasicPreferredCredential.rst new file mode 100644 index 0000000000..7c303ef36c --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.BasicPreferredCredential.rst @@ -0,0 +1,11 @@ +BasicPreferredCredential +======================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: BasicPreferredCredential + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.PreferredCredential.rst b/docs/api/database_management/models/oci.database_management.models.PreferredCredential.rst new file mode 100644 index 0000000000..8daac89218 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.PreferredCredential.rst @@ -0,0 +1,11 @@ +PreferredCredential +=================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: PreferredCredential + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.PreferredCredentialCollection.rst b/docs/api/database_management/models/oci.database_management.models.PreferredCredentialCollection.rst new file mode 100644 index 0000000000..870102c405 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.PreferredCredentialCollection.rst @@ -0,0 +1,11 @@ +PreferredCredentialCollection +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: PreferredCredentialCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.PreferredCredentialSummary.rst b/docs/api/database_management/models/oci.database_management.models.PreferredCredentialSummary.rst new file mode 100644 index 0000000000..5916614c98 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.PreferredCredentialSummary.rst @@ -0,0 +1,11 @@ +PreferredCredentialSummary +========================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: PreferredCredentialSummary + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.TestBasicPreferredCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.TestBasicPreferredCredentialDetails.rst new file mode 100644 index 0000000000..485857fd5b --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.TestBasicPreferredCredentialDetails.rst @@ -0,0 +1,11 @@ +TestBasicPreferredCredentialDetails +=================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: TestBasicPreferredCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialDetails.rst new file mode 100644 index 0000000000..0cac606221 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialDetails.rst @@ -0,0 +1,11 @@ +TestPreferredCredentialDetails +============================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: TestPreferredCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialStatus.rst b/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialStatus.rst new file mode 100644 index 0000000000..38d1967548 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.TestPreferredCredentialStatus.rst @@ -0,0 +1,11 @@ +TestPreferredCredentialStatus +============================= + +.. currentmodule:: oci.database_management.models + +.. autoclass:: TestPreferredCredentialStatus + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.UpdateBasicPreferredCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.UpdateBasicPreferredCredentialDetails.rst new file mode 100644 index 0000000000..797b7602d6 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.UpdateBasicPreferredCredentialDetails.rst @@ -0,0 +1,11 @@ +UpdateBasicPreferredCredentialDetails +===================================== + +.. currentmodule:: oci.database_management.models + +.. autoclass:: UpdateBasicPreferredCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/database_management/models/oci.database_management.models.UpdatePreferredCredentialDetails.rst b/docs/api/database_management/models/oci.database_management.models.UpdatePreferredCredentialDetails.rst new file mode 100644 index 0000000000..fd8e303155 --- /dev/null +++ b/docs/api/database_management/models/oci.database_management.models.UpdatePreferredCredentialDetails.rst @@ -0,0 +1,11 @@ +UpdatePreferredCredentialDetails +================================ + +.. currentmodule:: oci.database_management.models + +.. autoclass:: UpdatePreferredCredentialDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/monitoring.rst b/docs/api/monitoring.rst index d29ebd95b4..fca82e9d5a 100644 --- a/docs/api/monitoring.rst +++ b/docs/api/monitoring.rst @@ -20,6 +20,8 @@ Monitoring oci.monitoring.models.AggregatedDatapoint oci.monitoring.models.Alarm + oci.monitoring.models.AlarmDimensionStatesCollection + oci.monitoring.models.AlarmDimensionStatesEntry oci.monitoring.models.AlarmHistoryCollection oci.monitoring.models.AlarmHistoryEntry oci.monitoring.models.AlarmStatusSummary @@ -34,6 +36,7 @@ Monitoring oci.monitoring.models.MetricDataDetails oci.monitoring.models.PostMetricDataDetails oci.monitoring.models.PostMetricDataResponseDetails + oci.monitoring.models.RetrieveDimensionStatesDetails oci.monitoring.models.SummarizeMetricsDataDetails oci.monitoring.models.Suppression oci.monitoring.models.UpdateAlarmDetails diff --git a/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesCollection.rst b/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesCollection.rst new file mode 100644 index 0000000000..7f3c7ed289 --- /dev/null +++ b/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesCollection.rst @@ -0,0 +1,11 @@ +AlarmDimensionStatesCollection +============================== + +.. currentmodule:: oci.monitoring.models + +.. autoclass:: AlarmDimensionStatesCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesEntry.rst b/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesEntry.rst new file mode 100644 index 0000000000..e63187e036 --- /dev/null +++ b/docs/api/monitoring/models/oci.monitoring.models.AlarmDimensionStatesEntry.rst @@ -0,0 +1,11 @@ +AlarmDimensionStatesEntry +========================= + +.. currentmodule:: oci.monitoring.models + +.. autoclass:: AlarmDimensionStatesEntry + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/monitoring/models/oci.monitoring.models.RetrieveDimensionStatesDetails.rst b/docs/api/monitoring/models/oci.monitoring.models.RetrieveDimensionStatesDetails.rst new file mode 100644 index 0000000000..d9e277b0f8 --- /dev/null +++ b/docs/api/monitoring/models/oci.monitoring.models.RetrieveDimensionStatesDetails.rst @@ -0,0 +1,11 @@ +RetrieveDimensionStatesDetails +============================== + +.. currentmodule:: oci.monitoring.models + +.. autoclass:: RetrieveDimensionStatesDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/src/oci/data_connectivity/data_connectivity_management_client.py b/src/oci/data_connectivity/data_connectivity_management_client.py index 55a8b8e5bd..3652dc6ddd 100644 --- a/src/oci/data_connectivity/data_connectivity_management_client.py +++ b/src/oci/data_connectivity/data_connectivity_management_client.py @@ -18,7 +18,7 @@ class DataConnectivityManagementClient(object): """ - Use the DCMS APIs to perform Metadata/Data operations. + Use the Data Connectivity Management Service APIs to perform common extract, load, and transform (ETL) tasks. """ def __init__(self, config, **kwargs): @@ -106,17 +106,17 @@ def __init__(self, config, **kwargs): def change_endpoint_compartment(self, endpoint_id, change_endpoint_compartment_details, **kwargs): """ - The Endpoint will be moved to the desired compartment. + The endpoint will be moved to the specified compartment. :param str endpoint_id: (required) - DCMS Endpoint id + DCMS endpoint ID. :param oci.data_connectivity.models.ChangeEndpointCompartmentDetails change_endpoint_compartment_details: (required) - The details of change compartment action. + The details of the change compartment action. :param str registry_id: (optional) - DCMS registry id + 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. @@ -129,7 +129,7 @@ def change_endpoint_compartment(self, endpoint_id, change_endpoint_compartment_d 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -227,14 +227,14 @@ def change_endpoint_compartment(self, endpoint_id, change_endpoint_compartment_d def change_registry_compartment(self, registry_id, change_registry_compartment_details, **kwargs): """ - The registry will be moved to the desired compartment. + The registry will be moved to the specified compartment. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.ChangeRegistryCompartmentDetails change_registry_compartment_details: (required) - The details of change compartment action. + The details of the 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. @@ -247,7 +247,7 @@ def change_registry_compartment(self, registry_id, change_registry_compartment_d 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -337,17 +337,17 @@ def change_registry_compartment(self, registry_id, change_registry_compartment_d def create_attach_data_asset(self, registry_id, endpoint_id, create_attach_data_asset_details, **kwargs): """ - Attaches list of DataAssets to the given endpoint + Attaches a list of data assets to the given endpoint. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str endpoint_id: (required) - DCMS Endpoint id + 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 + Request body parameters to attach data asset to a private endpoint. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -355,7 +355,7 @@ def create_attach_data_asset(self, registry_id, endpoint_id, create_attach_data_ 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -457,10 +457,10 @@ def create_connection(self, registry_id, create_connection_details, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateConnectionDetails create_connection_details: (required) - The information needed to create a connection. + The information required to create a connection. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -468,12 +468,12 @@ def create_connection(self, registry_id, create_connection_details, **kwargs): 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -527,6 +527,8 @@ def create_connection(self, registry_id, create_connection_details, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -562,10 +564,10 @@ def create_connection_validation(self, registry_id, create_connection_validation :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateConnectionValidationDetails create_connection_validation_details: (required) - The information needed to validate a connection. + The information required to validate a connection. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -573,15 +575,15 @@ def create_connection_validation(self, registry_id, create_connection_validation 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -641,6 +643,8 @@ def create_connection_validation(self, registry_id, create_connection_validation 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): @@ -678,10 +682,10 @@ def create_connectivity_validation(self, registry_id, create_connectivity_valida :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateConnectivityValidationDetails create_connectivity_validation_details: (required) - Request body parameters to trigger connectivity validations + Request body parameters to trigger connectivity validations. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -689,15 +693,15 @@ def create_connectivity_validation(self, registry_id, create_connectivity_valida 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -757,6 +761,8 @@ def create_connectivity_validation(self, registry_id, create_connectivity_valida 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): @@ -794,10 +800,10 @@ def create_data_asset(self, registry_id, create_data_asset_details, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateDataAssetDetails create_data_asset_details: (required) - The information needed to create a data asset. + The information required to create a data asset. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -805,12 +811,12 @@ def create_data_asset(self, registry_id, create_data_asset_details, **kwargs): 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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 +870,8 @@ def create_data_asset(self, registry_id, create_data_asset_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): @@ -895,14 +903,14 @@ def create_data_asset(self, registry_id, create_data_asset_details, **kwargs): def create_data_preview(self, registry_id, create_data_preview_details, **kwargs): """ - Provide data preview on live schema + Provide data preview on live schema. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateDataPreviewDetails create_data_preview_details: (required) - Request body parameters to provide data preview + Request body parameters to provide data preview. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -910,7 +918,7 @@ def create_data_preview(self, registry_id, create_data_preview_details, **kwargs 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -918,12 +926,12 @@ def create_data_preview(self, registry_id, create_data_preview_details, **kwargs 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. + 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. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -985,6 +993,8 @@ def create_data_preview(self, registry_id, create_data_preview_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): @@ -1018,14 +1028,14 @@ def create_data_preview(self, registry_id, create_data_preview_details, **kwargs def create_data_profile(self, registry_id, create_data_profile_details, **kwargs): """ - Execute data profiling on live schema + Execute data profiling on live schema. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateDataProfileDetails create_data_profile_details: (required) - Request body parameters to execute data profiling + Request body parameters to execute data profiling. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1033,7 +1043,7 @@ def create_data_profile(self, registry_id, create_data_profile_details, **kwargs 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1041,12 +1051,12 @@ def create_data_profile(self, registry_id, create_data_profile_details, **kwargs 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. + 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. + 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`. @@ -1108,6 +1118,8 @@ def create_data_profile(self, registry_id, create_data_profile_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): @@ -1141,17 +1153,17 @@ def create_data_profile(self, registry_id, create_data_profile_details, **kwargs def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_reference_artifact_details, **kwargs): """ - DeRereferenced a dcms artifact. + Dereferenced a dcms artifact. :param str registry_id: (required) - The registry Ocid. + 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. + The information required to delete a dcms artifact reference. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1159,7 +1171,7 @@ def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_ 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1169,7 +1181,7 @@ def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_ :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -1226,6 +1238,8 @@ def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_ 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): @@ -1257,17 +1271,17 @@ def create_de_reference_artifact(self, registry_id, dcms_artifact_id, create_de_ def create_detach_data_asset(self, registry_id, endpoint_id, create_detach_data_asset_details, **kwargs): """ - Detaches list of DataAssets to the given endpoint + Detaches a list of data assets to the given endpoint. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str endpoint_id: (required) - DCMS Endpoint id + 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 + Request body parameters to detach data asset to a private endpoint. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1275,7 +1289,7 @@ def create_detach_data_asset(self, registry_id, endpoint_id, create_detach_data_ 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1373,17 +1387,17 @@ def create_detach_data_asset(self, registry_id, endpoint_id, create_detach_data_ def create_endpoint(self, create_endpoint_details, **kwargs): """ - Creates a new Data Connectivity Management Endpoint ready for performing data Connectivity. + Creates a new Data Connectivity Management endpoint ready to perform 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 + Details of the new Data Connectivity Management endpoint. :param str opc_retry_token: (optional) - A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. + + :param str registry_id: (optional) + DCMS registry ID :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1417,8 +1431,8 @@ def create_endpoint(self, create_endpoint_details, **kwargs): expected_kwargs = [ "allow_control_chars", "retry_strategy", - "registry_id", "opc_retry_token", + "registry_id", "opc_request_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -1476,7 +1490,7 @@ def create_entity_shape(self, registry_id, connection_key, schema_resource_name, :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -1485,7 +1499,7 @@ def create_entity_shape(self, registry_id, connection_key, schema_resource_name, 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. + The details required to create the data entity shape. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1493,7 +1507,7 @@ def create_entity_shape(self, registry_id, connection_key, schema_resource_name, 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1506,12 +1520,12 @@ def create_entity_shape(self, registry_id, connection_key, schema_resource_name, Allowed values are: "OBO", "USER_PRINCIPAL", "RESOURCE_PRINCIPAL", "INSTANCE_PRINCIPAL", "UNDEFINED" :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -1584,6 +1598,8 @@ def create_entity_shape(self, registry_id, connection_key, schema_resource_name, 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): @@ -1621,7 +1637,7 @@ def create_execute_operation_job(self, registry_id, connection_key, schema_resou :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -1638,10 +1654,10 @@ def create_execute_operation_job(self, registry_id, connection_key, schema_resou please provide the request ID. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1741,14 +1757,14 @@ def create_execute_operation_job(self, registry_id, connection_key, schema_resou def create_folder(self, registry_id, create_folder_details, **kwargs): """ - Creates a folder under a specefied registry. + Creates a folder under a specified registry. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateFolderDetails create_folder_details: (required) - The information needed to create a folder. + The information required to create a folder. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1756,12 +1772,12 @@ def create_folder(self, registry_id, create_folder_details, **kwargs): 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -1815,6 +1831,8 @@ def create_folder(self, registry_id, create_folder_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): @@ -1846,14 +1864,14 @@ def create_folder(self, registry_id, create_folder_details, **kwargs): 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). + This endpoint is used to create a connectivity task (such as PushdownTask). :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateFullPushDownTaskDetails create_full_push_down_task_details: (required) - Request body parameter for full pushdown task + Request body parameter for full pushdown task. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1861,7 +1879,7 @@ def create_full_push_down_task(self, registry_id, create_full_push_down_task_det 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1869,12 +1887,12 @@ def create_full_push_down_task(self, registry_id, create_full_push_down_task_det 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. + 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. + 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`. @@ -1936,6 +1954,8 @@ def create_full_push_down_task(self, registry_id, create_full_push_down_task_det 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): @@ -1973,13 +1993,13 @@ def create_reference_artifact(self, registry_id, dcms_artifact_id, create_refere :param str registry_id: (required) - The registry Ocid. + 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 + The information required to reference a dcms artifact. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -1987,7 +2007,7 @@ def create_reference_artifact(self, registry_id, dcms_artifact_id, create_refere 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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. @@ -1997,7 +2017,7 @@ def create_reference_artifact(self, registry_id, dcms_artifact_id, create_refere :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -2054,6 +2074,8 @@ def create_reference_artifact(self, registry_id, dcms_artifact_id, create_refere 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): @@ -2085,14 +2107,14 @@ def create_reference_artifact(self, registry_id, dcms_artifact_id, create_refere def create_registry(self, create_registry_details, **kwargs): """ - Creates a new Data Connectivity Management Registry ready for performing data Connectivity Management. + Creates a new Data Connectivity Management registry ready to perform 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -2173,14 +2195,14 @@ def create_registry(self, create_registry_details, **kwargs): 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 + Execute network validation on the selected data assets associated with the provided private endpoint. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.CreateTestNetworkConnectivityDetails create_test_network_connectivity_details: (required) - Request body parameters to execute network validation + Request body parameters to execute network validation. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -2188,10 +2210,10 @@ def create_test_network_connectivity(self, registry_id, create_test_network_conn 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. @@ -2300,7 +2322,7 @@ def delete_connection(self, registry_id, connection_key, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -2397,127 +2419,13 @@ def delete_connection(self, registry_id, connection_key, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) - 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" - operation_name = "delete_connection_validation" - api_reference_link = "" - - # 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, - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link) - def delete_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. + The registry OCID. :param str data_asset_key: (required) The data asset key. @@ -2616,14 +2524,14 @@ def delete_data_asset(self, registry_id, data_asset_key, **kwargs): def delete_endpoint(self, endpoint_id, **kwargs): """ - Deletes a Data Connectivity Management Endpoint resource by identifier + Deletes a Data Connectivity Management endpoint resource by its identifier. :param str endpoint_id: (required) - DCMS Endpoint id + DCMS endpoint ID. :param str registry_id: (optional) - DCMS registry id + DCMS registry ID :param bool is_force_operation: (optional) Try to delete forcefully after drain timeout. @@ -2735,7 +2643,7 @@ def delete_folder(self, registry_id, folder_key, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str folder_key: (required) The folder ID. @@ -2838,7 +2746,7 @@ def delete_network_connectivity_status(self, registry_id, network_validation_sta :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str network_validation_status_key: (required) NetworkValidationStatus key. @@ -2937,11 +2845,11 @@ def delete_network_connectivity_status(self, registry_id, network_validation_sta def delete_registry(self, registry_id, **kwargs): """ - Deletes a Data Connectivity Management Registry resource by identifier + Deletes a Data Connectivity Management registry resource by its identifier. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param bool is_force_operation: (optional) Try to delete forcefully after drain timeout. @@ -3045,22 +2953,25 @@ def delete_registry(self, registry_id, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) - def get_connection(self, registry_id, connection_key, **kwargs): + def derive_entities(self, registry_id, derive_entities_details, **kwargs): """ - Retrieves the connection details using the specified identifier. + Get the Derived Entities from the EntityFlowMode and reference key of DataObject :param str registry_id: (required) - The registry Ocid. + The registry OCID. - :param str connection_key: (required) - The connection key. + :param oci.data_connectivity.models.DeriveEntitiesDetails derive_entities_details: (required) + The details needed to create the derived entities. :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 the 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. @@ -3073,31 +2984,31 @@ def get_connection(self, registry_id, connection_key, **kwargs): allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.Connection` + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.DeriveEntities` :rtype: :class:`~oci.response.Response` :example: - Click `here `__ to see an example of how to use get_connection API. + Click `here `__ to see an example of how to use derive_entities API. """ - resource_path = "/registries/{registryId}/connections/{connectionKey}" - method = "GET" - operation_name = "get_connection" + resource_path = "/registries/{registryId}/actions/deriveEntities" + method = "POST" + operation_name = "derive_entities" api_reference_link = "" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "opc_retry_token" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( - "get_connection got unknown kwargs: {!r}".format(extra_kwargs)) + "derive_entities got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { - "registryId": registry_id, - "connectionKey": connection_key + "registryId": registry_id } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3109,7 +3020,8 @@ def get_connection(self, registry_id, connection_key, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "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} @@ -3120,6 +3032,7 @@ def get_connection(self, registry_id, connection_key, **kwargs): if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) self.base_client.add_opc_client_retries_header(header_params) retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) return retry_strategy.make_retrying_call( @@ -3128,7 +3041,8 @@ def get_connection(self, registry_id, connection_key, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="Connection", + body=derive_entities_details, + response_type="DeriveEntities", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link) @@ -3138,34 +3052,32 @@ def get_connection(self, registry_id, connection_key, **kwargs): method=method, path_params=path_params, header_params=header_params, - response_type="Connection", + body=derive_entities_details, + response_type="DeriveEntities", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link) - def get_connection_validation(self, registry_id, connection_validation_key, **kwargs): + def get_connection(self, registry_id, connection_key, **kwargs): """ - Retrieves a connection validation using the specified identifier. + Retrieves the connection details using the specified identifier. :param str registry_id: (required) - The registry Ocid. + The registry OCID. - :param str connection_validation_key: (required) - The key of the connection validation. + :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 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. + 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`. @@ -3174,32 +3086,31 @@ def get_connection_validation(self, registry_id, connection_validation_key, **kw allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings - :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_connectivity.models.ConnectionValidation` + :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_validation API. + Click `here `__ to see an example of how to use get_connection API. """ - resource_path = "/registries/{registryId}/connectionValidations/{connectionValidationKey}" + resource_path = "/registries/{registryId}/connections/{connectionKey}" method = "GET" - operation_name = "get_connection_validation" + operation_name = "get_connection" api_reference_link = "" # Don't accept unknown kwargs expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id", - "endpoint_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_connection_validation got unknown kwargs: {!r}".format(extra_kwargs)) + "get_connection got unknown kwargs: {!r}".format(extra_kwargs)) path_params = { "registryId": registry_id, - "connectionValidationKey": connection_validation_key + "connectionKey": connection_key } path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} @@ -3208,11 +3119,6 @@ def get_connection_validation(self, registry_id, connection_validation_key, **kw 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", @@ -3224,6 +3130,8 @@ def get_connection_validation(self, registry_id, connection_validation_key, **kw operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -3234,9 +3142,8 @@ def get_connection_validation(self, registry_id, connection_validation_key, **kw resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="ConnectionValidation", + response_type="Connection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link) @@ -3245,9 +3152,8 @@ def get_connection_validation(self, registry_id, connection_validation_key, **kw resource_path=resource_path, method=method, path_params=path_params, - query_params=query_params, header_params=header_params, - response_type="ConnectionValidation", + response_type="Connection", allow_control_chars=kwargs.get('allow_control_chars'), operation_name=operation_name, api_reference_link=api_reference_link) @@ -3258,7 +3164,7 @@ def get_data_asset(self, registry_id, data_asset_key, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str data_asset_key: (required) The data asset key. @@ -3271,7 +3177,7 @@ def get_data_asset(self, registry_id, data_asset_key, **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`. @@ -3324,6 +3230,8 @@ def get_data_asset(self, registry_id, data_asset_key, **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): @@ -3356,7 +3264,7 @@ def get_data_entity(self, registry_id, connection_key, schema_resource_name, dat :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -3373,12 +3281,12 @@ def get_data_entity(self, registry_id, connection_key, schema_resource_name, dat please provide the request ID. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -3439,6 +3347,8 @@ def get_data_entity(self, registry_id, connection_key, schema_resource_name, dat 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): @@ -3469,14 +3379,14 @@ def get_data_entity(self, registry_id, connection_key, schema_resource_name, dat def get_endpoint(self, endpoint_id, **kwargs): """ - Gets a Data Connectivity Management Endpoint by identifier + Gets a Data Connectivity Management endpoint by its identifier. :param str endpoint_id: (required) - DCMS Endpoint id + DCMS endpoint ID. :param str registry_id: (optional) - DCMS registry id + DCMS registry ID :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -3486,7 +3396,7 @@ def get_endpoint(self, endpoint_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`. @@ -3544,6 +3454,8 @@ def get_endpoint(self, endpoint_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): @@ -3572,13 +3484,131 @@ def get_endpoint(self, endpoint_id, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) + def get_engine_configurations(self, registry_id, connection_key, **kwargs): + """ + This endpoint is used to fetch connector-specific engine configurations. + + + :param str registry_id: (required) + The registry OCID. + + :param str connection_key: (required) + The connection key. + + :param str engine_type_query_param: (optional) + Specifies the runtime engine for the bulk read/write operation. Default is SPARK. + + Allowed values are: "SPARK" + + :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.ConfigDetails` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_engine_configurations API. + """ + resource_path = "/registries/{registryId}/connections/{connectionKey}/engineConfigurations" + method = "GET" + operation_name = "get_engine_configurations" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "engine_type_query_param", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_engine_configurations 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 'engine_type_query_param' in kwargs: + engine_type_query_param_allowed_values = ["SPARK"] + if kwargs['engine_type_query_param'] not in engine_type_query_param_allowed_values: + raise ValueError( + "Invalid value for `engine_type_query_param`, must be one of {0}".format(engine_type_query_param_allowed_values) + ) + + query_params = { + "engineTypeQueryParam": kwargs.get("engine_type_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="ConfigDetails", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ConfigDetails", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + 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 + Get the status or the result of the execution. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -3587,7 +3617,7 @@ def get_execute_operation_job(self, registry_id, connection_key, schema_resource The schema resource name used for retrieving schemas. :param str execute_operation_job_key: (required) - Job id returned by execute operation job api + Job ID returned by the execute operation job API. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -3595,12 +3625,12 @@ def get_execute_operation_job(self, registry_id, connection_key, schema_resource please provide the request ID. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -3661,6 +3691,8 @@ def get_execute_operation_job(self, registry_id, connection_key, schema_resource 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): @@ -3695,7 +3727,7 @@ def get_folder(self, registry_id, folder_key, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str folder_key: (required) The folder ID. @@ -3708,7 +3740,7 @@ def get_folder(self, registry_id, folder_key, **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`. @@ -3761,6 +3793,8 @@ def get_folder(self, registry_id, folder_key, **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): @@ -3789,11 +3823,11 @@ def get_folder(self, registry_id, folder_key, **kwargs): 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 + Get the status of network reachability check, with the timestamp of when the status was last checked, for a given PrivateEndpoint-DataAsset pair. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str data_asset_key: (required) The data asset key. @@ -3804,10 +3838,10 @@ def get_network_connectivity_status(self, registry_id, data_asset_key, **kwargs) 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. @@ -3817,7 +3851,7 @@ def get_network_connectivity_status(self, registry_id, data_asset_key, **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`. @@ -3880,6 +3914,8 @@ def get_network_connectivity_status(self, registry_id, data_asset_key, **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): @@ -3911,11 +3947,11 @@ def get_network_connectivity_status(self, registry_id, data_asset_key, **kwargs) def get_operation(self, registry_id, connection_key, schema_resource_name, operation_resource_name, **kwargs): """ - Retrieves the details of operation with given resource name. + Retrieves the details of operation with the given resource name. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -3924,7 +3960,7 @@ def get_operation(self, registry_id, connection_key, schema_resource_name, opera 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. + The operation resource name used for retrieving the details of operation. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -3932,12 +3968,12 @@ def get_operation(self, registry_id, connection_key, schema_resource_name, opera please provide the request ID. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -3998,6 +4034,8 @@ def get_operation(self, registry_id, connection_key, schema_resource_name, opera 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): @@ -4028,11 +4066,11 @@ def get_operation(self, registry_id, connection_key, schema_resource_name, opera def get_registry(self, registry_id, **kwargs): """ - Gets a Data Connectivity Management Registry by identifier + Retrieves a Data Connectivity Management registry using the specified identifier. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -4042,7 +4080,7 @@ def get_registry(self, registry_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`. @@ -4094,6 +4132,8 @@ def get_registry(self, registry_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): @@ -4126,7 +4166,7 @@ def get_schema(self, registry_id, connection_key, schema_resource_name, **kwargs :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -4140,12 +4180,12 @@ def get_schema(self, registry_id, connection_key, schema_resource_name, **kwargs please provide the request ID. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -4205,6 +4245,8 @@ def get_schema(self, registry_id, connection_key, schema_resource_name, **kwargs operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -4235,14 +4277,14 @@ def get_schema(self, registry_id, connection_key, schema_resource_name, **kwargs def get_type(self, registry_id, type_key, **kwargs): """ - This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry + This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str type_key: (required) - key of the a specefic Type. + Key of the a specific type. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -4255,7 +4297,7 @@ def get_type(self, registry_id, type_key, **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`. @@ -4314,6 +4356,8 @@ def get_type(self, registry_id, type_key, **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): @@ -4358,7 +4402,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`. @@ -4410,6 +4454,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): @@ -4436,180 +4482,13 @@ def get_work_request(self, work_request_id, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) - 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" - operation_name = "list_connection_validations" - api_reference_link = "" - - # 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", - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link) - else: - return self.base_client.call_api( - resource_path=resource_path, - method=method, - path_params=path_params, - query_params=query_params, - header_params=header_params, - response_type="ConnectionValidationSummaryCollection", - allow_control_chars=kwargs.get('allow_control_chars'), - operation_name=operation_name, - api_reference_link=api_reference_link) - def list_connections(self, registry_id, data_asset_key, **kwargs): """ Retrieves a list of all connections. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str data_asset_key: (required) Used to filter by the data asset key of the object. @@ -4634,7 +4513,7 @@ def list_connections(self, registry_id, data_asset_key, **kwargs): 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -4656,7 +4535,7 @@ def list_connections(self, registry_id, data_asset_key, **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`. @@ -4750,6 +4629,8 @@ def list_connections(self, registry_id, data_asset_key, **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): @@ -4784,7 +4665,7 @@ def list_data_assets(self, registry_id, **kwargs): :param str registry_id: (required) - The registry Ocid. + 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`__. @@ -4800,10 +4681,10 @@ def list_data_assets(self, registry_id, **kwargs): Specifies the fields to get for an object. :param list[str] include_types: (optional) - DataAsset type which needs to be listed while listing dataAssets + Artifact type which needs to be listed while listing Artifacts. :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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -4821,7 +4702,7 @@ def list_data_assets(self, registry_id, **kwargs): please provide the request ID. :param list[str] exclude_types: (optional) - Types which wont be listed while listing dataAsset/Connection + The types that will be excluded from the list of data assets/connections. :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. @@ -4832,15 +4713,15 @@ def list_data_assets(self, registry_id, **kwargs): Unique key of the folder. :param list[str] endpoint_ids: (optional) - Endpoint Ids used for data-plane APIs to filter or prefer specific endpoint. + 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 + Endpoints which will be excluded while listing data assets. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -4941,6 +4822,8 @@ def list_data_assets(self, registry_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): @@ -4975,7 +4858,7 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -5003,7 +4886,7 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -5026,15 +4909,18 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, 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. + This parameter can be used to specify whether entity search type is a pattern search. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + Endpoint ID used for getDataAssetFullDetails. + + :param list[str] include_types: (optional) + Artifact type which needs to be listed while listing Artifacts. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -5069,7 +4955,8 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, "api_mode", "name_list", "is_pattern", - "endpoint_id" + "endpoint_id", + "include_types" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -5120,7 +5007,8 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, "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) + "endpointId": kwargs.get("endpoint_id", missing), + "includeTypes": self.base_client.generate_collection_format_param(kwargs.get("include_types", missing), 'multi') } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -5135,6 +5023,8 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5165,14 +5055,14 @@ def list_data_entities(self, registry_id, connection_key, schema_resource_name, def list_endpoints(self, compartment_id, **kwargs): """ - Returns a list of Data Connectivity Management Endpoints. + 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 + DCMS registry ID :param str name: (optional) Used to filter by the name of the object. @@ -5190,7 +5080,7 @@ def list_endpoints(self, compartment_id, **kwargs): :param str lifecycle_state: (optional) Lifecycle state of the resource. - Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "STARTING", "STOPPING", "STOPPED" :param str sort_order: (optional) Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). @@ -5198,7 +5088,7 @@ def list_endpoints(self, compartment_id, **kwargs): 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). + 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" @@ -5210,7 +5100,7 @@ def list_endpoints(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`. @@ -5249,7 +5139,7 @@ def list_endpoints(self, compartment_id, **kwargs): "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"] + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "STARTING", "STOPPING", "STOPPED"] 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) @@ -5292,6 +5182,8 @@ def list_endpoints(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): @@ -5320,11 +5212,11 @@ def list_endpoints(self, compartment_id, **kwargs): def list_folders(self, registry_id, **kwargs): """ - Retrieves a list of all folders. + Retrieves a list of all the folders. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str name: (optional) Used to filter by the name of the object. @@ -5346,7 +5238,7 @@ def list_folders(self, registry_id, **kwargs): 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -5368,7 +5260,7 @@ def list_folders(self, registry_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`. @@ -5461,6 +5353,8 @@ def list_folders(self, registry_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): @@ -5491,11 +5385,11 @@ def list_folders(self, registry_id, **kwargs): 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. + Lists the summary of operations that are present in the schema, identified by the schema name. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -5522,7 +5416,7 @@ def list_operations(self, registry_id, connection_key, schema_resource_name, **k __ 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -5532,12 +5426,12 @@ def list_operations(self, registry_id, connection_key, schema_resource_name, **k Allowed values are: "ASC", "DESC" :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + 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. + 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`. @@ -5621,6 +5515,8 @@ def list_operations(self, registry_id, connection_key, schema_resource_name, **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): @@ -5655,7 +5551,7 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str dcms_artifact_id: (required) The ID of a dcms artifact (DataAsset or Endpoint). @@ -5677,7 +5573,7 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -5695,7 +5591,7 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): please provide the request ID. :param list[str] exclude_types: (optional) - Types which wont be listed while listing dataAsset/Connection + The types that will be excluded from the list of data assets/connections. :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. @@ -5708,7 +5604,7 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. @@ -5806,6 +5702,8 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): operation_retry_strategy=kwargs.get('retry_strategy'), client_retry_strategy=self.retry_strategy ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY if retry_strategy: if not isinstance(retry_strategy, retry.NoneRetryStrategy): @@ -5836,7 +5734,7 @@ def list_reference_artifacts(self, registry_id, dcms_artifact_id, **kwargs): def list_registries(self, compartment_id, **kwargs): """ - Returns a list of Data Connectivity Management Registries. + Retrieves a list of Data Connectivity Management registries. :param str compartment_id: (required) @@ -5856,12 +5754,12 @@ def list_registries(self, compartment_id, **kwargs): __ 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. + This parameter allows list registries to deep look at the whole tenancy. :param str lifecycle_state: (optional) Lifecycle state of the resource. - Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" + Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "STARTING", "STOPPING", "STOPPED" :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -5871,7 +5769,7 @@ def list_registries(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`. @@ -5908,7 +5806,7 @@ def list_registries(self, compartment_id, **kwargs): "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"] + lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "STARTING", "STOPPING", "STOPPED"] 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) @@ -5935,6 +5833,8 @@ def list_registries(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): @@ -5967,7 +5867,7 @@ def list_schemas(self, registry_id, connection_key, **kwargs): :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str connection_key: (required) The connection key. @@ -5986,7 +5886,7 @@ def list_schemas(self, registry_id, connection_key, **kwargs): 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -6010,12 +5910,15 @@ def list_schemas(self, registry_id, connection_key, **kwargs): Used to filter by the name of the object. :param str endpoint_id: (optional) - Endpoint Id used for getDataAssetFullDetails. + Endpoint ID used for getDataAssetFullDetails. + + :param list[str] include_types: (optional) + Artifact type which needs to be listed while listing Artifacts. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -6048,7 +5951,8 @@ def list_schemas(self, registry_id, connection_key, **kwargs): "name", "opc_request_id", "name_list", - "endpoint_id" + "endpoint_id", + "include_types" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -6089,7 +5993,8 @@ def list_schemas(self, registry_id, connection_key, **kwargs): "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) + "endpointId": kwargs.get("endpoint_id", missing), + "includeTypes": self.base_client.generate_collection_format_param(kwargs.get("include_types", missing), 'multi') } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -6104,6 +6009,8 @@ def list_schemas(self, registry_id, connection_key, **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): @@ -6134,11 +6041,11 @@ def list_schemas(self, registry_id, connection_key, **kwargs): def list_types(self, registry_id, **kwargs): """ - This endpoint retrieves list of all the supported connector types + This endpoint retrieves a list of all the supported connector types. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -6159,7 +6066,7 @@ def list_types(self, registry_id, **kwargs): 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -6174,7 +6081,7 @@ def list_types(self, registry_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`. @@ -6256,6 +6163,8 @@ def list_types(self, registry_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): @@ -6286,7 +6195,7 @@ def list_types(self, registry_id, **kwargs): def list_work_request_errors(self, work_request_id, **kwargs): """ - Return a (paginated) list of errors for a given work request. + Returns a (paginated) list of errors for a given work request. :param str work_request_id: (required) @@ -6310,7 +6219,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`. @@ -6370,6 +6279,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): @@ -6400,7 +6311,7 @@ def list_work_request_errors(self, work_request_id, **kwargs): def list_work_request_logs(self, work_request_id, **kwargs): """ - Return a (paginated) list of logs for a given work request. + Returns a (paginated) list of logs for a given work request. :param str work_request_id: (required) @@ -6424,7 +6335,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`. @@ -6484,6 +6395,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): @@ -6525,11 +6438,11 @@ def list_work_requests(self, compartment_id, **kwargs): 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 registry_id: (optional) + DCMS registry ID :param str work_request_status: (optional) - Work Request status. + Work request status. Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" @@ -6546,7 +6459,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`. @@ -6571,7 +6484,7 @@ def list_work_requests(self, compartment_id, **kwargs): "allow_control_chars", "retry_strategy", "opc_request_id", - "resource_id", + "registry_id", "work_request_status", "page", "limit" @@ -6590,7 +6503,7 @@ def list_work_requests(self, compartment_id, **kwargs): query_params = { "compartmentId": compartment_id, - "resourceId": kwargs.get("resource_id", missing), + "registryId": kwargs.get("registry_id", missing), "workRequestStatus": kwargs.get("work_request_status", missing), "page": kwargs.get("page", missing), "limit": kwargs.get("limit", missing) @@ -6608,6 +6521,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): @@ -6640,13 +6555,13 @@ def update_connection(self, registry_id, connection_key, update_connection_detai :param str registry_id: (required) - The registry Ocid. + 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. + The information required to update a connection. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -6750,13 +6665,13 @@ def update_data_asset(self, registry_id, data_asset_key, update_data_asset_detai :param str registry_id: (required) - The registry Ocid. + 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. + The information required to update a data asset. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -6856,17 +6771,17 @@ def update_data_asset(self, registry_id, data_asset_key, update_data_asset_detai def update_endpoint(self, endpoint_id, update_endpoint_details, **kwargs): """ - Updates the Data Connectivity Management Endpoint + Updates the Data Connectivity Management endpoint. :param str endpoint_id: (required) - DCMS Endpoint id + 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 + 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. @@ -6973,17 +6888,17 @@ def update_endpoint(self, endpoint_id, update_endpoint_details, **kwargs): def update_folder(self, registry_id, folder_key, update_folder_details, **kwargs): """ - Updates a folder under a specefied registry. + Updates a folder under a specified registry. :param str registry_id: (required) - The registry Ocid. + 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. + The information required to update a folder. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If @@ -7083,11 +6998,11 @@ def update_folder(self, registry_id, folder_key, update_folder_details, **kwargs def update_registry(self, registry_id, update_registry_details, **kwargs): """ - Updates the Data Connectivity Management Registry + Updates the Data Connectivity Management Registry. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.UpdateRegistryDetails update_registry_details: (required) The information to be updated. @@ -7189,11 +7104,11 @@ def update_registry(self, registry_id, update_registry_details, **kwargs): def validate_data_asset_network_reachablity(self, endpoint_id, **kwargs): """ - Validates the dataAsset network Reachability. + Validates the dataAsset network reachability. :param str endpoint_id: (required) - DCMS Endpoint id + 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. @@ -7206,10 +7121,10 @@ def validate_data_asset_network_reachablity(self, endpoint_id, **kwargs): 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :param str registry_id: (optional) - DCMS registry id + 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. 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 index 565a17e7bb..8b3957cd6a 100644 --- a/src/oci/data_connectivity/data_connectivity_management_client_composite_operations.py +++ b/src/oci/data_connectivity/data_connectivity_management_client_composite_operations.py @@ -29,10 +29,10 @@ def change_endpoint_compartment_and_wait_for_state(self, endpoint_id, change_end to enter the given state(s). :param str endpoint_id: (required) - DCMS Endpoint id + DCMS endpoint ID. :param oci.data_connectivity.models.ChangeEndpointCompartmentDetails change_endpoint_compartment_details: (required) - The details of change compartment action. + The details of the 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` @@ -70,10 +70,10 @@ def change_registry_compartment_and_wait_for_state(self, registry_id, change_reg to enter the given state(s). :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.ChangeRegistryCompartmentDetails change_registry_compartment_details: (required) - The details of change compartment action. + The details of the 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` @@ -111,7 +111,7 @@ def create_endpoint_and_wait_for_state(self, create_endpoint_details, wait_for_s to enter the given state(s). :param oci.data_connectivity.models.CreateEndpointDetails create_endpoint_details: (required) - Details for the new Data Connectivity Management Endpoint. + Details of 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` @@ -187,7 +187,7 @@ def delete_endpoint_and_wait_for_state(self, endpoint_id, wait_for_states=[], op to enter the given state(s). :param str endpoint_id: (required) - DCMS Endpoint id + 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` @@ -233,7 +233,7 @@ def delete_registry_and_wait_for_state(self, registry_id, wait_for_states=[], op to enter the given state(s). :param str registry_id: (required) - The registry Ocid. + 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` @@ -279,7 +279,7 @@ def update_endpoint_and_wait_for_state(self, endpoint_id, update_endpoint_detail to enter the given state(s). :param str endpoint_id: (required) - DCMS Endpoint id + DCMS endpoint ID. :param oci.data_connectivity.models.UpdateEndpointDetails update_endpoint_details: (required) The information to be updated. @@ -320,7 +320,7 @@ def update_registry_and_wait_for_state(self, registry_id, update_registry_detail to enter the given state(s). :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param oci.data_connectivity.models.UpdateRegistryDetails update_registry_details: (required) The information to be updated. @@ -361,7 +361,7 @@ def validate_data_asset_network_reachablity_and_wait_for_state(self, endpoint_id to enter the given state(s). :param str endpoint_id: (required) - DCMS Endpoint id + 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` diff --git a/src/oci/data_connectivity/models/__init__.py b/src/oci/data_connectivity/models/__init__.py index 5218e00689..e9fb1f45c3 100644 --- a/src/oci/data_connectivity/models/__init__.py +++ b/src/oci/data_connectivity/models/__init__.py @@ -7,6 +7,7 @@ from .abstract_call_attribute import AbstractCallAttribute from .abstract_data_operation_config import AbstractDataOperationConfig from .abstract_format_attribute import AbstractFormatAttribute +from .abstract_operation_attributes import AbstractOperationAttributes from .abstract_read_attribute import AbstractReadAttribute from .abstract_write_attribute import AbstractWriteAttribute from .aggregator_summary import AggregatorSummary @@ -24,6 +25,7 @@ from .composite_type import CompositeType from .compression import Compression from .config_definition import ConfigDefinition +from .config_details import ConfigDetails from .config_parameter_definition import ConfigParameterDefinition from .config_parameter_value import ConfigParameterValue from .config_values import ConfigValues @@ -34,7 +36,8 @@ 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_usage import ConnectivityUsage +from .connectivity_usage_details import ConnectivityUsageDetails from .connectivity_validation import ConnectivityValidation from .connector_attribute import ConnectorAttribute from .create_attach_data_asset_details import CreateAttachDataAssetDetails @@ -53,6 +56,7 @@ 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_message import CreateEntityShapeFromMessage from .create_entity_shape_from_sql import CreateEntityShapeFromSQL from .create_entity_shape_from_table import CreateEntityShapeFromTable from .create_entity_shape_from_view import CreateEntityShapeFromView @@ -72,6 +76,7 @@ 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_message_entity_details import DataEntityFromMessageEntityDetails from .data_entity_from_sql import DataEntityFromSql from .data_entity_from_sql_entity_details import DataEntityFromSqlEntityDetails from .data_entity_from_table import DataEntityFromTable @@ -92,6 +97,10 @@ from .data_type_stat import DataTypeStat from .date_attribute import DateAttribute from .de_reference_info import DeReferenceInfo +from .derive_entities import DeriveEntities +from .derive_entities_details import DeriveEntitiesDetails +from .derive_entities_item import DeriveEntitiesItem +from .derived_entity import DerivedEntity from .derived_type import DerivedType from .detach_data_asset_info import DetachDataAssetInfo from .dp_endpoint import DpEndpoint @@ -110,10 +119,12 @@ from .entity_shape import EntityShape from .entity_shape_from_data_store import EntityShapeFromDataStore from .entity_shape_from_file import EntityShapeFromFile +from .entity_shape_from_message import EntityShapeFromMessage 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 .excel_format_attribute import ExcelFormatAttribute from .execute_operation_job import ExecuteOperationJob from .execute_operation_job_details import ExecuteOperationJobDetails from .external_storage import ExternalStorage @@ -123,6 +134,8 @@ from .folder_summary_collection import FolderSummaryCollection from .foreign_key import ForeignKey from .full_push_down_task_response import FullPushDownTaskResponse +from .generic_rest_api_attributes import GenericRestApiAttributes +from .generic_rest_call_attribute import GenericRestCallAttribute from .hdfs_write_attributes import HdfsWriteAttributes from .histogram import Histogram from .input_port import InputPort @@ -142,10 +155,12 @@ from .object_storage_write_attributes import ObjectStorageWriteAttributes from .operation import Operation from .operation_exec_result import OperationExecResult +from .operation_from_api import OperationFromApi 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_api import OperationSummaryFromApi from .operation_summary_from_procedure import OperationSummaryFromProcedure from .oracle_adwc_write_attributes import OracleAdwcWriteAttributes from .oracle_atp_write_attributes import OracleAtpWriteAttributes @@ -167,6 +182,9 @@ from .reference_artifact_summary import ReferenceArtifactSummary from .reference_artifact_summary_collection import ReferenceArtifactSummaryCollection from .reference_info import ReferenceInfo +from .referenced_data_object import ReferencedDataObject +from .referenced_data_object_from_api import ReferencedDataObjectFromAPI +from .referenced_data_object_from_procedure import ReferencedDataObjectFromProcedure from .registry import Registry from .registry_metadata import RegistryMetadata from .registry_summary import RegistrySummary @@ -219,6 +237,7 @@ "AbstractCallAttribute": AbstractCallAttribute, "AbstractDataOperationConfig": AbstractDataOperationConfig, "AbstractFormatAttribute": AbstractFormatAttribute, + "AbstractOperationAttributes": AbstractOperationAttributes, "AbstractReadAttribute": AbstractReadAttribute, "AbstractWriteAttribute": AbstractWriteAttribute, "AggregatorSummary": AggregatorSummary, @@ -236,6 +255,7 @@ "CompositeType": CompositeType, "Compression": Compression, "ConfigDefinition": ConfigDefinition, + "ConfigDetails": ConfigDetails, "ConfigParameterDefinition": ConfigParameterDefinition, "ConfigParameterValue": ConfigParameterValue, "ConfigValues": ConfigValues, @@ -246,7 +266,8 @@ "ConnectionSummaryCollection": ConnectionSummaryCollection, "ConnectionValidation": ConnectionValidation, "ConnectionValidationSummary": ConnectionValidationSummary, - "ConnectionValidationSummaryCollection": ConnectionValidationSummaryCollection, + "ConnectivityUsage": ConnectivityUsage, + "ConnectivityUsageDetails": ConnectivityUsageDetails, "ConnectivityValidation": ConnectivityValidation, "ConnectorAttribute": ConnectorAttribute, "CreateAttachDataAssetDetails": CreateAttachDataAssetDetails, @@ -265,6 +286,7 @@ "CreateEntityShapeDetails": CreateEntityShapeDetails, "CreateEntityShapeFromDataStore": CreateEntityShapeFromDataStore, "CreateEntityShapeFromFile": CreateEntityShapeFromFile, + "CreateEntityShapeFromMessage": CreateEntityShapeFromMessage, "CreateEntityShapeFromSQL": CreateEntityShapeFromSQL, "CreateEntityShapeFromTable": CreateEntityShapeFromTable, "CreateEntityShapeFromView": CreateEntityShapeFromView, @@ -284,6 +306,7 @@ "DataEntityFromDataStoreEntityDetails": DataEntityFromDataStoreEntityDetails, "DataEntityFromFile": DataEntityFromFile, "DataEntityFromFileEntityDetails": DataEntityFromFileEntityDetails, + "DataEntityFromMessageEntityDetails": DataEntityFromMessageEntityDetails, "DataEntityFromSql": DataEntityFromSql, "DataEntityFromSqlEntityDetails": DataEntityFromSqlEntityDetails, "DataEntityFromTable": DataEntityFromTable, @@ -304,6 +327,10 @@ "DataTypeStat": DataTypeStat, "DateAttribute": DateAttribute, "DeReferenceInfo": DeReferenceInfo, + "DeriveEntities": DeriveEntities, + "DeriveEntitiesDetails": DeriveEntitiesDetails, + "DeriveEntitiesItem": DeriveEntitiesItem, + "DerivedEntity": DerivedEntity, "DerivedType": DerivedType, "DetachDataAssetInfo": DetachDataAssetInfo, "DpEndpoint": DpEndpoint, @@ -322,10 +349,12 @@ "EntityShape": EntityShape, "EntityShapeFromDataStore": EntityShapeFromDataStore, "EntityShapeFromFile": EntityShapeFromFile, + "EntityShapeFromMessage": EntityShapeFromMessage, "EntityShapeFromSQL": EntityShapeFromSQL, "EntityShapeFromTable": EntityShapeFromTable, "EntityShapeFromView": EntityShapeFromView, "ErrorDetails": ErrorDetails, + "ExcelFormatAttribute": ExcelFormatAttribute, "ExecuteOperationJob": ExecuteOperationJob, "ExecuteOperationJobDetails": ExecuteOperationJobDetails, "ExternalStorage": ExternalStorage, @@ -335,6 +364,8 @@ "FolderSummaryCollection": FolderSummaryCollection, "ForeignKey": ForeignKey, "FullPushDownTaskResponse": FullPushDownTaskResponse, + "GenericRestApiAttributes": GenericRestApiAttributes, + "GenericRestCallAttribute": GenericRestCallAttribute, "HdfsWriteAttributes": HdfsWriteAttributes, "Histogram": Histogram, "InputPort": InputPort, @@ -354,10 +385,12 @@ "ObjectStorageWriteAttributes": ObjectStorageWriteAttributes, "Operation": Operation, "OperationExecResult": OperationExecResult, + "OperationFromApi": OperationFromApi, "OperationFromProcedure": OperationFromProcedure, "OperationInputRecord": OperationInputRecord, "OperationSummary": OperationSummary, "OperationSummaryCollection": OperationSummaryCollection, + "OperationSummaryFromApi": OperationSummaryFromApi, "OperationSummaryFromProcedure": OperationSummaryFromProcedure, "OracleAdwcWriteAttributes": OracleAdwcWriteAttributes, "OracleAtpWriteAttributes": OracleAtpWriteAttributes, @@ -379,6 +412,9 @@ "ReferenceArtifactSummary": ReferenceArtifactSummary, "ReferenceArtifactSummaryCollection": ReferenceArtifactSummaryCollection, "ReferenceInfo": ReferenceInfo, + "ReferencedDataObject": ReferencedDataObject, + "ReferencedDataObjectFromAPI": ReferencedDataObjectFromAPI, + "ReferencedDataObjectFromProcedure": ReferencedDataObjectFromProcedure, "Registry": Registry, "RegistryMetadata": RegistryMetadata, "RegistrySummary": RegistrySummary, diff --git a/src/oci/data_connectivity/models/abstract_call_attribute.py b/src/oci/data_connectivity/models/abstract_call_attribute.py index 088f8d7d78..a5d4f542ff 100644 --- a/src/oci/data_connectivity/models/abstract_call_attribute.py +++ b/src/oci/data_connectivity/models/abstract_call_attribute.py @@ -10,25 +10,30 @@ @init_model_state_from_kwargs class AbstractCallAttribute(object): """ - The call attributes + 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" + #: A constant which can be used with the model_type property of a AbstractCallAttribute. + #: This constant has a value of "GENERIC_REST_CALL_ATTRIBUTE" + MODEL_TYPE_GENERIC_REST_CALL_ATTRIBUTE = "GENERIC_REST_CALL_ATTRIBUTE" + 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` + * :class:`~oci.data_connectivity.models.GenericRestCallAttribute` 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" + Allowed values for this property are: "BIPCALLATTRIBUTE", "GENERIC_REST_CALL_ATTRIBUTE" :type model_type: str """ @@ -52,6 +57,9 @@ def get_subtype(object_dictionary): if type == 'BIPCALLATTRIBUTE': return 'BipCallAttribute' + + if type == 'GENERIC_REST_CALL_ATTRIBUTE': + return 'GenericRestCallAttribute' else: return 'AbstractCallAttribute' @@ -59,9 +67,9 @@ def get_subtype(object_dictionary): def model_type(self): """ **[Required]** Gets the model_type of this AbstractCallAttribute. - The operation type + The operation type. - Allowed values for this property are: "BIPCALLATTRIBUTE" + Allowed values for this property are: "BIPCALLATTRIBUTE", "GENERIC_REST_CALL_ATTRIBUTE" :return: The model_type of this AbstractCallAttribute. @@ -73,13 +81,13 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this AbstractCallAttribute. - The operation type + The operation type. :param model_type: The model_type of this AbstractCallAttribute. :type: str """ - allowed_values = ["BIPCALLATTRIBUTE"] + allowed_values = ["BIPCALLATTRIBUTE", "GENERIC_REST_CALL_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}" diff --git a/src/oci/data_connectivity/models/abstract_data_operation_config.py b/src/oci/data_connectivity/models/abstract_data_operation_config.py index 8463d5e70c..cc5765de7f 100644 --- a/src/oci/data_connectivity/models/abstract_data_operation_config.py +++ b/src/oci/data_connectivity/models/abstract_data_operation_config.py @@ -36,16 +36,23 @@ def __init__(self, **kwargs): Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" :type model_type: str + :param derived_attributes: + The value to assign to the derived_attributes property of this AbstractDataOperationConfig. + :type derived_attributes: dict(str, str) + """ self.swagger_types = { - 'model_type': 'str' + 'model_type': 'str', + 'derived_attributes': 'dict(str, str)' } self.attribute_map = { - 'model_type': 'modelType' + 'model_type': 'modelType', + 'derived_attributes': 'derivedAttributes' } self._model_type = None + self._derived_attributes = None @staticmethod def get_subtype(object_dictionary): @@ -95,6 +102,30 @@ def model_type(self, model_type): ) self._model_type = model_type + @property + def derived_attributes(self): + """ + Gets the derived_attributes of this AbstractDataOperationConfig. + this map is used for passing BIP report/REST parameter values. + + + :return: The derived_attributes of this AbstractDataOperationConfig. + :rtype: dict(str, str) + """ + return self._derived_attributes + + @derived_attributes.setter + def derived_attributes(self, derived_attributes): + """ + Sets the derived_attributes of this AbstractDataOperationConfig. + this map is used for passing BIP report/REST parameter values. + + + :param derived_attributes: The derived_attributes of this AbstractDataOperationConfig. + :type: dict(str, str) + """ + self._derived_attributes = derived_attributes + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/abstract_format_attribute.py b/src/oci/data_connectivity/models/abstract_format_attribute.py index e5d85c48ea..ee2d8d6e53 100644 --- a/src/oci/data_connectivity/models/abstract_format_attribute.py +++ b/src/oci/data_connectivity/models/abstract_format_attribute.py @@ -38,6 +38,7 @@ def __init__(self, **kwargs): * :class:`~oci.data_connectivity.models.JsonFormatAttribute` * :class:`~oci.data_connectivity.models.CsvFormatAttribute` * :class:`~oci.data_connectivity.models.ParquetFormatAttribute` + * :class:`~oci.data_connectivity.models.ExcelFormatAttribute` The following keyword arguments are supported (corresponding to the getters/setters of this class): @@ -77,6 +78,9 @@ def get_subtype(object_dictionary): if type == 'PARQUET_FORMAT': return 'ParquetFormatAttribute' + + if type == 'EXCEL_FORMAT': + return 'ExcelFormatAttribute' else: return 'AbstractFormatAttribute' diff --git a/src/oci/data_connectivity/models/abstract_operation_attributes.py b/src/oci/data_connectivity/models/abstract_operation_attributes.py new file mode 100644 index 0000000000..6fbea2434e --- /dev/null +++ b/src/oci/data_connectivity/models/abstract_operation_attributes.py @@ -0,0 +1,99 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AbstractOperationAttributes(object): + """ + The operation attributes + """ + + #: A constant which can be used with the model_type property of a AbstractOperationAttributes. + #: This constant has a value of "GENERIC_REST_API_ATTRIBUTES" + MODEL_TYPE_GENERIC_REST_API_ATTRIBUTES = "GENERIC_REST_API_ATTRIBUTES" + + def __init__(self, **kwargs): + """ + Initializes a new AbstractOperationAttributes 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.GenericRestApiAttributes` + + 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 AbstractOperationAttributes. + Allowed values for this property are: "GENERIC_REST_API_ATTRIBUTES", '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 == 'GENERIC_REST_API_ATTRIBUTES': + return 'GenericRestApiAttributes' + else: + return 'AbstractOperationAttributes' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this AbstractOperationAttributes. + The operation type. + + Allowed values for this property are: "GENERIC_REST_API_ATTRIBUTES", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this AbstractOperationAttributes. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this AbstractOperationAttributes. + The operation type. + + + :param model_type: The model_type of this AbstractOperationAttributes. + :type: str + """ + allowed_values = ["GENERIC_REST_API_ATTRIBUTES"] + 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/aggregator_summary.py b/src/oci/data_connectivity/models/aggregator_summary.py index 6f66f31f9d..8f27fc8808 100644 --- a/src/oci/data_connectivity/models/aggregator_summary.py +++ b/src/oci/data_connectivity/models/aggregator_summary.py @@ -10,7 +10,7 @@ @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. + A summary type containing information about the object's aggregator including its type, key, name, and description. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/attach_data_asset_info.py b/src/oci/data_connectivity/models/attach_data_asset_info.py index 035d04073e..24e524b1e5 100644 --- a/src/oci/data_connectivity/models/attach_data_asset_info.py +++ b/src/oci/data_connectivity/models/attach_data_asset_info.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def reference_info(self): """ **[Required]** Gets the reference_info of this AttachDataAssetInfo. - Map of DataAsset name as key and results as value + Mapping the DataAsset name as the key to the results as the value. :return: The reference_info of this AttachDataAssetInfo. @@ -49,7 +49,7 @@ def reference_info(self): def reference_info(self, reference_info): """ Sets the reference_info of this AttachDataAssetInfo. - Map of DataAsset name as key and results as value + Mapping the DataAsset name as the key to the results as the value. :param reference_info: The reference_info of this AttachDataAssetInfo. diff --git a/src/oci/data_connectivity/models/attribute.py b/src/oci/data_connectivity/models/attribute.py index 0a6af11857..4d599e9777 100644 --- a/src/oci/data_connectivity/models/attribute.py +++ b/src/oci/data_connectivity/models/attribute.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Attribute(object): """ - Registry Attribute Object, to get connector details + The attribute object fo the registry that can be used to get the connector details. """ def __init__(self, **kwargs): @@ -79,7 +79,7 @@ def __init__(self, **kwargs): def name(self): """ **[Required]** Gets the name of this Attribute. - The name of of the Attribute. + The name of of the attribute. :return: The name of this Attribute. @@ -91,7 +91,7 @@ def name(self): def name(self, name): """ Sets the name of this Attribute. - The name of of the Attribute. + The name of of the attribute. :param name: The name of this Attribute. @@ -103,7 +103,7 @@ def name(self, name): def is_sensitive(self): """ Gets the is_sensitive of this Attribute. - True if Attribute is sensitive. + True if attribute is sensitive. :return: The is_sensitive of this Attribute. @@ -115,7 +115,7 @@ def is_sensitive(self): def is_sensitive(self, is_sensitive): """ Sets the is_sensitive of this Attribute. - True if Attribute is sensitive. + True if attribute is sensitive. :param is_sensitive: The is_sensitive of this Attribute. @@ -127,7 +127,7 @@ def is_sensitive(self, is_sensitive): def is_mandatory(self): """ Gets the is_mandatory of this Attribute. - True if Attribute is mandatory. + True if attribute is mandatory. :return: The is_mandatory of this Attribute. @@ -139,7 +139,7 @@ def is_mandatory(self): def is_mandatory(self, is_mandatory): """ Sets the is_mandatory of this Attribute. - True if Attribute is mandatory. + True if attribute is mandatory. :param is_mandatory: The is_mandatory of this Attribute. @@ -151,7 +151,7 @@ def is_mandatory(self, is_mandatory): def is_generated(self): """ Gets the is_generated of this Attribute. - True if Attribute is generated. + True if attribute is generated. :return: The is_generated of this Attribute. @@ -163,7 +163,7 @@ def is_generated(self): def is_generated(self, is_generated): """ Sets the is_generated of this Attribute. - True if Attribute is generated. + True if attribute is generated. :param is_generated: The is_generated of this Attribute. @@ -175,7 +175,7 @@ def is_generated(self, is_generated): def is_base64_encoded(self): """ Gets the is_base64_encoded of this Attribute. - True if Attribute is encoded. + True if attribute is encoded. :return: The is_base64_encoded of this Attribute. @@ -187,7 +187,7 @@ def is_base64_encoded(self): def is_base64_encoded(self, is_base64_encoded): """ Sets the is_base64_encoded of this Attribute. - True if Attribute is encoded. + True if attribute is encoded. :param is_base64_encoded: The is_base64_encoded of this Attribute. @@ -199,7 +199,7 @@ def is_base64_encoded(self, is_base64_encoded): def valid_key_list(self): """ Gets the valid_key_list of this Attribute. - List of valid key list + The list of valid keys. :return: The valid_key_list of this Attribute. @@ -211,7 +211,7 @@ def valid_key_list(self): def valid_key_list(self, valid_key_list): """ Sets the valid_key_list of this Attribute. - List of valid key list + The list of valid keys. :param valid_key_list: The valid_key_list of this Attribute. @@ -223,7 +223,7 @@ def valid_key_list(self, valid_key_list): def attribute_type(self): """ Gets the attribute_type of this Attribute. - Attribute type details + The attribute type details. :return: The attribute_type of this Attribute. @@ -235,7 +235,7 @@ def attribute_type(self): def attribute_type(self, attribute_type): """ Sets the attribute_type of this Attribute. - Attribute type details + The attribute type details. :param attribute_type: The attribute_type of this Attribute. diff --git a/src/oci/data_connectivity/models/attribute_profile_result.py b/src/oci/data_connectivity/models/attribute_profile_result.py index 42832703c4..bda8eca443 100644 --- a/src/oci/data_connectivity/models/attribute_profile_result.py +++ b/src/oci/data_connectivity/models/attribute_profile_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class AttributeProfileResult(object): """ - A summary of profiling results of a specefic attribute. + A summary of profiling results of a specific attribute. """ def __init__(self, **kwargs): @@ -142,7 +142,7 @@ def type(self, type): def name(self): """ Gets the name of this AttributeProfileResult. - Name of attribute + Name of the attribute :return: The name of this AttributeProfileResult. @@ -154,7 +154,7 @@ def name(self): def name(self, name): """ Sets the name of this AttributeProfileResult. - Name of attribute + Name of the attribute :param name: The name of this AttributeProfileResult. @@ -286,7 +286,7 @@ def duplicate_count(self, duplicate_count): 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. + Top N value frequencies for the column as described already in the topNValueFrequency profile config property. :return: The value_frequencies of this AttributeProfileResult. @@ -298,7 +298,7 @@ def value_frequencies(self): 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. + Top N value frequencies for the column as described already in the topNValueFrequency profile config property. :param value_frequencies: The value_frequencies of this AttributeProfileResult. diff --git a/src/oci/data_connectivity/models/base_type.py b/src/oci/data_connectivity/models/base_type.py index 4bab557c2c..54c67dadd0 100644 --- a/src/oci/data_connectivity/models/base_type.py +++ b/src/oci/data_connectivity/models/base_type.py @@ -134,7 +134,7 @@ def get_subtype(object_dictionary): def model_type(self): """ **[Required]** Gets the model_type of this BaseType. - The property which disciminates the subtypes. + The property which differentiates 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'. @@ -149,7 +149,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this BaseType. - The property which disciminates the subtypes. + The property which differentiates the subtypes. :param model_type: The model_type of this BaseType. @@ -232,7 +232,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -244,7 +244,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -280,7 +280,7 @@ def object_status(self, object_status): def description(self): """ Gets the description of this BaseType. - A user defined description for the object. + A user-defined description for the object. :return: The description of this BaseType. @@ -292,7 +292,7 @@ def description(self): def description(self, description): """ Sets the description of this BaseType. - A user defined description for the object. + A user-defined description for the object. :param description: The description of this BaseType. diff --git a/src/oci/data_connectivity/models/bicc_read_attributes.py b/src/oci/data_connectivity/models/bicc_read_attributes.py index b8bde688dc..002df054e6 100644 --- a/src/oci/data_connectivity/models/bicc_read_attributes.py +++ b/src/oci/data_connectivity/models/bicc_read_attributes.py @@ -160,7 +160,7 @@ def external_storage(self, external_storage): def initial_extract_date(self): """ Gets the initial_extract_date of this BiccReadAttributes. - Date from where extract should start + Date from where extract should start. :return: The initial_extract_date of this BiccReadAttributes. @@ -172,7 +172,7 @@ def initial_extract_date(self): def initial_extract_date(self, initial_extract_date): """ Sets the initial_extract_date of this BiccReadAttributes. - Date from where extract should start + Date from where extract should start. :param initial_extract_date: The initial_extract_date of this BiccReadAttributes. diff --git a/src/oci/data_connectivity/models/bip_call_attribute.py b/src/oci/data_connectivity/models/bip_call_attribute.py index 8bc51a15ae..0a688dd2d4 100644 --- a/src/oci/data_connectivity/models/bip_call_attribute.py +++ b/src/oci/data_connectivity/models/bip_call_attribute.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class BipCallAttribute(AbstractCallAttribute): """ - The call attributes impl + The call attributes impl. """ def __init__(self, **kwargs): @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :param model_type: The value to assign to the model_type property of this BipCallAttribute. - Allowed values for this property are: "BIPCALLATTRIBUTE" + Allowed values for this property are: "BIPCALLATTRIBUTE", "GENERIC_REST_CALL_ATTRIBUTE" :type model_type: str :param staging_bucket: @@ -102,7 +102,7 @@ def staging_bucket(self, staging_bucket): def offset_parameter(self): """ Gets the offset_parameter of this BipCallAttribute. - Parameter to set offset + The parameter to set offset. :return: The offset_parameter of this BipCallAttribute. @@ -114,7 +114,7 @@ def offset_parameter(self): def offset_parameter(self, offset_parameter): """ Sets the offset_parameter of this BipCallAttribute. - Parameter to set offset + The parameter to set offset. :param offset_parameter: The offset_parameter of this BipCallAttribute. @@ -126,7 +126,7 @@ def offset_parameter(self, offset_parameter): def fetch_next_rows_parameter(self): """ Gets the fetch_next_rows_parameter of this BipCallAttribute. - Parameter to fetch next set of rows + The parameter to fetch the next set of rows. :return: The fetch_next_rows_parameter of this BipCallAttribute. @@ -138,7 +138,7 @@ def fetch_next_rows_parameter(self): 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 + The parameter to fetch the next set of rows. :param fetch_next_rows_parameter: The fetch_next_rows_parameter of this BipCallAttribute. @@ -190,7 +190,7 @@ def staging_connection(self, staging_connection): def staging_prefix(self): """ Gets the staging_prefix of this BipCallAttribute. - Prefix for the staging DataAsset + The prefix for the staging DataAsset. :return: The staging_prefix of this BipCallAttribute. @@ -202,7 +202,7 @@ def staging_prefix(self): def staging_prefix(self, staging_prefix): """ Sets the staging_prefix of this BipCallAttribute. - Prefix for the staging DataAsset + The prefix for the staging DataAsset. :param staging_prefix: The staging_prefix of this BipCallAttribute. diff --git a/src/oci/data_connectivity/models/call_operation_config.py b/src/oci/data_connectivity/models/call_operation_config.py index b59b428be1..e6bdc393cc 100644 --- a/src/oci/data_connectivity/models/call_operation_config.py +++ b/src/oci/data_connectivity/models/call_operation_config.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CallOperationConfig(object): """ - Holder for parameters names. + Holder for parameter names. """ def __init__(self, **kwargs): @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def in_fields(self): """ Gets the in_fields of this CallOperationConfig. - List of names of IN/INOUT parameters. + The list of names of the IN/INOUT parameters. :return: The in_fields of this CallOperationConfig. @@ -70,7 +70,7 @@ def in_fields(self): def in_fields(self, in_fields): """ Sets the in_fields of this CallOperationConfig. - List of names of IN/INOUT parameters. + The list of names of the IN/INOUT parameters. :param in_fields: The in_fields of this CallOperationConfig. @@ -82,7 +82,7 @@ def in_fields(self, in_fields): def out_fields(self): """ Gets the out_fields of this CallOperationConfig. - List of names of OUT/INOUT parameters. + The list of names of the OUT/INOUT parameters. :return: The out_fields of this CallOperationConfig. @@ -94,7 +94,7 @@ def out_fields(self): def out_fields(self, out_fields): """ Sets the out_fields of this CallOperationConfig. - List of names of OUT/INOUT parameters. + The list of names of the OUT/INOUT parameters. :param out_fields: The out_fields of this CallOperationConfig. @@ -126,7 +126,7 @@ def call_attribute(self, call_attribute): def push_down_operations(self): """ Gets the push_down_operations of this CallOperationConfig. - List of push down operations. + The List of push down operations. :return: The push_down_operations of this CallOperationConfig. @@ -138,7 +138,7 @@ def push_down_operations(self): def push_down_operations(self, push_down_operations): """ Sets the push_down_operations of this CallOperationConfig. - List of push down operations. + The List of push down operations. :param push_down_operations: The push_down_operations of this CallOperationConfig. diff --git a/src/oci/data_connectivity/models/change_registry_compartment_details.py b/src/oci/data_connectivity/models/change_registry_compartment_details.py index aeec339faa..ef1e9e1222 100644 --- a/src/oci/data_connectivity/models/change_registry_compartment_details.py +++ b/src/oci/data_connectivity/models/change_registry_compartment_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ChangeRegistryCompartmentDetails(object): """ - The information about change compartment action. + The information about the change compartment action. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/column.py b/src/oci/data_connectivity/models/column.py index 05b740632b..de01e39dae 100644 --- a/src/oci/data_connectivity/models/column.py +++ b/src/oci/data_connectivity/models/column.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def name(self): """ Gets the name of this Column. - Column Name. + Column name. :return: The name of this Column. @@ -56,7 +56,7 @@ def name(self): def name(self, name): """ Sets the name of this Column. - Column Name. + Column name. :param name: The name of this Column. diff --git a/src/oci/data_connectivity/models/composite_type.py b/src/oci/data_connectivity/models/composite_type.py index 73b441d5a9..4d038a52f6 100644 --- a/src/oci/data_connectivity/models/composite_type.py +++ b/src/oci/data_connectivity/models/composite_type.py @@ -10,7 +10,7 @@ @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. + 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): diff --git a/src/oci/data_connectivity/models/config_definition.py b/src/oci/data_connectivity/models/config_definition.py index ec1cb13734..a6bb0b5f92 100644 --- a/src/oci/data_connectivity/models/config_definition.py +++ b/src/oci/data_connectivity/models/config_definition.py @@ -178,7 +178,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -190,7 +190,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -202,7 +202,7 @@ def name(self, name): def is_contained(self): """ Gets the is_contained of this ConfigDefinition. - Specifies whether the configuration is contained or not. + Specifies whether the configuration is contained. :return: The is_contained of this ConfigDefinition. @@ -214,7 +214,7 @@ def is_contained(self): def is_contained(self, is_contained): """ Sets the is_contained of this ConfigDefinition. - Specifies whether the configuration is contained or not. + Specifies whether the configuration is contained. :param is_contained: The is_contained of this ConfigDefinition. diff --git a/src/oci/data_connectivity/models/config_details.py b/src/oci/data_connectivity/models/config_details.py new file mode 100644 index 0000000000..16099c1e99 --- /dev/null +++ b/src/oci/data_connectivity/models/config_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 ConfigDetails(object): + """ + The connector-specific engine configurations. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConfigDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param config_map: + The value to assign to the config_map property of this ConfigDetails. + :type config_map: dict(str, str) + + """ + self.swagger_types = { + 'config_map': 'dict(str, str)' + } + + self.attribute_map = { + 'config_map': 'configMap' + } + + self._config_map = None + + @property + def config_map(self): + """ + **[Required]** Gets the config_map of this ConfigDetails. + The connector-specific engine configurations configuration represented in a key-value map. Example - \"spark.sql.catalogImplementation\", \"hive\" + + + :return: The config_map of this ConfigDetails. + :rtype: dict(str, str) + """ + return self._config_map + + @config_map.setter + def config_map(self, config_map): + """ + Sets the config_map of this ConfigDetails. + The connector-specific engine configurations configuration represented in a key-value map. Example - \"spark.sql.catalogImplementation\", \"hive\" + + + :param config_map: The config_map of this ConfigDetails. + :type: dict(str, str) + """ + self._config_map = config_map + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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 index 94275a2761..b2a29e5781 100644 --- a/src/oci/data_connectivity/models/config_parameter_definition.py +++ b/src/oci/data_connectivity/models/config_parameter_definition.py @@ -123,7 +123,7 @@ def parameter_name(self, parameter_name): def description(self): """ Gets the description of this ConfigParameterDefinition. - A user defined description for the object. + A user-defined description for the object. :return: The description of this ConfigParameterDefinition. @@ -135,7 +135,7 @@ def description(self): def description(self, description): """ Sets the description of this ConfigParameterDefinition. - A user defined description for the object. + A user-defined description for the object. :param description: The description of this ConfigParameterDefinition. @@ -195,7 +195,7 @@ def class_field_name(self, class_field_name): def is_static(self): """ Gets the is_static of this ConfigParameterDefinition. - Specifies whether the parameter is static or not. + Specifies whether the parameter is static. :return: The is_static of this ConfigParameterDefinition. @@ -207,7 +207,7 @@ def is_static(self): def is_static(self, is_static): """ Sets the is_static of this ConfigParameterDefinition. - Specifies whether the parameter is static or not. + Specifies whether the parameter is static. :param is_static: The is_static of this ConfigParameterDefinition. @@ -219,7 +219,7 @@ def is_static(self, is_static): 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. + Specifies whether the parameter is a class field. :return: The is_class_field_value of this ConfigParameterDefinition. @@ -231,7 +231,7 @@ def is_class_field_value(self): 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. + Specifies whether the parameter is a class field. :param is_class_field_value: The is_class_field_value of this ConfigParameterDefinition. diff --git a/src/oci/data_connectivity/models/config_values.py b/src/oci/data_connectivity/models/config_values.py index 39e4dac128..ce75dc73fa 100644 --- a/src/oci/data_connectivity/models/config_values.py +++ b/src/oci/data_connectivity/models/config_values.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ConfigValues(object): """ - Configuration values can be string, objects, or parameters. + Configuration values can be a string, objects, or parameters. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/configured_type.py b/src/oci/data_connectivity/models/configured_type.py index 0a03ce3751..9616945b81 100644 --- a/src/oci/data_connectivity/models/configured_type.py +++ b/src/oci/data_connectivity/models/configured_type.py @@ -10,7 +10,7 @@ @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. + A `ConfiguredType` represents a type that has built-in configuration to the type itself. An example is an `SSN` type whose basic type is `VARCHAR`, but the type itself also has a built-in configuration, such as length=10. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/connection.py b/src/oci/data_connectivity/models/connection.py index c0a0c21395..8491f8d43a 100644 --- a/src/oci/data_connectivity/models/connection.py +++ b/src/oci/data_connectivity/models/connection.py @@ -135,7 +135,7 @@ def __init__(self, **kwargs): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :return: The key of this Connection. @@ -147,7 +147,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :param key: The key of this Connection. @@ -207,7 +207,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -219,7 +219,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -303,7 +303,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this Connection. @@ -315,7 +315,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this Connection. @@ -347,7 +347,7 @@ def primary_schema(self, primary_schema): def connection_properties(self): """ Gets the connection_properties of this Connection. - The properties for the connection. + The properties of the connection. :return: The connection_properties of this Connection. @@ -359,7 +359,7 @@ def connection_properties(self): def connection_properties(self, connection_properties): """ Sets the connection_properties of this Connection. - The properties for the connection. + The properties of the connection. :param connection_properties: The connection_properties of this Connection. @@ -371,7 +371,7 @@ def connection_properties(self, connection_properties): def properties(self): """ Gets the properties of this Connection. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :return: The properties of this Connection. @@ -383,7 +383,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this Connection. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :param properties: The properties of this Connection. @@ -419,7 +419,7 @@ def type(self, type): def is_default(self): """ Gets the is_default of this Connection. - The default property for the connection. + The default property of the connection. :return: The is_default of this Connection. @@ -431,7 +431,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this Connection. - The default property for the connection. + The default property of the connection. :param is_default: The is_default of this Connection. diff --git a/src/oci/data_connectivity/models/connection_property.py b/src/oci/data_connectivity/models/connection_property.py index 2ebd5af95b..2edc043dc7 100644 --- a/src/oci/data_connectivity/models/connection_property.py +++ b/src/oci/data_connectivity/models/connection_property.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): 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. + Free form text without any restriction on the 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. @@ -56,7 +56,7 @@ def name(self): 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. + Free form text without any restriction on the 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. diff --git a/src/oci/data_connectivity/models/connection_summary.py b/src/oci/data_connectivity/models/connection_summary.py index dbc655518d..12f8478d64 100644 --- a/src/oci/data_connectivity/models/connection_summary.py +++ b/src/oci/data_connectivity/models/connection_summary.py @@ -135,7 +135,7 @@ def __init__(self, **kwargs): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :return: The key of this ConnectionSummary. @@ -147,7 +147,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :param key: The key of this ConnectionSummary. @@ -207,7 +207,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -219,7 +219,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -303,7 +303,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this ConnectionSummary. @@ -315,7 +315,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this ConnectionSummary. @@ -347,7 +347,7 @@ def primary_schema(self, primary_schema): def connection_properties(self): """ Gets the connection_properties of this ConnectionSummary. - The properties for the connection. + The properties of the connection. :return: The connection_properties of this ConnectionSummary. @@ -359,7 +359,7 @@ def connection_properties(self): def connection_properties(self, connection_properties): """ Sets the connection_properties of this ConnectionSummary. - The properties for the connection. + The properties of the connection. :param connection_properties: The connection_properties of this ConnectionSummary. @@ -371,7 +371,7 @@ def connection_properties(self, connection_properties): def properties(self): """ Gets the properties of this ConnectionSummary. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :return: The properties of this ConnectionSummary. @@ -383,7 +383,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this ConnectionSummary. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :param properties: The properties of this ConnectionSummary. @@ -419,7 +419,7 @@ def type(self, type): def is_default(self): """ Gets the is_default of this ConnectionSummary. - The default property for the connection. + The default property of the connection. :return: The is_default of this ConnectionSummary. @@ -431,7 +431,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this ConnectionSummary. - The default property for the connection. + The default property of the connection. :param is_default: The is_default of this ConnectionSummary. diff --git a/src/oci/data_connectivity/models/connection_summary_collection.py b/src/oci/data_connectivity/models/connection_summary_collection.py index 044c046c18..3dadef3f36 100644 --- a/src/oci/data_connectivity/models/connection_summary_collection.py +++ b/src/oci/data_connectivity/models/connection_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of connection summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/connection_validation.py b/src/oci/data_connectivity/models/connection_validation.py index 0f5ec38773..aabbe2295b 100644 --- a/src/oci/data_connectivity/models/connection_validation.py +++ b/src/oci/data_connectivity/models/connection_validation.py @@ -240,7 +240,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -252,7 +252,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -264,7 +264,7 @@ def name(self, name): def description(self): """ Gets the description of this ConnectionValidation. - Detailed description for the object. + Detailed description of the object. :return: The description of this ConnectionValidation. @@ -276,7 +276,7 @@ def description(self): def description(self, description): """ Sets the description of this ConnectionValidation. - Detailed description for the object. + Detailed description of the object. :param description: The description of this ConnectionValidation. @@ -396,7 +396,7 @@ def data_asset(self, data_asset): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this ConnectionValidation. @@ -408,7 +408,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this ConnectionValidation. diff --git a/src/oci/data_connectivity/models/connection_validation_summary.py b/src/oci/data_connectivity/models/connection_validation_summary.py index f0947dd93b..2ee471510f 100644 --- a/src/oci/data_connectivity/models/connection_validation_summary.py +++ b/src/oci/data_connectivity/models/connection_validation_summary.py @@ -240,7 +240,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -252,7 +252,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -264,7 +264,7 @@ def name(self, name): def description(self): """ Gets the description of this ConnectionValidationSummary. - Detailed description for the object. + Detailed description of the object. :return: The description of this ConnectionValidationSummary. @@ -276,7 +276,7 @@ def description(self): def description(self, description): """ Sets the description of this ConnectionValidationSummary. - Detailed description for the object. + Detailed description of the object. :param description: The description of this ConnectionValidationSummary. @@ -396,7 +396,7 @@ def data_asset(self, data_asset): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this ConnectionValidationSummary. @@ -408,7 +408,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this ConnectionValidationSummary. diff --git a/src/oci/data_connectivity/models/connectivity_usage.py b/src/oci/data_connectivity/models/connectivity_usage.py new file mode 100644 index 0000000000..eb6d5b3ef0 --- /dev/null +++ b/src/oci/data_connectivity/models/connectivity_usage.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 ConnectivityUsage(object): + """ + Contains details of ConnectivityUsage. + """ + + #: A constant which can be used with the status property of a ConnectivityUsage. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + #: A constant which can be used with the status property of a ConnectivityUsage. + #: This constant has a value of "SUCCESS" + STATUS_SUCCESS = "SUCCESS" + + def __init__(self, **kwargs): + """ + Initializes a new ConnectivityUsage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this ConnectivityUsage. + Allowed values for this property are: "FAILED", "SUCCESS" + :type status: str + + :param error_message: + The value to assign to the error_message property of this ConnectivityUsage. + :type error_message: str + + """ + self.swagger_types = { + 'status': 'str', + 'error_message': 'str' + } + + self.attribute_map = { + 'status': 'status', + 'error_message': 'errorMessage' + } + + self._status = None + self._error_message = None + + @property + def status(self): + """ + **[Required]** Gets the status of this ConnectivityUsage. + The status of the usage report/update. + + Allowed values for this property are: "FAILED", "SUCCESS" + + + :return: The status of this ConnectivityUsage. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this ConnectivityUsage. + The status of the usage report/update. + + + :param status: The status of this ConnectivityUsage. + :type: str + """ + allowed_values = ["FAILED", "SUCCESS"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + raise ValueError( + "Invalid value for `status`, must be None or one of {0}" + .format(allowed_values) + ) + self._status = status + + @property + def error_message(self): + """ + Gets the error_message of this ConnectivityUsage. + Error message when usage report/update. + + + :return: The error_message of this ConnectivityUsage. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this ConnectivityUsage. + Error message when usage report/update. + + + :param error_message: The error_message of this ConnectivityUsage. + :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/connectivity_usage_details.py b/src/oci/data_connectivity/models/connectivity_usage_details.py new file mode 100644 index 0000000000..564b8092d7 --- /dev/null +++ b/src/oci/data_connectivity/models/connectivity_usage_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 ConnectivityUsageDetails(object): + """ + Input details to ConnectivityUsage. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ConnectivityUsageDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param connection_key: + The value to assign to the connection_key property of this ConnectivityUsageDetails. + :type connection_key: str + + :param action: + The value to assign to the action property of this ConnectivityUsageDetails. + :type action: str + + :param consuming_service: + The value to assign to the consuming_service property of this ConnectivityUsageDetails. + :type consuming_service: str + + """ + self.swagger_types = { + 'connection_key': 'str', + 'action': 'str', + 'consuming_service': 'str' + } + + self.attribute_map = { + 'connection_key': 'connectionKey', + 'action': 'action', + 'consuming_service': 'consumingService' + } + + self._connection_key = None + self._action = None + self._consuming_service = None + + @property + def connection_key(self): + """ + Gets the connection_key of this ConnectivityUsageDetails. + connection Key. + + + :return: The connection_key of this ConnectivityUsageDetails. + :rtype: str + """ + return self._connection_key + + @connection_key.setter + def connection_key(self, connection_key): + """ + Sets the connection_key of this ConnectivityUsageDetails. + connection Key. + + + :param connection_key: The connection_key of this ConnectivityUsageDetails. + :type: str + """ + self._connection_key = connection_key + + @property + def action(self): + """ + **[Required]** Gets the action of this ConnectivityUsageDetails. + Action type where connection used. + + + :return: The action of this ConnectivityUsageDetails. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this ConnectivityUsageDetails. + Action type where connection used. + + + :param action: The action of this ConnectivityUsageDetails. + :type: str + """ + self._action = action + + @property + def consuming_service(self): + """ + **[Required]** Gets the consuming_service of this ConnectivityUsageDetails. + Consuming serviceType where connection used. + + + :return: The consuming_service of this ConnectivityUsageDetails. + :rtype: str + """ + return self._consuming_service + + @consuming_service.setter + def consuming_service(self, consuming_service): + """ + Sets the consuming_service of this ConnectivityUsageDetails. + Consuming serviceType where connection used. + + + :param consuming_service: The consuming_service of this ConnectivityUsageDetails. + :type: str + """ + self._consuming_service = consuming_service + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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 index 6045f1b0f4..3549d3baaf 100644 --- a/src/oci/data_connectivity/models/connectivity_validation.py +++ b/src/oci/data_connectivity/models/connectivity_validation.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ConnectivityValidation(object): """ - The information about connectivity validation results + The information about connectivity validation results. """ def __init__(self, **kwargs): @@ -65,7 +65,7 @@ def __init__(self, **kwargs): def total_message_count(self): """ **[Required]** Gets the total_message_count of this ConnectivityValidation. - Total number of validation messages + Total number of validation messages. :return: The total_message_count of this ConnectivityValidation. @@ -77,7 +77,7 @@ def total_message_count(self): def total_message_count(self, total_message_count): """ Sets the total_message_count of this ConnectivityValidation. - Total number of validation messages + Total number of validation messages. :param total_message_count: The total_message_count of this ConnectivityValidation. @@ -89,7 +89,7 @@ def total_message_count(self, total_message_count): def error_message_count(self): """ Gets the error_message_count of this ConnectivityValidation. - Total number of validation error messages + Total number of validation error messages. :return: The error_message_count of this ConnectivityValidation. @@ -101,7 +101,7 @@ def error_message_count(self): def error_message_count(self, error_message_count): """ Sets the error_message_count of this ConnectivityValidation. - Total number of validation error messages + Total number of validation error messages. :param error_message_count: The error_message_count of this ConnectivityValidation. @@ -113,7 +113,7 @@ def error_message_count(self, error_message_count): def warn_message_count(self): """ Gets the warn_message_count of this ConnectivityValidation. - Total number of validation warning messages + Total number of validation warning messages. :return: The warn_message_count of this ConnectivityValidation. @@ -125,7 +125,7 @@ def warn_message_count(self): def warn_message_count(self, warn_message_count): """ Sets the warn_message_count of this ConnectivityValidation. - Total number of validation warning messages + Total number of validation warning messages. :param warn_message_count: The warn_message_count of this ConnectivityValidation. @@ -137,7 +137,7 @@ def warn_message_count(self, warn_message_count): def info_message_count(self): """ Gets the info_message_count of this ConnectivityValidation. - Total number of validation information messages + Total number of validation information messages. :return: The info_message_count of this ConnectivityValidation. @@ -149,7 +149,7 @@ def info_message_count(self): def info_message_count(self, info_message_count): """ Sets the info_message_count of this ConnectivityValidation. - Total number of validation information messages + Total number of validation information messages. :param info_message_count: The info_message_count of this ConnectivityValidation. 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 index fc9b9f329a..2e10b189b2 100644 --- a/src/oci/data_connectivity/models/create_attach_data_asset_details.py +++ b/src/oci/data_connectivity/models/create_attach_data_asset_details.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def data_assets(self): """ **[Required]** Gets the data_assets of this CreateAttachDataAssetDetails. - The array of DataAsset keys + The array of DataAsset keys. :return: The data_assets of this CreateAttachDataAssetDetails. @@ -49,7 +49,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this CreateAttachDataAssetDetails. - The array of DataAsset keys + The array of DataAsset keys. :param data_assets: The data_assets of this CreateAttachDataAssetDetails. diff --git a/src/oci/data_connectivity/models/create_connection_details.py b/src/oci/data_connectivity/models/create_connection_details.py index ac7b00ab79..c46418072e 100644 --- a/src/oci/data_connectivity/models/create_connection_details.py +++ b/src/oci/data_connectivity/models/create_connection_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateConnectionDetails(object): """ - Properties used in connection create operations. + Properties used in the create connection operations. """ def __init__(self, **kwargs): @@ -135,7 +135,7 @@ def __init__(self, **kwargs): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :return: The key of this CreateConnectionDetails. @@ -147,7 +147,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create. :param key: The key of this CreateConnectionDetails. @@ -207,7 +207,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -219,7 +219,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -231,7 +231,7 @@ def name(self, name): def description(self): """ Gets the description of this CreateConnectionDetails. - User-defined description for the connection. + User-defined description of the connection. :return: The description of this CreateConnectionDetails. @@ -243,7 +243,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateConnectionDetails. - User-defined description for the connection. + User-defined description of the connection. :param description: The description of this CreateConnectionDetails. @@ -303,7 +303,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateConnectionDetails. @@ -315,7 +315,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateConnectionDetails. @@ -347,7 +347,7 @@ def primary_schema(self, primary_schema): def connection_properties(self): """ Gets the connection_properties of this CreateConnectionDetails. - The properties for the connection. + The properties of the connection. :return: The connection_properties of this CreateConnectionDetails. @@ -359,7 +359,7 @@ def connection_properties(self): def connection_properties(self, connection_properties): """ Sets the connection_properties of this CreateConnectionDetails. - The properties for the connection. + The properties of the connection. :param connection_properties: The connection_properties of this CreateConnectionDetails. @@ -371,7 +371,7 @@ def connection_properties(self, connection_properties): def properties(self): """ **[Required]** Gets the properties of this CreateConnectionDetails. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :return: The properties of this CreateConnectionDetails. @@ -383,7 +383,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this CreateConnectionDetails. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :param properties: The properties of this CreateConnectionDetails. @@ -419,7 +419,7 @@ def type(self, type): def is_default(self): """ Gets the is_default of this CreateConnectionDetails. - The default property for the connection. + The default property of the connection. :return: The is_default of this CreateConnectionDetails. @@ -431,7 +431,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this CreateConnectionDetails. - The default property for the connection. + The default property of the connection. :param is_default: The is_default of this CreateConnectionDetails. diff --git a/src/oci/data_connectivity/models/create_connection_validation_details.py b/src/oci/data_connectivity/models/create_connection_validation_details.py index 4d975147ec..cf076ba9cc 100644 --- a/src/oci/data_connectivity/models/create_connection_validation_details.py +++ b/src/oci/data_connectivity/models/create_connection_validation_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateConnectionValidationDetails(object): """ - The properties used in create connection validation operations. + The properties used in the create connection validation operations. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/create_connectivity_validation_details.py b/src/oci/data_connectivity/models/create_connectivity_validation_details.py index 66e887c809..a1a3f5c25d 100644 --- a/src/oci/data_connectivity/models/create_connectivity_validation_details.py +++ b/src/oci/data_connectivity/models/create_connectivity_validation_details.py @@ -10,7 +10,7 @@ @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. + Input to perform connector validation. Defines the data integration semantics in a data flow. It can be about reading, writing, or transforming the data. """ #: A constant which can be used with the model_type property of a CreateConnectivityValidationDetails. @@ -251,7 +251,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -263,7 +263,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -395,7 +395,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateConnectivityValidationDetails. @@ -407,7 +407,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateConnectivityValidationDetails. diff --git a/src/oci/data_connectivity/models/create_data_asset_details.py b/src/oci/data_connectivity/models/create_data_asset_details.py index fb99894603..4a412cf288 100644 --- a/src/oci/data_connectivity/models/create_data_asset_details.py +++ b/src/oci/data_connectivity/models/create_data_asset_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateDataAssetDetails(object): """ - Properties used in data asset Create operations. + Properties used in the create data asset operations. """ def __init__(self, **kwargs): @@ -149,7 +149,7 @@ def __init__(self, **kwargs): def key(self): """ Gets the key of this CreateDataAssetDetails. - Generated key that can be used in API calls to identify dataasset. + Generated key that can be used in API calls to identify the data asset. :return: The key of this CreateDataAssetDetails. @@ -161,7 +161,7 @@ def key(self): def key(self, key): """ Sets the key of this CreateDataAssetDetails. - Generated key that can be used in API calls to identify dataasset. + Generated key that can be used in API calls to identify the data asset. :param key: The key of this CreateDataAssetDetails. @@ -221,7 +221,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -233,7 +233,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -317,7 +317,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateDataAssetDetails. @@ -329,7 +329,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateDataAssetDetails. @@ -341,7 +341,7 @@ def identifier(self, identifier): def external_key(self): """ Gets the external_key of this CreateDataAssetDetails. - The external key for the object. + The external key of the object. :return: The external_key of this CreateDataAssetDetails. @@ -353,7 +353,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this CreateDataAssetDetails. - The external key for the object. + The external key of the object. :param external_key: The external_key of this CreateDataAssetDetails. 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 index 6994f47f89..e72f76275e 100644 --- a/src/oci/data_connectivity/models/create_de_reference_artifact_details.py +++ b/src/oci/data_connectivity/models/create_de_reference_artifact_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateDeReferenceArtifactDetails(object): """ - Represents the info needed for de-referencing a dcms artifact. + Represents the info required for de-referencing a DCMS artifact. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def service_artifact_id(self): """ **[Required]** Gets the service_artifact_id of this CreateDeReferenceArtifactDetails. - unique id of service which is referencing data asset. + The unique ID of the service that is referencing a data asset. :return: The service_artifact_id of this CreateDeReferenceArtifactDetails. @@ -49,7 +49,7 @@ def service_artifact_id(self): 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. + The unique ID of the service that is referencing a data asset. :param service_artifact_id: The service_artifact_id of this CreateDeReferenceArtifactDetails. 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 index e9d5938366..7bf540be19 100644 --- a/src/oci/data_connectivity/models/create_detach_data_asset_details.py +++ b/src/oci/data_connectivity/models/create_detach_data_asset_details.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def data_assets(self): """ **[Required]** Gets the data_assets of this CreateDetachDataAssetDetails. - The array of DataAsset keys + The array of DataAsset keys. :return: The data_assets of this CreateDetachDataAssetDetails. @@ -49,7 +49,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this CreateDetachDataAssetDetails. - The array of DataAsset keys + The array of DataAsset keys. :param data_assets: The data_assets of this CreateDetachDataAssetDetails. diff --git a/src/oci/data_connectivity/models/create_dp_endpoint_details.py b/src/oci/data_connectivity/models/create_dp_endpoint_details.py index c46575e049..04e01e8dc5 100644 --- a/src/oci/data_connectivity/models/create_dp_endpoint_details.py +++ b/src/oci/data_connectivity/models/create_dp_endpoint_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateDpEndpointDetails(object): """ - Properties used in endpoint create operations. + Properties used in the create operations of the endpoint. """ #: A constant which can be used with the model_type property of a CreateDpEndpointDetails. @@ -162,7 +162,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :return: The key of this CreateDpEndpointDetails. @@ -174,7 +174,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :param key: The key of this CreateDpEndpointDetails. @@ -230,7 +230,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -242,7 +242,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -254,7 +254,7 @@ def name(self, name): def description(self): """ Gets the description of this CreateDpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :return: The description of this CreateDpEndpointDetails. @@ -266,7 +266,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateDpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :param description: The description of this CreateDpEndpointDetails. @@ -326,7 +326,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateDpEndpointDetails. @@ -338,7 +338,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateDpEndpointDetails. @@ -350,7 +350,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this CreateDpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :return: The data_assets of this CreateDpEndpointDetails. @@ -362,7 +362,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this CreateDpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :param data_assets: The data_assets of this CreateDpEndpointDetails. 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 index 30a268c8a7..be4f7d06ed 100644 --- a/src/oci/data_connectivity/models/create_dp_endpoint_from_private.py +++ b/src/oci/data_connectivity/models/create_dp_endpoint_from_private.py @@ -185,7 +185,7 @@ def dcms_endpoint_id(self, dcms_endpoint_id): def pe_id(self): """ Gets the pe_id of this CreateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The pe_id of this CreateDpEndpointFromPrivate. @@ -197,7 +197,7 @@ def pe_id(self): def pe_id(self, pe_id): """ Sets the pe_id of this CreateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param pe_id: The pe_id of this CreateDpEndpointFromPrivate. @@ -209,7 +209,7 @@ def pe_id(self, pe_id): def compartment_id(self): """ Gets the compartment_id of this CreateDpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :return: The compartment_id of this CreateDpEndpointFromPrivate. @@ -221,7 +221,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateDpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :param compartment_id: The compartment_id of this CreateDpEndpointFromPrivate. @@ -233,7 +233,7 @@ def compartment_id(self, compartment_id): def dns_proxy_ip(self): """ Gets the dns_proxy_ip of this CreateDpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :return: The dns_proxy_ip of this CreateDpEndpointFromPrivate. @@ -245,7 +245,7 @@ def dns_proxy_ip(self): def dns_proxy_ip(self, dns_proxy_ip): """ Sets the dns_proxy_ip of this CreateDpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :param dns_proxy_ip: The dns_proxy_ip of this CreateDpEndpointFromPrivate. @@ -257,7 +257,7 @@ def dns_proxy_ip(self, dns_proxy_ip): def private_endpoint_ip(self): """ Gets the private_endpoint_ip of this CreateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The private_endpoint_ip of this CreateDpEndpointFromPrivate. @@ -269,7 +269,7 @@ def private_endpoint_ip(self): def private_endpoint_ip(self, private_endpoint_ip): """ Sets the private_endpoint_ip of this CreateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param private_endpoint_ip: The private_endpoint_ip of this CreateDpEndpointFromPrivate. @@ -281,7 +281,7 @@ def private_endpoint_ip(self, private_endpoint_ip): def dns_zones(self): """ Gets the dns_zones of this CreateDpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :return: The dns_zones of this CreateDpEndpointFromPrivate. @@ -293,7 +293,7 @@ def dns_zones(self): def dns_zones(self, dns_zones): """ Sets the dns_zones of this CreateDpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :param dns_zones: The dns_zones of this CreateDpEndpointFromPrivate. diff --git a/src/oci/data_connectivity/models/create_endpoint_details.py b/src/oci/data_connectivity/models/create_endpoint_details.py index f87abe193e..fe77c15bb3 100644 --- a/src/oci/data_connectivity/models/create_endpoint_details.py +++ b/src/oci/data_connectivity/models/create_endpoint_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateEndpointDetails(object): """ - The information about new Endpoint. + Information about a new endpoint. """ def __init__(self, **kwargs): @@ -100,7 +100,7 @@ def __init__(self, **kwargs): def vcn_id(self): """ Gets the vcn_id of this CreateEndpointDetails. - VCN Identifier where the subnet resides. + VCN identifier where the subnet resides. :return: The vcn_id of this CreateEndpointDetails. @@ -112,7 +112,7 @@ def vcn_id(self): def vcn_id(self, vcn_id): """ Sets the vcn_id of this CreateEndpointDetails. - VCN Identifier where the subnet resides. + VCN identifier where the subnet resides. :param vcn_id: The vcn_id of this CreateEndpointDetails. @@ -124,7 +124,7 @@ def vcn_id(self, vcn_id): def subnet_id(self): """ Gets the subnet_id of this CreateEndpointDetails. - Subnet Identifier for customer connected databases + Subnet identifier for the customer-connected databases. :return: The subnet_id of this CreateEndpointDetails. @@ -136,7 +136,7 @@ def subnet_id(self): def subnet_id(self, subnet_id): """ Sets the subnet_id of this CreateEndpointDetails. - Subnet Identifier for customer connected databases + Subnet identifier for the customer-connected databases. :param subnet_id: The subnet_id of this CreateEndpointDetails. @@ -148,7 +148,7 @@ def subnet_id(self, subnet_id): 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. + The 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 @@ -161,7 +161,7 @@ def dns_zones(self): 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. + The 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 @@ -174,7 +174,7 @@ def dns_zones(self, dns_zones): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -187,7 +187,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -250,7 +250,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this CreateEndpointDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :return: The display_name of this CreateEndpointDetails. @@ -262,7 +262,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateEndpointDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :param display_name: The display_name of this CreateEndpointDetails. @@ -322,7 +322,7 @@ def endpoint_size(self, endpoint_size): def nsg_ids(self): """ Gets the nsg_ids of this CreateEndpointDetails. - List of NSGs to which the Private Endpoint VNIC must be added. + The list of NSGs to which the private endpoint VNIC must be added. :return: The nsg_ids of this CreateEndpointDetails. @@ -334,7 +334,7 @@ def nsg_ids(self): 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. + The list of NSGs to which the private endpoint VNIC must be added. :param nsg_ids: The nsg_ids of this CreateEndpointDetails. diff --git a/src/oci/data_connectivity/models/create_entity_shape_details.py b/src/oci/data_connectivity/models/create_entity_shape_details.py index da9b4c5ba4..ff302572bb 100644 --- a/src/oci/data_connectivity/models/create_entity_shape_details.py +++ b/src/oci/data_connectivity/models/create_entity_shape_details.py @@ -33,6 +33,10 @@ class CreateEntityShapeDetails(object): #: 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 CreateEntityShapeDetails. + #: This constant has a value of "MESSAGE_ENTITY" + MODEL_TYPE_MESSAGE_ENTITY = "MESSAGE_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" @@ -49,12 +53,21 @@ class CreateEntityShapeDetails(object): #: This constant has a value of "SQL" ENTITY_TYPE_SQL = "SQL" + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a CreateEntityShapeDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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.CreateEntityShapeFromMessage` * :class:`~oci.data_connectivity.models.CreateEntityShapeFromTable` * :class:`~oci.data_connectivity.models.CreateEntityShapeFromSQL` * :class:`~oci.data_connectivity.models.CreateEntityShapeFromFile` @@ -64,7 +77,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -101,7 +114,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -209,6 +222,9 @@ def get_subtype(object_dictionary): if type == 'DATA_STORE_ENTITY': return 'CreateEntityShapeFromDataStore' + if type == 'MESSAGE_ENTITY': + return 'CreateEntityShapeFromMessage' + if type == 'TABLE_ENTITY': return 'CreateEntityShapeFromTable' @@ -229,7 +245,7 @@ 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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :return: The model_type of this CreateEntityShapeDetails. @@ -247,7 +263,7 @@ def model_type(self, model_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"] + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_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}" @@ -283,7 +299,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this CreateEntityShapeDetails. - The object's model version. + The model version of the object. :return: The model_version of this CreateEntityShapeDetails. @@ -295,7 +311,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this CreateEntityShapeDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this CreateEntityShapeDetails. @@ -327,7 +343,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -339,7 +355,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -375,7 +391,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this CreateEntityShapeDetails. - The external key for the object. + The external key of the object. :return: The external_key of this CreateEntityShapeDetails. @@ -387,7 +403,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this CreateEntityShapeDetails. - The external key for the object. + The external key of the object. :param external_key: The external_key of this CreateEntityShapeDetails. @@ -445,7 +461,7 @@ def entity_type(self): Gets the entity_type of this CreateEntityShapeDetails. The entity type. - Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this CreateEntityShapeDetails. @@ -463,7 +479,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this CreateEntityShapeDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -595,7 +611,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateEntityShapeDetails. @@ -607,7 +623,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateEntityShapeDetails. 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 index 3b3cca4c05..1f7210d5a0 100644 --- 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 @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -58,7 +58,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: 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 index ece6b7089a..bd943ec3c6 100644 --- a/src/oci/data_connectivity/models/create_entity_shape_from_file.py +++ b/src/oci/data_connectivity/models/create_entity_shape_from_file.py @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -58,7 +58,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: diff --git a/src/oci/data_connectivity/models/create_entity_shape_from_message.py b/src/oci/data_connectivity/models/create_entity_shape_from_message.py new file mode 100644 index 0000000000..a8e8a3f006 --- /dev/null +++ b/src/oci/data_connectivity/models/create_entity_shape_from_message.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 CreateEntityShapeFromMessage(CreateEntityShapeDetails): + """ + The message data entity details. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateEntityShapeFromMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.CreateEntityShapeFromMessage.model_type` attribute + of this class is ``MESSAGE_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 CreateEntityShapeFromMessage. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this CreateEntityShapeFromMessage. + :type key: str + + :param model_version: + The value to assign to the model_version property of this CreateEntityShapeFromMessage. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this CreateEntityShapeFromMessage. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this CreateEntityShapeFromMessage. + :type name: str + + :param object_version: + The value to assign to the object_version property of this CreateEntityShapeFromMessage. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this CreateEntityShapeFromMessage. + :type external_key: str + + :param shape: + The value to assign to the shape property of this CreateEntityShapeFromMessage. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this CreateEntityShapeFromMessage. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this CreateEntityShapeFromMessage. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this CreateEntityShapeFromMessage. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this CreateEntityShapeFromMessage. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this CreateEntityShapeFromMessage. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this CreateEntityShapeFromMessage. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this CreateEntityShapeFromMessage. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this CreateEntityShapeFromMessage. + :type identifier: str + + :param types: + The value to assign to the types property of this CreateEntityShapeFromMessage. + :type types: oci.data_connectivity.models.TypeLibrary + + :param entity_properties: + The value to assign to the entity_properties property of this CreateEntityShapeFromMessage. + :type entity_properties: dict(str, str) + + :param data_format: + The value to assign to the data_format property of this CreateEntityShapeFromMessage. + :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 = 'MESSAGE_ENTITY' + + @property + def data_format(self): + """ + Gets the data_format of this CreateEntityShapeFromMessage. + + :return: The data_format of this CreateEntityShapeFromMessage. + :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 CreateEntityShapeFromMessage. + + :param data_format: The data_format of this CreateEntityShapeFromMessage. + :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 index 2441a3f7ec..a90bc926fe 100644 --- a/src/oci/data_connectivity/models/create_entity_shape_from_sql.py +++ b/src/oci/data_connectivity/models/create_entity_shape_from_sql.py @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -58,7 +58,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: 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 index 7af9530797..3392531cb9 100644 --- a/src/oci/data_connectivity/models/create_entity_shape_from_table.py +++ b/src/oci/data_connectivity/models/create_entity_shape_from_table.py @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -58,7 +58,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: 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 index 28f12f267a..48add97e0d 100644 --- a/src/oci/data_connectivity/models/create_entity_shape_from_view.py +++ b/src/oci/data_connectivity/models/create_entity_shape_from_view.py @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -58,7 +58,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: 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 index f1fd9b58be..b81c8828c2 100644 --- a/src/oci/data_connectivity/models/create_execute_operation_job_details.py +++ b/src/oci/data_connectivity/models/create_execute_operation_job_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateExecuteOperationJobDetails(object): """ - Input details to execute operation. + Input details to execute an operation. """ def __init__(self, **kwargs): @@ -91,7 +91,7 @@ def call_operation_config(self, call_operation_config): def input_records(self): """ Gets the input_records of this CreateExecuteOperationJobDetails. - Collection of input parameters supplied. + Collection of the input parameters supplied. :return: The input_records of this CreateExecuteOperationJobDetails. @@ -103,7 +103,7 @@ def input_records(self): def input_records(self, input_records): """ Sets the input_records of this CreateExecuteOperationJobDetails. - Collection of input parameters supplied. + Collection of the input parameters supplied. :param input_records: The input_records of this CreateExecuteOperationJobDetails. diff --git a/src/oci/data_connectivity/models/create_folder_details.py b/src/oci/data_connectivity/models/create_folder_details.py index 397f077039..65d91096ad 100644 --- a/src/oci/data_connectivity/models/create_folder_details.py +++ b/src/oci/data_connectivity/models/create_folder_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateFolderDetails(object): """ - Properties used in folder create operations. + Properties used in the create operations of the folder. """ def __init__(self, **kwargs): @@ -124,7 +124,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :return: The key of this CreateFolderDetails. @@ -136,7 +136,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :param key: The key of this CreateFolderDetails. @@ -192,7 +192,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -204,7 +204,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -216,7 +216,7 @@ def name(self, name): def description(self): """ Gets the description of this CreateFolderDetails. - User-defined description for the folder. + User-defined description of the folder. :return: The description of this CreateFolderDetails. @@ -228,7 +228,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateFolderDetails. - User-defined description for the folder. + User-defined description of the folder. :param description: The description of this CreateFolderDetails. @@ -288,7 +288,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this CreateFolderDetails. @@ -300,7 +300,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this CreateFolderDetails. @@ -312,7 +312,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this CreateFolderDetails. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :return: The data_assets of this CreateFolderDetails. @@ -324,7 +324,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this CreateFolderDetails. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :param data_assets: The data_assets of this CreateFolderDetails. 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 index e3f0318144..0047ef3ed4 100644 --- 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 @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateFullPushDownTaskDetails(object): """ - The full pushdown task parameter + The full pushdown task parameter. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def model_type(self): """ **[Required]** Gets the model_type of this CreateFullPushDownTaskDetails. - The type of of FullPushDownTask. + The type of FullPushDownTask. :return: The model_type of this CreateFullPushDownTaskDetails. @@ -63,7 +63,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this CreateFullPushDownTaskDetails. - The type of of FullPushDownTask. + The type of FullPushDownTask. :param model_type: The model_type of this CreateFullPushDownTaskDetails. diff --git a/src/oci/data_connectivity/models/create_reference_artifact_details.py b/src/oci/data_connectivity/models/create_reference_artifact_details.py index ca2f36fc39..d89c25bb22 100644 --- a/src/oci/data_connectivity/models/create_reference_artifact_details.py +++ b/src/oci/data_connectivity/models/create_reference_artifact_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateReferenceArtifactDetails(object): """ - Represents the info needed for creating dcms artifact reference. + Represents the info required for creating a DCMS artifact reference. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def service_artifact_id(self): """ **[Required]** Gets the service_artifact_id of this CreateReferenceArtifactDetails. - unique id of service which is referencing data asset. + The unique ID of the service that is referencing a data asset. :return: The service_artifact_id of this CreateReferenceArtifactDetails. @@ -49,7 +49,7 @@ def service_artifact_id(self): 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. + The unique ID of the service that is referencing a data asset. :param service_artifact_id: The service_artifact_id of this CreateReferenceArtifactDetails. diff --git a/src/oci/data_connectivity/models/create_registry_details.py b/src/oci/data_connectivity/models/create_registry_details.py index 23f0d8acf6..908bde3e0d 100644 --- a/src/oci/data_connectivity/models/create_registry_details.py +++ b/src/oci/data_connectivity/models/create_registry_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class CreateRegistryDetails(object): """ - The information about new Registry. + The information about a new Registry. """ def __init__(self, **kwargs): @@ -65,7 +65,7 @@ def __init__(self, **kwargs): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -78,7 +78,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -141,7 +141,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this CreateRegistryDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management Registry display name; registries can be renamed. :return: The display_name of this CreateRegistryDetails. @@ -153,7 +153,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateRegistryDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management Registry display name; registries can be renamed. :param display_name: The display_name of this CreateRegistryDetails. diff --git a/src/oci/data_connectivity/models/csv_format_attribute.py b/src/oci/data_connectivity/models/csv_format_attribute.py index a94165b66c..52449ae7ef 100644 --- a/src/oci/data_connectivity/models/csv_format_attribute.py +++ b/src/oci/data_connectivity/models/csv_format_attribute.py @@ -52,6 +52,18 @@ def __init__(self, **kwargs): The value to assign to the timestamp_format property of this CsvFormatAttribute. :type timestamp_format: str + :param is_quote_all: + The value to assign to the is_quote_all property of this CsvFormatAttribute. + :type is_quote_all: bool + + :param is_multiline: + The value to assign to the is_multiline property of this CsvFormatAttribute. + :type is_multiline: bool + + :param is_trailing_delimiter: + The value to assign to the is_trailing_delimiter property of this CsvFormatAttribute. + :type is_trailing_delimiter: bool + """ self.swagger_types = { 'model_type': 'str', @@ -61,7 +73,10 @@ def __init__(self, **kwargs): 'quote_character': 'str', 'has_header': 'bool', 'is_file_pattern': 'bool', - 'timestamp_format': 'str' + 'timestamp_format': 'str', + 'is_quote_all': 'bool', + 'is_multiline': 'bool', + 'is_trailing_delimiter': 'bool' } self.attribute_map = { @@ -72,7 +87,10 @@ def __init__(self, **kwargs): 'quote_character': 'quoteCharacter', 'has_header': 'hasHeader', 'is_file_pattern': 'isFilePattern', - 'timestamp_format': 'timestampFormat' + 'timestamp_format': 'timestampFormat', + 'is_quote_all': 'isQuoteAll', + 'is_multiline': 'isMultiline', + 'is_trailing_delimiter': 'isTrailingDelimiter' } self._model_type = None @@ -83,6 +101,9 @@ def __init__(self, **kwargs): self._has_header = None self._is_file_pattern = None self._timestamp_format = None + self._is_quote_all = None + self._is_multiline = None + self._is_trailing_delimiter = None self._model_type = 'CSV_FORMAT' @property @@ -253,6 +274,78 @@ def timestamp_format(self, timestamp_format): """ self._timestamp_format = timestamp_format + @property + def is_quote_all(self): + """ + Gets the is_quote_all of this CsvFormatAttribute. + Defines whether the quote entire content while performing read/write. + + + :return: The is_quote_all of this CsvFormatAttribute. + :rtype: bool + """ + return self._is_quote_all + + @is_quote_all.setter + def is_quote_all(self, is_quote_all): + """ + Sets the is_quote_all of this CsvFormatAttribute. + Defines whether the quote entire content while performing read/write. + + + :param is_quote_all: The is_quote_all of this CsvFormatAttribute. + :type: bool + """ + self._is_quote_all = is_quote_all + + @property + def is_multiline(self): + """ + Gets the is_multiline of this CsvFormatAttribute. + Defines whether the file has a multiline content + + + :return: The is_multiline of this CsvFormatAttribute. + :rtype: bool + """ + return self._is_multiline + + @is_multiline.setter + def is_multiline(self, is_multiline): + """ + Sets the is_multiline of this CsvFormatAttribute. + Defines whether the file has a multiline content + + + :param is_multiline: The is_multiline of this CsvFormatAttribute. + :type: bool + """ + self._is_multiline = is_multiline + + @property + def is_trailing_delimiter(self): + """ + Gets the is_trailing_delimiter of this CsvFormatAttribute. + Defines whether the file has a trailing delimiter + + + :return: The is_trailing_delimiter of this CsvFormatAttribute. + :rtype: bool + """ + return self._is_trailing_delimiter + + @is_trailing_delimiter.setter + def is_trailing_delimiter(self, is_trailing_delimiter): + """ + Sets the is_trailing_delimiter of this CsvFormatAttribute. + Defines whether the file has a trailing delimiter + + + :param is_trailing_delimiter: The is_trailing_delimiter of this CsvFormatAttribute. + :type: bool + """ + self._is_trailing_delimiter = is_trailing_delimiter + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/data_asset.py b/src/oci/data_connectivity/models/data_asset.py index cae9dd460f..a2aede94b9 100644 --- a/src/oci/data_connectivity/models/data_asset.py +++ b/src/oci/data_connectivity/models/data_asset.py @@ -149,7 +149,7 @@ def __init__(self, **kwargs): def key(self): """ **[Required]** Gets the key of this DataAsset. - Currently not used on data asset creation. Reserved for future. + Currently not used while creating a data asset. Reserved for future. :return: The key of this DataAsset. @@ -161,7 +161,7 @@ def key(self): def key(self, key): """ Sets the key of this DataAsset. - Currently not used on data asset creation. Reserved for future. + Currently not used while creating a data asset. Reserved for future. :param key: The key of this DataAsset. @@ -221,7 +221,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -233,7 +233,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -317,7 +317,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataAsset. @@ -329,7 +329,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataAsset. @@ -341,7 +341,7 @@ def identifier(self, identifier): def external_key(self): """ Gets the external_key of this DataAsset. - The external key for the object. + The external key of the object. :return: The external_key of this DataAsset. @@ -353,7 +353,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataAsset. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataAsset. diff --git a/src/oci/data_connectivity/models/data_asset_summary.py b/src/oci/data_connectivity/models/data_asset_summary.py index 3b6b1b87b6..8db6080fec 100644 --- a/src/oci/data_connectivity/models/data_asset_summary.py +++ b/src/oci/data_connectivity/models/data_asset_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DataAssetSummary(object): """ - The summary object for data asset. + The summary object of the data asset. """ def __init__(self, **kwargs): @@ -149,7 +149,7 @@ def __init__(self, **kwargs): def key(self): """ **[Required]** Gets the key of this DataAssetSummary. - Currently not used on data asset creation. Reserved for future. + Currently not used while creating a data asset. Reserved for future. :return: The key of this DataAssetSummary. @@ -161,7 +161,7 @@ def key(self): def key(self, key): """ Sets the key of this DataAssetSummary. - Currently not used on data asset creation. Reserved for future. + Currently not used while creating a data asset. Reserved for future. :param key: The key of this DataAssetSummary. @@ -221,7 +221,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -233,7 +233,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -317,7 +317,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataAssetSummary. @@ -329,7 +329,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataAssetSummary. @@ -341,7 +341,7 @@ def identifier(self, identifier): def external_key(self): """ Gets the external_key of this DataAssetSummary. - The external key for the object. + The external key of the object. :return: The external_key of this DataAssetSummary. @@ -353,7 +353,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataAssetSummary. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataAssetSummary. diff --git a/src/oci/data_connectivity/models/data_asset_summary_collection.py b/src/oci/data_connectivity/models/data_asset_summary_collection.py index 1d414e4088..9849cf2134 100644 --- a/src/oci/data_connectivity/models/data_asset_summary_collection.py +++ b/src/oci/data_connectivity/models/data_asset_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of data asset summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/data_entity.py b/src/oci/data_connectivity/models/data_entity.py index 4003a4dc5c..b66a0b06ea 100644 --- a/src/oci/data_connectivity/models/data_entity.py +++ b/src/oci/data_connectivity/models/data_entity.py @@ -33,6 +33,14 @@ class DataEntity(object): #: 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 DataEntity. + #: This constant has a value of "DERIVED_ENTITY" + MODEL_TYPE_DERIVED_ENTITY = "DERIVED_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntity. + #: This constant has a value of "MESSAGE_ENTITY" + MODEL_TYPE_MESSAGE_ENTITY = "MESSAGE_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 @@ -43,12 +51,17 @@ def __init__(self, **kwargs): * :class:`~oci.data_connectivity.models.DataEntityFromView` * :class:`~oci.data_connectivity.models.DataEntityFromSql` * :class:`~oci.data_connectivity.models.DataEntityFromFile` + * :class:`~oci.data_connectivity.models.DerivedEntity` The following keyword arguments are supported (corresponding to the getters/setters of this class): + :param entity_properties: + The value to assign to the entity_properties property of this DataEntity. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -58,15 +71,18 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata' } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata' } + self._entity_properties = None self._model_type = None self._metadata = None @@ -92,16 +108,43 @@ def get_subtype(object_dictionary): if type == 'FILE_ENTITY': return 'DataEntityFromFile' + + if type == 'DERIVED_ENTITY': + return 'DerivedEntity' else: return 'DataEntity' + @property + def entity_properties(self): + """ + Gets the entity_properties of this DataEntity. + Map for entity properties + + + :return: The entity_properties of this DataEntity. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this DataEntity. + Map for entity properties + + + :param entity_properties: The entity_properties of this DataEntity. + :type: dict(str, str) + """ + self._entity_properties = entity_properties + @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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -120,7 +163,7 @@ def model_type(self, model_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"] + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY"] if not value_allowed_none_or_none_sentinel(model_type, allowed_values): model_type = 'UNKNOWN_ENUM_VALUE' self._model_type = model_type diff --git a/src/oci/data_connectivity/models/data_entity_details.py b/src/oci/data_connectivity/models/data_entity_details.py index e4658d948f..7fe72a9fe6 100644 --- a/src/oci/data_connectivity/models/data_entity_details.py +++ b/src/oci/data_connectivity/models/data_entity_details.py @@ -33,6 +33,14 @@ class DataEntityDetails(object): #: 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 DataEntityDetails. + #: This constant has a value of "DERIVED_ENTITY" + MODEL_TYPE_DERIVED_ENTITY = "DERIVED_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntityDetails. + #: This constant has a value of "MESSAGE_ENTITY" + MODEL_TYPE_MESSAGE_ENTITY = "MESSAGE_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 @@ -42,13 +50,14 @@ def __init__(self, **kwargs): * :class:`~oci.data_connectivity.models.DataEntityFromViewEntityDetails` * :class:`~oci.data_connectivity.models.DataEntityFromSqlEntityDetails` * :class:`~oci.data_connectivity.models.DataEntityFromDataStoreEntityDetails` + * :class:`~oci.data_connectivity.models.DataEntityFromMessageEntityDetails` * :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str """ @@ -82,6 +91,9 @@ def get_subtype(object_dictionary): if type == 'DATA_STORE_ENTITY': return 'DataEntityFromDataStoreEntityDetails' + if type == 'MESSAGE_ENTITY': + return 'DataEntityFromMessageEntityDetails' + if type == 'TABLE_ENTITY': return 'DataEntityFromTableEntityDetails' else: @@ -93,7 +105,7 @@ 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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :return: The model_type of this DataEntityDetails. @@ -111,7 +123,7 @@ def model_type(self, model_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"] + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_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}" 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 index f8028e3fa9..cee41fa020 100644 --- a/src/oci/data_connectivity/models/data_entity_from_data_store.py +++ b/src/oci/data_connectivity/models/data_entity_from_data_store.py @@ -33,15 +33,23 @@ class DataEntityFromDataStore(DataEntity): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromDataStore. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 entity_properties: + The value to assign to the entity_properties property of this DataEntityFromDataStore. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +95,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -137,6 +145,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -163,6 +172,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -188,6 +198,7 @@ def __init__(self, **kwargs): 'supports_incremental': 'supportsIncremental' } + self._entity_properties = None self._model_type = None self._metadata = None self._key = None @@ -241,7 +252,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromDataStore. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromDataStore. @@ -253,7 +264,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromDataStore. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromDataStore. @@ -285,7 +296,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -297,7 +308,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -309,7 +320,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromDataStore. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromDataStore. @@ -321,7 +332,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromDataStore. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromDataStore. @@ -357,7 +368,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromDataStore. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromDataStore. @@ -369,7 +380,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromDataStore. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromDataStore. @@ -427,7 +438,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -446,7 +457,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromDataStore. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -575,7 +586,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromDataStore. @@ -587,7 +598,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromDataStore. @@ -599,7 +610,7 @@ def identifier(self, identifier): def filters(self): """ Gets the filters of this DataEntityFromDataStore. - Filters present in the Datastore. It can be Null. + Filters present in the datastore. It can be null. :return: The filters of this DataEntityFromDataStore. @@ -611,7 +622,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this DataEntityFromDataStore. - Filters present in the Datastore. It can be Null. + Filters present in the datastore. It can be null. :param filters: The filters of this DataEntityFromDataStore. @@ -623,7 +634,7 @@ def filters(self, filters): def is_effective_date_disabled(self): """ Gets the is_effective_date_disabled of this DataEntityFromDataStore. - It shows whether or not effective date is disabled + It shows whether the effective date is disabled. :return: The is_effective_date_disabled of this DataEntityFromDataStore. @@ -635,7 +646,7 @@ def is_effective_date_disabled(self): 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 + It shows whether the effective date is disabled. :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntityFromDataStore. @@ -647,7 +658,7 @@ def is_effective_date_disabled(self, is_effective_date_disabled): def is_flex_data_store(self): """ Gets the is_flex_data_store of this DataEntityFromDataStore. - It shows whether the datastore is of flex type + It shows whether the datastore is of flex type. :return: The is_flex_data_store of this DataEntityFromDataStore. @@ -659,7 +670,7 @@ def is_flex_data_store(self): 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 + It shows whether the datastore is of flex type. :param is_flex_data_store: The is_flex_data_store of this DataEntityFromDataStore. @@ -671,7 +682,7 @@ def is_flex_data_store(self, is_flex_data_store): 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 + It shows whether the extraction of this datastore will stop when an error occurs. :return: The is_silent_error of this DataEntityFromDataStore. @@ -683,7 +694,7 @@ def is_silent_error(self): 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 + It shows whether the extraction of this datastore will stop when an error occurs. :param is_silent_error: The is_silent_error of this DataEntityFromDataStore. @@ -695,7 +706,7 @@ def is_silent_error(self, is_silent_error): def supports_incremental(self): """ Gets the supports_incremental of this DataEntityFromDataStore. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :return: The supports_incremental of this DataEntityFromDataStore. @@ -707,7 +718,7 @@ def supports_incremental(self): def supports_incremental(self, supports_incremental): """ Sets the supports_incremental of this DataEntityFromDataStore. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :param supports_incremental: The supports_incremental of this DataEntityFromDataStore. 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 index bcafafd71c..9cc72aea1c 100644 --- 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 @@ -33,6 +33,10 @@ class DataEntityFromDataStoreEntityDetails(DataEntityDetails): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -82,7 +86,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -232,7 +236,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromDataStoreEntityDetails. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromDataStoreEntityDetails. @@ -244,7 +248,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromDataStoreEntityDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromDataStoreEntityDetails. @@ -276,7 +280,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -288,7 +292,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -300,7 +304,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromDataStoreEntityDetails. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromDataStoreEntityDetails. @@ -312,7 +316,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromDataStoreEntityDetails. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromDataStoreEntityDetails. @@ -348,7 +352,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromDataStoreEntityDetails. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromDataStoreEntityDetails. @@ -360,7 +364,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromDataStoreEntityDetails. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromDataStoreEntityDetails. @@ -418,7 +422,7 @@ 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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this DataEntityFromDataStoreEntityDetails. @@ -436,7 +440,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromDataStoreEntityDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -568,7 +572,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromDataStoreEntityDetails. @@ -580,7 +584,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromDataStoreEntityDetails. @@ -592,7 +596,7 @@ def identifier(self, identifier): def filters(self): """ Gets the filters of this DataEntityFromDataStoreEntityDetails. - Filters present in the Datastore. It can be Null. + Filters present in the datastore. It can be null. :return: The filters of this DataEntityFromDataStoreEntityDetails. @@ -604,7 +608,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this DataEntityFromDataStoreEntityDetails. - Filters present in the Datastore. It can be Null. + Filters present in the datastore. It can be null. :param filters: The filters of this DataEntityFromDataStoreEntityDetails. @@ -616,7 +620,7 @@ def filters(self, filters): def is_effective_date_disabled(self): """ Gets the is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. - It shows whether or not effective date is disabled + It shows whether the effective date is disabled. :return: The is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. @@ -628,7 +632,7 @@ def is_effective_date_disabled(self): 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 + It shows whether the effective date is disabled. :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. @@ -640,7 +644,7 @@ def is_effective_date_disabled(self, is_effective_date_disabled): def is_flex_data_store(self): """ Gets the is_flex_data_store of this DataEntityFromDataStoreEntityDetails. - It shows whether the datastore is of flex type + It shows whether the datastore is of flex type.. :return: The is_flex_data_store of this DataEntityFromDataStoreEntityDetails. @@ -652,7 +656,7 @@ def is_flex_data_store(self): 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 + It shows whether the datastore is of flex type.. :param is_flex_data_store: The is_flex_data_store of this DataEntityFromDataStoreEntityDetails. @@ -664,7 +668,7 @@ def is_flex_data_store(self, is_flex_data_store): 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 + It shows whether the extraction of this datastore will stop when an error occurs. :return: The is_silent_error of this DataEntityFromDataStoreEntityDetails. @@ -676,7 +680,7 @@ def is_silent_error(self): 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 + It shows whether the extraction of this datastore will stop when an error occurs. :param is_silent_error: The is_silent_error of this DataEntityFromDataStoreEntityDetails. @@ -688,7 +692,7 @@ def is_silent_error(self, is_silent_error): def supports_incremental(self): """ Gets the supports_incremental of this DataEntityFromDataStoreEntityDetails. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :return: The supports_incremental of this DataEntityFromDataStoreEntityDetails. @@ -700,7 +704,7 @@ def supports_incremental(self): def supports_incremental(self, supports_incremental): """ Sets the supports_incremental of this DataEntityFromDataStoreEntityDetails. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :param supports_incremental: The supports_incremental of this DataEntityFromDataStoreEntityDetails. diff --git a/src/oci/data_connectivity/models/data_entity_from_file.py b/src/oci/data_connectivity/models/data_entity_from_file.py index 46d7379268..b6890bebf2 100644 --- a/src/oci/data_connectivity/models/data_entity_from_file.py +++ b/src/oci/data_connectivity/models/data_entity_from_file.py @@ -33,15 +33,23 @@ class DataEntityFromFile(DataEntity): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromFile. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 entity_properties: + The value to assign to the entity_properties property of this DataEntityFromFile. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +95,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -121,6 +129,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -143,6 +152,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -164,6 +174,7 @@ def __init__(self, **kwargs): 'identifier': 'identifier' } + self._entity_properties = None self._model_type = None self._metadata = None self._key = None @@ -213,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromFile. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromFile. @@ -225,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromFile. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromFile. @@ -257,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromFile. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromFile. @@ -293,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromFile. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromFile. @@ -329,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromFile. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntityFromFile. @@ -341,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromFile. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntityFromFile. @@ -399,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromFile. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromFile. @@ -579,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromFile. 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 index b1ea92bd55..76652c7e4a 100644 --- 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 @@ -33,6 +33,10 @@ class DataEntityFromFileEntityDetails(DataEntityDetails): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromFileEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -82,7 +86,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -204,7 +208,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromFileEntityDetails. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromFileEntityDetails. @@ -216,7 +220,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromFileEntityDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromFileEntityDetails. @@ -248,7 +252,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -260,7 +264,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -272,7 +276,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromFileEntityDetails. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromFileEntityDetails. @@ -284,7 +288,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromFileEntityDetails. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromFileEntityDetails. @@ -320,7 +324,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromFileEntityDetails. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntityFromFileEntityDetails. @@ -332,7 +336,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromFileEntityDetails. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntityFromFileEntityDetails. @@ -390,7 +394,7 @@ 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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this DataEntityFromFileEntityDetails. @@ -408,7 +412,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromFileEntityDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -560,7 +564,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromFileEntityDetails. @@ -572,7 +576,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromFileEntityDetails. diff --git a/src/oci/data_connectivity/models/data_entity_from_message_entity_details.py b/src/oci/data_connectivity/models/data_entity_from_message_entity_details.py new file mode 100644 index 0000000000..b422200780 --- /dev/null +++ b/src/oci/data_connectivity/models/data_entity_from_message_entity_details.py @@ -0,0 +1,597 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/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 DataEntityFromMessageEntityDetails(DataEntityDetails): + """ + The message data entity details. + """ + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a DataEntityFromMessageEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + + def __init__(self, **kwargs): + """ + Initializes a new DataEntityFromMessageEntityDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DataEntityFromMessageEntityDetails.model_type` attribute + of this class is ``MESSAGE_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 DataEntityFromMessageEntityDetails. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" + :type model_type: str + + :param key: + The value to assign to the key property of this DataEntityFromMessageEntityDetails. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DataEntityFromMessageEntityDetails. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DataEntityFromMessageEntityDetails. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DataEntityFromMessageEntityDetails. + :type name: str + + :param description: + The value to assign to the description property of this DataEntityFromMessageEntityDetails. + :type description: str + + :param object_version: + The value to assign to the object_version property of this DataEntityFromMessageEntityDetails. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this DataEntityFromMessageEntityDetails. + :type external_key: str + + :param shape: + The value to assign to the shape property of this DataEntityFromMessageEntityDetails. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DataEntityFromMessageEntityDetails. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this DataEntityFromMessageEntityDetails. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" + :type entity_type: str + + :param other_type_label: + The value to assign to the other_type_label property of this DataEntityFromMessageEntityDetails. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this DataEntityFromMessageEntityDetails. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this DataEntityFromMessageEntityDetails. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this DataEntityFromMessageEntityDetails. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this DataEntityFromMessageEntityDetails. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this DataEntityFromMessageEntityDetails. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DataEntityFromMessageEntityDetails. + :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 = 'MESSAGE_ENTITY' + + @property + def key(self): + """ + Gets the key of this DataEntityFromMessageEntityDetails. + The object key. + + + :return: The key of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DataEntityFromMessageEntityDetails. + The object key. + + + :param key: The key of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DataEntityFromMessageEntityDetails. + The model version of the object. + + + :return: The model_version of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DataEntityFromMessageEntityDetails. + The model version of the object. + + + :param model_version: The model_version of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DataEntityFromMessageEntityDetails. + + :return: The parent_ref of this DataEntityFromMessageEntityDetails. + :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 DataEntityFromMessageEntityDetails. + + :param parent_ref: The parent_ref of this DataEntityFromMessageEntityDetails. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this DataEntityFromMessageEntityDetails. + Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :return: The name of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DataEntityFromMessageEntityDetails. + Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :param name: The name of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this DataEntityFromMessageEntityDetails. + Detailed description of the object. + + + :return: The description of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DataEntityFromMessageEntityDetails. + Detailed description of the object. + + + :param description: The description of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this DataEntityFromMessageEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DataEntityFromMessageEntityDetails. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DataEntityFromMessageEntityDetails. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DataEntityFromMessageEntityDetails. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this DataEntityFromMessageEntityDetails. + The external key of the object. + + + :return: The external_key of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this DataEntityFromMessageEntityDetails. + The external key of the object. + + + :param external_key: The external_key of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this DataEntityFromMessageEntityDetails. + + :return: The shape of this DataEntityFromMessageEntityDetails. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DataEntityFromMessageEntityDetails. + + :param shape: The shape of this DataEntityFromMessageEntityDetails. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DataEntityFromMessageEntityDetails. + The shape ID. + + + :return: The shape_id of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DataEntityFromMessageEntityDetails. + The shape ID. + + + :param shape_id: The shape_id of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this DataEntityFromMessageEntityDetails. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" + + + :return: The entity_type of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this DataEntityFromMessageEntityDetails. + The entity type. + + + :param entity_type: The entity_type of this DataEntityFromMessageEntityDetails. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] + 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 DataEntityFromMessageEntityDetails. + Specifies other type label. + + + :return: The other_type_label of this DataEntityFromMessageEntityDetails. + :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 DataEntityFromMessageEntityDetails. + Specifies other type label. + + + :param other_type_label: The other_type_label of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this DataEntityFromMessageEntityDetails. + An array of unique keys. + + + :return: The unique_keys of this DataEntityFromMessageEntityDetails. + :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 DataEntityFromMessageEntityDetails. + An array of unique keys. + + + :param unique_keys: The unique_keys of this DataEntityFromMessageEntityDetails. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this DataEntityFromMessageEntityDetails. + An array of foreign keys. + + + :return: The foreign_keys of this DataEntityFromMessageEntityDetails. + :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 DataEntityFromMessageEntityDetails. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this DataEntityFromMessageEntityDetails. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this DataEntityFromMessageEntityDetails. + The resource name. + + + :return: The resource_name of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DataEntityFromMessageEntityDetails. + The resource name. + + + :param resource_name: The resource_name of this DataEntityFromMessageEntityDetails. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this DataEntityFromMessageEntityDetails. + + :return: The data_format of this DataEntityFromMessageEntityDetails. + :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 DataEntityFromMessageEntityDetails. + + :param data_format: The data_format of this DataEntityFromMessageEntityDetails. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this DataEntityFromMessageEntityDetails. + 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 DataEntityFromMessageEntityDetails. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DataEntityFromMessageEntityDetails. + 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 DataEntityFromMessageEntityDetails. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DataEntityFromMessageEntityDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. + + + :return: The identifier of this DataEntityFromMessageEntityDetails. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DataEntityFromMessageEntityDetails. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this DataEntityFromMessageEntityDetails. + :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 index ac581afaa5..e78c13e818 100644 --- a/src/oci/data_connectivity/models/data_entity_from_sql.py +++ b/src/oci/data_connectivity/models/data_entity_from_sql.py @@ -29,15 +29,27 @@ class DataEntityFromSql(DataEntity): #: This constant has a value of "SQL" ENTITY_TYPE_SQL = "SQL" + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSql. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 entity_properties: + The value to assign to the entity_properties property of this DataEntityFromSql. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -83,7 +95,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -117,6 +129,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -139,6 +152,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -160,6 +174,7 @@ def __init__(self, **kwargs): 'sql_query': 'sqlQuery' } + self._entity_properties = None self._model_type = None self._metadata = None self._key = None @@ -209,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromSql. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromSql. @@ -221,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromSql. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromSql. @@ -253,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -265,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -277,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromSql. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromSql. @@ -289,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromSql. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromSql. @@ -325,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromSql. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromSql. @@ -337,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromSql. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromSql. @@ -395,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -414,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromSql. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -543,7 +558,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromSql. @@ -555,7 +570,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromSql. 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 index aa0b85824f..8996533225 100644 --- 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 @@ -29,6 +29,14 @@ class DataEntityFromSqlEntityDetails(DataEntityDetails): #: This constant has a value of "SQL" ENTITY_TYPE_SQL = "SQL" + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a DataEntityFromSqlEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -37,7 +45,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -78,7 +86,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -200,7 +208,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromSqlEntityDetails. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromSqlEntityDetails. @@ -212,7 +220,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromSqlEntityDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromSqlEntityDetails. @@ -244,7 +252,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -256,7 +264,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -268,7 +276,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromSqlEntityDetails. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromSqlEntityDetails. @@ -280,7 +288,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromSqlEntityDetails. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromSqlEntityDetails. @@ -316,7 +324,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromSqlEntityDetails. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromSqlEntityDetails. @@ -328,7 +336,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromSqlEntityDetails. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromSqlEntityDetails. @@ -386,7 +394,7 @@ def entity_type(self): Gets the entity_type of this DataEntityFromSqlEntityDetails. The entity type. - Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this DataEntityFromSqlEntityDetails. @@ -404,7 +412,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromSqlEntityDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -536,7 +544,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromSqlEntityDetails. @@ -548,7 +556,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromSqlEntityDetails. diff --git a/src/oci/data_connectivity/models/data_entity_from_table.py b/src/oci/data_connectivity/models/data_entity_from_table.py index 214203228f..d31b88fd0d 100644 --- a/src/oci/data_connectivity/models/data_entity_from_table.py +++ b/src/oci/data_connectivity/models/data_entity_from_table.py @@ -33,15 +33,23 @@ class DataEntityFromTable(DataEntity): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromTable. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 entity_properties: + The value to assign to the entity_properties property of this DataEntityFromTable. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +95,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -117,6 +125,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -138,6 +147,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -158,6 +168,7 @@ def __init__(self, **kwargs): 'identifier': 'identifier' } + self._entity_properties = None self._model_type = None self._metadata = None self._key = None @@ -206,7 +217,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromTable. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromTable. @@ -218,7 +229,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromTable. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromTable. @@ -250,7 +261,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -262,7 +273,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -274,7 +285,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromTable. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromTable. @@ -286,7 +297,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromTable. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromTable. @@ -322,7 +333,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromTable. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntityFromTable. @@ -334,7 +345,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromTable. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntityFromTable. @@ -392,7 +403,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -411,7 +422,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromTable. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -540,7 +551,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromTable. @@ -552,7 +563,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromTable. 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 index b54ea018d0..49fa878e83 100644 --- 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 @@ -33,6 +33,10 @@ class DataEntityFromTableEntityDetails(DataEntityDetails): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromTableEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -82,7 +86,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -197,7 +201,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromTableEntityDetails. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromTableEntityDetails. @@ -209,7 +213,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromTableEntityDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromTableEntityDetails. @@ -241,7 +245,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -253,7 +257,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -265,7 +269,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromTableEntityDetails. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromTableEntityDetails. @@ -277,7 +281,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromTableEntityDetails. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromTableEntityDetails. @@ -313,7 +317,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromTableEntityDetails. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntityFromTableEntityDetails. @@ -325,7 +329,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromTableEntityDetails. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntityFromTableEntityDetails. @@ -383,7 +387,7 @@ 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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this DataEntityFromTableEntityDetails. @@ -401,7 +405,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromTableEntityDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -533,7 +537,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromTableEntityDetails. @@ -545,7 +549,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromTableEntityDetails. diff --git a/src/oci/data_connectivity/models/data_entity_from_view.py b/src/oci/data_connectivity/models/data_entity_from_view.py index 81c0ed68a3..44d2443310 100644 --- a/src/oci/data_connectivity/models/data_entity_from_view.py +++ b/src/oci/data_connectivity/models/data_entity_from_view.py @@ -33,15 +33,23 @@ class DataEntityFromView(DataEntity): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromView. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 entity_properties: + The value to assign to the entity_properties property of this DataEntityFromView. + :type entity_properties: dict(str, str) + :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +95,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -117,6 +125,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'entity_properties': 'dict(str, str)', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -138,6 +147,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'entity_properties': 'entityProperties', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -158,6 +168,7 @@ def __init__(self, **kwargs): 'identifier': 'identifier' } + self._entity_properties = None self._model_type = None self._metadata = None self._key = None @@ -206,7 +217,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromView. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromView. @@ -218,7 +229,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromView. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromView. @@ -250,7 +261,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -262,7 +273,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -274,7 +285,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromView. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromView. @@ -286,7 +297,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromView. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromView. @@ -322,7 +333,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromView. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromView. @@ -334,7 +345,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromView. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromView. @@ -392,7 +403,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -411,7 +422,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromView. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -540,7 +551,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromView. @@ -552,7 +563,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromView. 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 index 623d96e839..f4f0389b4f 100644 --- 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 @@ -33,6 +33,10 @@ class DataEntityFromViewEntityDetails(DataEntityDetails): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntityFromViewEntityDetails. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY" :type model_type: str :param key: @@ -82,7 +86,7 @@ def __init__(self, **kwargs): :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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :type entity_type: str :param other_type_label: @@ -197,7 +201,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntityFromViewEntityDetails. - The object's model version. + The model version of the object. :return: The model_version of this DataEntityFromViewEntityDetails. @@ -209,7 +213,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntityFromViewEntityDetails. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntityFromViewEntityDetails. @@ -241,7 +245,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -253,7 +257,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -265,7 +269,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntityFromViewEntityDetails. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntityFromViewEntityDetails. @@ -277,7 +281,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntityFromViewEntityDetails. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntityFromViewEntityDetails. @@ -313,7 +317,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntityFromViewEntityDetails. - The external key for the object + The external key of the object. :return: The external_key of this DataEntityFromViewEntityDetails. @@ -325,7 +329,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntityFromViewEntityDetails. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntityFromViewEntityDetails. @@ -383,7 +387,7 @@ 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" + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE" :return: The entity_type of this DataEntityFromViewEntityDetails. @@ -401,7 +405,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntityFromViewEntityDetails. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] 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}" @@ -533,7 +537,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntityFromViewEntityDetails. @@ -545,7 +549,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntityFromViewEntityDetails. diff --git a/src/oci/data_connectivity/models/data_entity_summary.py b/src/oci/data_connectivity/models/data_entity_summary.py index 3dc55f7287..3967494473 100644 --- a/src/oci/data_connectivity/models/data_entity_summary.py +++ b/src/oci/data_connectivity/models/data_entity_summary.py @@ -33,6 +33,14 @@ class DataEntitySummary(object): #: 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 DataEntitySummary. + #: This constant has a value of "DERIVED_ENTITY" + MODEL_TYPE_DERIVED_ENTITY = "DERIVED_ENTITY" + + #: A constant which can be used with the model_type property of a DataEntitySummary. + #: This constant has a value of "MESSAGE_ENTITY" + MODEL_TYPE_MESSAGE_ENTITY = "MESSAGE_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 @@ -48,7 +56,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -101,7 +109,7 @@ 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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -120,7 +128,7 @@ def model_type(self, model_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"] + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY"] if not value_allowed_none_or_none_sentinel(model_type, allowed_values): model_type = 'UNKNOWN_ENUM_VALUE' self._model_type = model_type diff --git a/src/oci/data_connectivity/models/data_entity_summary_collection.py b/src/oci/data_connectivity/models/data_entity_summary_collection.py index d212b9ba24..fce35d222f 100644 --- a/src/oci/data_connectivity/models/data_entity_summary_collection.py +++ b/src/oci/data_connectivity/models/data_entity_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of data entity summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): 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 index a0da1fd3ec..1815fcd90c 100644 --- 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 @@ -33,6 +33,10 @@ class DataEntitySummaryFromDataStore(DataEntitySummary): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromDataStore. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -241,7 +245,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntitySummaryFromDataStore. - The object's model version. + The model version of the object. :return: The model_version of this DataEntitySummaryFromDataStore. @@ -253,7 +257,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntitySummaryFromDataStore. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntitySummaryFromDataStore. @@ -285,7 +289,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -297,7 +301,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -309,7 +313,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntitySummaryFromDataStore. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntitySummaryFromDataStore. @@ -321,7 +325,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntitySummaryFromDataStore. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntitySummaryFromDataStore. @@ -357,7 +361,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntitySummaryFromDataStore. - The external key for the object + The external key of the object. :return: The external_key of this DataEntitySummaryFromDataStore. @@ -369,7 +373,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntitySummaryFromDataStore. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntitySummaryFromDataStore. @@ -427,7 +431,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -446,7 +450,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntitySummaryFromDataStore. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -575,7 +579,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntitySummaryFromDataStore. @@ -587,7 +591,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntitySummaryFromDataStore. @@ -599,7 +603,7 @@ def identifier(self, identifier): def filters(self): """ Gets the filters of this DataEntitySummaryFromDataStore. - Query filter for the extract. It can be Null. + Query filter for the extract. It can be null. :return: The filters of this DataEntitySummaryFromDataStore. @@ -611,7 +615,7 @@ def filters(self): def filters(self, filters): """ Sets the filters of this DataEntitySummaryFromDataStore. - Query filter for the extract. It can be Null. + Query filter for the extract. It can be null. :param filters: The filters of this DataEntitySummaryFromDataStore. @@ -623,7 +627,7 @@ def filters(self, filters): def is_effective_date_disabled(self): """ Gets the is_effective_date_disabled of this DataEntitySummaryFromDataStore. - It shows whether or not effective date is disabled + It shows whether the effective date is disabled. :return: The is_effective_date_disabled of this DataEntitySummaryFromDataStore. @@ -635,7 +639,7 @@ def is_effective_date_disabled(self): 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 + It shows whether the effective date is disabled. :param is_effective_date_disabled: The is_effective_date_disabled of this DataEntitySummaryFromDataStore. @@ -647,7 +651,7 @@ def is_effective_date_disabled(self, is_effective_date_disabled): 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 + Is a flex data store. Metadata CSV will be generated for a flex data store. :return: The is_flex_data_store of this DataEntitySummaryFromDataStore. @@ -659,7 +663,7 @@ def is_flex_data_store(self): 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 + Is a flex data store. Metadata CSV will be generated for a flex data store. :param is_flex_data_store: The is_flex_data_store of this DataEntitySummaryFromDataStore. @@ -695,7 +699,7 @@ def is_silent_error(self, is_silent_error): def supports_incremental(self): """ Gets the supports_incremental of this DataEntitySummaryFromDataStore. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :return: The supports_incremental of this DataEntitySummaryFromDataStore. @@ -707,7 +711,7 @@ def supports_incremental(self): def supports_incremental(self, supports_incremental): """ Sets the supports_incremental of this DataEntitySummaryFromDataStore. - It shows whether the datastore supports Incremental Extract or not. + It shows whether the datastore supports incremental extract. :param supports_incremental: The supports_incremental of this DataEntitySummaryFromDataStore. 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 index 2ac6929ce9..a3e599c971 100644 --- a/src/oci/data_connectivity/models/data_entity_summary_from_file.py +++ b/src/oci/data_connectivity/models/data_entity_summary_from_file.py @@ -33,6 +33,10 @@ class DataEntitySummaryFromFile(DataEntitySummary): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromFile. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -213,7 +217,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntitySummaryFromFile. - The object's model version. + The model version of the object. :return: The model_version of this DataEntitySummaryFromFile. @@ -225,7 +229,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntitySummaryFromFile. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntitySummaryFromFile. @@ -257,7 +261,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +273,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +285,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntitySummaryFromFile. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntitySummaryFromFile. @@ -293,7 +297,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntitySummaryFromFile. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntitySummaryFromFile. @@ -329,7 +333,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntitySummaryFromFile. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntitySummaryFromFile. @@ -341,7 +345,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntitySummaryFromFile. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntitySummaryFromFile. @@ -399,7 +403,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +422,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntitySummaryFromFile. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +571,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntitySummaryFromFile. @@ -579,7 +583,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntitySummaryFromFile. 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 index d8db004501..21c80c9e15 100644 --- a/src/oci/data_connectivity/models/data_entity_summary_from_sql.py +++ b/src/oci/data_connectivity/models/data_entity_summary_from_sql.py @@ -29,6 +29,14 @@ class DataEntitySummaryFromSql(DataEntitySummary): #: This constant has a value of "SQL" ENTITY_TYPE_SQL = "SQL" + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromSql. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -37,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -83,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -209,7 +217,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntitySummaryFromSql. - The object's model version. + The model version of the object. :return: The model_version of this DataEntitySummaryFromSql. @@ -221,7 +229,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntitySummaryFromSql. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntitySummaryFromSql. @@ -253,7 +261,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -265,7 +273,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -277,7 +285,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntitySummaryFromSql. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntitySummaryFromSql. @@ -289,7 +297,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntitySummaryFromSql. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntitySummaryFromSql. @@ -325,7 +333,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntitySummaryFromSql. - The external key for the object + The external key of the object. :return: The external_key of this DataEntitySummaryFromSql. @@ -337,7 +345,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntitySummaryFromSql. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntitySummaryFromSql. @@ -395,7 +403,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -414,7 +422,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntitySummaryFromSql. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -543,7 +551,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntitySummaryFromSql. @@ -555,7 +563,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntitySummaryFromSql. 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 index 4b48532c9f..c1ab753205 100644 --- a/src/oci/data_connectivity/models/data_entity_summary_from_table.py +++ b/src/oci/data_connectivity/models/data_entity_summary_from_table.py @@ -33,6 +33,10 @@ class DataEntitySummaryFromTable(DataEntitySummary): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromTable. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -206,7 +210,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntitySummaryFromTable. - The object's model version. + The model version of the object. :return: The model_version of this DataEntitySummaryFromTable. @@ -218,7 +222,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntitySummaryFromTable. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntitySummaryFromTable. @@ -250,7 +254,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -262,7 +266,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -274,7 +278,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntitySummaryFromTable. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntitySummaryFromTable. @@ -286,7 +290,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntitySummaryFromTable. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntitySummaryFromTable. @@ -322,7 +326,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntitySummaryFromTable. - The external key for the object. + The external key of the object. :return: The external_key of this DataEntitySummaryFromTable. @@ -334,7 +338,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntitySummaryFromTable. - The external key for the object. + The external key of the object. :param external_key: The external_key of this DataEntitySummaryFromTable. @@ -392,7 +396,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -411,7 +415,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntitySummaryFromTable. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -540,7 +544,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntitySummaryFromTable. @@ -552,7 +556,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntitySummaryFromTable. 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 index dfbb299217..f8d04990ea 100644 --- a/src/oci/data_connectivity/models/data_entity_summary_from_view.py +++ b/src/oci/data_connectivity/models/data_entity_summary_from_view.py @@ -33,6 +33,10 @@ class DataEntitySummaryFromView(DataEntitySummary): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a DataEntitySummaryFromView. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -206,7 +210,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this DataEntitySummaryFromView. - The object's model version. + The model version of the object. :return: The model_version of this DataEntitySummaryFromView. @@ -218,7 +222,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this DataEntitySummaryFromView. - The object's model version. + The model version of the object. :param model_version: The model_version of this DataEntitySummaryFromView. @@ -250,7 +254,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -262,7 +266,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -274,7 +278,7 @@ def name(self, name): def description(self): """ Gets the description of this DataEntitySummaryFromView. - Detailed description for the object. + Detailed description of the object. :return: The description of this DataEntitySummaryFromView. @@ -286,7 +290,7 @@ def description(self): def description(self, description): """ Sets the description of this DataEntitySummaryFromView. - Detailed description for the object. + Detailed description of the object. :param description: The description of this DataEntitySummaryFromView. @@ -322,7 +326,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this DataEntitySummaryFromView. - The external key for the object + The external key of the object. :return: The external_key of this DataEntitySummaryFromView. @@ -334,7 +338,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this DataEntitySummaryFromView. - The external key for the object + The external key of the object. :param external_key: The external_key of this DataEntitySummaryFromView. @@ -392,7 +396,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -411,7 +415,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this DataEntitySummaryFromView. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -540,7 +544,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DataEntitySummaryFromView. @@ -552,7 +556,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DataEntitySummaryFromView. diff --git a/src/oci/data_connectivity/models/data_preview.py b/src/oci/data_connectivity/models/data_preview.py index cb06c768b0..a790493e9c 100644 --- a/src/oci/data_connectivity/models/data_preview.py +++ b/src/oci/data_connectivity/models/data_preview.py @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def entity_name(self): """ **[Required]** Gets the entity_name of this DataPreview. - Name of the entity for which data preview was requested + Name of the entity for which data preview is requested. :return: The entity_name of this DataPreview. @@ -70,7 +70,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this DataPreview. - Name of the entity for which data preview was requested + Name of the entity for which data preview is requested. :param entity_name: The entity_name of this DataPreview. @@ -82,7 +82,7 @@ def entity_name(self, entity_name): def sample_rows_count(self): """ Gets the sample_rows_count of this DataPreview. - Total number of rows taken for sampling + Total number of rows taken for sampling. :return: The sample_rows_count of this DataPreview. @@ -94,7 +94,7 @@ def sample_rows_count(self): def sample_rows_count(self, sample_rows_count): """ Sets the sample_rows_count of this DataPreview. - Total number of rows taken for sampling + Total number of rows taken for sampling. :param sample_rows_count: The sample_rows_count of this DataPreview. @@ -106,7 +106,7 @@ def sample_rows_count(self, sample_rows_count): def columns(self): """ Gets the columns of this DataPreview. - Array of column definition for the preview result + Array of column definition for the preview result. :return: The columns of this DataPreview. @@ -118,7 +118,7 @@ def columns(self): def columns(self, columns): """ Sets the columns of this DataPreview. - Array of column definition for the preview result + Array of column definition for the preview result. :param columns: The columns of this DataPreview. @@ -130,7 +130,7 @@ def columns(self, columns): def rows(self): """ Gets the rows of this DataPreview. - Array of rows values for the preview result + Array of row values for the preview result. :return: The rows of this DataPreview. @@ -142,7 +142,7 @@ def rows(self): def rows(self, rows): """ Sets the rows of this DataPreview. - Array of rows values for the preview result + Array of row values for the preview result. :param rows: The rows of this DataPreview. diff --git a/src/oci/data_connectivity/models/data_profile.py b/src/oci/data_connectivity/models/data_profile.py index f29ec828df..adbf603d1c 100644 --- a/src/oci/data_connectivity/models/data_profile.py +++ b/src/oci/data_connectivity/models/data_profile.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def entity_name(self): """ **[Required]** Gets the entity_name of this DataProfile. - Entity name for which prodilig is requested. + Entity name for which profiling is requested. :return: The entity_name of this DataProfile. @@ -63,7 +63,7 @@ def entity_name(self): def entity_name(self, entity_name): """ Sets the entity_name of this DataProfile. - Entity name for which prodilig is requested. + Entity name for which profiling is requested. :param entity_name: The entity_name of this DataProfile. @@ -95,7 +95,7 @@ def entity_profile_result(self, entity_profile_result): def attribute_profile_results(self): """ Gets the attribute_profile_results of this DataProfile. - Array of profiling results + Array of profiling results. :return: The attribute_profile_results of this DataProfile. @@ -107,7 +107,7 @@ def attribute_profile_results(self): def attribute_profile_results(self, attribute_profile_results): """ Sets the attribute_profile_results of this DataProfile. - Array of profiling results + Array of profiling results. :param attribute_profile_results: The attribute_profile_results of this DataProfile. diff --git a/src/oci/data_connectivity/models/data_type_stat.py b/src/oci/data_connectivity/models/data_type_stat.py index 5cfa5d9e89..e2053bc269 100644 --- a/src/oci/data_connectivity/models/data_type_stat.py +++ b/src/oci/data_connectivity/models/data_type_stat.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DataTypeStat(object): """ - Statistical data in profiling results + Statistical data in profiling results. """ def __init__(self, **kwargs): @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def value(self): """ Gets the value of this DataTypeStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :return: The value of this DataTypeStat. @@ -70,7 +70,7 @@ def value(self): def value(self, value): """ Sets the value of this DataTypeStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :param value: The value of this DataTypeStat. @@ -106,7 +106,7 @@ def confidence(self, confidence): def freq(self): """ Gets the freq of this DataTypeStat. - How many times that value occurred. + The number of times the value appeared. :return: The freq of this DataTypeStat. @@ -118,7 +118,7 @@ def freq(self): def freq(self, freq): """ Sets the freq of this DataTypeStat. - How many times that value occurred. + The number of times the value appeared. :param freq: The freq of this DataTypeStat. diff --git a/src/oci/data_connectivity/models/de_reference_info.py b/src/oci/data_connectivity/models/de_reference_info.py index c3ef0acbc7..fbb9f35fcf 100644 --- a/src/oci/data_connectivity/models/de_reference_info.py +++ b/src/oci/data_connectivity/models/de_reference_info.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DeReferenceInfo(object): """ - Represents de-reference details of a dcms artifact. + Represents de-reference details of a DCMS artifact. """ def __init__(self, **kwargs): @@ -145,7 +145,7 @@ def model_type(self, model_type): def key(self): """ Gets the key of this DeReferenceInfo. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :return: The key of this DeReferenceInfo. @@ -157,7 +157,7 @@ def key(self): def key(self, key): """ Sets the key of this DeReferenceInfo. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :param key: The key of this DeReferenceInfo. @@ -193,7 +193,7 @@ def model_version(self, model_version): 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. + Free form text without any restriction on the 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. @@ -205,7 +205,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -289,7 +289,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DeReferenceInfo. @@ -301,7 +301,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DeReferenceInfo. @@ -313,7 +313,7 @@ def identifier(self, identifier): def dcms_artifact_id(self): """ **[Required]** Gets the dcms_artifact_id of this DeReferenceInfo. - unique id of dcms artifact that is getting referenced. + The unique ID of the DCMS artifact that is getting referenced. :return: The dcms_artifact_id of this DeReferenceInfo. @@ -325,7 +325,7 @@ def dcms_artifact_id(self): 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. + The unique ID of the DCMS artifact that is getting referenced. :param dcms_artifact_id: The dcms_artifact_id of this DeReferenceInfo. @@ -337,7 +337,7 @@ def dcms_artifact_id(self, dcms_artifact_id): def service_artifact_id(self): """ **[Required]** Gets the service_artifact_id of this DeReferenceInfo. - unique id of service which is referencing dcms artifact. + The unique ID of the service that is referencing a DCMS artifact. :return: The service_artifact_id of this DeReferenceInfo. @@ -349,7 +349,7 @@ def service_artifact_id(self): 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. + The unique ID of the service that is referencing a DCMS artifact. :param service_artifact_id: The service_artifact_id of this DeReferenceInfo. @@ -361,7 +361,7 @@ def service_artifact_id(self, service_artifact_id): 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. + The number of times a DCMS artifact has been registered by a service. :return: The reference_count of this DeReferenceInfo. @@ -373,7 +373,7 @@ def reference_count(self): 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. + The number of times a DCMS artifact has been registered by a service. :param reference_count: The reference_count of this DeReferenceInfo. diff --git a/src/oci/data_connectivity/models/derive_entities.py b/src/oci/data_connectivity/models/derive_entities.py new file mode 100644 index 0000000000..3ac853d958 --- /dev/null +++ b/src/oci/data_connectivity/models/derive_entities.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 DeriveEntities(object): + """ + The response object for Derived Entities. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeriveEntities 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 DeriveEntities. + :type items: list[oci.data_connectivity.models.DerivedEntity] + + """ + self.swagger_types = { + 'items': 'list[DerivedEntity]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DeriveEntities. + The array of DerivedEntity + + + :return: The items of this DeriveEntities. + :rtype: list[oci.data_connectivity.models.DerivedEntity] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DeriveEntities. + The array of DerivedEntity + + + :param items: The items of this DeriveEntities. + :type: list[oci.data_connectivity.models.DerivedEntity] + """ + 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/derive_entities_details.py b/src/oci/data_connectivity/models/derive_entities_details.py new file mode 100644 index 0000000000..d15cb14dc8 --- /dev/null +++ b/src/oci/data_connectivity/models/derive_entities_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 DeriveEntitiesDetails(object): + """ + The request object for derived Entities. + """ + + def __init__(self, **kwargs): + """ + Initializes a new DeriveEntitiesDetails 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 DeriveEntitiesDetails. + :type items: list[oci.data_connectivity.models.DeriveEntitiesItem] + + """ + self.swagger_types = { + 'items': 'list[DeriveEntitiesItem]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this DeriveEntitiesDetails. + The array of DeriveEntitiesRequestItem + + + :return: The items of this DeriveEntitiesDetails. + :rtype: list[oci.data_connectivity.models.DeriveEntitiesItem] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this DeriveEntitiesDetails. + The array of DeriveEntitiesRequestItem + + + :param items: The items of this DeriveEntitiesDetails. + :type: list[oci.data_connectivity.models.DeriveEntitiesItem] + """ + 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/derive_entities_item.py b/src/oci/data_connectivity/models/derive_entities_item.py new file mode 100644 index 0000000000..798713745a --- /dev/null +++ b/src/oci/data_connectivity/models/derive_entities_item.py @@ -0,0 +1,145 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class DeriveEntitiesItem(object): + """ + The request object for single derived Entity. + """ + + #: A constant which can be used with the mode property of a DeriveEntitiesItem. + #: This constant has a value of "IN" + MODE_IN = "IN" + + #: A constant which can be used with the mode property of a DeriveEntitiesItem. + #: This constant has a value of "OUT" + MODE_OUT = "OUT" + + def __init__(self, **kwargs): + """ + Initializes a new DeriveEntitiesItem 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 DeriveEntitiesItem. + :type model_type: str + + :param mode: + The value to assign to the mode property of this DeriveEntitiesItem. + Allowed values for this property are: "IN", "OUT" + :type mode: str + + :param referenced_data_object: + The value to assign to the referenced_data_object property of this DeriveEntitiesItem. + :type referenced_data_object: oci.data_connectivity.models.ReferencedDataObject + + """ + self.swagger_types = { + 'model_type': 'str', + 'mode': 'str', + 'referenced_data_object': 'ReferencedDataObject' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'mode': 'mode', + 'referenced_data_object': 'referencedDataObject' + } + + self._model_type = None + self._mode = None + self._referenced_data_object = None + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this DeriveEntitiesItem. + The model type of DeriveEntitiesRequestItem + + + :return: The model_type of this DeriveEntitiesItem. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this DeriveEntitiesItem. + The model type of DeriveEntitiesRequestItem + + + :param model_type: The model_type of this DeriveEntitiesItem. + :type: str + """ + self._model_type = model_type + + @property + def mode(self): + """ + **[Required]** Gets the mode of this DeriveEntitiesItem. + Determines whether derived entity is treated as source or target + + Allowed values for this property are: "IN", "OUT" + + + :return: The mode of this DeriveEntitiesItem. + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """ + Sets the mode of this DeriveEntitiesItem. + Determines whether derived entity is treated as source or target + + + :param mode: The mode of this DeriveEntitiesItem. + :type: str + """ + allowed_values = ["IN", "OUT"] + if not value_allowed_none_or_none_sentinel(mode, allowed_values): + raise ValueError( + "Invalid value for `mode`, must be None or one of {0}" + .format(allowed_values) + ) + self._mode = mode + + @property + def referenced_data_object(self): + """ + **[Required]** Gets the referenced_data_object of this DeriveEntitiesItem. + + :return: The referenced_data_object of this DeriveEntitiesItem. + :rtype: oci.data_connectivity.models.ReferencedDataObject + """ + return self._referenced_data_object + + @referenced_data_object.setter + def referenced_data_object(self, referenced_data_object): + """ + Sets the referenced_data_object of this DeriveEntitiesItem. + + :param referenced_data_object: The referenced_data_object of this DeriveEntitiesItem. + :type: oci.data_connectivity.models.ReferencedDataObject + """ + self._referenced_data_object = referenced_data_object + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_entity.py b/src/oci/data_connectivity/models/derived_entity.py new file mode 100644 index 0000000000..008bb095b8 --- /dev/null +++ b/src/oci/data_connectivity/models/derived_entity.py @@ -0,0 +1,471 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/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 DerivedEntity(DataEntity): + """ + The Derive entity object + """ + + #: A constant which can be used with the mode property of a DerivedEntity. + #: This constant has a value of "IN" + MODE_IN = "IN" + + #: A constant which can be used with the mode property of a DerivedEntity. + #: This constant has a value of "OUT" + MODE_OUT = "OUT" + + def __init__(self, **kwargs): + """ + Initializes a new DerivedEntity object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.DerivedEntity.model_type` attribute + of this class is ``DERIVED_ENTITY`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param entity_properties: + The value to assign to the entity_properties property of this DerivedEntity. + :type entity_properties: dict(str, str) + + :param model_type: + The value to assign to the model_type property of this DerivedEntity. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "DATA_STORE_ENTITY", "SQL_ENTITY", "DERIVED_ENTITY", "MESSAGE_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 DerivedEntity. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this DerivedEntity. + :type key: str + + :param model_version: + The value to assign to the model_version property of this DerivedEntity. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this DerivedEntity. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this DerivedEntity. + :type name: str + + :param object_version: + The value to assign to the object_version property of this DerivedEntity. + :type object_version: int + + :param shape: + The value to assign to the shape property of this DerivedEntity. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this DerivedEntity. + :type shape_id: str + + :param resource_name: + The value to assign to the resource_name property of this DerivedEntity. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this DerivedEntity. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this DerivedEntity. + :type identifier: str + + :param ref_data_object: + The value to assign to the ref_data_object property of this DerivedEntity. + :type ref_data_object: oci.data_connectivity.models.ReferencedDataObject + + :param mode: + The value to assign to the mode property of this DerivedEntity. + Allowed values for this property are: "IN", "OUT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type mode: str + + :param derived_properties: + The value to assign to the derived_properties property of this DerivedEntity. + :type derived_properties: dict(str, object) + + """ + self.swagger_types = { + 'entity_properties': 'dict(str, str)', + 'model_type': 'str', + 'metadata': 'ObjectMetadata', + 'key': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'shape': 'Shape', + 'shape_id': 'str', + 'resource_name': 'str', + 'object_status': 'int', + 'identifier': 'str', + 'ref_data_object': 'ReferencedDataObject', + 'mode': 'str', + 'derived_properties': 'dict(str, object)' + } + + self.attribute_map = { + 'entity_properties': 'entityProperties', + 'model_type': 'modelType', + 'metadata': 'metadata', + 'key': 'key', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'shape': 'shape', + 'shape_id': 'shapeId', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'identifier': 'identifier', + 'ref_data_object': 'refDataObject', + 'mode': 'mode', + 'derived_properties': 'derivedProperties' + } + + self._entity_properties = None + 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._shape = None + self._shape_id = None + self._resource_name = None + self._object_status = None + self._identifier = None + self._ref_data_object = None + self._mode = None + self._derived_properties = None + self._model_type = 'DERIVED_ENTITY' + + @property + def key(self): + """ + Gets the key of this DerivedEntity. + The object key. + + + :return: The key of this DerivedEntity. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this DerivedEntity. + The object key. + + + :param key: The key of this DerivedEntity. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this DerivedEntity. + The object's model version. + + + :return: The model_version of this DerivedEntity. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this DerivedEntity. + The object's model version. + + + :param model_version: The model_version of this DerivedEntity. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this DerivedEntity. + + :return: The parent_ref of this DerivedEntity. + :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 DerivedEntity. + + :param parent_ref: The parent_ref of this DerivedEntity. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this DerivedEntity. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :return: The name of this DerivedEntity. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DerivedEntity. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :param name: The name of this DerivedEntity. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this DerivedEntity. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this DerivedEntity. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this DerivedEntity. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this DerivedEntity. + :type: int + """ + self._object_version = object_version + + @property + def shape(self): + """ + Gets the shape of this DerivedEntity. + + :return: The shape of this DerivedEntity. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this DerivedEntity. + + :param shape: The shape of this DerivedEntity. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this DerivedEntity. + The shape ID. + + + :return: The shape_id of this DerivedEntity. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this DerivedEntity. + The shape ID. + + + :param shape_id: The shape_id of this DerivedEntity. + :type: str + """ + self._shape_id = shape_id + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this DerivedEntity. + The resource name. + + + :return: The resource_name of this DerivedEntity. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this DerivedEntity. + The resource name. + + + :param resource_name: The resource_name of this DerivedEntity. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this DerivedEntity. + 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 DerivedEntity. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this DerivedEntity. + 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 DerivedEntity. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this DerivedEntity. + 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 DerivedEntity. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this DerivedEntity. + 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 DerivedEntity. + :type: str + """ + self._identifier = identifier + + @property + def ref_data_object(self): + """ + Gets the ref_data_object of this DerivedEntity. + + :return: The ref_data_object of this DerivedEntity. + :rtype: oci.data_connectivity.models.ReferencedDataObject + """ + return self._ref_data_object + + @ref_data_object.setter + def ref_data_object(self, ref_data_object): + """ + Sets the ref_data_object of this DerivedEntity. + + :param ref_data_object: The ref_data_object of this DerivedEntity. + :type: oci.data_connectivity.models.ReferencedDataObject + """ + self._ref_data_object = ref_data_object + + @property + def mode(self): + """ + Gets the mode of this DerivedEntity. + Determines whether entity is treated as source or target + + Allowed values for this property are: "IN", "OUT", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The mode of this DerivedEntity. + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """ + Sets the mode of this DerivedEntity. + Determines whether entity is treated as source or target + + + :param mode: The mode of this DerivedEntity. + :type: str + """ + allowed_values = ["IN", "OUT"] + if not value_allowed_none_or_none_sentinel(mode, allowed_values): + mode = 'UNKNOWN_ENUM_VALUE' + self._mode = mode + + @property + def derived_properties(self): + """ + Gets the derived_properties of this DerivedEntity. + Property-bag (key-value pairs where key is Shape Field resource name and value is object) + + + :return: The derived_properties of this DerivedEntity. + :rtype: dict(str, object) + """ + return self._derived_properties + + @derived_properties.setter + def derived_properties(self, derived_properties): + """ + Sets the derived_properties of this DerivedEntity. + Property-bag (key-value pairs where key is Shape Field resource name and value is object) + + + :param derived_properties: The derived_properties of this DerivedEntity. + :type: dict(str, object) + """ + self._derived_properties = derived_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/detach_data_asset_info.py b/src/oci/data_connectivity/models/detach_data_asset_info.py index 5a9d48c1c1..f3f6138898 100644 --- a/src/oci/data_connectivity/models/detach_data_asset_info.py +++ b/src/oci/data_connectivity/models/detach_data_asset_info.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def reference_info(self): """ **[Required]** Gets the reference_info of this DetachDataAssetInfo. - Map of DataAsset name as key and results as value + Mapping the DataAsset name as the key to the results as the value. :return: The reference_info of this DetachDataAssetInfo. @@ -49,7 +49,7 @@ def reference_info(self): def reference_info(self, reference_info): """ Sets the reference_info of this DetachDataAssetInfo. - Map of DataAsset name as key and results as value + Mapping the DataAsset name as the key to the results as the value. :param reference_info: The reference_info of this DetachDataAssetInfo. diff --git a/src/oci/data_connectivity/models/dp_endpoint.py b/src/oci/data_connectivity/models/dp_endpoint.py index 6d7285fa74..a745dc4bda 100644 --- a/src/oci/data_connectivity/models/dp_endpoint.py +++ b/src/oci/data_connectivity/models/dp_endpoint.py @@ -161,7 +161,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :return: The key of this DpEndpoint. @@ -173,7 +173,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :param key: The key of this DpEndpoint. @@ -229,7 +229,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -241,7 +241,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -253,7 +253,7 @@ def name(self, name): def description(self): """ Gets the description of this DpEndpoint. - User-defined description for the endpoint. + User-defined description of the endpoint. :return: The description of this DpEndpoint. @@ -265,7 +265,7 @@ def description(self): def description(self, description): """ Sets the description of this DpEndpoint. - User-defined description for the endpoint. + User-defined description of the endpoint. :param description: The description of this DpEndpoint. @@ -325,7 +325,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DpEndpoint. @@ -337,7 +337,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DpEndpoint. @@ -349,7 +349,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this DpEndpoint. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :return: The data_assets of this DpEndpoint. @@ -361,7 +361,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this DpEndpoint. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :param data_assets: The data_assets of this DpEndpoint. diff --git a/src/oci/data_connectivity/models/dp_endpoint_details.py b/src/oci/data_connectivity/models/dp_endpoint_details.py index cc2ca0edfb..e0992e567b 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_details.py +++ b/src/oci/data_connectivity/models/dp_endpoint_details.py @@ -162,7 +162,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :return: The key of this DpEndpointDetails. @@ -174,7 +174,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :param key: The key of this DpEndpointDetails. @@ -230,7 +230,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -242,7 +242,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -254,7 +254,7 @@ def name(self, name): def description(self): """ Gets the description of this DpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :return: The description of this DpEndpointDetails. @@ -266,7 +266,7 @@ def description(self): def description(self, description): """ Sets the description of this DpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :param description: The description of this DpEndpointDetails. @@ -326,7 +326,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DpEndpointDetails. @@ -338,7 +338,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DpEndpointDetails. @@ -350,7 +350,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this DpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :return: The data_assets of this DpEndpointDetails. @@ -362,7 +362,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this DpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :param data_assets: The data_assets of this DpEndpointDetails. diff --git a/src/oci/data_connectivity/models/dp_endpoint_from_private.py b/src/oci/data_connectivity/models/dp_endpoint_from_private.py index 8f8c188533..daff69f973 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_from_private.py +++ b/src/oci/data_connectivity/models/dp_endpoint_from_private.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpEndpointFromPrivate(DpEndpoint): """ - The endpoint details for a private endpoint. + The endpoint details of a private endpoint. """ #: A constant which can be used with the state property of a DpEndpointFromPrivate. @@ -187,7 +187,7 @@ def dcms_endpoint_id(self, dcms_endpoint_id): def pe_id(self): """ Gets the pe_id of this DpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The pe_id of this DpEndpointFromPrivate. @@ -199,7 +199,7 @@ def pe_id(self): def pe_id(self, pe_id): """ Sets the pe_id of this DpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param pe_id: The pe_id of this DpEndpointFromPrivate. @@ -211,7 +211,7 @@ def pe_id(self, pe_id): def compartment_id(self): """ Gets the compartment_id of this DpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :return: The compartment_id of this DpEndpointFromPrivate. @@ -223,7 +223,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :param compartment_id: The compartment_id of this DpEndpointFromPrivate. @@ -235,7 +235,7 @@ def compartment_id(self, compartment_id): def dns_proxy_ip(self): """ Gets the dns_proxy_ip of this DpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of the DNS proxy. :return: The dns_proxy_ip of this DpEndpointFromPrivate. @@ -247,7 +247,7 @@ def dns_proxy_ip(self): def dns_proxy_ip(self, dns_proxy_ip): """ Sets the dns_proxy_ip of this DpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of the DNS proxy. :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointFromPrivate. @@ -259,7 +259,7 @@ def dns_proxy_ip(self, dns_proxy_ip): def private_endpoint_ip(self): """ Gets the private_endpoint_ip of this DpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The private_endpoint_ip of this DpEndpointFromPrivate. @@ -271,7 +271,7 @@ def private_endpoint_ip(self): def private_endpoint_ip(self, private_endpoint_ip): """ Sets the private_endpoint_ip of this DpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointFromPrivate. @@ -283,7 +283,7 @@ def private_endpoint_ip(self, private_endpoint_ip): def dns_zones(self): """ Gets the dns_zones of this DpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :return: The dns_zones of this DpEndpointFromPrivate. @@ -295,7 +295,7 @@ def dns_zones(self): def dns_zones(self, dns_zones): """ Sets the dns_zones of this DpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :param dns_zones: The dns_zones of this DpEndpointFromPrivate. 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 index eecabe7820..69fcd2c14e 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_from_private_details.py +++ b/src/oci/data_connectivity/models/dp_endpoint_from_private_details.py @@ -185,7 +185,7 @@ def dcms_endpoint_id(self, dcms_endpoint_id): def pe_id(self): """ Gets the pe_id of this DpEndpointFromPrivateDetails. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The pe_id of this DpEndpointFromPrivateDetails. @@ -197,7 +197,7 @@ def pe_id(self): def pe_id(self, pe_id): """ Sets the pe_id of this DpEndpointFromPrivateDetails. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param pe_id: The pe_id of this DpEndpointFromPrivateDetails. @@ -209,7 +209,7 @@ def pe_id(self, pe_id): def compartment_id(self): """ Gets the compartment_id of this DpEndpointFromPrivateDetails. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :return: The compartment_id of this DpEndpointFromPrivateDetails. @@ -221,7 +221,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DpEndpointFromPrivateDetails. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :param compartment_id: The compartment_id of this DpEndpointFromPrivateDetails. @@ -233,7 +233,7 @@ def compartment_id(self, compartment_id): def dns_proxy_ip(self): """ Gets the dns_proxy_ip of this DpEndpointFromPrivateDetails. - The IP address of dns proxy. + The IP address of DNS proxy. :return: The dns_proxy_ip of this DpEndpointFromPrivateDetails. @@ -245,7 +245,7 @@ def dns_proxy_ip(self): def dns_proxy_ip(self, dns_proxy_ip): """ Sets the dns_proxy_ip of this DpEndpointFromPrivateDetails. - The IP address of dns proxy. + The IP address of DNS proxy. :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointFromPrivateDetails. @@ -257,7 +257,7 @@ def dns_proxy_ip(self, dns_proxy_ip): def private_endpoint_ip(self): """ Gets the private_endpoint_ip of this DpEndpointFromPrivateDetails. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The private_endpoint_ip of this DpEndpointFromPrivateDetails. @@ -269,7 +269,7 @@ def private_endpoint_ip(self): def private_endpoint_ip(self, private_endpoint_ip): """ Sets the private_endpoint_ip of this DpEndpointFromPrivateDetails. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointFromPrivateDetails. @@ -281,7 +281,7 @@ def private_endpoint_ip(self, private_endpoint_ip): def dns_zones(self): """ Gets the dns_zones of this DpEndpointFromPrivateDetails. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :return: The dns_zones of this DpEndpointFromPrivateDetails. @@ -293,7 +293,7 @@ def dns_zones(self): def dns_zones(self, dns_zones): """ Sets the dns_zones of this DpEndpointFromPrivateDetails. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :param dns_zones: The dns_zones of this DpEndpointFromPrivateDetails. diff --git a/src/oci/data_connectivity/models/dp_endpoint_from_public.py b/src/oci/data_connectivity/models/dp_endpoint_from_public.py index 6133f3fb1c..a994c7976e 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_from_public.py +++ b/src/oci/data_connectivity/models/dp_endpoint_from_public.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpEndpointFromPublic(DpEndpoint): """ - The endpoint details for a public endpoint. + The endpoint details of a public endpoint. """ def __init__(self, **kwargs): 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 index 6bceef9846..88f3226e17 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_from_public_details.py +++ b/src/oci/data_connectivity/models/dp_endpoint_from_public_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpEndpointFromPublicDetails(DpEndpointDetails): """ - The endpoint details for a public endpoint. + The endpoint details of a public endpoint. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/dp_endpoint_summary.py b/src/oci/data_connectivity/models/dp_endpoint_summary.py index f4a4b48537..072b18d6c2 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_summary.py +++ b/src/oci/data_connectivity/models/dp_endpoint_summary.py @@ -162,7 +162,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :return: The key of this DpEndpointSummary. @@ -174,7 +174,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :param key: The key of this DpEndpointSummary. @@ -230,7 +230,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -242,7 +242,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -254,7 +254,7 @@ def name(self, name): def description(self): """ Gets the description of this DpEndpointSummary. - User-defined description for the endpoint. + User-defined description of the endpoint. :return: The description of this DpEndpointSummary. @@ -266,7 +266,7 @@ def description(self): def description(self, description): """ Sets the description of this DpEndpointSummary. - User-defined description for the endpoint. + User-defined description of the endpoint. :param description: The description of this DpEndpointSummary. @@ -326,7 +326,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this DpEndpointSummary. @@ -338,7 +338,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this DpEndpointSummary. @@ -350,7 +350,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this DpEndpointSummary. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :return: The data_assets of this DpEndpointSummary. @@ -362,7 +362,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this DpEndpointSummary. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :param data_assets: The data_assets of this DpEndpointSummary. 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 index cac1ed194f..3d2a046e19 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_summary_from_private.py +++ b/src/oci/data_connectivity/models/dp_endpoint_summary_from_private.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpEndpointSummaryFromPrivate(DpEndpointSummary): """ - The endpoint summary details for a private endpoint. + The endpoint summary details of a private endpoint. """ #: A constant which can be used with the state property of a DpEndpointSummaryFromPrivate. @@ -185,7 +185,7 @@ def dcms_endpoint_id(self, dcms_endpoint_id): def pe_id(self): """ Gets the pe_id of this DpEndpointSummaryFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The pe_id of this DpEndpointSummaryFromPrivate. @@ -197,7 +197,7 @@ def pe_id(self): def pe_id(self, pe_id): """ Sets the pe_id of this DpEndpointSummaryFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param pe_id: The pe_id of this DpEndpointSummaryFromPrivate. @@ -209,7 +209,7 @@ def pe_id(self, pe_id): def compartment_id(self): """ Gets the compartment_id of this DpEndpointSummaryFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :return: The compartment_id of this DpEndpointSummaryFromPrivate. @@ -221,7 +221,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this DpEndpointSummaryFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :param compartment_id: The compartment_id of this DpEndpointSummaryFromPrivate. @@ -233,7 +233,7 @@ def compartment_id(self, compartment_id): def dns_proxy_ip(self): """ Gets the dns_proxy_ip of this DpEndpointSummaryFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :return: The dns_proxy_ip of this DpEndpointSummaryFromPrivate. @@ -245,7 +245,7 @@ def dns_proxy_ip(self): def dns_proxy_ip(self, dns_proxy_ip): """ Sets the dns_proxy_ip of this DpEndpointSummaryFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :param dns_proxy_ip: The dns_proxy_ip of this DpEndpointSummaryFromPrivate. @@ -257,7 +257,7 @@ def dns_proxy_ip(self, dns_proxy_ip): def private_endpoint_ip(self): """ Gets the private_endpoint_ip of this DpEndpointSummaryFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The private_endpoint_ip of this DpEndpointSummaryFromPrivate. @@ -269,7 +269,7 @@ def private_endpoint_ip(self): def private_endpoint_ip(self, private_endpoint_ip): """ Sets the private_endpoint_ip of this DpEndpointSummaryFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param private_endpoint_ip: The private_endpoint_ip of this DpEndpointSummaryFromPrivate. @@ -281,7 +281,7 @@ def private_endpoint_ip(self, private_endpoint_ip): def dns_zones(self): """ Gets the dns_zones of this DpEndpointSummaryFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :return: The dns_zones of this DpEndpointSummaryFromPrivate. @@ -293,7 +293,7 @@ def dns_zones(self): def dns_zones(self, dns_zones): """ Sets the dns_zones of this DpEndpointSummaryFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :param dns_zones: The dns_zones of this DpEndpointSummaryFromPrivate. 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 index 264a146943..9c8947ec05 100644 --- a/src/oci/data_connectivity/models/dp_endpoint_summary_from_public.py +++ b/src/oci/data_connectivity/models/dp_endpoint_summary_from_public.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class DpEndpointSummaryFromPublic(DpEndpointSummary): """ - The endpoint summary details for a public endpoint. + The endpoint summary details of a public endpoint. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/endpoint.py b/src/oci/data_connectivity/models/endpoint.py index c2eafac3c5..d3c7df94fa 100644 --- a/src/oci/data_connectivity/models/endpoint.py +++ b/src/oci/data_connectivity/models/endpoint.py @@ -10,7 +10,7 @@ @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. + 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. @@ -189,7 +189,7 @@ def vcn_id(self, vcn_id): def subnet_id(self): """ **[Required]** Gets the subnet_id of this Endpoint. - Subnet OCID for the customer connected network where databases for example reside. + Subnet OCID of the customer connected network where, for example, the databases reside. :return: The subnet_id of this Endpoint. @@ -201,7 +201,7 @@ def subnet_id(self): 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. + Subnet OCID of the customer connected network where, for example, the databases reside. :param subnet_id: The subnet_id of this Endpoint. @@ -239,7 +239,7 @@ def dns_zones(self, dns_zones): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -252,7 +252,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -315,7 +315,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this Endpoint. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management Registry display name; registries can be renamed. :return: The display_name of this Endpoint. @@ -327,7 +327,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Endpoint. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management Registry display name; registries can be renamed. :param display_name: The display_name of this Endpoint. @@ -363,7 +363,7 @@ def compartment_id(self, compartment_id): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :return: The time_created of this Endpoint. @@ -375,7 +375,7 @@ def time_created(self): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :param time_created: The time_created of this Endpoint. @@ -387,7 +387,7 @@ def time_created(self, time_created): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :return: The time_updated of this Endpoint. @@ -399,7 +399,7 @@ def time_updated(self): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :param time_updated: The time_updated of this Endpoint. @@ -411,15 +411,15 @@ def time_updated(self, time_updated): 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 + Lifecycle states for registries in the 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 + 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 + 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'. @@ -434,15 +434,15 @@ def lifecycle_state(self): 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 + Lifecycle states for registries in the 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 + 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 + 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. @@ -481,7 +481,7 @@ def state_message(self, state_message): def id(self): """ **[Required]** Gets the id of this Endpoint. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :return: The id of this Endpoint. @@ -493,7 +493,7 @@ def id(self): def id(self, id): """ Sets the id of this Endpoint. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :param id: The id of this Endpoint. @@ -529,7 +529,7 @@ def endpoint_size(self, endpoint_size): def nsg_ids(self): """ Gets the nsg_ids of this Endpoint. - List of NSGs to which the Private Endpoint VNIC must be added. + The list of NSGs to which the private endpoint VNIC must be added. :return: The nsg_ids of this Endpoint. @@ -541,7 +541,7 @@ def nsg_ids(self): 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. + The list of NSGs to which the private endpoint VNIC must be added. :param nsg_ids: The nsg_ids of this Endpoint. diff --git a/src/oci/data_connectivity/models/endpoint_summary.py b/src/oci/data_connectivity/models/endpoint_summary.py index 0f93f03aca..628ad59619 100644 --- a/src/oci/data_connectivity/models/endpoint_summary.py +++ b/src/oci/data_connectivity/models/endpoint_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class EndpointSummary(object): """ - Summary of a Endpoint. + Summary of an endpoint. """ def __init__(self, **kwargs): @@ -100,7 +100,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this EndpointSummary. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :return: The id of this EndpointSummary. @@ -112,7 +112,7 @@ def id(self): def id(self, id): """ Sets the id of this EndpointSummary. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :param id: The id of this EndpointSummary. @@ -148,7 +148,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this EndpointSummary. - Data Connectivity Management Endpoint display name, Endpoints can be renamed + Data Connectivity Management Endpoint display name; endpoints can be renamed. :return: The display_name of this EndpointSummary. @@ -160,7 +160,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this EndpointSummary. - Data Connectivity Management Endpoint display name, Endpoints can be renamed + Data Connectivity Management Endpoint display name; endpoints can be renamed. :param display_name: The display_name of this EndpointSummary. @@ -196,7 +196,7 @@ def compartment_id(self, compartment_id): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :return: The time_created of this EndpointSummary. @@ -208,7 +208,7 @@ def time_created(self): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :param time_created: The time_created of this EndpointSummary. @@ -220,7 +220,7 @@ def time_created(self, time_created): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :return: The time_updated of this EndpointSummary. @@ -232,7 +232,7 @@ def time_updated(self): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :param time_updated: The time_updated of this EndpointSummary. @@ -244,7 +244,7 @@ def time_updated(self, time_updated): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -257,7 +257,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` diff --git a/src/oci/data_connectivity/models/endpoint_summary_collection.py b/src/oci/data_connectivity/models/endpoint_summary_collection.py index 99a2ca69f4..87a58b56ce 100644 --- a/src/oci/data_connectivity/models/endpoint_summary_collection.py +++ b/src/oci/data_connectivity/models/endpoint_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class EndpointSummaryCollection(object): """ - List of endpoint summaries. + The list of endpoint summaries. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this EndpointSummaryCollection. - The array of endpoint summariess + The array of endpoint summaries. :return: The items of this EndpointSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this EndpointSummaryCollection. - The array of endpoint summariess + The array of endpoint summaries. :param items: The items of this EndpointSummaryCollection. diff --git a/src/oci/data_connectivity/models/entity_profile_result.py b/src/oci/data_connectivity/models/entity_profile_result.py index b7a61dbb27..ee11bcca47 100644 --- a/src/oci/data_connectivity/models/entity_profile_result.py +++ b/src/oci/data_connectivity/models/entity_profile_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class EntityProfileResult(object): """ - A metadata details of a profiling entity result. + The metadata details of a profiling entity result. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): 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. + 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. @@ -63,7 +63,7 @@ def attribute_count(self): 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. + 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. @@ -75,7 +75,7 @@ def attribute_count(self, attribute_count): def sampled_row_count(self): """ Gets the sampled_row_count of this EntityProfileResult. - Number of rows were that were sampled + Number of rows that are sampled. :return: The sampled_row_count of this EntityProfileResult. @@ -87,7 +87,7 @@ def sampled_row_count(self): def sampled_row_count(self, sampled_row_count): """ Sets the sampled_row_count of this EntityProfileResult. - Number of rows were that were sampled + Number of rows that are sampled. :param sampled_row_count: The sampled_row_count of this EntityProfileResult. diff --git a/src/oci/data_connectivity/models/entity_shape.py b/src/oci/data_connectivity/models/entity_shape.py index f8cbe114c2..4643aee80e 100644 --- a/src/oci/data_connectivity/models/entity_shape.py +++ b/src/oci/data_connectivity/models/entity_shape.py @@ -33,12 +33,17 @@ class EntityShape(object): #: 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 EntityShape. + #: This constant has a value of "MESSAGE_ENTITY" + MODEL_TYPE_MESSAGE_ENTITY = "MESSAGE_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.EntityShapeFromMessage` * :class:`~oci.data_connectivity.models.EntityShapeFromTable` * :class:`~oci.data_connectivity.models.EntityShapeFromSQL` * :class:`~oci.data_connectivity.models.EntityShapeFromView` @@ -48,7 +53,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -81,6 +86,9 @@ def get_subtype(object_dictionary): if type == 'DATA_STORE_ENTITY': return 'EntityShapeFromDataStore' + if type == 'MESSAGE_ENTITY': + return 'EntityShapeFromMessage' + if type == 'TABLE_ENTITY': return 'EntityShapeFromTable' @@ -101,7 +109,7 @@ 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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -120,7 +128,7 @@ def model_type(self, model_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"] + allowed_values = ["VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY"] if not value_allowed_none_or_none_sentinel(model_type, allowed_values): model_type = 'UNKNOWN_ENUM_VALUE' self._model_type = model_type 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 index 9bb5ec5456..d35875b71b 100644 --- a/src/oci/data_connectivity/models/entity_shape_from_data_store.py +++ b/src/oci/data_connectivity/models/entity_shape_from_data_store.py @@ -33,6 +33,10 @@ class EntityShapeFromDataStore(EntityShape): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a EntityShapeFromDataStore. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -119,6 +123,10 @@ def __init__(self, **kwargs): The value to assign to the identifier property of this EntityShapeFromDataStore. :type identifier: str + :param entity_properties: + The value to assign to the entity_properties property of this EntityShapeFromDataStore. + :type entity_properties: dict(str, str) + """ self.swagger_types = { 'model_type': 'str', @@ -139,7 +147,8 @@ def __init__(self, **kwargs): 'resource_name': 'str', 'data_format': 'DataFormat', 'object_status': 'int', - 'identifier': 'str' + 'identifier': 'str', + 'entity_properties': 'dict(str, str)' } self.attribute_map = { @@ -161,7 +170,8 @@ def __init__(self, **kwargs): 'resource_name': 'resourceName', 'data_format': 'dataFormat', 'object_status': 'objectStatus', - 'identifier': 'identifier' + 'identifier': 'identifier', + 'entity_properties': 'entityProperties' } self._model_type = None @@ -183,6 +193,7 @@ def __init__(self, **kwargs): self._data_format = None self._object_status = None self._identifier = None + self._entity_properties = None self._model_type = 'DATA_STORE_ENTITY' @property @@ -213,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this EntityShapeFromDataStore. - The object's model version. + The model version of the object. :return: The model_version of this EntityShapeFromDataStore. @@ -225,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this EntityShapeFromDataStore. - The object's model version. + The model version of the object. :param model_version: The model_version of this EntityShapeFromDataStore. @@ -257,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this EntityShapeFromDataStore. - Detailed description for the object. + Detailed description of the object. :return: The description of this EntityShapeFromDataStore. @@ -293,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this EntityShapeFromDataStore. - Detailed description for the object. + Detailed description of the object. :param description: The description of this EntityShapeFromDataStore. @@ -329,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this EntityShapeFromDataStore. - The external key for the object. + The external key of the object. :return: The external_key of this EntityShapeFromDataStore. @@ -341,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this EntityShapeFromDataStore. - The external key for the object. + The external key of the object. :param external_key: The external_key of this EntityShapeFromDataStore. @@ -399,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this EntityShapeFromDataStore. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this EntityShapeFromDataStore. @@ -579,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this EntityShapeFromDataStore. @@ -587,6 +598,30 @@ def identifier(self, identifier): """ self._identifier = identifier + @property + def entity_properties(self): + """ + Gets the entity_properties of this EntityShapeFromDataStore. + Map for entity properties + + + :return: The entity_properties of this EntityShapeFromDataStore. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this EntityShapeFromDataStore. + Map for entity properties + + + :param entity_properties: The entity_properties of this EntityShapeFromDataStore. + :type: dict(str, str) + """ + self._entity_properties = entity_properties + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/entity_shape_from_file.py b/src/oci/data_connectivity/models/entity_shape_from_file.py index dcea4626b5..2f26ae1ca4 100644 --- a/src/oci/data_connectivity/models/entity_shape_from_file.py +++ b/src/oci/data_connectivity/models/entity_shape_from_file.py @@ -33,6 +33,10 @@ class EntityShapeFromFile(EntityShape): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a EntityShapeFromFile. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -119,6 +123,10 @@ def __init__(self, **kwargs): The value to assign to the identifier property of this EntityShapeFromFile. :type identifier: str + :param entity_properties: + The value to assign to the entity_properties property of this EntityShapeFromFile. + :type entity_properties: dict(str, str) + """ self.swagger_types = { 'model_type': 'str', @@ -139,7 +147,8 @@ def __init__(self, **kwargs): 'resource_name': 'str', 'data_format': 'DataFormat', 'object_status': 'int', - 'identifier': 'str' + 'identifier': 'str', + 'entity_properties': 'dict(str, str)' } self.attribute_map = { @@ -161,7 +170,8 @@ def __init__(self, **kwargs): 'resource_name': 'resourceName', 'data_format': 'dataFormat', 'object_status': 'objectStatus', - 'identifier': 'identifier' + 'identifier': 'identifier', + 'entity_properties': 'entityProperties' } self._model_type = None @@ -183,6 +193,7 @@ def __init__(self, **kwargs): self._data_format = None self._object_status = None self._identifier = None + self._entity_properties = None self._model_type = 'FILE_ENTITY' @property @@ -213,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this EntityShapeFromFile. - The object's model version. + The model version of the object. :return: The model_version of this EntityShapeFromFile. @@ -225,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this EntityShapeFromFile. - The object's model version. + The model version of the object. :param model_version: The model_version of this EntityShapeFromFile. @@ -257,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this EntityShapeFromFile. - Detailed description for the object. + Detailed description of the object. :return: The description of this EntityShapeFromFile. @@ -293,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this EntityShapeFromFile. - Detailed description for the object. + Detailed description of the object. :param description: The description of this EntityShapeFromFile. @@ -329,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this EntityShapeFromFile. - The external key for the object. + The external key of the object. :return: The external_key of this EntityShapeFromFile. @@ -341,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this EntityShapeFromFile. - The external key for the object. + The external key of the object. :param external_key: The external_key of this EntityShapeFromFile. @@ -399,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this EntityShapeFromFile. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this EntityShapeFromFile. @@ -579,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this EntityShapeFromFile. @@ -587,6 +598,30 @@ def identifier(self, identifier): """ self._identifier = identifier + @property + def entity_properties(self): + """ + Gets the entity_properties of this EntityShapeFromFile. + Map for entity properties + + + :return: The entity_properties of this EntityShapeFromFile. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this EntityShapeFromFile. + Map for entity properties + + + :param entity_properties: The entity_properties of this EntityShapeFromFile. + :type: dict(str, str) + """ + self._entity_properties = entity_properties + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/entity_shape_from_message.py b/src/oci/data_connectivity/models/entity_shape_from_message.py new file mode 100644 index 0000000000..47b837b66a --- /dev/null +++ b/src/oci/data_connectivity/models/entity_shape_from_message.py @@ -0,0 +1,604 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/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 EntityShapeFromMessage(EntityShape): + """ + The message data entity details. + """ + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "TABLE" + ENTITY_TYPE_TABLE = "TABLE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "VIEW" + ENTITY_TYPE_VIEW = "VIEW" + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "FILE" + ENTITY_TYPE_FILE = "FILE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "SQL" + ENTITY_TYPE_SQL = "SQL" + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromMessage. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + + def __init__(self, **kwargs): + """ + Initializes a new EntityShapeFromMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.EntityShapeFromMessage.model_type` attribute + of this class is ``MESSAGE_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 EntityShapeFromMessage. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_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 EntityShapeFromMessage. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this EntityShapeFromMessage. + :type key: str + + :param model_version: + The value to assign to the model_version property of this EntityShapeFromMessage. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this EntityShapeFromMessage. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this EntityShapeFromMessage. + :type name: str + + :param description: + The value to assign to the description property of this EntityShapeFromMessage. + :type description: str + + :param object_version: + The value to assign to the object_version property of this EntityShapeFromMessage. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this EntityShapeFromMessage. + :type external_key: str + + :param shape: + The value to assign to the shape property of this EntityShapeFromMessage. + :type shape: oci.data_connectivity.models.Shape + + :param shape_id: + The value to assign to the shape_id property of this EntityShapeFromMessage. + :type shape_id: str + + :param entity_type: + The value to assign to the entity_type property of this EntityShapeFromMessage. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", '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 EntityShapeFromMessage. + :type other_type_label: str + + :param unique_keys: + The value to assign to the unique_keys property of this EntityShapeFromMessage. + :type unique_keys: list[oci.data_connectivity.models.UniqueKey] + + :param foreign_keys: + The value to assign to the foreign_keys property of this EntityShapeFromMessage. + :type foreign_keys: list[oci.data_connectivity.models.ForeignKey] + + :param resource_name: + The value to assign to the resource_name property of this EntityShapeFromMessage. + :type resource_name: str + + :param data_format: + The value to assign to the data_format property of this EntityShapeFromMessage. + :type data_format: oci.data_connectivity.models.DataFormat + + :param object_status: + The value to assign to the object_status property of this EntityShapeFromMessage. + :type object_status: int + + :param identifier: + The value to assign to the identifier property of this EntityShapeFromMessage. + :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 = 'MESSAGE_ENTITY' + + @property + def key(self): + """ + Gets the key of this EntityShapeFromMessage. + The object key. + + + :return: The key of this EntityShapeFromMessage. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this EntityShapeFromMessage. + The object key. + + + :param key: The key of this EntityShapeFromMessage. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this EntityShapeFromMessage. + The model version of the object. + + + :return: The model_version of this EntityShapeFromMessage. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this EntityShapeFromMessage. + The model version of the object. + + + :param model_version: The model_version of this EntityShapeFromMessage. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this EntityShapeFromMessage. + + :return: The parent_ref of this EntityShapeFromMessage. + :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 EntityShapeFromMessage. + + :param parent_ref: The parent_ref of this EntityShapeFromMessage. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + **[Required]** Gets the name of this EntityShapeFromMessage. + Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :return: The name of this EntityShapeFromMessage. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this EntityShapeFromMessage. + Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :param name: The name of this EntityShapeFromMessage. + :type: str + """ + self._name = name + + @property + def description(self): + """ + Gets the description of this EntityShapeFromMessage. + Detailed description of the object. + + + :return: The description of this EntityShapeFromMessage. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this EntityShapeFromMessage. + Detailed description of the object. + + + :param description: The description of this EntityShapeFromMessage. + :type: str + """ + self._description = description + + @property + def object_version(self): + """ + Gets the object_version of this EntityShapeFromMessage. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this EntityShapeFromMessage. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this EntityShapeFromMessage. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this EntityShapeFromMessage. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this EntityShapeFromMessage. + The external key of the object. + + + :return: The external_key of this EntityShapeFromMessage. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this EntityShapeFromMessage. + The external key of the object. + + + :param external_key: The external_key of this EntityShapeFromMessage. + :type: str + """ + self._external_key = external_key + + @property + def shape(self): + """ + Gets the shape of this EntityShapeFromMessage. + + :return: The shape of this EntityShapeFromMessage. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this EntityShapeFromMessage. + + :param shape: The shape of this EntityShapeFromMessage. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def shape_id(self): + """ + Gets the shape_id of this EntityShapeFromMessage. + The shape ID. + + + :return: The shape_id of this EntityShapeFromMessage. + :rtype: str + """ + return self._shape_id + + @shape_id.setter + def shape_id(self, shape_id): + """ + Sets the shape_id of this EntityShapeFromMessage. + The shape ID. + + + :param shape_id: The shape_id of this EntityShapeFromMessage. + :type: str + """ + self._shape_id = shape_id + + @property + def entity_type(self): + """ + Gets the entity_type of this EntityShapeFromMessage. + The entity type. + + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The entity_type of this EntityShapeFromMessage. + :rtype: str + """ + return self._entity_type + + @entity_type.setter + def entity_type(self, entity_type): + """ + Sets the entity_type of this EntityShapeFromMessage. + The entity type. + + + :param entity_type: The entity_type of this EntityShapeFromMessage. + :type: str + """ + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] + 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 EntityShapeFromMessage. + Specifies other type label. + + + :return: The other_type_label of this EntityShapeFromMessage. + :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 EntityShapeFromMessage. + Specifies other type label. + + + :param other_type_label: The other_type_label of this EntityShapeFromMessage. + :type: str + """ + self._other_type_label = other_type_label + + @property + def unique_keys(self): + """ + Gets the unique_keys of this EntityShapeFromMessage. + An array of unique keys. + + + :return: The unique_keys of this EntityShapeFromMessage. + :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 EntityShapeFromMessage. + An array of unique keys. + + + :param unique_keys: The unique_keys of this EntityShapeFromMessage. + :type: list[oci.data_connectivity.models.UniqueKey] + """ + self._unique_keys = unique_keys + + @property + def foreign_keys(self): + """ + Gets the foreign_keys of this EntityShapeFromMessage. + An array of foreign keys. + + + :return: The foreign_keys of this EntityShapeFromMessage. + :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 EntityShapeFromMessage. + An array of foreign keys. + + + :param foreign_keys: The foreign_keys of this EntityShapeFromMessage. + :type: list[oci.data_connectivity.models.ForeignKey] + """ + self._foreign_keys = foreign_keys + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this EntityShapeFromMessage. + The resource name. + + + :return: The resource_name of this EntityShapeFromMessage. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this EntityShapeFromMessage. + The resource name. + + + :param resource_name: The resource_name of this EntityShapeFromMessage. + :type: str + """ + self._resource_name = resource_name + + @property + def data_format(self): + """ + Gets the data_format of this EntityShapeFromMessage. + + :return: The data_format of this EntityShapeFromMessage. + :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 EntityShapeFromMessage. + + :param data_format: The data_format of this EntityShapeFromMessage. + :type: oci.data_connectivity.models.DataFormat + """ + self._data_format = data_format + + @property + def object_status(self): + """ + Gets the object_status of this EntityShapeFromMessage. + 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 EntityShapeFromMessage. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this EntityShapeFromMessage. + 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 EntityShapeFromMessage. + :type: int + """ + self._object_status = object_status + + @property + def identifier(self): + """ + Gets the identifier of this EntityShapeFromMessage. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. + + + :return: The identifier of this EntityShapeFromMessage. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this EntityShapeFromMessage. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. + + + :param identifier: The identifier of this EntityShapeFromMessage. + :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 index 83fab40ed2..1546190583 100644 --- a/src/oci/data_connectivity/models/entity_shape_from_sql.py +++ b/src/oci/data_connectivity/models/entity_shape_from_sql.py @@ -29,6 +29,14 @@ class EntityShapeFromSQL(EntityShape): #: This constant has a value of "SQL" ENTITY_TYPE_SQL = "SQL" + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "DATA_STORE" + ENTITY_TYPE_DATA_STORE = "DATA_STORE" + + #: A constant which can be used with the entity_type property of a EntityShapeFromSQL. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -37,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -83,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -216,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this EntityShapeFromSQL. - The object's model version. + The model version of the object. :return: The model_version of this EntityShapeFromSQL. @@ -228,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this EntityShapeFromSQL. - The object's model version. + The model version of the object. :param model_version: The model_version of this EntityShapeFromSQL. @@ -260,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -272,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -284,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this EntityShapeFromSQL. - Detailed description for the object. + Detailed description of the object. :return: The description of this EntityShapeFromSQL. @@ -296,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this EntityShapeFromSQL. - Detailed description for the object. + Detailed description of the object. :param description: The description of this EntityShapeFromSQL. @@ -332,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this EntityShapeFromSQL. - The external key for the object. + The external key of the object. :return: The external_key of this EntityShapeFromSQL. @@ -344,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this EntityShapeFromSQL. - The external key for the object. + The external key of the object. :param external_key: The external_key of this EntityShapeFromSQL. @@ -402,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -421,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this EntityShapeFromSQL. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -570,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this EntityShapeFromSQL. @@ -582,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this EntityShapeFromSQL. diff --git a/src/oci/data_connectivity/models/entity_shape_from_table.py b/src/oci/data_connectivity/models/entity_shape_from_table.py index 9ae8eb033d..b05ebe6b06 100644 --- a/src/oci/data_connectivity/models/entity_shape_from_table.py +++ b/src/oci/data_connectivity/models/entity_shape_from_table.py @@ -33,6 +33,10 @@ class EntityShapeFromTable(EntityShape): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a EntityShapeFromTable. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -119,6 +123,10 @@ def __init__(self, **kwargs): The value to assign to the identifier property of this EntityShapeFromTable. :type identifier: str + :param entity_properties: + The value to assign to the entity_properties property of this EntityShapeFromTable. + :type entity_properties: dict(str, str) + """ self.swagger_types = { 'model_type': 'str', @@ -139,7 +147,8 @@ def __init__(self, **kwargs): 'resource_name': 'str', 'data_format': 'DataFormat', 'object_status': 'int', - 'identifier': 'str' + 'identifier': 'str', + 'entity_properties': 'dict(str, str)' } self.attribute_map = { @@ -161,7 +170,8 @@ def __init__(self, **kwargs): 'resource_name': 'resourceName', 'data_format': 'dataFormat', 'object_status': 'objectStatus', - 'identifier': 'identifier' + 'identifier': 'identifier', + 'entity_properties': 'entityProperties' } self._model_type = None @@ -183,6 +193,7 @@ def __init__(self, **kwargs): self._data_format = None self._object_status = None self._identifier = None + self._entity_properties = None self._model_type = 'TABLE_ENTITY' @property @@ -213,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this EntityShapeFromTable. - The object's model version. + The model version of the object. :return: The model_version of this EntityShapeFromTable. @@ -225,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this EntityShapeFromTable. - The object's model version. + The model version of the object. :param model_version: The model_version of this EntityShapeFromTable. @@ -257,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this EntityShapeFromTable. - Detailed description for the object. + Detailed description of the object. :return: The description of this EntityShapeFromTable. @@ -293,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this EntityShapeFromTable. - Detailed description for the object. + Detailed description of the object. :param description: The description of this EntityShapeFromTable. @@ -329,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this EntityShapeFromTable. - The external key for the object. + The external key of the object. :return: The external_key of this EntityShapeFromTable. @@ -341,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this EntityShapeFromTable. - The external key for the object. + The external key of the object. :param external_key: The external_key of this EntityShapeFromTable. @@ -399,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this EntityShapeFromTable. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this EntityShapeFromTable. @@ -579,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this EntityShapeFromTable. @@ -587,6 +598,30 @@ def identifier(self, identifier): """ self._identifier = identifier + @property + def entity_properties(self): + """ + Gets the entity_properties of this EntityShapeFromTable. + Map for entity properties + + + :return: The entity_properties of this EntityShapeFromTable. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this EntityShapeFromTable. + Map for entity properties + + + :param entity_properties: The entity_properties of this EntityShapeFromTable. + :type: dict(str, str) + """ + self._entity_properties = entity_properties + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/entity_shape_from_view.py b/src/oci/data_connectivity/models/entity_shape_from_view.py index b09c795901..d216f594b1 100644 --- a/src/oci/data_connectivity/models/entity_shape_from_view.py +++ b/src/oci/data_connectivity/models/entity_shape_from_view.py @@ -33,6 +33,10 @@ class EntityShapeFromView(EntityShape): #: This constant has a value of "DATA_STORE" ENTITY_TYPE_DATA_STORE = "DATA_STORE" + #: A constant which can be used with the entity_type property of a EntityShapeFromView. + #: This constant has a value of "MESSAGE" + ENTITY_TYPE_MESSAGE = "MESSAGE" + 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 @@ -41,7 +45,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "VIEW_ENTITY", "TABLE_ENTITY", "FILE_ENTITY", "SQL_ENTITY", "DATA_STORE_ENTITY", "MESSAGE_ENTITY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -87,7 +91,7 @@ def __init__(self, **kwargs): :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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type entity_type: str @@ -119,6 +123,10 @@ def __init__(self, **kwargs): The value to assign to the identifier property of this EntityShapeFromView. :type identifier: str + :param entity_properties: + The value to assign to the entity_properties property of this EntityShapeFromView. + :type entity_properties: dict(str, str) + """ self.swagger_types = { 'model_type': 'str', @@ -139,7 +147,8 @@ def __init__(self, **kwargs): 'resource_name': 'str', 'data_format': 'DataFormat', 'object_status': 'int', - 'identifier': 'str' + 'identifier': 'str', + 'entity_properties': 'dict(str, str)' } self.attribute_map = { @@ -161,7 +170,8 @@ def __init__(self, **kwargs): 'resource_name': 'resourceName', 'data_format': 'dataFormat', 'object_status': 'objectStatus', - 'identifier': 'identifier' + 'identifier': 'identifier', + 'entity_properties': 'entityProperties' } self._model_type = None @@ -183,6 +193,7 @@ def __init__(self, **kwargs): self._data_format = None self._object_status = None self._identifier = None + self._entity_properties = None self._model_type = 'VIEW_ENTITY' @property @@ -213,7 +224,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this EntityShapeFromView. - The object's model version. + The model version of the object. :return: The model_version of this EntityShapeFromView. @@ -225,7 +236,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this EntityShapeFromView. - The object's model version. + The model version of the object. :param model_version: The model_version of this EntityShapeFromView. @@ -257,7 +268,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -269,7 +280,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -281,7 +292,7 @@ def name(self, name): def description(self): """ Gets the description of this EntityShapeFromView. - Detailed description for the object. + Detailed description of the object. :return: The description of this EntityShapeFromView. @@ -293,7 +304,7 @@ def description(self): def description(self, description): """ Sets the description of this EntityShapeFromView. - Detailed description for the object. + Detailed description of the object. :param description: The description of this EntityShapeFromView. @@ -329,7 +340,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this EntityShapeFromView. - The external key for the object. + The external key of the object. :return: The external_key of this EntityShapeFromView. @@ -341,7 +352,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this EntityShapeFromView. - The external key for the object. + The external key of the object. :param external_key: The external_key of this EntityShapeFromView. @@ -399,7 +410,7 @@ 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'. + Allowed values for this property are: "TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -418,7 +429,7 @@ def entity_type(self, entity_type): :param entity_type: The entity_type of this EntityShapeFromView. :type: str """ - allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE"] + allowed_values = ["TABLE", "VIEW", "FILE", "SQL", "DATA_STORE", "MESSAGE"] if not value_allowed_none_or_none_sentinel(entity_type, allowed_values): entity_type = 'UNKNOWN_ENUM_VALUE' self._entity_type = entity_type @@ -567,7 +578,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this EntityShapeFromView. @@ -579,7 +590,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this EntityShapeFromView. @@ -587,6 +598,30 @@ def identifier(self, identifier): """ self._identifier = identifier + @property + def entity_properties(self): + """ + Gets the entity_properties of this EntityShapeFromView. + Map for entity properties + + + :return: The entity_properties of this EntityShapeFromView. + :rtype: dict(str, str) + """ + return self._entity_properties + + @entity_properties.setter + def entity_properties(self, entity_properties): + """ + Sets the entity_properties of this EntityShapeFromView. + Map for entity properties + + + :param entity_properties: The entity_properties of this EntityShapeFromView. + :type: dict(str, str) + """ + self._entity_properties = entity_properties + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/excel_format_attribute.py b/src/oci/data_connectivity/models/excel_format_attribute.py new file mode 100644 index 0000000000..c3d0d0422a --- /dev/null +++ b/src/oci/data_connectivity/models/excel_format_attribute.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_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 ExcelFormatAttribute(AbstractFormatAttribute): + """ + The Excel format attribute. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ExcelFormatAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ExcelFormatAttribute.model_type` attribute + of this class is ``EXCEL_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 ExcelFormatAttribute. + Allowed values for this property are: "JSON_FORMAT", "CSV_FORMAT", "AVRO_FORMAT", "PARQUET_FORMAT" + :type model_type: str + + :param data_address: + The value to assign to the data_address property of this ExcelFormatAttribute. + :type data_address: str + + :param header: + The value to assign to the header property of this ExcelFormatAttribute. + :type header: bool + + :param password: + The value to assign to the password property of this ExcelFormatAttribute. + :type password: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'data_address': 'str', + 'header': 'bool', + 'password': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'data_address': 'dataAddress', + 'header': 'header', + 'password': 'password' + } + + self._model_type = None + self._data_address = None + self._header = None + self._password = None + self._model_type = 'EXCEL_FORMAT' + + @property + def data_address(self): + """ + Gets the data_address of this ExcelFormatAttribute. + Range of the data. For example, \"'My Sheet'!B3:C35\" + + + :return: The data_address of this ExcelFormatAttribute. + :rtype: str + """ + return self._data_address + + @data_address.setter + def data_address(self, data_address): + """ + Sets the data_address of this ExcelFormatAttribute. + Range of the data. For example, \"'My Sheet'!B3:C35\" + + + :param data_address: The data_address of this ExcelFormatAttribute. + :type: str + """ + self._data_address = data_address + + @property + def header(self): + """ + Gets the header of this ExcelFormatAttribute. + Whether the dataAddress contains the header with column names. If false - column names fill be generated. + + + :return: The header of this ExcelFormatAttribute. + :rtype: bool + """ + return self._header + + @header.setter + def header(self, header): + """ + Sets the header of this ExcelFormatAttribute. + Whether the dataAddress contains the header with column names. If false - column names fill be generated. + + + :param header: The header of this ExcelFormatAttribute. + :type: bool + """ + self._header = header + + @property + def password(self): + """ + Gets the password of this ExcelFormatAttribute. + Workbook password if it is password protected. + + + :return: The password of this ExcelFormatAttribute. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this ExcelFormatAttribute. + Workbook password if it is password protected. + + + :param password: The password of this ExcelFormatAttribute. + :type: str + """ + self._password = password + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_connectivity/models/execute_operation_job.py b/src/oci/data_connectivity/models/execute_operation_job.py index b49dae80bc..8bbd704d10 100644 --- a/src/oci/data_connectivity/models/execute_operation_job.py +++ b/src/oci/data_connectivity/models/execute_operation_job.py @@ -89,7 +89,7 @@ def operation_status(self, operation_status): def error_message(self): """ Gets the error_message of this ExecuteOperationJob. - Error message, if whole operation is failed. + Error message when the whole operation fails. :return: The error_message of this ExecuteOperationJob. @@ -101,7 +101,7 @@ def error_message(self): def error_message(self, error_message): """ Sets the error_message of this ExecuteOperationJob. - Error message, if whole operation is failed. + Error message when the whole operation fails. :param error_message: The error_message of this ExecuteOperationJob. @@ -137,7 +137,7 @@ def operation_name(self, operation_name): def out_params(self): """ Gets the out_params of this ExecuteOperationJob. - List of names of OUT/INOUT params. + The list of names of OUT/INOUT parameters. :return: The out_params of this ExecuteOperationJob. @@ -149,7 +149,7 @@ def out_params(self): def out_params(self, out_params): """ Sets the out_params of this ExecuteOperationJob. - List of names of OUT/INOUT params. + The list of names of OUT/INOUT parameters. :param out_params: The out_params of this ExecuteOperationJob. @@ -161,7 +161,7 @@ def out_params(self, out_params): def operation_result(self): """ **[Required]** Gets the operation_result of this ExecuteOperationJob. - List of operation execution result for each input set. + The list of operation execution result for each input set. :return: The operation_result of this ExecuteOperationJob. @@ -173,7 +173,7 @@ def operation_result(self): def operation_result(self, operation_result): """ Sets the operation_result of this ExecuteOperationJob. - List of operation execution result for each input set. + The list of operation execution result for each input set. :param operation_result: The operation_result of this ExecuteOperationJob. diff --git a/src/oci/data_connectivity/models/execute_operation_job_details.py b/src/oci/data_connectivity/models/execute_operation_job_details.py index c7ec5a467c..739e91e814 100644 --- a/src/oci/data_connectivity/models/execute_operation_job_details.py +++ b/src/oci/data_connectivity/models/execute_operation_job_details.py @@ -61,7 +61,7 @@ def __init__(self, **kwargs): def execute_operation_job_id(self): """ **[Required]** Gets the execute_operation_job_id of this ExecuteOperationJobDetails. - Job id to track job status. + Job ID to track the job status. :return: The execute_operation_job_id of this ExecuteOperationJobDetails. @@ -73,7 +73,7 @@ def execute_operation_job_id(self): 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. + Job ID to track the job status. :param execute_operation_job_id: The execute_operation_job_id of this ExecuteOperationJobDetails. @@ -85,7 +85,7 @@ def execute_operation_job_id(self, execute_operation_job_id): def status(self): """ **[Required]** Gets the status of this ExecuteOperationJobDetails. - The status of job + The status of the 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'. @@ -100,7 +100,7 @@ def status(self): def status(self, status): """ Sets the status of this ExecuteOperationJobDetails. - The status of job + The status of the job. :param status: The status of this ExecuteOperationJobDetails. @@ -115,7 +115,7 @@ def status(self, status): def error_message(self): """ Gets the error_message of this ExecuteOperationJobDetails. - Error message if job creation is failed. + Error message when the job creation fails. :return: The error_message of this ExecuteOperationJobDetails. @@ -127,7 +127,7 @@ def error_message(self): def error_message(self, error_message): """ Sets the error_message of this ExecuteOperationJobDetails. - Error message if job creation is failed. + Error message when the job creation fails. :param error_message: The error_message of this ExecuteOperationJobDetails. diff --git a/src/oci/data_connectivity/models/external_storage.py b/src/oci/data_connectivity/models/external_storage.py index 86192133c9..82fdbb460b 100644 --- a/src/oci/data_connectivity/models/external_storage.py +++ b/src/oci/data_connectivity/models/external_storage.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ExternalStorage(ConnectorAttribute): """ - BICC Connector Attribute.Object Storage as External storage where the BICC extracted files are written + BICC Connector Attribute. Object Storage as External storage where the BICC extracted files are written. """ def __init__(self, **kwargs): @@ -82,7 +82,7 @@ def __init__(self, **kwargs): def storage_id(self): """ Gets the storage_id of this ExternalStorage. - Id of the external stoarge configured in BICC console. Usually its numeric. + ID of the external stoarge configured in the BICC console. Usually it's numeric. :return: The storage_id of this ExternalStorage. @@ -94,7 +94,7 @@ def storage_id(self): 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. + ID of the external stoarge configured in the BICC console. Usually it's numeric. :param storage_id: The storage_id of this ExternalStorage. @@ -106,7 +106,7 @@ def storage_id(self, storage_id): def storage_name(self): """ Gets the storage_name of this ExternalStorage. - Name of the external storage configured in BICC console + Name of the external storage configured in the BICC console. :return: The storage_name of this ExternalStorage. @@ -118,7 +118,7 @@ def storage_name(self): def storage_name(self, storage_name): """ Sets the storage_name of this ExternalStorage. - Name of the external storage configured in BICC console + Name of the external storage configured in the BICC console. :param storage_name: The storage_name of this ExternalStorage. @@ -130,7 +130,7 @@ def storage_name(self, storage_name): def host(self): """ Gets the host of this ExternalStorage. - Object Storage host Url. DO not give http/https. + Object Storage host URL. DO not give http/https. :return: The host of this ExternalStorage. @@ -142,7 +142,7 @@ def host(self): def host(self, host): """ Sets the host of this ExternalStorage. - Object Storage host Url. DO not give http/https. + Object Storage host URL. DO not give http/https. :param host: The host of this ExternalStorage. @@ -154,7 +154,7 @@ def host(self, host): def tenancy_id(self): """ Gets the tenancy_id of this ExternalStorage. - Tenancy OCID for the OOS bucket + Tenancy OCID of the OOS bucket. :return: The tenancy_id of this ExternalStorage. @@ -166,7 +166,7 @@ def tenancy_id(self): def tenancy_id(self, tenancy_id): """ Sets the tenancy_id of this ExternalStorage. - Tenancy OCID for the OOS bucket + Tenancy OCID of the OOS bucket. :param tenancy_id: The tenancy_id of this ExternalStorage. @@ -178,7 +178,7 @@ def tenancy_id(self, tenancy_id): def namespace(self): """ Gets the namespace of this ExternalStorage. - Namespace for the OOS bucket + Namespace of the OOS bucket. :return: The namespace of this ExternalStorage. @@ -190,7 +190,7 @@ def namespace(self): def namespace(self, namespace): """ Sets the namespace of this ExternalStorage. - Namespace for the OOS bucket + Namespace of the OOS bucket. :param namespace: The namespace of this ExternalStorage. @@ -202,7 +202,7 @@ def namespace(self, namespace): def bucket(self): """ Gets the bucket of this ExternalStorage. - Bucket Name where BICC extracts stores the files + Bucket name where BICC extracts and stores the files. :return: The bucket of this ExternalStorage. @@ -214,7 +214,7 @@ def bucket(self): def bucket(self, bucket): """ Sets the bucket of this ExternalStorage. - Bucket Name where BICC extracts stores the files + Bucket name where BICC extracts and stores the files. :param bucket: The bucket of this ExternalStorage. diff --git a/src/oci/data_connectivity/models/folder.py b/src/oci/data_connectivity/models/folder.py index 210bda114a..793a097207 100644 --- a/src/oci/data_connectivity/models/folder.py +++ b/src/oci/data_connectivity/models/folder.py @@ -124,7 +124,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :return: The key of this Folder. @@ -136,7 +136,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :param key: The key of this Folder. @@ -192,7 +192,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -204,7 +204,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -216,7 +216,7 @@ def name(self, name): def description(self): """ Gets the description of this Folder. - User-defined description for the folder. + User-defined description of the folder. :return: The description of this Folder. @@ -228,7 +228,7 @@ def description(self): def description(self, description): """ Sets the description of this Folder. - User-defined description for the folder. + User-defined description of the folder. :param description: The description of this Folder. @@ -288,7 +288,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this Folder. @@ -300,7 +300,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this Folder. @@ -312,7 +312,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this Folder. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :return: The data_assets of this Folder. @@ -324,7 +324,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this Folder. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :param data_assets: The data_assets of this Folder. diff --git a/src/oci/data_connectivity/models/folder_summary.py b/src/oci/data_connectivity/models/folder_summary.py index be7c64dfc2..fc35e4299c 100644 --- a/src/oci/data_connectivity/models/folder_summary.py +++ b/src/oci/data_connectivity/models/folder_summary.py @@ -124,7 +124,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :return: The key of this FolderSummary. @@ -136,7 +136,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :param key: The key of this FolderSummary. @@ -192,7 +192,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -204,7 +204,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -216,7 +216,7 @@ def name(self, name): def description(self): """ Gets the description of this FolderSummary. - User-defined description for the folder. + User-defined description of the folder. :return: The description of this FolderSummary. @@ -228,7 +228,7 @@ def description(self): def description(self, description): """ Sets the description of this FolderSummary. - User-defined description for the folder. + User-defined description of the folder. :param description: The description of this FolderSummary. @@ -288,7 +288,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this FolderSummary. @@ -300,7 +300,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this FolderSummary. @@ -312,7 +312,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this FolderSummary. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :return: The data_assets of this FolderSummary. @@ -324,7 +324,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this FolderSummary. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :param data_assets: The data_assets of this FolderSummary. diff --git a/src/oci/data_connectivity/models/folder_summary_collection.py b/src/oci/data_connectivity/models/folder_summary_collection.py index d125d13d27..bd3acfadb2 100644 --- a/src/oci/data_connectivity/models/folder_summary_collection.py +++ b/src/oci/data_connectivity/models/folder_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of folder summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/foreign_key.py b/src/oci/data_connectivity/models/foreign_key.py index 5508cb24f1..e35d6e62b1 100644 --- a/src/oci/data_connectivity/models/foreign_key.py +++ b/src/oci/data_connectivity/models/foreign_key.py @@ -128,7 +128,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this ForeignKey. - The object's model version. + The model version of the object. :return: The model_version of this ForeignKey. @@ -140,7 +140,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this ForeignKey. - The object's model version. + The model version of the object. :param model_version: The model_version of this ForeignKey. @@ -172,7 +172,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -184,7 +184,7 @@ def name(self): 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. + Free form text without any restriction on the 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. 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 index fa6fa45333..cb738ad0da 100644 --- a/src/oci/data_connectivity/models/full_push_down_task_response.py +++ b/src/oci/data_connectivity/models/full_push_down_task_response.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class FullPushDownTaskResponse(object): """ - The full pushdown task + The full pushdown task. """ def __init__(self, **kwargs): @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def model_type(self): """ **[Required]** Gets the model_type of this FullPushDownTaskResponse. - The type of of FullPushDownTask Response. + The type of of FullPushDownTask response. :return: The model_type of this FullPushDownTaskResponse. @@ -63,7 +63,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this FullPushDownTaskResponse. - The type of of FullPushDownTask Response. + The type of of FullPushDownTask response. :param model_type: The model_type of this FullPushDownTaskResponse. @@ -75,7 +75,7 @@ def model_type(self, model_type): def error_message(self): """ Gets the error_message of this FullPushDownTaskResponse. - The error message in response object. + The error message in the response object. :return: The error_message of this FullPushDownTaskResponse. @@ -87,7 +87,7 @@ def error_message(self): def error_message(self, error_message): """ Sets the error_message of this FullPushDownTaskResponse. - The error message in response object. + The error message in the response object. :param error_message: The error_message of this FullPushDownTaskResponse. diff --git a/src/oci/data_connectivity/models/generic_rest_api_attributes.py b/src/oci/data_connectivity/models/generic_rest_api_attributes.py new file mode 100644 index 0000000000..c0b93945dc --- /dev/null +++ b/src/oci/data_connectivity/models/generic_rest_api_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_operation_attributes import AbstractOperationAttributes +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class GenericRestApiAttributes(AbstractOperationAttributes): + """ + Generic rest api specific attributes. + """ + + def __init__(self, **kwargs): + """ + Initializes a new GenericRestApiAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.GenericRestApiAttributes.model_type` attribute + of this class is ``GENERIC_REST_API_ATTRIBUTES`` 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 GenericRestApiAttributes. + Allowed values for this property are: "GENERIC_REST_API_ATTRIBUTES" + :type model_type: str + + :param server_url: + The value to assign to the server_url property of this GenericRestApiAttributes. + :type server_url: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'server_url': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'server_url': 'serverUrl' + } + + self._model_type = None + self._server_url = None + self._model_type = 'GENERIC_REST_API_ATTRIBUTES' + + @property + def server_url(self): + """ + Gets the server_url of this GenericRestApiAttributes. + The server Url serving operation. + + + :return: The server_url of this GenericRestApiAttributes. + :rtype: str + """ + return self._server_url + + @server_url.setter + def server_url(self, server_url): + """ + Sets the server_url of this GenericRestApiAttributes. + The server Url serving operation. + + + :param server_url: The server_url of this GenericRestApiAttributes. + :type: str + """ + self._server_url = server_url + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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/generic_rest_call_attribute.py b/src/oci/data_connectivity/models/generic_rest_call_attribute.py new file mode 100644 index 0000000000..5791185059 --- /dev/null +++ b/src/oci/data_connectivity/models/generic_rest_call_attribute.py @@ -0,0 +1,49 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .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 GenericRestCallAttribute(AbstractCallAttribute): + """ + The generic rest call attributes. + """ + + def __init__(self, **kwargs): + """ + Initializes a new GenericRestCallAttribute object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.GenericRestCallAttribute.model_type` attribute + of this class is ``GENERIC_REST_CALL_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 GenericRestCallAttribute. + Allowed values for this property are: "BIPCALLATTRIBUTE", "GENERIC_REST_CALL_ATTRIBUTE" + :type model_type: str + + """ + self.swagger_types = { + 'model_type': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType' + } + + self._model_type = None + self._model_type = 'GENERIC_REST_CALL_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/hdfs_write_attributes.py b/src/oci/data_connectivity/models/hdfs_write_attributes.py index 9623a2784f..36b62ba3d9 100644 --- a/src/oci/data_connectivity/models/hdfs_write_attributes.py +++ b/src/oci/data_connectivity/models/hdfs_write_attributes.py @@ -47,7 +47,7 @@ def __init__(self, **kwargs): 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. + Specifies whether to write output to a single file. :return: The write_to_single_file of this HdfsWriteAttributes. @@ -59,7 +59,7 @@ def write_to_single_file(self): 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. + Specifies whether to write output to a single file. :param write_to_single_file: The write_to_single_file of this HdfsWriteAttributes. diff --git a/src/oci/data_connectivity/models/histogram.py b/src/oci/data_connectivity/models/histogram.py index 29201cc7d5..2845416423 100644 --- a/src/oci/data_connectivity/models/histogram.py +++ b/src/oci/data_connectivity/models/histogram.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Histogram(object): """ - To capture all the histograms data related to profiling + To capture all the histograms data related to profiling. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/input_port.py b/src/oci/data_connectivity/models/input_port.py index c5d7e44511..f15d5630e7 100644 --- a/src/oci/data_connectivity/models/input_port.py +++ b/src/oci/data_connectivity/models/input_port.py @@ -116,7 +116,7 @@ def __init__(self, **kwargs): def port_type(self): """ Gets the port_type of this InputPort. - The port details for the data asset.Type. + The port details of the data asset type. Allowed values for this property are: "DATA", "CONTROL", "MODEL" @@ -130,7 +130,7 @@ def port_type(self): def port_type(self, port_type): """ Sets the port_type of this InputPort. - The port details for the data asset.Type. + The port details of the data asset type. :param port_type: The port_type of this InputPort. diff --git a/src/oci/data_connectivity/models/network_connectivity_status.py b/src/oci/data_connectivity/models/network_connectivity_status.py index 8996b3131c..93c653d012 100644 --- a/src/oci/data_connectivity/models/network_connectivity_status.py +++ b/src/oci/data_connectivity/models/network_connectivity_status.py @@ -151,7 +151,7 @@ def error_message(self, error_message): 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.. + The timestamp when the network validation was last updated for the given DataAsset-PrivateEndpoint pair. :return: The time_last_updated of this NetworkConnectivityStatus. @@ -163,7 +163,7 @@ def time_last_updated(self): 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.. + The timestamp when the network validation was last updated for the given DataAsset-PrivateEndpoint pair. :param time_last_updated: The time_last_updated of this NetworkConnectivityStatus. diff --git a/src/oci/data_connectivity/models/numeric_attribute.py b/src/oci/data_connectivity/models/numeric_attribute.py index fa5a13ad67..0a2e5128bb 100644 --- a/src/oci/data_connectivity/models/numeric_attribute.py +++ b/src/oci/data_connectivity/models/numeric_attribute.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class NumericAttribute(AttributeProfileResult): """ - A summary of profiling results of a specefic attribute. + A summary of profiling results of a specific attribute. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/object_freq_stat.py b/src/oci/data_connectivity/models/object_freq_stat.py index 7d827d1b2a..91a4cdb41d 100644 --- a/src/oci/data_connectivity/models/object_freq_stat.py +++ b/src/oci/data_connectivity/models/object_freq_stat.py @@ -10,7 +10,7 @@ @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. + One specific element. Its meaning changes according to the context. For example, 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 represents a format. """ def __init__(self, **kwargs): @@ -58,7 +58,7 @@ def __init__(self, **kwargs): def value(self): """ Gets the value of this ObjectFreqStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :return: The value of this ObjectFreqStat. @@ -70,7 +70,7 @@ def value(self): def value(self, value): """ Sets the value of this ObjectFreqStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :param value: The value of this ObjectFreqStat. @@ -106,7 +106,7 @@ def confidence(self, confidence): def freq(self): """ Gets the freq of this ObjectFreqStat. - How many times that value occurred. + The number of times the value appeared. :return: The freq of this ObjectFreqStat. @@ -118,7 +118,7 @@ def freq(self): def freq(self, freq): """ Sets the freq of this ObjectFreqStat. - How many times that value occurred. + The number of times the value appeared. :param freq: The freq of this ObjectFreqStat. diff --git a/src/oci/data_connectivity/models/object_metadata.py b/src/oci/data_connectivity/models/object_metadata.py index c115e7e1db..56a7a59afa 100644 --- a/src/oci/data_connectivity/models/object_metadata.py +++ b/src/oci/data_connectivity/models/object_metadata.py @@ -10,7 +10,7 @@ @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. + A summary type containing information about the object including its key, name, the time that it was created or updated, and the user who created or updated it. """ def __init__(self, **kwargs): @@ -309,7 +309,7 @@ def aggregator(self, aggregator): def identifier_path(self): """ Gets the identifier_path of this ObjectMetadata. - The full path to identify this object. + The full path to identify the object. :return: The identifier_path of this ObjectMetadata. @@ -321,7 +321,7 @@ def identifier_path(self): def identifier_path(self, identifier_path): """ Sets the identifier_path of this ObjectMetadata. - The full path to identify this object. + The full path to identify the object. :param identifier_path: The identifier_path of this ObjectMetadata. @@ -381,7 +381,7 @@ def registry_version(self, registry_version): 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. + 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. @@ -393,7 +393,7 @@ def labels(self): 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. + 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. @@ -405,7 +405,7 @@ def labels(self, labels): def is_favorite(self): """ Gets the is_favorite of this ObjectMetadata. - Specifies whether this object is a favorite or not. + Specifies whether this object is a favorite. :return: The is_favorite of this ObjectMetadata. @@ -417,7 +417,7 @@ def is_favorite(self): def is_favorite(self, is_favorite): """ Sets the is_favorite of this ObjectMetadata. - Specifies whether this object is a favorite or not. + Specifies whether this object is a favorite. :param is_favorite: The is_favorite of this ObjectMetadata. diff --git a/src/oci/data_connectivity/models/object_storage_write_attributes.py b/src/oci/data_connectivity/models/object_storage_write_attributes.py index fa2d81be5b..ce78a66acc 100644 --- a/src/oci/data_connectivity/models/object_storage_write_attributes.py +++ b/src/oci/data_connectivity/models/object_storage_write_attributes.py @@ -47,7 +47,7 @@ def __init__(self, **kwargs): 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. + Specifies whether to write the output to a single file. :return: The write_to_single_file of this ObjectStorageWriteAttributes. @@ -59,7 +59,7 @@ def write_to_single_file(self): 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. + Specifies whether to write the output to a single file. :param write_to_single_file: The write_to_single_file of this ObjectStorageWriteAttributes. diff --git a/src/oci/data_connectivity/models/operation.py b/src/oci/data_connectivity/models/operation.py index a1103a38c1..bb86d68628 100644 --- a/src/oci/data_connectivity/models/operation.py +++ b/src/oci/data_connectivity/models/operation.py @@ -17,18 +17,27 @@ class Operation(object): #: This constant has a value of "PROCEDURE" MODEL_TYPE_PROCEDURE = "PROCEDURE" + #: A constant which can be used with the model_type property of a Operation. + #: This constant has a value of "API" + MODEL_TYPE_API = "API" + 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` + * :class:`~oci.data_connectivity.models.OperationFromApi` The following keyword arguments are supported (corresponding to the getters/setters of this class): + :param operation_attributes: + The value to assign to the operation_attributes property of this Operation. + :type operation_attributes: oci.data_connectivity.models.AbstractOperationAttributes + :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'. + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -38,15 +47,18 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'operation_attributes': 'AbstractOperationAttributes', 'model_type': 'str', 'metadata': 'ObjectMetadata' } self.attribute_map = { + 'operation_attributes': 'operationAttributes', 'model_type': 'modelType', 'metadata': 'metadata' } + self._operation_attributes = None self._model_type = None self._metadata = None @@ -60,16 +72,39 @@ def get_subtype(object_dictionary): if type == 'PROCEDURE': return 'OperationFromProcedure' + + if type == 'API': + return 'OperationFromApi' else: return 'Operation' + @property + def operation_attributes(self): + """ + Gets the operation_attributes of this Operation. + + :return: The operation_attributes of this Operation. + :rtype: oci.data_connectivity.models.AbstractOperationAttributes + """ + return self._operation_attributes + + @operation_attributes.setter + def operation_attributes(self, operation_attributes): + """ + Sets the operation_attributes of this Operation. + + :param operation_attributes: The operation_attributes of this Operation. + :type: oci.data_connectivity.models.AbstractOperationAttributes + """ + self._operation_attributes = operation_attributes + @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'. + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -88,7 +123,7 @@ def model_type(self, model_type): :param model_type: The model_type of this Operation. :type: str """ - allowed_values = ["PROCEDURE"] + allowed_values = ["PROCEDURE", "API"] if not value_allowed_none_or_none_sentinel(model_type, allowed_values): model_type = 'UNKNOWN_ENUM_VALUE' self._model_type = model_type diff --git a/src/oci/data_connectivity/models/operation_exec_result.py b/src/oci/data_connectivity/models/operation_exec_result.py index 6755e52fd8..b41bdcd974 100644 --- a/src/oci/data_connectivity/models/operation_exec_result.py +++ b/src/oci/data_connectivity/models/operation_exec_result.py @@ -83,7 +83,7 @@ def __init__(self, **kwargs): def execution_status(self): """ Gets the execution_status of this OperationExecResult. - Status of the operation job for particular set of input. + Status of the operation job for a 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'. @@ -98,7 +98,7 @@ def execution_status(self): def execution_status(self, execution_status): """ Sets the execution_status of this OperationExecResult. - Status of the operation job for particular set of input. + Status of the operation job for a particular set of input. :param execution_status: The execution_status of this OperationExecResult. @@ -113,7 +113,7 @@ def execution_status(self, execution_status): def error_message(self): """ Gets the error_message of this OperationExecResult. - Error message if execution of operation is failed. + Error message when the execution of operation fails. :return: The error_message of this OperationExecResult. @@ -125,7 +125,7 @@ def error_message(self): def error_message(self, error_message): """ Sets the error_message of this OperationExecResult. - Error message if execution of operation is failed. + Error message when the execution of operation fails. :param error_message: The error_message of this OperationExecResult. @@ -161,7 +161,7 @@ def metrics(self, metrics): def output_values(self): """ Gets the output_values of this OperationExecResult. - List of emitted rows for each OUT/INOUT param. + The list of emitted rows for each OUT/INOUT parameter. :return: The output_values of this OperationExecResult. @@ -173,7 +173,7 @@ def output_values(self): def output_values(self, output_values): """ Sets the output_values of this OperationExecResult. - List of emitted rows for each OUT/INOUT param. + The list of emitted rows for each OUT/INOUT parameter. :param output_values: The output_values of this OperationExecResult. @@ -185,7 +185,7 @@ def output_values(self, output_values): def is_whitelisted_error_message(self): """ Gets the is_whitelisted_error_message of this OperationExecResult. - True, if error message should be displayed on UI. + True, if the error message must be displayed in the UI. :return: The is_whitelisted_error_message of this OperationExecResult. @@ -197,7 +197,7 @@ def is_whitelisted_error_message(self): 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. + True, if the error message must be displayed in the UI. :param is_whitelisted_error_message: The is_whitelisted_error_message of this OperationExecResult. diff --git a/src/oci/data_connectivity/models/operation_from_api.py b/src/oci/data_connectivity/models/operation_from_api.py new file mode 100644 index 0000000000..91e36ded8d --- /dev/null +++ b/src/oci/data_connectivity/models/operation_from_api.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 .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 OperationFromApi(Operation): + """ + The API operation object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationFromApi object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OperationFromApi.model_type` attribute + of this class is ``API`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param operation_attributes: + The value to assign to the operation_attributes property of this OperationFromApi. + :type operation_attributes: oci.data_connectivity.models.AbstractOperationAttributes + + :param model_type: + The value to assign to the model_type property of this OperationFromApi. + Allowed values for this property are: "PROCEDURE", "API" + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this OperationFromApi. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this OperationFromApi. + :type key: str + + :param model_version: + The value to assign to the model_version property of this OperationFromApi. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this OperationFromApi. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param shape: + The value to assign to the shape property of this OperationFromApi. + :type shape: oci.data_connectivity.models.Shape + + :param name: + The value to assign to the name property of this OperationFromApi. + :type name: str + + :param object_version: + The value to assign to the object_version property of this OperationFromApi. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this OperationFromApi. + :type external_key: str + + :param resource_name: + The value to assign to the resource_name property of this OperationFromApi. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this OperationFromApi. + :type object_status: int + + """ + self.swagger_types = { + 'operation_attributes': 'AbstractOperationAttributes', + '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 = { + 'operation_attributes': 'operationAttributes', + '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._operation_attributes = None + 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 = 'API' + + @property + def key(self): + """ + Gets the key of this OperationFromApi. + The object key. + + + :return: The key of this OperationFromApi. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this OperationFromApi. + The object key. + + + :param key: The key of this OperationFromApi. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this OperationFromApi. + The model version of the object. + + + :return: The model_version of this OperationFromApi. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this OperationFromApi. + The model version of the object. + + + :param model_version: The model_version of this OperationFromApi. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this OperationFromApi. + + :return: The parent_ref of this OperationFromApi. + :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 OperationFromApi. + + :param parent_ref: The parent_ref of this OperationFromApi. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def shape(self): + """ + Gets the shape of this OperationFromApi. + + :return: The shape of this OperationFromApi. + :rtype: oci.data_connectivity.models.Shape + """ + return self._shape + + @shape.setter + def shape(self, shape): + """ + Sets the shape of this OperationFromApi. + + :param shape: The shape of this OperationFromApi. + :type: oci.data_connectivity.models.Shape + """ + self._shape = shape + + @property + def name(self): + """ + **[Required]** Gets the name of this OperationFromApi. + The operation name. This value is unique. + + + :return: The name of this OperationFromApi. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this OperationFromApi. + The operation name. This value is unique. + + + :param name: The name of this OperationFromApi. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this OperationFromApi. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this OperationFromApi. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this OperationFromApi. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this OperationFromApi. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this OperationFromApi. + The external key for the object. + + + :return: The external_key of this OperationFromApi. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this OperationFromApi. + The external key for the object. + + + :param external_key: The external_key of this OperationFromApi. + :type: str + """ + self._external_key = external_key + + @property + def resource_name(self): + """ + **[Required]** Gets the resource_name of this OperationFromApi. + The resource name. + + + :return: The resource_name of this OperationFromApi. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this OperationFromApi. + The resource name. + + + :param resource_name: The resource_name of this OperationFromApi. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this OperationFromApi. + 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 OperationFromApi. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this OperationFromApi. + 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 OperationFromApi. + :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_from_procedure.py b/src/oci/data_connectivity/models/operation_from_procedure.py index 94ad264333..a53997501e 100644 --- a/src/oci/data_connectivity/models/operation_from_procedure.py +++ b/src/oci/data_connectivity/models/operation_from_procedure.py @@ -19,9 +19,13 @@ def __init__(self, **kwargs): 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 operation_attributes: + The value to assign to the operation_attributes property of this OperationFromProcedure. + :type operation_attributes: oci.data_connectivity.models.AbstractOperationAttributes + :param model_type: The value to assign to the model_type property of this OperationFromProcedure. - Allowed values for this property are: "PROCEDURE" + Allowed values for this property are: "PROCEDURE", "API" :type model_type: str :param metadata: @@ -66,6 +70,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { + 'operation_attributes': 'AbstractOperationAttributes', 'model_type': 'str', 'metadata': 'ObjectMetadata', 'key': 'str', @@ -80,6 +85,7 @@ def __init__(self, **kwargs): } self.attribute_map = { + 'operation_attributes': 'operationAttributes', 'model_type': 'modelType', 'metadata': 'metadata', 'key': 'key', @@ -93,6 +99,7 @@ def __init__(self, **kwargs): 'object_status': 'objectStatus' } + self._operation_attributes = None self._model_type = None self._metadata = None self._key = None @@ -246,7 +253,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this OperationFromProcedure. - The external key for the object. + The external key of the object. :return: The external_key of this OperationFromProcedure. @@ -258,7 +265,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this OperationFromProcedure. - The external key for the object. + The external key of the object. :param external_key: The external_key of this OperationFromProcedure. diff --git a/src/oci/data_connectivity/models/operation_input_record.py b/src/oci/data_connectivity/models/operation_input_record.py index c16c09ccec..870e8d2555 100644 --- a/src/oci/data_connectivity/models/operation_input_record.py +++ b/src/oci/data_connectivity/models/operation_input_record.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class OperationInputRecord(object): """ - Holder for IN/INOUT params' values. + Holder for IN/INOUT parameter values. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def field_values(self): """ Gets the field_values of this OperationInputRecord. - values of IN/INOUT params. + Values of IN/INOUT parameter. :return: The field_values of this OperationInputRecord. @@ -49,7 +49,7 @@ def field_values(self): def field_values(self, field_values): """ Sets the field_values of this OperationInputRecord. - values of IN/INOUT params. + Values of IN/INOUT parameter. :param field_values: The field_values of this OperationInputRecord. diff --git a/src/oci/data_connectivity/models/operation_summary.py b/src/oci/data_connectivity/models/operation_summary.py index 67bd8e87ef..487bb626fa 100644 --- a/src/oci/data_connectivity/models/operation_summary.py +++ b/src/oci/data_connectivity/models/operation_summary.py @@ -10,25 +10,30 @@ @init_model_state_from_kwargs class OperationSummary(object): """ - The operation summary 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" + #: A constant which can be used with the model_type property of a OperationSummary. + #: This constant has a value of "API" + MODEL_TYPE_API = "API" + 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` + * :class:`~oci.data_connectivity.models.OperationSummaryFromApi` 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'. + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type model_type: str @@ -60,6 +65,9 @@ def get_subtype(object_dictionary): if type == 'PROCEDURE': return 'OperationSummaryFromProcedure' + + if type == 'API': + return 'OperationSummaryFromApi' else: return 'OperationSummary' @@ -67,9 +75,9 @@ def get_subtype(object_dictionary): def model_type(self): """ **[Required]** Gets the model_type of this OperationSummary. - The operation type + The operation type. - Allowed values for this property are: "PROCEDURE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -82,13 +90,13 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this OperationSummary. - The operation type + The operation type. :param model_type: The model_type of this OperationSummary. :type: str """ - allowed_values = ["PROCEDURE"] + allowed_values = ["PROCEDURE", "API"] if not value_allowed_none_or_none_sentinel(model_type, allowed_values): model_type = 'UNKNOWN_ENUM_VALUE' self._model_type = model_type diff --git a/src/oci/data_connectivity/models/operation_summary_collection.py b/src/oci/data_connectivity/models/operation_summary_collection.py index 360f071d3d..70e214b35a 100644 --- a/src/oci/data_connectivity/models/operation_summary_collection.py +++ b/src/oci/data_connectivity/models/operation_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class OperationSummaryCollection(object): """ - This is the collection of operation summaries, it will contain very shallow details of an operation. + This is the collection of operation summaries, with minimal details of an operation. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this OperationSummaryCollection. - The array of operation summary + The array of operation summary. :return: The items of this OperationSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this OperationSummaryCollection. - The array of operation summary + The array of operation summary. :param items: The items of this OperationSummaryCollection. diff --git a/src/oci/data_connectivity/models/operation_summary_from_api.py b/src/oci/data_connectivity/models/operation_summary_from_api.py new file mode 100644 index 0000000000..58af957928 --- /dev/null +++ b/src/oci/data_connectivity/models/operation_summary_from_api.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 OperationSummaryFromApi(OperationSummary): + """ + The API operation summary object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new OperationSummaryFromApi object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.OperationSummaryFromApi.model_type` attribute + of this class is ``API`` 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 OperationSummaryFromApi. + Allowed values for this property are: "PROCEDURE", "API" + :type model_type: str + + :param metadata: + The value to assign to the metadata property of this OperationSummaryFromApi. + :type metadata: oci.data_connectivity.models.ObjectMetadata + + :param key: + The value to assign to the key property of this OperationSummaryFromApi. + :type key: str + + :param model_version: + The value to assign to the model_version property of this OperationSummaryFromApi. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this OperationSummaryFromApi. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this OperationSummaryFromApi. + :type name: str + + :param object_version: + The value to assign to the object_version property of this OperationSummaryFromApi. + :type object_version: int + + :param external_key: + The value to assign to the external_key property of this OperationSummaryFromApi. + :type external_key: str + + :param resource_name: + The value to assign to the resource_name property of this OperationSummaryFromApi. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this OperationSummaryFromApi. + :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 = 'API' + + @property + def key(self): + """ + Gets the key of this OperationSummaryFromApi. + The object key. + + + :return: The key of this OperationSummaryFromApi. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this OperationSummaryFromApi. + The object key. + + + :param key: The key of this OperationSummaryFromApi. + :type: str + """ + self._key = key + + @property + def model_version(self): + """ + Gets the model_version of this OperationSummaryFromApi. + The model version of the object. + + + :return: The model_version of this OperationSummaryFromApi. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this OperationSummaryFromApi. + The model version of the object. + + + :param model_version: The model_version of this OperationSummaryFromApi. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this OperationSummaryFromApi. + + :return: The parent_ref of this OperationSummaryFromApi. + :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 OperationSummaryFromApi. + + :param parent_ref: The parent_ref of this OperationSummaryFromApi. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this OperationSummaryFromApi. + The operation name. + + + :return: The name of this OperationSummaryFromApi. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this OperationSummaryFromApi. + The operation name. + + + :param name: The name of this OperationSummaryFromApi. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this OperationSummaryFromApi. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this OperationSummaryFromApi. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this OperationSummaryFromApi. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this OperationSummaryFromApi. + :type: int + """ + self._object_version = object_version + + @property + def external_key(self): + """ + Gets the external_key of this OperationSummaryFromApi. + The external key for the object. + + + :return: The external_key of this OperationSummaryFromApi. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this OperationSummaryFromApi. + The external key for the object. + + + :param external_key: The external_key of this OperationSummaryFromApi. + :type: str + """ + self._external_key = external_key + + @property + def resource_name(self): + """ + Gets the resource_name of this OperationSummaryFromApi. + The resource name. + + + :return: The resource_name of this OperationSummaryFromApi. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this OperationSummaryFromApi. + The resource name. + + + :param resource_name: The resource_name of this OperationSummaryFromApi. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this OperationSummaryFromApi. + 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 OperationSummaryFromApi. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this OperationSummaryFromApi. + 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 OperationSummaryFromApi. + :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_summary_from_procedure.py b/src/oci/data_connectivity/models/operation_summary_from_procedure.py index 18b2c4fe57..7670a7c5f9 100644 --- a/src/oci/data_connectivity/models/operation_summary_from_procedure.py +++ b/src/oci/data_connectivity/models/operation_summary_from_procedure.py @@ -21,7 +21,7 @@ def __init__(self, **kwargs): :param model_type: The value to assign to the model_type property of this OperationSummaryFromProcedure. - Allowed values for this property are: "PROCEDURE" + Allowed values for this property are: "PROCEDURE", "API" :type model_type: str :param metadata: @@ -219,7 +219,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this OperationSummaryFromProcedure. - The external key for the object. + The external key of the object. :return: The external_key of this OperationSummaryFromProcedure. @@ -231,7 +231,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this OperationSummaryFromProcedure. - The external key for the object. + The external key of the object. :param external_key: The external_key of this OperationSummaryFromProcedure. diff --git a/src/oci/data_connectivity/models/outlier.py b/src/oci/data_connectivity/models/outlier.py index ae6991fad2..3370cfcba8 100644 --- a/src/oci/data_connectivity/models/outlier.py +++ b/src/oci/data_connectivity/models/outlier.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Outlier(object): """ - To capture all the Outlier details related to profiling + To capture all the Outlier details related to profiling. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/output_port.py b/src/oci/data_connectivity/models/output_port.py index 18d3ffa05c..81bd5e08b6 100644 --- a/src/oci/data_connectivity/models/output_port.py +++ b/src/oci/data_connectivity/models/output_port.py @@ -116,7 +116,7 @@ def __init__(self, **kwargs): def port_type(self): """ Gets the port_type of this OutputPort. - The port details for the data asset.Type. + The port details of the data asset type. Allowed values for this property are: "DATA", "CONTROL", "MODEL" @@ -130,7 +130,7 @@ def port_type(self): def port_type(self, port_type): """ Sets the port_type of this OutputPort. - The port details for the data asset.Type. + The port details of the data asset type. :param port_type: The port_type of this OutputPort. diff --git a/src/oci/data_connectivity/models/parameter.py b/src/oci/data_connectivity/models/parameter.py index 358d31e0de..df820eac4e 100644 --- a/src/oci/data_connectivity/models/parameter.py +++ b/src/oci/data_connectivity/models/parameter.py @@ -199,7 +199,7 @@ def default_value(self, default_value): 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. + 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. @@ -211,7 +211,7 @@ def root_object_default_value(self): 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. + 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. @@ -223,7 +223,7 @@ def root_object_default_value(self, root_object_default_value): def is_input(self): """ Gets the is_input of this Parameter. - Specifies whether the parameter is input value. + Specifies whether the parameter is an input value. :return: The is_input of this Parameter. @@ -235,7 +235,7 @@ def is_input(self): def is_input(self, is_input): """ Sets the is_input of this Parameter. - Specifies whether the parameter is input value. + Specifies whether the parameter is an input value. :param is_input: The is_input of this Parameter. @@ -247,7 +247,7 @@ def is_input(self, is_input): def is_output(self): """ Gets the is_output of this Parameter. - Specifies whether the parameter is output value. + Specifies whether the parameter is an output value. :return: The is_output of this Parameter. @@ -259,7 +259,7 @@ def is_output(self): def is_output(self, is_output): """ Sets the is_output of this Parameter. - Specifies whether the parameter is output value. + Specifies whether the parameter is an output value. :param is_output: The is_output of this Parameter. diff --git a/src/oci/data_connectivity/models/parent_reference.py b/src/oci/data_connectivity/models/parent_reference.py index b48183f07d..8729ca1d24 100644 --- a/src/oci/data_connectivity/models/parent_reference.py +++ b/src/oci/data_connectivity/models/parent_reference.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ParentReference(object): """ - A reference to the object's parent. + A reference to the parent object. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/profile_config.py b/src/oci/data_connectivity/models/profile_config.py index d67550885a..98052d72a4 100644 --- a/src/oci/data_connectivity/models/profile_config.py +++ b/src/oci/data_connectivity/models/profile_config.py @@ -146,7 +146,7 @@ def __init__(self, **kwargs): def attributes(self): """ Gets the attributes of this ProfileConfig. - Array of column names to profile. If empty all columns in the entity are profiled. + Array of column names to profile. If empty, all the columns in the entity are profiled. :return: The attributes of this ProfileConfig. @@ -158,7 +158,7 @@ def attributes(self): 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. + Array of column names to profile. If empty, all the columns in the entity are profiled. :param attributes: The attributes of this ProfileConfig. @@ -170,7 +170,7 @@ def attributes(self, attributes): 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. + Array of enum strings to decide which profile functions to run. If empty, all the 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" @@ -184,7 +184,7 @@ def functions(self): 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. + Array of enum strings to decide which profile functions to run. If empty, all the supported functions are run. :param functions: The functions of this ProfileConfig. @@ -205,7 +205,7 @@ def functions(self, functions): 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. + 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. @@ -217,7 +217,7 @@ def top_n_val_freq(self): 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. + 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. @@ -229,7 +229,7 @@ def top_n_val_freq(self, top_n_val_freq): 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. + A pattern has to qualify at least this percentage threshold to be considered a pattern on its own. Patterns that do not qualify are clubbed together into 'Others' pattern. :return: The pattern_threshold of this ProfileConfig. @@ -241,7 +241,7 @@ def pattern_threshold(self): 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. + A pattern has to qualify at least this percentage threshold to be considered a pattern on its own. Patterns that do not qualify are clubbed together into 'Others' pattern. :param pattern_threshold: The pattern_threshold of this ProfileConfig. @@ -253,7 +253,7 @@ def pattern_threshold(self, pattern_threshold): 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. + A data type has to qualify at least this percentage threshold to be considered an inferred data type for a column. :return: The data_type_threshold of this ProfileConfig. @@ -265,7 +265,7 @@ def data_type_threshold(self): 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. + A data type has to qualify at least this percentage threshold to be considered an inferred data type for a column. :param data_type_threshold: The data_type_threshold of this ProfileConfig. diff --git a/src/oci/data_connectivity/models/profile_stat.py b/src/oci/data_connectivity/models/profile_stat.py index 3f8b264529..687ca1cc67 100644 --- a/src/oci/data_connectivity/models/profile_stat.py +++ b/src/oci/data_connectivity/models/profile_stat.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ProfileStat(object): """ - To capture all the statistical data related to profiling + To capture all the statistical data related to profiling. """ def __init__(self, **kwargs): @@ -68,7 +68,7 @@ def confidence(self, confidence): def value(self): """ Gets the value of this ProfileStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :return: The value of this ProfileStat. @@ -80,7 +80,7 @@ def value(self): def value(self, value): """ Sets the value of this ProfileStat. - Value of the confidence of the profile result + Value of the confidence of the profile result. :param value: The value of this ProfileStat. diff --git a/src/oci/data_connectivity/models/read_operation_config.py b/src/oci/data_connectivity/models/read_operation_config.py index a28230b8df..a8b9a14a00 100644 --- a/src/oci/data_connectivity/models/read_operation_config.py +++ b/src/oci/data_connectivity/models/read_operation_config.py @@ -24,6 +24,10 @@ def __init__(self, **kwargs): Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" :type model_type: str + :param derived_attributes: + The value to assign to the derived_attributes property of this ReadOperationConfig. + :type derived_attributes: dict(str, str) + :param key: The value to assign to the key property of this ReadOperationConfig. :type key: str @@ -63,6 +67,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { 'model_type': 'str', + 'derived_attributes': 'dict(str, str)', 'key': 'str', 'model_version': 'str', 'parent_ref': 'ParentReference', @@ -76,6 +81,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'model_type': 'modelType', + 'derived_attributes': 'derivedAttributes', 'key': 'key', 'model_version': 'modelVersion', 'parent_ref': 'parentRef', @@ -88,6 +94,7 @@ def __init__(self, **kwargs): } self._model_type = None + self._derived_attributes = None self._key = None self._model_version = None self._parent_ref = None @@ -127,7 +134,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this ReadOperationConfig. - The object's model version. + The model version of the object. :return: The model_version of this ReadOperationConfig. @@ -139,7 +146,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this ReadOperationConfig. - The object's model version. + The model version of the object. :param model_version: The model_version of this ReadOperationConfig. @@ -279,7 +286,7 @@ def object_status(self, object_status): def read_raw_data(self): """ Gets the read_raw_data of this ReadOperationConfig. - Specifies if this readOperationConfig operation should trigger raw data preview flow. + Specifies if the readOperationConfig operation should trigger a raw data preview flow. :return: The read_raw_data of this ReadOperationConfig. @@ -291,7 +298,7 @@ def read_raw_data(self): 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. + Specifies if the readOperationConfig operation should trigger a raw data preview flow. :param read_raw_data: The read_raw_data of this ReadOperationConfig. diff --git a/src/oci/data_connectivity/models/reference_artifact_summary.py b/src/oci/data_connectivity/models/reference_artifact_summary.py index d25b79e69d..c6d201faa0 100644 --- a/src/oci/data_connectivity/models/reference_artifact_summary.py +++ b/src/oci/data_connectivity/models/reference_artifact_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ReferenceArtifactSummary(object): """ - Represents Reference details of a data asset. + Represents the reference details of a data asset. """ def __init__(self, **kwargs): @@ -121,7 +121,7 @@ def __init__(self, **kwargs): def model_type(self): """ **[Required]** Gets the model_type of this ReferenceArtifactSummary. - The type of the ReferenceInfo. + The type of ReferenceInfo. :return: The model_type of this ReferenceArtifactSummary. @@ -133,7 +133,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this ReferenceArtifactSummary. - The type of the ReferenceInfo. + The type of ReferenceInfo. :param model_type: The model_type of this ReferenceArtifactSummary. @@ -145,7 +145,7 @@ def model_type(self, model_type): def key(self): """ Gets the key of this ReferenceArtifactSummary. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :return: The key of this ReferenceArtifactSummary. @@ -157,7 +157,7 @@ def key(self): def key(self, key): """ Sets the key of this ReferenceArtifactSummary. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :param key: The key of this ReferenceArtifactSummary. @@ -193,7 +193,7 @@ def model_version(self, model_version): 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. + Free form text without any restriction on the 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. @@ -205,7 +205,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -289,7 +289,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this ReferenceArtifactSummary. @@ -301,7 +301,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this ReferenceArtifactSummary. @@ -313,7 +313,7 @@ def identifier(self, identifier): def dcms_artifact_id(self): """ Gets the dcms_artifact_id of this ReferenceArtifactSummary. - unique id of dcms artifact that is getting registered. + The unique ID of the DCMS artifact that is getting registered. :return: The dcms_artifact_id of this ReferenceArtifactSummary. @@ -325,7 +325,7 @@ def dcms_artifact_id(self): 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. + The unique ID of the DCMS artifact that is getting registered. :param dcms_artifact_id: The dcms_artifact_id of this ReferenceArtifactSummary. @@ -337,7 +337,7 @@ def dcms_artifact_id(self, dcms_artifact_id): def service_artifact_id(self): """ **[Required]** Gets the service_artifact_id of this ReferenceArtifactSummary. - unique id of service which is referencing dcms artifact. + The unique ID of the service that is referencing a DCMS artifact. :return: The service_artifact_id of this ReferenceArtifactSummary. @@ -349,7 +349,7 @@ def service_artifact_id(self): 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. + The unique ID of the service that is referencing a DCMS artifact. :param service_artifact_id: The service_artifact_id of this ReferenceArtifactSummary. @@ -361,7 +361,7 @@ def service_artifact_id(self, service_artifact_id): 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. + The number of times a DCMS artifact has been registered by a service. :return: The reference_count of this ReferenceArtifactSummary. @@ -373,7 +373,7 @@ def reference_count(self): 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. + The number of times a DCMS artifact has been registered by a service. :param reference_count: The reference_count of this ReferenceArtifactSummary. diff --git a/src/oci/data_connectivity/models/reference_artifact_summary_collection.py b/src/oci/data_connectivity/models/reference_artifact_summary_collection.py index eeb70f09f2..49b968b8ea 100644 --- a/src/oci/data_connectivity/models/reference_artifact_summary_collection.py +++ b/src/oci/data_connectivity/models/reference_artifact_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of reference details summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/reference_info.py b/src/oci/data_connectivity/models/reference_info.py index 6e82171337..606e91991e 100644 --- a/src/oci/data_connectivity/models/reference_info.py +++ b/src/oci/data_connectivity/models/reference_info.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ReferenceInfo(object): """ - Represents reference details of a dcms artifact. + Represents reference details of a DCMS artifact. """ def __init__(self, **kwargs): @@ -145,7 +145,7 @@ def model_type(self, model_type): def key(self): """ Gets the key of this ReferenceInfo. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :return: The key of this ReferenceInfo. @@ -157,7 +157,7 @@ def key(self): def key(self, key): """ Sets the key of this ReferenceInfo. - Generated key that can be used in API calls to identify referenceinfo. + Generated key that can be used in API calls to identify the referenceinfo. :param key: The key of this ReferenceInfo. @@ -193,7 +193,7 @@ def model_version(self, model_version): 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. + Free form text without any restriction on the 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. @@ -205,7 +205,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -289,7 +289,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this ReferenceInfo. @@ -301,7 +301,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this ReferenceInfo. @@ -313,7 +313,7 @@ def identifier(self, identifier): def dcms_artifact_id(self): """ **[Required]** Gets the dcms_artifact_id of this ReferenceInfo. - unique id of dcms artifact that is getting registered. + The unique ID of the DCMS artifact that is getting registered. :return: The dcms_artifact_id of this ReferenceInfo. @@ -325,7 +325,7 @@ def dcms_artifact_id(self): 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. + The unique ID of the DCMS artifact that is getting registered. :param dcms_artifact_id: The dcms_artifact_id of this ReferenceInfo. @@ -337,7 +337,7 @@ def dcms_artifact_id(self, dcms_artifact_id): def service_artifact_id(self): """ **[Required]** Gets the service_artifact_id of this ReferenceInfo. - unique id of service which is referencing data asset. + The unique ID of the service that is referencing a data asset. :return: The service_artifact_id of this ReferenceInfo. @@ -349,7 +349,7 @@ def service_artifact_id(self): 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. + The unique ID of the service that is referencing a data asset. :param service_artifact_id: The service_artifact_id of this ReferenceInfo. @@ -361,7 +361,7 @@ def service_artifact_id(self, service_artifact_id): 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. + The number of times a data asset has been registered by a service. :return: The reference_count of this ReferenceInfo. @@ -373,7 +373,7 @@ def reference_count(self): 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. + The number of times a data asset has been registered by a service. :param reference_count: The reference_count of this ReferenceInfo. diff --git a/src/oci/data_connectivity/models/referenced_data_object.py b/src/oci/data_connectivity/models/referenced_data_object.py new file mode 100644 index 0000000000..5732c2fba9 --- /dev/null +++ b/src/oci/data_connectivity/models/referenced_data_object.py @@ -0,0 +1,320 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferencedDataObject(object): + """ + The input Operation for which derived entity is to be formed. + """ + + #: A constant which can be used with the model_type property of a ReferencedDataObject. + #: This constant has a value of "PROCEDURE" + MODEL_TYPE_PROCEDURE = "PROCEDURE" + + #: A constant which can be used with the model_type property of a ReferencedDataObject. + #: This constant has a value of "API" + MODEL_TYPE_API = "API" + + def __init__(self, **kwargs): + """ + Initializes a new ReferencedDataObject 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.ReferencedDataObjectFromAPI` + * :class:`~oci.data_connectivity.models.ReferencedDataObjectFromProcedure` + + 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 ReferencedDataObject. + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ReferencedDataObject. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ReferencedDataObject. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ReferencedDataObject. + :type name: str + + :param object_version: + The value to assign to the object_version property of this ReferencedDataObject. + :type object_version: int + + :param resource_name: + The value to assign to the resource_name property of this ReferencedDataObject. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this ReferencedDataObject. + :type object_status: int + + :param external_key: + The value to assign to the external_key property of this ReferencedDataObject. + :type external_key: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'resource_name': 'str', + 'object_status': 'int', + 'external_key': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'external_key': 'externalKey' + } + + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._resource_name = None + self._object_status = None + self._external_key = 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 == 'API': + return 'ReferencedDataObjectFromAPI' + + if type == 'PROCEDURE': + return 'ReferencedDataObjectFromProcedure' + else: + return 'ReferencedDataObject' + + @property + def model_type(self): + """ + **[Required]** Gets the model_type of this ReferencedDataObject. + The input Operation type. + + Allowed values for this property are: "PROCEDURE", "API", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The model_type of this ReferencedDataObject. + :rtype: str + """ + return self._model_type + + @model_type.setter + def model_type(self, model_type): + """ + Sets the model_type of this ReferencedDataObject. + The input Operation type. + + + :param model_type: The model_type of this ReferencedDataObject. + :type: str + """ + allowed_values = ["PROCEDURE", "API"] + if not value_allowed_none_or_none_sentinel(model_type, allowed_values): + model_type = 'UNKNOWN_ENUM_VALUE' + self._model_type = model_type + + @property + def model_version(self): + """ + Gets the model_version of this ReferencedDataObject. + The object's model version. + + + :return: The model_version of this ReferencedDataObject. + :rtype: str + """ + return self._model_version + + @model_version.setter + def model_version(self, model_version): + """ + Sets the model_version of this ReferencedDataObject. + The object's model version. + + + :param model_version: The model_version of this ReferencedDataObject. + :type: str + """ + self._model_version = model_version + + @property + def parent_ref(self): + """ + Gets the parent_ref of this ReferencedDataObject. + + :return: The parent_ref of this ReferencedDataObject. + :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 ReferencedDataObject. + + :param parent_ref: The parent_ref of this ReferencedDataObject. + :type: oci.data_connectivity.models.ParentReference + """ + self._parent_ref = parent_ref + + @property + def name(self): + """ + Gets the name of this ReferencedDataObject. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :return: The name of this ReferencedDataObject. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ReferencedDataObject. + Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters. + + + :param name: The name of this ReferencedDataObject. + :type: str + """ + self._name = name + + @property + def object_version(self): + """ + Gets the object_version of this ReferencedDataObject. + The version of the object that is used to track changes in the object instance. + + + :return: The object_version of this ReferencedDataObject. + :rtype: int + """ + return self._object_version + + @object_version.setter + def object_version(self, object_version): + """ + Sets the object_version of this ReferencedDataObject. + The version of the object that is used to track changes in the object instance. + + + :param object_version: The object_version of this ReferencedDataObject. + :type: int + """ + self._object_version = object_version + + @property + def resource_name(self): + """ + Gets the resource_name of this ReferencedDataObject. + The resource name. + + + :return: The resource_name of this ReferencedDataObject. + :rtype: str + """ + return self._resource_name + + @resource_name.setter + def resource_name(self, resource_name): + """ + Sets the resource_name of this ReferencedDataObject. + The resource name. + + + :param resource_name: The resource_name of this ReferencedDataObject. + :type: str + """ + self._resource_name = resource_name + + @property + def object_status(self): + """ + Gets the object_status of this ReferencedDataObject. + 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 ReferencedDataObject. + :rtype: int + """ + return self._object_status + + @object_status.setter + def object_status(self, object_status): + """ + Sets the object_status of this ReferencedDataObject. + 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 ReferencedDataObject. + :type: int + """ + self._object_status = object_status + + @property + def external_key(self): + """ + Gets the external_key of this ReferencedDataObject. + The external key for the object. + + + :return: The external_key of this ReferencedDataObject. + :rtype: str + """ + return self._external_key + + @external_key.setter + def external_key(self, external_key): + """ + Sets the external_key of this ReferencedDataObject. + The external key for the object. + + + :param external_key: The external_key of this ReferencedDataObject. + :type: str + """ + self._external_key = external_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/referenced_data_object_from_api.py b/src/oci/data_connectivity/models/referenced_data_object_from_api.py new file mode 100644 index 0000000000..59b1763f29 --- /dev/null +++ b/src/oci/data_connectivity/models/referenced_data_object_from_api.py @@ -0,0 +1,129 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .referenced_data_object import ReferencedDataObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferencedDataObjectFromAPI(ReferencedDataObject): + """ + The input procedure object + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferencedDataObjectFromAPI object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ReferencedDataObjectFromAPI.model_type` attribute + of this class is ``API`` 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 ReferencedDataObjectFromAPI. + Allowed values for this property are: "PROCEDURE", "API" + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ReferencedDataObjectFromAPI. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ReferencedDataObjectFromAPI. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ReferencedDataObjectFromAPI. + :type name: str + + :param object_version: + The value to assign to the object_version property of this ReferencedDataObjectFromAPI. + :type object_version: int + + :param resource_name: + The value to assign to the resource_name property of this ReferencedDataObjectFromAPI. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this ReferencedDataObjectFromAPI. + :type object_status: int + + :param external_key: + The value to assign to the external_key property of this ReferencedDataObjectFromAPI. + :type external_key: str + + :param key: + The value to assign to the key property of this ReferencedDataObjectFromAPI. + :type key: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'resource_name': 'str', + 'object_status': 'int', + 'external_key': 'str', + 'key': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'external_key': 'externalKey', + 'key': 'key' + } + + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._resource_name = None + self._object_status = None + self._external_key = None + self._key = None + self._model_type = 'API' + + @property + def key(self): + """ + Gets the key of this ReferencedDataObjectFromAPI. + The object key. + + + :return: The key of this ReferencedDataObjectFromAPI. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferencedDataObjectFromAPI. + The object key. + + + :param key: The key of this ReferencedDataObjectFromAPI. + :type: str + """ + self._key = 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/referenced_data_object_from_procedure.py b/src/oci/data_connectivity/models/referenced_data_object_from_procedure.py new file mode 100644 index 0000000000..2b133f4812 --- /dev/null +++ b/src/oci/data_connectivity/models/referenced_data_object_from_procedure.py @@ -0,0 +1,129 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .referenced_data_object import ReferencedDataObject +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ReferencedDataObjectFromProcedure(ReferencedDataObject): + """ + The input procedure object + """ + + def __init__(self, **kwargs): + """ + Initializes a new ReferencedDataObjectFromProcedure object with values from keyword arguments. The default value of the :py:attr:`~oci.data_connectivity.models.ReferencedDataObjectFromProcedure.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 ReferencedDataObjectFromProcedure. + Allowed values for this property are: "PROCEDURE", "API" + :type model_type: str + + :param model_version: + The value to assign to the model_version property of this ReferencedDataObjectFromProcedure. + :type model_version: str + + :param parent_ref: + The value to assign to the parent_ref property of this ReferencedDataObjectFromProcedure. + :type parent_ref: oci.data_connectivity.models.ParentReference + + :param name: + The value to assign to the name property of this ReferencedDataObjectFromProcedure. + :type name: str + + :param object_version: + The value to assign to the object_version property of this ReferencedDataObjectFromProcedure. + :type object_version: int + + :param resource_name: + The value to assign to the resource_name property of this ReferencedDataObjectFromProcedure. + :type resource_name: str + + :param object_status: + The value to assign to the object_status property of this ReferencedDataObjectFromProcedure. + :type object_status: int + + :param external_key: + The value to assign to the external_key property of this ReferencedDataObjectFromProcedure. + :type external_key: str + + :param key: + The value to assign to the key property of this ReferencedDataObjectFromProcedure. + :type key: str + + """ + self.swagger_types = { + 'model_type': 'str', + 'model_version': 'str', + 'parent_ref': 'ParentReference', + 'name': 'str', + 'object_version': 'int', + 'resource_name': 'str', + 'object_status': 'int', + 'external_key': 'str', + 'key': 'str' + } + + self.attribute_map = { + 'model_type': 'modelType', + 'model_version': 'modelVersion', + 'parent_ref': 'parentRef', + 'name': 'name', + 'object_version': 'objectVersion', + 'resource_name': 'resourceName', + 'object_status': 'objectStatus', + 'external_key': 'externalKey', + 'key': 'key' + } + + self._model_type = None + self._model_version = None + self._parent_ref = None + self._name = None + self._object_version = None + self._resource_name = None + self._object_status = None + self._external_key = None + self._key = None + self._model_type = 'PROCEDURE' + + @property + def key(self): + """ + Gets the key of this ReferencedDataObjectFromProcedure. + The object key. + + + :return: The key of this ReferencedDataObjectFromProcedure. + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """ + Sets the key of this ReferencedDataObjectFromProcedure. + The object key. + + + :param key: The key of this ReferencedDataObjectFromProcedure. + :type: str + """ + self._key = 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/registry.py b/src/oci/data_connectivity/models/registry.py index 89e3ddb80a..55df15731a 100644 --- a/src/oci/data_connectivity/models/registry.py +++ b/src/oci/data_connectivity/models/registry.py @@ -10,7 +10,7 @@ @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 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. @@ -137,7 +137,7 @@ def __init__(self, **kwargs): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -150,7 +150,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -213,7 +213,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this Registry. - Data Connectivity Management Registry display name, registries can be renamed + Data Connectivity Management registry display name; registries can be renamed. :return: The display_name of this Registry. @@ -225,7 +225,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Registry. - Data Connectivity Management Registry display name, registries can be renamed + Data Connectivity Management registry display name; registries can be renamed. :param display_name: The display_name of this Registry. @@ -237,7 +237,7 @@ def display_name(self, display_name): def updated_by(self): """ Gets the updated_by of this Registry. - Name of the user who updated the DCMS Registry. + Name of the user who updated the DCMS registry. :return: The updated_by of this Registry. @@ -249,7 +249,7 @@ def updated_by(self): def updated_by(self, updated_by): """ Sets the updated_by of this Registry. - Name of the user who updated the DCMS Registry. + Name of the user who updated the DCMS registry. :param updated_by: The updated_by of this Registry. @@ -285,7 +285,7 @@ def compartment_id(self, compartment_id): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :return: The time_created of this Registry. @@ -297,7 +297,7 @@ def time_created(self): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :param time_created: The time_created of this Registry. @@ -309,7 +309,7 @@ def time_created(self, time_created): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :return: The time_updated of this Registry. @@ -321,7 +321,7 @@ def time_updated(self): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :param time_updated: The time_updated of this Registry. @@ -333,15 +333,15 @@ def time_updated(self, time_updated): 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 + Lifecycle states for registries in the 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 + 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 + 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'. @@ -356,15 +356,15 @@ def lifecycle_state(self): 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 + Lifecycle states for registries in the 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 + 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 + 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. @@ -403,7 +403,7 @@ def state_message(self, state_message): def id(self): """ **[Required]** Gets the id of this Registry. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :return: The id of this Registry. @@ -415,7 +415,7 @@ def id(self): def id(self, id): """ Sets the id of this Registry. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :param id: The id of this Registry. diff --git a/src/oci/data_connectivity/models/registry_metadata.py b/src/oci/data_connectivity/models/registry_metadata.py index 543d2580b4..2867491e34 100644 --- a/src/oci/data_connectivity/models/registry_metadata.py +++ b/src/oci/data_connectivity/models/registry_metadata.py @@ -131,7 +131,7 @@ def aggregator_key(self, aggregator_key): 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. + Labels are keywords or labels 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 RegistryMetadata. @@ -143,7 +143,7 @@ def labels(self): 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. + Labels are keywords or labels 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 RegistryMetadata. @@ -203,7 +203,7 @@ def key(self, key): def is_favorite(self): """ Gets the is_favorite of this RegistryMetadata. - Specifies whether this object is a favorite or not. + Specifies whether the object is a favorite. :return: The is_favorite of this RegistryMetadata. @@ -215,7 +215,7 @@ def is_favorite(self): def is_favorite(self, is_favorite): """ Sets the is_favorite of this RegistryMetadata. - Specifies whether this object is a favorite or not. + Specifies whether the object is a favorite. :param is_favorite: The is_favorite of this RegistryMetadata. @@ -227,7 +227,7 @@ def is_favorite(self, is_favorite): def created_by_user_id(self): """ Gets the created_by_user_id of this RegistryMetadata. - The id of the user who created the object. + The ID of the user who created the object. :return: The created_by_user_id of this RegistryMetadata. @@ -239,7 +239,7 @@ def created_by_user_id(self): 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. + The ID of the user who created the object. :param created_by_user_id: The created_by_user_id of this RegistryMetadata. @@ -275,7 +275,7 @@ def created_by_user_name(self, created_by_user_name): def updated_by_user_id(self): """ Gets the updated_by_user_id of this RegistryMetadata. - The id of the user who updated the object. + The ID of the user who updated the object. :return: The updated_by_user_id of this RegistryMetadata. @@ -287,7 +287,7 @@ def updated_by_user_id(self): 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. + The ID of the user who updated the object. :param updated_by_user_id: The updated_by_user_id of this RegistryMetadata. diff --git a/src/oci/data_connectivity/models/registry_summary.py b/src/oci/data_connectivity/models/registry_summary.py index 4a9b559cf9..e6079d4c38 100644 --- a/src/oci/data_connectivity/models/registry_summary.py +++ b/src/oci/data_connectivity/models/registry_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RegistrySummary(object): """ - Summary of a Registry. + The summary of a registry. """ def __init__(self, **kwargs): @@ -107,7 +107,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this RegistrySummary. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :return: The id of this RegistrySummary. @@ -119,7 +119,7 @@ def id(self): def id(self, id): """ Sets the id of this RegistrySummary. - Unique identifier that is immutable on creation + A unique identifier that is immutable on creation. :param id: The id of this RegistrySummary. @@ -131,7 +131,7 @@ def id(self, id): def description(self): """ Gets the description of this RegistrySummary. - Registry description + Registry description. :return: The description of this RegistrySummary. @@ -143,7 +143,7 @@ def description(self): def description(self, description): """ Sets the description of this RegistrySummary. - Registry description + Registry description. :param description: The description of this RegistrySummary. @@ -155,7 +155,7 @@ def description(self, description): def display_name(self): """ **[Required]** Gets the display_name of this RegistrySummary. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :return: The display_name of this RegistrySummary. @@ -167,7 +167,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this RegistrySummary. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :param display_name: The display_name of this RegistrySummary. @@ -203,7 +203,7 @@ def compartment_id(self, compartment_id): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :return: The time_created of this RegistrySummary. @@ -215,7 +215,7 @@ def time_created(self): 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 + Time when the Data Connectivity Management registry was created. An RFC3339 formatted datetime string. :param time_created: The time_created of this RegistrySummary. @@ -227,7 +227,7 @@ def time_created(self, time_created): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :return: The time_updated of this RegistrySummary. @@ -239,7 +239,7 @@ def time_updated(self): 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 + Time when the Data Connectivity Management registry was updated. An RFC3339 formatted datetime string. :param time_updated: The time_updated of this RegistrySummary. @@ -251,7 +251,7 @@ def time_updated(self, time_updated): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -264,7 +264,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` diff --git a/src/oci/data_connectivity/models/registry_summary_collection.py b/src/oci/data_connectivity/models/registry_summary_collection.py index bc7efedcae..3b98c17d9b 100644 --- a/src/oci/data_connectivity/models/registry_summary_collection.py +++ b/src/oci/data_connectivity/models/registry_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class RegistrySummaryCollection(object): """ - List of Registry summaries. + The list of registry summaries. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this RegistrySummaryCollection. - The array of Registry summariess + The array of registry summaries. :return: The items of this RegistrySummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this RegistrySummaryCollection. - The array of Registry summariess + The array of registry summaries. :param items: The items of this RegistrySummaryCollection. diff --git a/src/oci/data_connectivity/models/row.py b/src/oci/data_connectivity/models/row.py index a3b49c895d..9008e76f50 100644 --- a/src/oci/data_connectivity/models/row.py +++ b/src/oci/data_connectivity/models/row.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Row(object): """ - Data preview row calues. + Data preview row values. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/schema.py b/src/oci/data_connectivity/models/schema.py index 36e901261f..2a82ad0a33 100644 --- a/src/oci/data_connectivity/models/schema.py +++ b/src/oci/data_connectivity/models/schema.py @@ -152,7 +152,7 @@ def key(self, key): def model_type(self): """ **[Required]** Gets the model_type of this Schema. - The object's type. + The object type. :return: The model_type of this Schema. @@ -164,7 +164,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this Schema. - The object's type. + The object type. :param model_type: The model_type of this Schema. @@ -176,7 +176,7 @@ def model_type(self, model_type): def model_version(self): """ Gets the model_version of this Schema. - The object's model version. + The model version of the object. :return: The model_version of this Schema. @@ -188,7 +188,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this Schema. - The object's model version. + The model version of the object. :param model_version: The model_version of this Schema. @@ -220,7 +220,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -232,7 +232,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -316,7 +316,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this Schema. - The external key for the object. + The external key of the object. :return: The external_key of this Schema. @@ -328,7 +328,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this Schema. - The external key for the object. + The external key of the object. :param external_key: The external_key of this Schema. @@ -412,7 +412,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this Schema. @@ -424,7 +424,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this Schema. diff --git a/src/oci/data_connectivity/models/schema_drift_config.py b/src/oci/data_connectivity/models/schema_drift_config.py index 3fcd7d77bd..7bb2133ee8 100644 --- a/src/oci/data_connectivity/models/schema_drift_config.py +++ b/src/oci/data_connectivity/models/schema_drift_config.py @@ -97,7 +97,7 @@ def __init__(self, **kwargs): 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. + The setting 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" @@ -111,7 +111,7 @@ def extra_column_handling(self): 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. + The setting 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. @@ -129,7 +129,7 @@ def extra_column_handling(self, extra_column_handling): 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. + The setting 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" @@ -143,7 +143,7 @@ def missing_column_handling(self): 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. + The setting 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. @@ -161,7 +161,7 @@ def missing_column_handling(self, missing_column_handling): 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. + The setting to handle columns/fields with changed data types. Allowed values for this property are: "ALLOW", "DO_CAST_IF_POSSIBLE", "DO_NOT_ALLOW" @@ -175,7 +175,7 @@ def data_type_change_handling(self): 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. + The setting to handle columns/fields with changed data types. :param data_type_change_handling: The data_type_change_handling of this SchemaDriftConfig. diff --git a/src/oci/data_connectivity/models/schema_summary.py b/src/oci/data_connectivity/models/schema_summary.py index 9e922e2362..60c8651c19 100644 --- a/src/oci/data_connectivity/models/schema_summary.py +++ b/src/oci/data_connectivity/models/schema_summary.py @@ -152,7 +152,7 @@ def key(self, key): def model_type(self): """ **[Required]** Gets the model_type of this SchemaSummary. - The object's type. + The object type. :return: The model_type of this SchemaSummary. @@ -164,7 +164,7 @@ def model_type(self): def model_type(self, model_type): """ Sets the model_type of this SchemaSummary. - The object's type. + The object type. :param model_type: The model_type of this SchemaSummary. @@ -176,7 +176,7 @@ def model_type(self, model_type): def model_version(self): """ Gets the model_version of this SchemaSummary. - The object's model version. + The model version of the object. :return: The model_version of this SchemaSummary. @@ -188,7 +188,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this SchemaSummary. - The object's model version. + The model version of the object. :param model_version: The model_version of this SchemaSummary. @@ -220,7 +220,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -232,7 +232,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -316,7 +316,7 @@ def object_version(self, object_version): def external_key(self): """ Gets the external_key of this SchemaSummary. - The external key for the object. + The external key of the object. :return: The external_key of this SchemaSummary. @@ -328,7 +328,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this SchemaSummary. - The external key for the object. + The external key of the object. :param external_key: The external_key of this SchemaSummary. @@ -412,7 +412,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this SchemaSummary. @@ -424,7 +424,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this SchemaSummary. diff --git a/src/oci/data_connectivity/models/schema_summary_collection.py b/src/oci/data_connectivity/models/schema_summary_collection.py index f97df42fb0..cb4baccfac 100644 --- a/src/oci/data_connectivity/models/schema_summary_collection.py +++ b/src/oci/data_connectivity/models/schema_summary_collection.py @@ -10,7 +10,7 @@ @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. + This is the collection of schema summaries; it can be a collection of lightweight details or full definitions. """ def __init__(self, **kwargs): diff --git a/src/oci/data_connectivity/models/shape_field.py b/src/oci/data_connectivity/models/shape_field.py index 0898665ad5..eabf73b9b6 100644 --- a/src/oci/data_connectivity/models/shape_field.py +++ b/src/oci/data_connectivity/models/shape_field.py @@ -134,7 +134,7 @@ def type(self, type): 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. + Labels are keywords or labels 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 ShapeField. @@ -146,7 +146,7 @@ def labels(self): 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. + Labels are keywords or labels 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 ShapeField. diff --git a/src/oci/data_connectivity/models/string_attribute.py b/src/oci/data_connectivity/models/string_attribute.py index c37d718c1e..a44b04f964 100644 --- a/src/oci/data_connectivity/models/string_attribute.py +++ b/src/oci/data_connectivity/models/string_attribute.py @@ -190,7 +190,7 @@ def mean_length(self, mean_length): def pattern_frequencies(self): """ Gets the pattern_frequencies of this StringAttribute. - Pattern frequencies for the column as described already in profile config. + Pattern frequencies for the column as described in the profile config. :return: The pattern_frequencies of this StringAttribute. @@ -202,7 +202,7 @@ def pattern_frequencies(self): def pattern_frequencies(self, pattern_frequencies): """ Sets the pattern_frequencies of this StringAttribute. - Pattern frequencies for the column as described already in profile config. + Pattern frequencies for the column as described in the profile config. :param pattern_frequencies: The pattern_frequencies of this StringAttribute. diff --git a/src/oci/data_connectivity/models/test_network_connectivity.py b/src/oci/data_connectivity/models/test_network_connectivity.py index d254ddbac4..a982d227ac 100644 --- a/src/oci/data_connectivity/models/test_network_connectivity.py +++ b/src/oci/data_connectivity/models/test_network_connectivity.py @@ -75,7 +75,7 @@ def network_validation_output(self, network_validation_output): def is_reachable(self): """ **[Required]** Gets the is_reachable of this TestNetworkConnectivity. - True if the data asset is has a valid network path. + True if the data asset has a valid network path. :return: The is_reachable of this TestNetworkConnectivity. @@ -87,7 +87,7 @@ def is_reachable(self): def is_reachable(self, is_reachable): """ Sets the is_reachable of this TestNetworkConnectivity. - True if the data asset is has a valid network path. + True if the data asset has a valid network path. :param is_reachable: The is_reachable of this TestNetworkConnectivity. diff --git a/src/oci/data_connectivity/models/type.py b/src/oci/data_connectivity/models/type.py index f0dee36915..d39345be1c 100644 --- a/src/oci/data_connectivity/models/type.py +++ b/src/oci/data_connectivity/models/type.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class Type(object): """ - DataAsset & Connection Registry Attributes + DataAsset and Connection Registry Attributes """ def __init__(self, **kwargs): @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def data_asset_attributes(self): """ **[Required]** Gets the data_asset_attributes of this Type. - list of attributes for the dataAsset + The list of attributes of the data asset. :return: The data_asset_attributes of this Type. @@ -56,7 +56,7 @@ def data_asset_attributes(self): def data_asset_attributes(self, data_asset_attributes): """ Sets the data_asset_attributes of this Type. - list of attributes for the dataAsset + The list of attributes of the data asset. :param data_asset_attributes: The data_asset_attributes of this Type. @@ -68,7 +68,7 @@ def data_asset_attributes(self, data_asset_attributes): def connection_attributes(self): """ **[Required]** Gets the connection_attributes of this Type. - Map of connectionType as key and List of attributes as value + Mapping the connectionType as the key to the list of attributes as the value. :return: The connection_attributes of this Type. @@ -80,7 +80,7 @@ def connection_attributes(self): def connection_attributes(self, connection_attributes): """ Sets the connection_attributes of this Type. - Map of connectionType as key and List of attributes as value + Mapping the connectionType as the key to the list of attributes as the value. :param connection_attributes: The connection_attributes of this Type. diff --git a/src/oci/data_connectivity/models/type_library.py b/src/oci/data_connectivity/models/type_library.py index 9cfb571a44..92a0cae020 100644 --- a/src/oci/data_connectivity/models/type_library.py +++ b/src/oci/data_connectivity/models/type_library.py @@ -192,7 +192,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -204,7 +204,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -312,7 +312,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this TypeLibrary. @@ -324,7 +324,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this TypeLibrary. diff --git a/src/oci/data_connectivity/models/type_summary.py b/src/oci/data_connectivity/models/type_summary.py index 68b6f3555f..bb53e22445 100644 --- a/src/oci/data_connectivity/models/type_summary.py +++ b/src/oci/data_connectivity/models/type_summary.py @@ -51,7 +51,7 @@ def __init__(self, **kwargs): def key(self): """ **[Required]** Gets the key of this TypeSummary. - unique id of specefic data asset type. + The unique ID of the specific data asset type. :return: The key of this TypeSummary. @@ -63,7 +63,7 @@ def key(self): def key(self, key): """ Sets the key of this TypeSummary. - unique id of specefic data asset type. + The unique ID of the specific data asset type. :param key: The key of this TypeSummary. @@ -99,7 +99,7 @@ def name(self, name): def description(self): """ Gets the description of this TypeSummary. - desctription for the specific data asset type. + Description for the specific data asset type. :return: The description of this TypeSummary. @@ -111,7 +111,7 @@ def description(self): def description(self, description): """ Sets the description of this TypeSummary. - desctription for the specific data asset type. + Description for the specific data asset type. :param description: The description of this TypeSummary. diff --git a/src/oci/data_connectivity/models/type_system.py b/src/oci/data_connectivity/models/type_system.py index 8ff813fe3f..9b31ea6bf8 100644 --- a/src/oci/data_connectivity/models/type_system.py +++ b/src/oci/data_connectivity/models/type_system.py @@ -206,7 +206,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -218,7 +218,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -230,7 +230,7 @@ def name(self, name): def description(self): """ Gets the description of this TypeSystem. - A user defined description for the object. + A user-defined description for the object. :return: The description of this TypeSystem. @@ -242,7 +242,7 @@ def description(self): def description(self, description): """ Sets the description of this TypeSystem. - A user defined description for the object. + A user-defined description for the object. :param description: The description of this TypeSystem. @@ -350,7 +350,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this TypeSystem. @@ -362,7 +362,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this TypeSystem. diff --git a/src/oci/data_connectivity/models/typed_object.py b/src/oci/data_connectivity/models/typed_object.py index 8aa9580d3d..5959e02cbc 100644 --- a/src/oci/data_connectivity/models/typed_object.py +++ b/src/oci/data_connectivity/models/typed_object.py @@ -280,7 +280,7 @@ def object_status(self, object_status): 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. + Free form text without any restriction on the 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. @@ -292,7 +292,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -304,7 +304,7 @@ def name(self, name): def description(self): """ Gets the description of this TypedObject. - Detailed description for the object. + A detailed description of the object. :return: The description of this TypedObject. @@ -316,7 +316,7 @@ def description(self): def description(self, description): """ Sets the description of this TypedObject. - Detailed description for the object. + A detailed description of the object. :param description: The description of this TypedObject. diff --git a/src/oci/data_connectivity/models/types_summary_collection.py b/src/oci/data_connectivity/models/types_summary_collection.py index 9ff754a9ff..180dc8c715 100644 --- a/src/oci/data_connectivity/models/types_summary_collection.py +++ b/src/oci/data_connectivity/models/types_summary_collection.py @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this TypesSummaryCollection. - The array of Type summaries + The array of type summaries. :return: The items of this TypesSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this TypesSummaryCollection. - The array of Type summaries + The array of type summaries. :param items: The items of this TypesSummaryCollection. diff --git a/src/oci/data_connectivity/models/unique_key.py b/src/oci/data_connectivity/models/unique_key.py index 51de87a2ce..ee0c356961 100644 --- a/src/oci/data_connectivity/models/unique_key.py +++ b/src/oci/data_connectivity/models/unique_key.py @@ -160,7 +160,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this UniqueKey. - The object's model version. + The model version of the object. :return: The model_version of this UniqueKey. @@ -172,7 +172,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this UniqueKey. - The object's model version. + The model version of the object. :param model_version: The model_version of this UniqueKey. @@ -204,7 +204,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -216,7 +216,7 @@ def name(self): 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. + Free form text without any restriction on the 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. diff --git a/src/oci/data_connectivity/models/update_connection_details.py b/src/oci/data_connectivity/models/update_connection_details.py index 13f58fd34c..a7fc5dc43d 100644 --- a/src/oci/data_connectivity/models/update_connection_details.py +++ b/src/oci/data_connectivity/models/update_connection_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateConnectionDetails(object): """ - Properties used in connection update operations. + Properties used in the update connection operations. """ def __init__(self, **kwargs): @@ -176,7 +176,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -188,7 +188,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -272,7 +272,7 @@ def object_status(self, object_status): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this UpdateConnectionDetails. @@ -284,7 +284,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this UpdateConnectionDetails. @@ -316,7 +316,7 @@ def primary_schema(self, primary_schema): def connection_properties(self): """ Gets the connection_properties of this UpdateConnectionDetails. - The properties for the connection. + The properties of the connection. :return: The connection_properties of this UpdateConnectionDetails. @@ -328,7 +328,7 @@ def connection_properties(self): def connection_properties(self, connection_properties): """ Sets the connection_properties of this UpdateConnectionDetails. - The properties for the connection. + The properties of the connection. :param connection_properties: The connection_properties of this UpdateConnectionDetails. @@ -340,7 +340,7 @@ def connection_properties(self, connection_properties): def properties(self): """ **[Required]** Gets the properties of this UpdateConnectionDetails. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :return: The properties of this UpdateConnectionDetails. @@ -352,7 +352,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this UpdateConnectionDetails. - All the properties for the connection in a key-value map format. + All the properties of the connection in a key-value map format. :param properties: The properties of this UpdateConnectionDetails. @@ -388,7 +388,7 @@ def type(self, type): def is_default(self): """ Gets the is_default of this UpdateConnectionDetails. - The default property for the connection. + The default property of the connection. :return: The is_default of this UpdateConnectionDetails. @@ -400,7 +400,7 @@ def is_default(self): def is_default(self, is_default): """ Sets the is_default of this UpdateConnectionDetails. - The default property for the connection. + The default property of the connection. :param is_default: The is_default of this UpdateConnectionDetails. diff --git a/src/oci/data_connectivity/models/update_data_asset_details.py b/src/oci/data_connectivity/models/update_data_asset_details.py index 8533e5ba07..fb6e86f895 100644 --- a/src/oci/data_connectivity/models/update_data_asset_details.py +++ b/src/oci/data_connectivity/models/update_data_asset_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateDataAssetDetails(object): """ - Properties used in data asset update operations. + Properties used in the update data asset operations. """ def __init__(self, **kwargs): @@ -190,7 +190,7 @@ def model_type(self, model_type): 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. + Free form text without any restriction on the 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. @@ -202,7 +202,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -286,7 +286,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this UpdateDataAssetDetails. @@ -298,7 +298,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this UpdateDataAssetDetails. @@ -310,7 +310,7 @@ def identifier(self, identifier): def external_key(self): """ Gets the external_key of this UpdateDataAssetDetails. - The external key for the object. + The external key of the object. :return: The external_key of this UpdateDataAssetDetails. @@ -322,7 +322,7 @@ def external_key(self): def external_key(self, external_key): """ Sets the external_key of this UpdateDataAssetDetails. - The external key for the object. + The external key of the object. :param external_key: The external_key of this UpdateDataAssetDetails. @@ -334,7 +334,7 @@ def external_key(self, external_key): def asset_properties(self): """ Gets the asset_properties of this UpdateDataAssetDetails. - Additional properties for the data asset. + Additional properties of the data asset. :return: The asset_properties of this UpdateDataAssetDetails. @@ -346,7 +346,7 @@ def asset_properties(self): def asset_properties(self, asset_properties): """ Sets the asset_properties of this UpdateDataAssetDetails. - Additional properties for the data asset. + Additional properties of the data asset. :param asset_properties: The asset_properties of this UpdateDataAssetDetails. @@ -358,7 +358,7 @@ def asset_properties(self, asset_properties): def properties(self): """ **[Required]** Gets the properties of this UpdateDataAssetDetails. - All the properties for the data asset in a key-value map format. + All the properties of the data asset in a key-value map format. :return: The properties of this UpdateDataAssetDetails. @@ -370,7 +370,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this UpdateDataAssetDetails. - All the properties for the data asset in a key-value map format. + All the properties of the data asset in a key-value map format. :param properties: The properties of this UpdateDataAssetDetails. diff --git a/src/oci/data_connectivity/models/update_dp_endpoint_details.py b/src/oci/data_connectivity/models/update_dp_endpoint_details.py index 955f99c3a9..f93b8fcd8f 100644 --- a/src/oci/data_connectivity/models/update_dp_endpoint_details.py +++ b/src/oci/data_connectivity/models/update_dp_endpoint_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateDpEndpointDetails(object): """ - Properties used in endpoint update operations. + Properties used in the update operations of the endpoint. """ #: A constant which can be used with the model_type property of a UpdateDpEndpointDetails. @@ -162,7 +162,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :return: The key of this UpdateDpEndpointDetails. @@ -174,7 +174,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create. :param key: The key of this UpdateDpEndpointDetails. @@ -230,7 +230,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -242,7 +242,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -254,7 +254,7 @@ def name(self, name): def description(self): """ Gets the description of this UpdateDpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :return: The description of this UpdateDpEndpointDetails. @@ -266,7 +266,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateDpEndpointDetails. - User-defined description for the endpoint. + User-defined description of the endpoint. :param description: The description of this UpdateDpEndpointDetails. @@ -326,7 +326,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this UpdateDpEndpointDetails. @@ -338,7 +338,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this UpdateDpEndpointDetails. @@ -350,7 +350,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this UpdateDpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :return: The data_assets of this UpdateDpEndpointDetails. @@ -362,7 +362,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this UpdateDpEndpointDetails. - List of data assets which belongs to this endpoint + The list of data assets that belong to the endpoint. :param data_assets: The data_assets of this UpdateDpEndpointDetails. 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 index 32e818a6cf..5a029717c9 100644 --- a/src/oci/data_connectivity/models/update_dp_endpoint_from_private.py +++ b/src/oci/data_connectivity/models/update_dp_endpoint_from_private.py @@ -185,7 +185,7 @@ def dcms_endpoint_id(self, dcms_endpoint_id): def pe_id(self): """ Gets the pe_id of this UpdateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The pe_id of this UpdateDpEndpointFromPrivate. @@ -197,7 +197,7 @@ def pe_id(self): def pe_id(self, pe_id): """ Sets the pe_id of this UpdateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param pe_id: The pe_id of this UpdateDpEndpointFromPrivate. @@ -209,7 +209,7 @@ def pe_id(self, pe_id): def compartment_id(self): """ Gets the compartment_id of this UpdateDpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :return: The compartment_id of this UpdateDpEndpointFromPrivate. @@ -221,7 +221,7 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this UpdateDpEndpointFromPrivate. - The compartmentId of private endpoint resource. + The compartmentId of the private endpoint resource. :param compartment_id: The compartment_id of this UpdateDpEndpointFromPrivate. @@ -233,7 +233,7 @@ def compartment_id(self, compartment_id): def dns_proxy_ip(self): """ Gets the dns_proxy_ip of this UpdateDpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :return: The dns_proxy_ip of this UpdateDpEndpointFromPrivate. @@ -245,7 +245,7 @@ def dns_proxy_ip(self): def dns_proxy_ip(self, dns_proxy_ip): """ Sets the dns_proxy_ip of this UpdateDpEndpointFromPrivate. - The IP address of dns proxy. + The IP address of DNS proxy. :param dns_proxy_ip: The dns_proxy_ip of this UpdateDpEndpointFromPrivate. @@ -257,7 +257,7 @@ def dns_proxy_ip(self, dns_proxy_ip): def private_endpoint_ip(self): """ Gets the private_endpoint_ip of this UpdateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :return: The private_endpoint_ip of this UpdateDpEndpointFromPrivate. @@ -269,7 +269,7 @@ def private_endpoint_ip(self): def private_endpoint_ip(self, private_endpoint_ip): """ Sets the private_endpoint_ip of this UpdateDpEndpointFromPrivate. - The ocid of private endpoint resource. + The OCID of the private endpoint resource. :param private_endpoint_ip: The private_endpoint_ip of this UpdateDpEndpointFromPrivate. @@ -281,7 +281,7 @@ def private_endpoint_ip(self, private_endpoint_ip): def dns_zones(self): """ Gets the dns_zones of this UpdateDpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :return: The dns_zones of this UpdateDpEndpointFromPrivate. @@ -293,7 +293,7 @@ def dns_zones(self): def dns_zones(self, dns_zones): """ Sets the dns_zones of this UpdateDpEndpointFromPrivate. - Array of dns zones to be use during private endpoint resolution. + Array of DNS zones to be used during the private endpoint resolution. :param dns_zones: The dns_zones of this UpdateDpEndpointFromPrivate. diff --git a/src/oci/data_connectivity/models/update_endpoint_details.py b/src/oci/data_connectivity/models/update_endpoint_details.py index e3a7f1a0be..adb8465541 100644 --- a/src/oci/data_connectivity/models/update_endpoint_details.py +++ b/src/oci/data_connectivity/models/update_endpoint_details.py @@ -42,6 +42,10 @@ def __init__(self, **kwargs): The value to assign to the nsg_ids property of this UpdateEndpointDetails. :type nsg_ids: list[str] + :param dns_zones: + The value to assign to the dns_zones property of this UpdateEndpointDetails. + :type dns_zones: list[str] + """ self.swagger_types = { 'freeform_tags': 'dict(str, str)', @@ -49,7 +53,8 @@ def __init__(self, **kwargs): 'description': 'str', 'display_name': 'str', 'endpoint_size': 'int', - 'nsg_ids': 'list[str]' + 'nsg_ids': 'list[str]', + 'dns_zones': 'list[str]' } self.attribute_map = { @@ -58,7 +63,8 @@ def __init__(self, **kwargs): 'description': 'description', 'display_name': 'displayName', 'endpoint_size': 'endpointSize', - 'nsg_ids': 'nsgIds' + 'nsg_ids': 'nsgIds', + 'dns_zones': 'dnsZones' } self._freeform_tags = None @@ -67,12 +73,13 @@ def __init__(self, **kwargs): self._display_name = None self._endpoint_size = None self._nsg_ids = None + self._dns_zones = 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -85,7 +92,7 @@ def freeform_tags(self): 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. + Simple key-value pair that is applied without any predefined name, type, or scope. Exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}` @@ -148,7 +155,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateEndpointDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :return: The display_name of this UpdateEndpointDetails. @@ -160,7 +167,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateEndpointDetails. - Data Connectivity Management Registry display name, registries can be renamed + The Data Connectivity Management registry display name; registries can be renamed. :param display_name: The display_name of this UpdateEndpointDetails. @@ -172,7 +179,7 @@ def display_name(self, display_name): def endpoint_size(self): """ Gets the endpoint_size of this UpdateEndpointDetails. - Update Endpoint size for reverse connection capacity. + Update endpoint size for reverse connection capacity. :return: The endpoint_size of this UpdateEndpointDetails. @@ -184,7 +191,7 @@ def endpoint_size(self): def endpoint_size(self, endpoint_size): """ Sets the endpoint_size of this UpdateEndpointDetails. - Update Endpoint size for reverse connection capacity. + Update endpoint size for reverse connection capacity. :param endpoint_size: The endpoint_size of this UpdateEndpointDetails. @@ -196,7 +203,7 @@ def endpoint_size(self, endpoint_size): def nsg_ids(self): """ Gets the nsg_ids of this UpdateEndpointDetails. - List of NSGs to which the Private Endpoint VNIC must be added. + The list of NSGs to which the Private Endpoint VNIC must be added. :return: The nsg_ids of this UpdateEndpointDetails. @@ -208,7 +215,7 @@ def nsg_ids(self): 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. + The list of NSGs to which the Private Endpoint VNIC must be added. :param nsg_ids: The nsg_ids of this UpdateEndpointDetails. @@ -216,6 +223,32 @@ def nsg_ids(self, nsg_ids): """ self._nsg_ids = nsg_ids + @property + def dns_zones(self): + """ + Gets the dns_zones of this UpdateEndpointDetails. + List of DNS zones to be used by the data assets. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :return: The dns_zones of this UpdateEndpointDetails. + :rtype: list[str] + """ + return self._dns_zones + + @dns_zones.setter + def dns_zones(self, dns_zones): + """ + Sets the dns_zones of this UpdateEndpointDetails. + List of DNS zones to be used by the data assets. + Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com + + + :param dns_zones: The dns_zones of this UpdateEndpointDetails. + :type: list[str] + """ + self._dns_zones = dns_zones + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_connectivity/models/update_folder_details.py b/src/oci/data_connectivity/models/update_folder_details.py index d2d40013e5..0a43eb91d4 100644 --- a/src/oci/data_connectivity/models/update_folder_details.py +++ b/src/oci/data_connectivity/models/update_folder_details.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class UpdateFolderDetails(object): """ - Properties used in folder update operations. + Properties used in the update operations of the folder. """ def __init__(self, **kwargs): @@ -124,7 +124,7 @@ def model_type(self, model_type): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :return: The key of this UpdateFolderDetails. @@ -136,7 +136,7 @@ def key(self): 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. + Generated key that can be used in API calls to identify the folder. In scenarios where reference to the folder is required, a value can be passed in create. :param key: The key of this UpdateFolderDetails. @@ -192,7 +192,7 @@ def parent_ref(self, parent_ref): 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. + Free form text without any restriction on the 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. @@ -204,7 +204,7 @@ def name(self): 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. + Free form text without any restriction on the 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. @@ -216,7 +216,7 @@ def name(self, name): def description(self): """ Gets the description of this UpdateFolderDetails. - User-defined description for the folder. + User-defined description of the folder. :return: The description of this UpdateFolderDetails. @@ -228,7 +228,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateFolderDetails. - User-defined description for the folder. + User-defined description of the folder. :param description: The description of this UpdateFolderDetails. @@ -288,7 +288,7 @@ def object_version(self, object_version): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :return: The identifier of this UpdateFolderDetails. @@ -300,7 +300,7 @@ def identifier(self): 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. + Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified. :param identifier: The identifier of this UpdateFolderDetails. @@ -312,7 +312,7 @@ def identifier(self, identifier): def data_assets(self): """ Gets the data_assets of this UpdateFolderDetails. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :return: The data_assets of this UpdateFolderDetails. @@ -324,7 +324,7 @@ def data_assets(self): def data_assets(self, data_assets): """ Sets the data_assets of this UpdateFolderDetails. - List of data assets which belongs to this folder + The list of data assets that belong to the folder. :param data_assets: The data_assets of this UpdateFolderDetails. diff --git a/src/oci/data_connectivity/models/update_registry_details.py b/src/oci/data_connectivity/models/update_registry_details.py index ebe1df626d..322e3bff5e 100644 --- a/src/oci/data_connectivity/models/update_registry_details.py +++ b/src/oci/data_connectivity/models/update_registry_details.py @@ -58,8 +58,10 @@ def __init__(self, **kwargs): 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\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or registry. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this UpdateRegistryDetails. @@ -71,8 +73,10 @@ def freeform_tags(self): 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\"}` + Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or registry. See `Resource Tags`__. + Example: `{\"Department\": \"Finance\"}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this UpdateRegistryDetails. @@ -84,8 +88,10 @@ def freeform_tags(self, freeform_tags): 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\"}}` + Defined tags for this resource. Each key is predefined and scoped to a registry. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this UpdateRegistryDetails. @@ -97,8 +103,10 @@ def defined_tags(self): 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\"}}` + Defined tags for this resource. Each key is predefined and scoped to a registry. See `Resource Tags`__. + Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` + + __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this UpdateRegistryDetails. @@ -110,7 +118,7 @@ def defined_tags(self, defined_tags): def description(self): """ Gets the description of this UpdateRegistryDetails. - Data Connectivity Management Registry description + Data Connectivity Management Registry description. :return: The description of this UpdateRegistryDetails. @@ -122,7 +130,7 @@ def description(self): def description(self, description): """ Sets the description of this UpdateRegistryDetails. - Data Connectivity Management Registry description + Data Connectivity Management Registry description. :param description: The description of this UpdateRegistryDetails. @@ -134,7 +142,7 @@ def description(self, description): def display_name(self): """ Gets the display_name of this UpdateRegistryDetails. - Data Connectivity Management Registry display name, registries can be renamed + Data Connectivity Management Registry display name, registries can be renamed. :return: The display_name of this UpdateRegistryDetails. @@ -146,7 +154,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateRegistryDetails. - Data Connectivity Management Registry display name, registries can be renamed + Data Connectivity Management Registry display name, registries can be renamed. :param display_name: The display_name of this UpdateRegistryDetails. diff --git a/src/oci/data_connectivity/models/validation_message.py b/src/oci/data_connectivity/models/validation_message.py index 9694bee393..546ac9fe7e 100644 --- a/src/oci/data_connectivity/models/validation_message.py +++ b/src/oci/data_connectivity/models/validation_message.py @@ -44,7 +44,7 @@ def __init__(self, **kwargs): def level(self): """ Gets the level of this ValidationMessage. - level of validation messages + The level of validation messages. :return: The level of this ValidationMessage. @@ -56,7 +56,7 @@ def level(self): def level(self, level): """ Sets the level of this ValidationMessage. - level of validation messages + The level of validation messages. :param level: The level of this ValidationMessage. diff --git a/src/oci/data_connectivity/models/validation_result.py b/src/oci/data_connectivity/models/validation_result.py index 43c1bc82f6..89bc559c64 100644 --- a/src/oci/data_connectivity/models/validation_result.py +++ b/src/oci/data_connectivity/models/validation_result.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class ValidationResult(object): """ - Validation Result object for a single DataAsset. + Validation result object for a single data asset. """ #: A constant which can be used with the status property of a ValidationResult. @@ -54,7 +54,7 @@ def __init__(self, **kwargs): def error_msg(self): """ Gets the error_msg of this ValidationResult. - Error text for validation failure + Error text for validation failure. :return: The error_msg of this ValidationResult. @@ -66,7 +66,7 @@ def error_msg(self): def error_msg(self, error_msg): """ Sets the error_msg of this ValidationResult. - Error text for validation failure + Error text for validation failure. :param error_msg: The error_msg of this ValidationResult. @@ -78,7 +78,7 @@ def error_msg(self, error_msg): def status(self): """ Gets the status of this ValidationResult. - Status of the validatio result execution + Status of the validation 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'. @@ -93,7 +93,7 @@ def status(self): def status(self, status): """ Sets the status of this ValidationResult. - Status of the validatio result execution + Status of the validation result execution. :param status: The status of this ValidationResult. diff --git a/src/oci/data_connectivity/models/work_request.py b/src/oci/data_connectivity/models/work_request.py index d9cef108c8..2a288fc01d 100644 --- a/src/oci/data_connectivity/models/work_request.py +++ b/src/oci/data_connectivity/models/work_request.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequest(object): """ - A description of workrequest status + A description of the status of the work request. """ #: A constant which can be used with the operation_type property of a WorkRequest. @@ -137,7 +137,7 @@ def __init__(self, **kwargs): def operation_type(self): """ **[Required]** Gets the operation_type of this WorkRequest. - type of the work request + 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'. @@ -152,7 +152,7 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this WorkRequest. - type of the work request + Type of the work request. :param operation_type: The operation_type of this WorkRequest. @@ -167,7 +167,7 @@ def operation_type(self, operation_type): def status(self): """ **[Required]** Gets the status of this WorkRequest. - status of current work request. + Status of the current work request. Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -182,7 +182,7 @@ def status(self): def status(self, status): """ Sets the status of this WorkRequest. - status of current work request. + Status of the current work request. :param status: The status of this WorkRequest. @@ -197,7 +197,7 @@ def status(self, status): def id(self): """ **[Required]** Gets the id of this WorkRequest. - The id of the work request. + The ID of the work request. :return: The id of this WorkRequest. @@ -209,7 +209,7 @@ def id(self): def id(self, id): """ Sets the id of this WorkRequest. - The id of the work request. + The ID of the work request. :param id: The id of this WorkRequest. @@ -221,10 +221,10 @@ def id(self, id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. Work requests should be scoped to + The 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 + resource whose compartment should be used. :return: The compartment_id of this WorkRequest. @@ -236,10 +236,10 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this WorkRequest. - The ocid of the compartment that contains the work request. Work requests should be scoped to + The 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 + resource whose compartment should be used. :param compartment_id: The compartment_id of this WorkRequest. @@ -275,7 +275,7 @@ def resources(self, resources): def percent_complete(self): """ **[Required]** Gets the percent_complete of this WorkRequest. - Percentage of the request completed. + The percentage of the request completed. :return: The percent_complete of this WorkRequest. @@ -287,7 +287,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this WorkRequest. - Percentage of the request completed. + The percentage of the request completed. :param percent_complete: The percent_complete of this WorkRequest. diff --git a/src/oci/data_connectivity/models/work_request_error.py b/src/oci/data_connectivity/models/work_request_error.py index 26ac6a8cc9..2562a6cd7a 100644 --- a/src/oci/data_connectivity/models/work_request_error.py +++ b/src/oci/data_connectivity/models/work_request_error.py @@ -51,8 +51,8 @@ def __init__(self, **kwargs): def code(self): """ **[Required]** Gets the code of this WorkRequestError. - A machine-usable code for the error that occured. Error codes are listed on - (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + A machine-usable code for the error that occured. Error codes are listed in + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :return: The code of this WorkRequestError. @@ -64,8 +64,8 @@ def code(self): def code(self, code): """ Sets the code of this WorkRequestError. - A machine-usable code for the error that occured. Error codes are listed on - (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) + A machine-usable code for the error that occured. Error codes are listed in + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :param code: The code of this WorkRequestError. diff --git a/src/oci/data_connectivity/models/work_request_error_collection.py b/src/oci/data_connectivity/models/work_request_error_collection.py index d78c77c992..4deea8d64a 100644 --- a/src/oci/data_connectivity/models/work_request_error_collection.py +++ b/src/oci/data_connectivity/models/work_request_error_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestErrorCollection(object): """ - List of WorkRequestError summaries. + The list of work request error summaries. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestErrorCollection. - The array of WorkRequestError summariess + The array of work request error summaries. :return: The items of this WorkRequestErrorCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestErrorCollection. - The array of WorkRequestError summariess + The array of work request error summaries. :param items: The items of this WorkRequestErrorCollection. diff --git a/src/oci/data_connectivity/models/work_request_error_summary.py b/src/oci/data_connectivity/models/work_request_error_summary.py index 35c15cdf43..140902a29d 100644 --- a/src/oci/data_connectivity/models/work_request_error_summary.py +++ b/src/oci/data_connectivity/models/work_request_error_summary.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestErrorSummary(object): """ - A work request error summary object. + The list of work request log summaries. """ def __init__(self, **kwargs): @@ -51,8 +51,8 @@ def __init__(self, **kwargs): 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) + A machine-usable code for the error that occured. Error codes are listed in + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :return: The code of this WorkRequestErrorSummary. @@ -64,8 +64,8 @@ def code(self): 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) + A machine-usable code for the error that occured. Error codes are listed in + (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). :param code: The code of this WorkRequestErrorSummary. diff --git a/src/oci/data_connectivity/models/work_request_log.py b/src/oci/data_connectivity/models/work_request_log.py index acb6f17af6..95544e8f65 100644 --- a/src/oci/data_connectivity/models/work_request_log.py +++ b/src/oci/data_connectivity/models/work_request_log.py @@ -68,7 +68,7 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestLog. - The time the log message was written. An RFC3339 formatted datetime string + Time when the log message was written. An RFC3339 formatted datetime string. :return: The timestamp of this WorkRequestLog. @@ -80,7 +80,7 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestLog. - The time the log message was written. An RFC3339 formatted datetime string + Time when the log message was written. An RFC3339 formatted datetime string. :param timestamp: The timestamp of this WorkRequestLog. diff --git a/src/oci/data_connectivity/models/work_request_log_collection.py b/src/oci/data_connectivity/models/work_request_log_collection.py index 64a5bdae60..e8f0d93e3e 100644 --- a/src/oci/data_connectivity/models/work_request_log_collection.py +++ b/src/oci/data_connectivity/models/work_request_log_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestLogCollection(object): """ - List of WorkRequestLog summaries. + The list of work request log summaries. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestLogCollection. - The array of WorkRequestLog summariess + The list of work request log summaries. :return: The items of this WorkRequestLogCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestLogCollection. - The array of WorkRequestLog summariess + The list of work request log summaries. :param items: The items of this WorkRequestLogCollection. diff --git a/src/oci/data_connectivity/models/work_request_resource.py b/src/oci/data_connectivity/models/work_request_resource.py index 3cd505c91c..c6615f6122 100644 --- a/src/oci/data_connectivity/models/work_request_resource.py +++ b/src/oci/data_connectivity/models/work_request_resource.py @@ -118,8 +118,8 @@ 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. + work is complete for that resource, after which it moves to CREATED, UPDATED, + or DELETED state, 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'. @@ -136,8 +136,8 @@ 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. + work is complete for that resource, after which it moves to CREATED, UPDATED, + or DELETED state, respectively. :param action_type: The action_type of this WorkRequestResource. @@ -176,7 +176,7 @@ def identifier(self, identifier): def entity_uri(self): """ Gets the entity_uri of this WorkRequestResource. - The URI path that the user can do a GET on to access the resource metadata + The URI path that the user can do a GET on to access the resource metadata. :return: The entity_uri of this WorkRequestResource. @@ -188,7 +188,7 @@ def entity_uri(self): def entity_uri(self, entity_uri): """ Sets the entity_uri of this WorkRequestResource. - The URI path that the user can do a GET on to access the resource metadata + The URI path that the user can do a GET on to access the resource metadata. :param entity_uri: The entity_uri of this WorkRequestResource. diff --git a/src/oci/data_connectivity/models/work_request_summary.py b/src/oci/data_connectivity/models/work_request_summary.py index b6fb8c7727..f306d307cd 100644 --- a/src/oci/data_connectivity/models/work_request_summary.py +++ b/src/oci/data_connectivity/models/work_request_summary.py @@ -137,7 +137,7 @@ def __init__(self, **kwargs): def operation_type(self): """ **[Required]** Gets the operation_type of this WorkRequestSummary. - type of the work request + 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'. @@ -152,7 +152,7 @@ def operation_type(self): def operation_type(self, operation_type): """ Sets the operation_type of this WorkRequestSummary. - type of the work request + Type of the work request. :param operation_type: The operation_type of this WorkRequestSummary. @@ -167,7 +167,7 @@ def operation_type(self, operation_type): def status(self): """ **[Required]** Gets the status of this WorkRequestSummary. - status of current work request. + Status of the current work request. Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -182,7 +182,7 @@ def status(self): def status(self, status): """ Sets the status of this WorkRequestSummary. - status of current work request. + Status of the current work request. :param status: The status of this WorkRequestSummary. @@ -197,7 +197,7 @@ def status(self, status): def id(self): """ **[Required]** Gets the id of this WorkRequestSummary. - The id of the work request. + The ID of the work request. :return: The id of this WorkRequestSummary. @@ -209,7 +209,7 @@ def id(self): def id(self, id): """ Sets the id of this WorkRequestSummary. - The id of the work request. + The ID of the work request. :param id: The id of this WorkRequestSummary. @@ -221,10 +221,10 @@ def id(self, id): def compartment_id(self): """ **[Required]** Gets the compartment_id of this WorkRequestSummary. - The ocid of the compartment that contains the work request. Work requests should be scoped to + The 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 + resource whose compartment should be used. :return: The compartment_id of this WorkRequestSummary. @@ -236,10 +236,10 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this WorkRequestSummary. - The ocid of the compartment that contains the work request. Work requests should be scoped to + The 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 + resource whose compartment should be used. :param compartment_id: The compartment_id of this WorkRequestSummary. @@ -275,7 +275,7 @@ def resources(self, resources): def percent_complete(self): """ **[Required]** Gets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. + The percentage of the request completed. :return: The percent_complete of this WorkRequestSummary. @@ -287,7 +287,7 @@ def percent_complete(self): def percent_complete(self, percent_complete): """ Sets the percent_complete of this WorkRequestSummary. - Percentage of the request completed. + The percentage of the request completed. :param percent_complete: The percent_complete of this WorkRequestSummary. diff --git a/src/oci/data_connectivity/models/work_request_summary_collection.py b/src/oci/data_connectivity/models/work_request_summary_collection.py index 470fe4132b..38fa4f1e32 100644 --- a/src/oci/data_connectivity/models/work_request_summary_collection.py +++ b/src/oci/data_connectivity/models/work_request_summary_collection.py @@ -10,7 +10,7 @@ @init_model_state_from_kwargs class WorkRequestSummaryCollection(object): """ - List of WorkRequest summaries. + The list of work request summaries. """ def __init__(self, **kwargs): @@ -37,7 +37,7 @@ def __init__(self, **kwargs): def items(self): """ **[Required]** Gets the items of this WorkRequestSummaryCollection. - The array of WorkRequest summariess + The array of work request summaries. :return: The items of this WorkRequestSummaryCollection. @@ -49,7 +49,7 @@ def items(self): def items(self, items): """ Sets the items of this WorkRequestSummaryCollection. - The array of WorkRequest summariess + The array of work request summaries. :param items: The items of this WorkRequestSummaryCollection. diff --git a/src/oci/data_connectivity/models/write_operation_config.py b/src/oci/data_connectivity/models/write_operation_config.py index 5905c811df..90e5f82e44 100644 --- a/src/oci/data_connectivity/models/write_operation_config.py +++ b/src/oci/data_connectivity/models/write_operation_config.py @@ -44,6 +44,10 @@ def __init__(self, **kwargs): Allowed values for this property are: "READ_OPERATION_CONFIG", "WRITE_OPERATION_CONFIG" :type model_type: str + :param derived_attributes: + The value to assign to the derived_attributes property of this WriteOperationConfig. + :type derived_attributes: dict(str, str) + :param key: The value to assign to the key property of this WriteOperationConfig. :type key: str @@ -92,6 +96,7 @@ def __init__(self, **kwargs): """ self.swagger_types = { 'model_type': 'str', + 'derived_attributes': 'dict(str, str)', 'key': 'str', 'model_version': 'str', 'parent_ref': 'ParentReference', @@ -107,6 +112,7 @@ def __init__(self, **kwargs): self.attribute_map = { 'model_type': 'modelType', + 'derived_attributes': 'derivedAttributes', 'key': 'key', 'model_version': 'modelVersion', 'parent_ref': 'parentRef', @@ -121,6 +127,7 @@ def __init__(self, **kwargs): } self._model_type = None + self._derived_attributes = None self._key = None self._model_version = None self._parent_ref = None @@ -162,7 +169,7 @@ def key(self, key): def model_version(self): """ Gets the model_version of this WriteOperationConfig. - The object's model version. + The model version of the object. :return: The model_version of this WriteOperationConfig. @@ -174,7 +181,7 @@ def model_version(self): def model_version(self, model_version): """ Sets the model_version of this WriteOperationConfig. - The object's model version. + The model version of the object. :param model_version: The model_version of this WriteOperationConfig. @@ -366,7 +373,7 @@ def object_status(self, object_status): def reject_limit(self): """ Gets the reject_limit of this WriteOperationConfig. - The number of rows are rejected based on which operation will error out. + The number of rows are rejected based on the operation that errors out. :return: The reject_limit of this WriteOperationConfig. @@ -378,7 +385,7 @@ def reject_limit(self): 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. + The number of rows are rejected based on the operation that errors out. :param reject_limit: The reject_limit of this WriteOperationConfig. diff --git a/src/oci/data_connectivity/network_validation_client.py b/src/oci/data_connectivity/network_validation_client.py index 18b4dfb841..c14d1586e9 100644 --- a/src/oci/data_connectivity/network_validation_client.py +++ b/src/oci/data_connectivity/network_validation_client.py @@ -18,7 +18,7 @@ class NetworkValidationClient(object): """ - Use the DCMS APIs to perform Metadata/Data operations. + Use the Data Connectivity Management Service APIs to perform common extract, load, and transform (ETL) tasks. """ def __init__(self, config, **kwargs): @@ -106,11 +106,11 @@ def __init__(self, config, **kwargs): 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. + This API is used to get the network connectivity status fofor all the data assets attached to the provided private endpoint. :param str registry_id: (required) - The registry Ocid. + The registry OCID. :param str endpoint_key: (required) The endpoint key. @@ -121,7 +121,7 @@ def get_network_connectivity_status_collection(self, registry_id, endpoint_key, 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. + A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. :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`__. @@ -134,7 +134,7 @@ def get_network_connectivity_status_collection(self, registry_id, endpoint_key, __ 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). + 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 are by relevance score in descending order). Allowed values are: "id", "timeCreated", "displayName" @@ -146,7 +146,7 @@ def get_network_connectivity_status_collection(self, registry_id, endpoint_key, :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. - This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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`. @@ -227,6 +227,8 @@ def get_network_connectivity_status_collection(self, registry_id, endpoint_key, 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/database_management/db_management_client.py b/src/oci/database_management/db_management_client.py index 6dcf9862e6..8bcf52fe72 100644 --- a/src/oci/database_management/db_management_client.py +++ b/src/oci/database_management/db_management_client.py @@ -1639,6 +1639,102 @@ def delete_managed_database_group(self, managed_database_group_id, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) + def delete_preferred_credential(self, managed_database_id, credential_name, **kwargs): + """ + Deletes the preferred credential based on the credentialName. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str credential_name: (required) + The name of the preferred credential. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type None + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use delete_preferred_credential API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}" + method = "DELETE" + operation_name = "delete_preferred_credential" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/PreferredCredential/DeletePreferredCredential" + + # 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( + "delete_preferred_credential got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "credentialName": credential_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def drop_tablespace(self, managed_database_id, tablespace_name, drop_tablespace_details, **kwargs): """ Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId. @@ -3566,6 +3662,104 @@ def get_pdb_metrics(self, managed_database_id, start_time, end_time, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) + def get_preferred_credential(self, managed_database_id, credential_name, **kwargs): + """ + Gets the preferred credential details for a Managed Database based on credentialName. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str credential_name: (required) + The name of the preferred credential. + + :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.database_management.models.PreferredCredential` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_preferred_credential API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}" + method = "GET" + operation_name = "get_preferred_credential" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/PreferredCredential/GetPreferredCredential" + + # 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_preferred_credential got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "credentialName": credential_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="PreferredCredential", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="PreferredCredential", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def get_tablespace(self, managed_database_id, tablespace_name, **kwargs): """ Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId. @@ -6652,6 +6846,100 @@ def list_optimizer_statistics_collection_operations(self, managed_database_id, * operation_name=operation_name, api_reference_link=api_reference_link) + def list_preferred_credentials(self, managed_database_id, **kwargs): + """ + Gets the list of preferred credentials for a given Managed Database. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str 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.database_management.models.PreferredCredentialCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_preferred_credentials API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/preferredCredentials" + method = "GET" + operation_name = "list_preferred_credentials" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/PreferredCredential/ListPreferredCredentials" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_preferred_credentials got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_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="PreferredCredentialCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + response_type="PreferredCredentialCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def list_proxied_for_users(self, managed_database_id, user_name, **kwargs): """ Gets the list of users on whose behalf the current user acts as proxy. @@ -10575,6 +10863,110 @@ def summarize_job_executions_statuses(self, compartment_id, start_time, end_time operation_name=operation_name, api_reference_link=api_reference_link) + def test_preferred_credential(self, managed_database_id, credential_name, **kwargs): + """ + Tests the preferred credential. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str credential_name: (required) + The name of the preferred credential. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param oci.database_management.models.TestPreferredCredentialDetails test_preferred_credential_details: (optional) + The details required to test preferred credential. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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.database_management.models.TestPreferredCredentialStatus` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use test_preferred_credential API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}/actions/test" + method = "POST" + operation_name = "test_preferred_credential" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/PreferredCredential/TestPreferredCredential" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "test_preferred_credential_details" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "test_preferred_credential got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "credentialName": credential_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=kwargs.get('test_preferred_credential_details'), + response_type="TestPreferredCredentialStatus", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=kwargs.get('test_preferred_credential_details'), + response_type="TestPreferredCredentialStatus", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def update_db_management_private_endpoint(self, db_management_private_endpoint_id, update_db_management_private_endpoint_details, **kwargs): """ Updates one or more attributes of a specific Database Management private endpoint. @@ -10897,6 +11289,118 @@ def update_managed_database_group(self, managed_database_group_id, update_manage operation_name=operation_name, api_reference_link=api_reference_link) + def update_preferred_credential(self, managed_database_id, credential_name, update_preferred_credential_details, **kwargs): + """ + Updates the preferred credential based on the credentialName. + + + :param str managed_database_id: (required) + The `OCID`__ of the Managed Database. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + :param str credential_name: (required) + The name of the preferred credential. + + :param oci.database_management.models.UpdatePreferredCredentialDetails update_preferred_credential_details: (required) + The details required to update preferred credential. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.database_management.models.PreferredCredential` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use update_preferred_credential API. + """ + resource_path = "/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}" + method = "PUT" + operation_name = "update_preferred_credential" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/database-management/20201101/PreferredCredential/UpdatePreferredCredential" + + # 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_preferred_credential got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "managedDatabaseId": managed_database_id, + "credentialName": credential_name + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "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_preferred_credential_details, + response_type="PreferredCredential", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=update_preferred_credential_details, + response_type="PreferredCredential", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def update_tablespace(self, managed_database_id, tablespace_name, update_tablespace_details, **kwargs): """ Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId. diff --git a/src/oci/database_management/models/__init__.py b/src/oci/database_management/models/__init__.py index fa3cba9cf1..ffd469abfc 100644 --- a/src/oci/database_management/models/__init__.py +++ b/src/oci/database_management/models/__init__.py @@ -49,6 +49,7 @@ from .awr_db_wait_event_collection import AwrDbWaitEventCollection from .awr_db_wait_event_summary import AwrDbWaitEventSummary from .awr_query_result import AwrQueryResult +from .basic_preferred_credential import BasicPreferredCredential from .change_database_parameter_details import ChangeDatabaseParameterDetails from .change_database_parameters_details import ChangeDatabaseParametersDetails from .change_db_management_private_endpoint_compartment_details import ChangeDbManagementPrivateEndpointCompartmentDetails @@ -143,6 +144,9 @@ from .parent_group import ParentGroup from .pdb_metrics import PdbMetrics from .pdb_status_details import PdbStatusDetails +from .preferred_credential import PreferredCredential +from .preferred_credential_collection import PreferredCredentialCollection +from .preferred_credential_summary import PreferredCredentialSummary from .proxied_for_user_collection import ProxiedForUserCollection from .proxied_for_user_summary import ProxiedForUserSummary from .proxy_user_collection import ProxyUserCollection @@ -201,12 +205,17 @@ from .tablespace_collection import TablespaceCollection from .tablespace_storage_size import TablespaceStorageSize from .tablespace_summary import TablespaceSummary +from .test_basic_preferred_credential_details import TestBasicPreferredCredentialDetails +from .test_preferred_credential_details import TestPreferredCredentialDetails +from .test_preferred_credential_status import TestPreferredCredentialStatus from .time_series_metric_data_point import TimeSeriesMetricDataPoint from .time_series_metric_definition import TimeSeriesMetricDefinition +from .update_basic_preferred_credential_details import UpdateBasicPreferredCredentialDetails from .update_database_parameters_result import UpdateDatabaseParametersResult from .update_db_management_private_endpoint_details import UpdateDbManagementPrivateEndpointDetails from .update_job_details import UpdateJobDetails from .update_managed_database_group_details import UpdateManagedDatabaseGroupDetails +from .update_preferred_credential_details import UpdatePreferredCredentialDetails from .update_sql_job_details import UpdateSqlJobDetails from .update_tablespace_details import UpdateTablespaceDetails from .user import User @@ -268,6 +277,7 @@ "AwrDbWaitEventCollection": AwrDbWaitEventCollection, "AwrDbWaitEventSummary": AwrDbWaitEventSummary, "AwrQueryResult": AwrQueryResult, + "BasicPreferredCredential": BasicPreferredCredential, "ChangeDatabaseParameterDetails": ChangeDatabaseParameterDetails, "ChangeDatabaseParametersDetails": ChangeDatabaseParametersDetails, "ChangeDbManagementPrivateEndpointCompartmentDetails": ChangeDbManagementPrivateEndpointCompartmentDetails, @@ -362,6 +372,9 @@ "ParentGroup": ParentGroup, "PdbMetrics": PdbMetrics, "PdbStatusDetails": PdbStatusDetails, + "PreferredCredential": PreferredCredential, + "PreferredCredentialCollection": PreferredCredentialCollection, + "PreferredCredentialSummary": PreferredCredentialSummary, "ProxiedForUserCollection": ProxiedForUserCollection, "ProxiedForUserSummary": ProxiedForUserSummary, "ProxyUserCollection": ProxyUserCollection, @@ -420,12 +433,17 @@ "TablespaceCollection": TablespaceCollection, "TablespaceStorageSize": TablespaceStorageSize, "TablespaceSummary": TablespaceSummary, + "TestBasicPreferredCredentialDetails": TestBasicPreferredCredentialDetails, + "TestPreferredCredentialDetails": TestPreferredCredentialDetails, + "TestPreferredCredentialStatus": TestPreferredCredentialStatus, "TimeSeriesMetricDataPoint": TimeSeriesMetricDataPoint, "TimeSeriesMetricDefinition": TimeSeriesMetricDefinition, + "UpdateBasicPreferredCredentialDetails": UpdateBasicPreferredCredentialDetails, "UpdateDatabaseParametersResult": UpdateDatabaseParametersResult, "UpdateDbManagementPrivateEndpointDetails": UpdateDbManagementPrivateEndpointDetails, "UpdateJobDetails": UpdateJobDetails, "UpdateManagedDatabaseGroupDetails": UpdateManagedDatabaseGroupDetails, + "UpdatePreferredCredentialDetails": UpdatePreferredCredentialDetails, "UpdateSqlJobDetails": UpdateSqlJobDetails, "UpdateTablespaceDetails": UpdateTablespaceDetails, "User": User, diff --git a/src/oci/database_management/models/basic_preferred_credential.py b/src/oci/database_management/models/basic_preferred_credential.py new file mode 100644 index 0000000000..67fc6f0842 --- /dev/null +++ b/src/oci/database_management/models/basic_preferred_credential.py @@ -0,0 +1,186 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +from .preferred_credential import PreferredCredential +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class BasicPreferredCredential(PreferredCredential): + """ + The details of the 'BASIC' preferred credential. + """ + + #: A constant which can be used with the role property of a BasicPreferredCredential. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a BasicPreferredCredential. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new BasicPreferredCredential object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.BasicPreferredCredential.type` attribute + of this class is ``BASIC`` 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 BasicPreferredCredential. + Allowed values for this property are: "BASIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param credential_name: + The value to assign to the credential_name property of this BasicPreferredCredential. + :type credential_name: str + + :param status: + The value to assign to the status property of this BasicPreferredCredential. + Allowed values for this property are: "SET", "NOT_SET", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param is_accessible: + The value to assign to the is_accessible property of this BasicPreferredCredential. + :type is_accessible: bool + + :param user_name: + The value to assign to the user_name property of this BasicPreferredCredential. + :type user_name: str + + :param role: + The value to assign to the role property of this BasicPreferredCredential. + Allowed values for this property are: "NORMAL", "SYSDBA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type role: str + + :param password_secret_id: + The value to assign to the password_secret_id property of this BasicPreferredCredential. + :type password_secret_id: str + + """ + self.swagger_types = { + 'type': 'str', + 'credential_name': 'str', + 'status': 'str', + 'is_accessible': 'bool', + 'user_name': 'str', + 'role': 'str', + 'password_secret_id': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'credential_name': 'credentialName', + 'status': 'status', + 'is_accessible': 'isAccessible', + 'user_name': 'userName', + 'role': 'role', + 'password_secret_id': 'passwordSecretId' + } + + self._type = None + self._credential_name = None + self._status = None + self._is_accessible = None + self._user_name = None + self._role = None + self._password_secret_id = None + self._type = 'BASIC' + + @property + def user_name(self): + """ + Gets the user_name of this BasicPreferredCredential. + The user name used to connect to the database. + + + :return: The user_name of this BasicPreferredCredential. + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """ + Sets the user_name of this BasicPreferredCredential. + The user name used to connect to the database. + + + :param user_name: The user_name of this BasicPreferredCredential. + :type: str + """ + self._user_name = user_name + + @property + def role(self): + """ + Gets the role of this BasicPreferredCredential. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The role of this BasicPreferredCredential. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this BasicPreferredCredential. + The role of the database user. + + + :param role: The role of this BasicPreferredCredential. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + role = 'UNKNOWN_ENUM_VALUE' + self._role = role + + @property + def password_secret_id(self): + """ + Gets the password_secret_id of this BasicPreferredCredential. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The password_secret_id of this BasicPreferredCredential. + :rtype: str + """ + return self._password_secret_id + + @password_secret_id.setter + def password_secret_id(self, password_secret_id): + """ + Sets the password_secret_id of this BasicPreferredCredential. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param password_secret_id: The password_secret_id of this BasicPreferredCredential. + :type: str + """ + self._password_secret_id = password_secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/preferred_credential.py b/src/oci/database_management/models/preferred_credential.py new file mode 100644 index 0000000000..9fc2394155 --- /dev/null +++ b/src/oci/database_management/models/preferred_credential.py @@ -0,0 +1,208 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PreferredCredential(object): + """ + The details of the preferred credential. + """ + + #: A constant which can be used with the type property of a PreferredCredential. + #: This constant has a value of "BASIC" + TYPE_BASIC = "BASIC" + + #: A constant which can be used with the status property of a PreferredCredential. + #: This constant has a value of "SET" + STATUS_SET = "SET" + + #: A constant which can be used with the status property of a PreferredCredential. + #: This constant has a value of "NOT_SET" + STATUS_NOT_SET = "NOT_SET" + + def __init__(self, **kwargs): + """ + Initializes a new PreferredCredential object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.database_management.models.BasicPreferredCredential` + + 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 PreferredCredential. + Allowed values for this property are: "BASIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type type: str + + :param credential_name: + The value to assign to the credential_name property of this PreferredCredential. + :type credential_name: str + + :param status: + The value to assign to the status property of this PreferredCredential. + Allowed values for this property are: "SET", "NOT_SET", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param is_accessible: + The value to assign to the is_accessible property of this PreferredCredential. + :type is_accessible: bool + + """ + self.swagger_types = { + 'type': 'str', + 'credential_name': 'str', + 'status': 'str', + 'is_accessible': 'bool' + } + + self.attribute_map = { + 'type': 'type', + 'credential_name': 'credentialName', + 'status': 'status', + 'is_accessible': 'isAccessible' + } + + self._type = None + self._credential_name = None + self._status = None + self._is_accessible = 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 == 'BASIC': + return 'BasicPreferredCredential' + else: + return 'PreferredCredential' + + @property + def type(self): + """ + Gets the type of this PreferredCredential. + The type of preferred credential. Only 'BASIC' is supported currently. + + Allowed values for this property are: "BASIC", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The type of this PreferredCredential. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this PreferredCredential. + The type of preferred credential. Only 'BASIC' is supported currently. + + + :param type: The type of this PreferredCredential. + :type: str + """ + allowed_values = ["BASIC"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + type = 'UNKNOWN_ENUM_VALUE' + self._type = type + + @property + def credential_name(self): + """ + Gets the credential_name of this PreferredCredential. + The name of the preferred credential. + + + :return: The credential_name of this PreferredCredential. + :rtype: str + """ + return self._credential_name + + @credential_name.setter + def credential_name(self, credential_name): + """ + Sets the credential_name of this PreferredCredential. + The name of the preferred credential. + + + :param credential_name: The credential_name of this PreferredCredential. + :type: str + """ + self._credential_name = credential_name + + @property + def status(self): + """ + Gets the status of this PreferredCredential. + The status of the preferred credential. + + Allowed values for this property are: "SET", "NOT_SET", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this PreferredCredential. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PreferredCredential. + The status of the preferred credential. + + + :param status: The status of this PreferredCredential. + :type: str + """ + allowed_values = ["SET", "NOT_SET"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def is_accessible(self): + """ + Gets the is_accessible of this PreferredCredential. + Indicates whether the preferred credential is accessible. + + + :return: The is_accessible of this PreferredCredential. + :rtype: bool + """ + return self._is_accessible + + @is_accessible.setter + def is_accessible(self, is_accessible): + """ + Sets the is_accessible of this PreferredCredential. + Indicates whether the preferred credential is accessible. + + + :param is_accessible: The is_accessible of this PreferredCredential. + :type: bool + """ + self._is_accessible = is_accessible + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/preferred_credential_collection.py b/src/oci/database_management/models/preferred_credential_collection.py new file mode 100644 index 0000000000..fb03ac2399 --- /dev/null +++ b/src/oci/database_management/models/preferred_credential_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 PreferredCredentialCollection(object): + """ + A collection of preferred credential attributes. + """ + + def __init__(self, **kwargs): + """ + Initializes a new PreferredCredentialCollection 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 PreferredCredentialCollection. + :type items: list[oci.database_management.models.PreferredCredentialSummary] + + """ + self.swagger_types = { + 'items': 'list[PreferredCredentialSummary]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this PreferredCredentialCollection. + The attributes of the preferred credential. + + + :return: The items of this PreferredCredentialCollection. + :rtype: list[oci.database_management.models.PreferredCredentialSummary] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this PreferredCredentialCollection. + The attributes of the preferred credential. + + + :param items: The items of this PreferredCredentialCollection. + :type: list[oci.database_management.models.PreferredCredentialSummary] + """ + self._items = items + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/preferred_credential_summary.py b/src/oci/database_management/models/preferred_credential_summary.py new file mode 100644 index 0000000000..9499cee2b8 --- /dev/null +++ b/src/oci/database_management/models/preferred_credential_summary.py @@ -0,0 +1,261 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class PreferredCredentialSummary(object): + """ + The summary of preferred credentials. + """ + + #: A constant which can be used with the status property of a PreferredCredentialSummary. + #: This constant has a value of "SET" + STATUS_SET = "SET" + + #: A constant which can be used with the status property of a PreferredCredentialSummary. + #: This constant has a value of "NOT_SET" + STATUS_NOT_SET = "NOT_SET" + + #: A constant which can be used with the role property of a PreferredCredentialSummary. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a PreferredCredentialSummary. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new PreferredCredentialSummary object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param credential_name: + The value to assign to the credential_name property of this PreferredCredentialSummary. + :type credential_name: str + + :param status: + The value to assign to the status property of this PreferredCredentialSummary. + Allowed values for this property are: "SET", "NOT_SET", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param is_accessible: + The value to assign to the is_accessible property of this PreferredCredentialSummary. + :type is_accessible: bool + + :param user_name: + The value to assign to the user_name property of this PreferredCredentialSummary. + :type user_name: str + + :param role: + The value to assign to the role property of this PreferredCredentialSummary. + Allowed values for this property are: "NORMAL", "SYSDBA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type role: str + + :param password_secret_id: + The value to assign to the password_secret_id property of this PreferredCredentialSummary. + :type password_secret_id: str + + """ + self.swagger_types = { + 'credential_name': 'str', + 'status': 'str', + 'is_accessible': 'bool', + 'user_name': 'str', + 'role': 'str', + 'password_secret_id': 'str' + } + + self.attribute_map = { + 'credential_name': 'credentialName', + 'status': 'status', + 'is_accessible': 'isAccessible', + 'user_name': 'userName', + 'role': 'role', + 'password_secret_id': 'passwordSecretId' + } + + self._credential_name = None + self._status = None + self._is_accessible = None + self._user_name = None + self._role = None + self._password_secret_id = None + + @property + def credential_name(self): + """ + **[Required]** Gets the credential_name of this PreferredCredentialSummary. + The name of the preferred credential. + + + :return: The credential_name of this PreferredCredentialSummary. + :rtype: str + """ + return self._credential_name + + @credential_name.setter + def credential_name(self, credential_name): + """ + Sets the credential_name of this PreferredCredentialSummary. + The name of the preferred credential. + + + :param credential_name: The credential_name of this PreferredCredentialSummary. + :type: str + """ + self._credential_name = credential_name + + @property + def status(self): + """ + **[Required]** Gets the status of this PreferredCredentialSummary. + The status of the preferred credential. + + Allowed values for this property are: "SET", "NOT_SET", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this PreferredCredentialSummary. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PreferredCredentialSummary. + The status of the preferred credential. + + + :param status: The status of this PreferredCredentialSummary. + :type: str + """ + allowed_values = ["SET", "NOT_SET"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def is_accessible(self): + """ + **[Required]** Gets the is_accessible of this PreferredCredentialSummary. + Indicates whether the preferred credential is accessible. + + + :return: The is_accessible of this PreferredCredentialSummary. + :rtype: bool + """ + return self._is_accessible + + @is_accessible.setter + def is_accessible(self, is_accessible): + """ + Sets the is_accessible of this PreferredCredentialSummary. + Indicates whether the preferred credential is accessible. + + + :param is_accessible: The is_accessible of this PreferredCredentialSummary. + :type: bool + """ + self._is_accessible = is_accessible + + @property + def user_name(self): + """ + Gets the user_name of this PreferredCredentialSummary. + The user name used to connect to the database. + + + :return: The user_name of this PreferredCredentialSummary. + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """ + Sets the user_name of this PreferredCredentialSummary. + The user name used to connect to the database. + + + :param user_name: The user_name of this PreferredCredentialSummary. + :type: str + """ + self._user_name = user_name + + @property + def role(self): + """ + Gets the role of this PreferredCredentialSummary. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The role of this PreferredCredentialSummary. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this PreferredCredentialSummary. + The role of the database user. + + + :param role: The role of this PreferredCredentialSummary. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + role = 'UNKNOWN_ENUM_VALUE' + self._role = role + + @property + def password_secret_id(self): + """ + Gets the password_secret_id of this PreferredCredentialSummary. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The password_secret_id of this PreferredCredentialSummary. + :rtype: str + """ + return self._password_secret_id + + @password_secret_id.setter + def password_secret_id(self, password_secret_id): + """ + Sets the password_secret_id of this PreferredCredentialSummary. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param password_secret_id: The password_secret_id of this PreferredCredentialSummary. + :type: str + """ + self._password_secret_id = password_secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/test_basic_preferred_credential_details.py b/src/oci/database_management/models/test_basic_preferred_credential_details.py new file mode 100644 index 0000000000..b853fe5c73 --- /dev/null +++ b/src/oci/database_management/models/test_basic_preferred_credential_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 .test_preferred_credential_details import TestPreferredCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestBasicPreferredCredentialDetails(TestPreferredCredentialDetails): + """ + The details of the 'BASIC' preferred credential. + """ + + #: A constant which can be used with the role property of a TestBasicPreferredCredentialDetails. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a TestBasicPreferredCredentialDetails. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new TestBasicPreferredCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.TestBasicPreferredCredentialDetails.type` attribute + of this class is ``BASIC`` 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 TestBasicPreferredCredentialDetails. + Allowed values for this property are: "BASIC" + :type type: str + + :param user_name: + The value to assign to the user_name property of this TestBasicPreferredCredentialDetails. + :type user_name: str + + :param role: + The value to assign to the role property of this TestBasicPreferredCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param password_secret_id: + The value to assign to the password_secret_id property of this TestBasicPreferredCredentialDetails. + :type password_secret_id: str + + """ + self.swagger_types = { + 'type': 'str', + 'user_name': 'str', + 'role': 'str', + 'password_secret_id': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'user_name': 'userName', + 'role': 'role', + 'password_secret_id': 'passwordSecretId' + } + + self._type = None + self._user_name = None + self._role = None + self._password_secret_id = None + self._type = 'BASIC' + + @property + def user_name(self): + """ + Gets the user_name of this TestBasicPreferredCredentialDetails. + The user name used to connect to the database. + + + :return: The user_name of this TestBasicPreferredCredentialDetails. + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """ + Sets the user_name of this TestBasicPreferredCredentialDetails. + The user name used to connect to the database. + + + :param user_name: The user_name of this TestBasicPreferredCredentialDetails. + :type: str + """ + self._user_name = user_name + + @property + def role(self): + """ + Gets the role of this TestBasicPreferredCredentialDetails. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA" + + + :return: The role of this TestBasicPreferredCredentialDetails. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this TestBasicPreferredCredentialDetails. + The role of the database user. + + + :param role: The role of this TestBasicPreferredCredentialDetails. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + raise ValueError( + "Invalid value for `role`, must be None or one of {0}" + .format(allowed_values) + ) + self._role = role + + @property + def password_secret_id(self): + """ + Gets the password_secret_id of this TestBasicPreferredCredentialDetails. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The password_secret_id of this TestBasicPreferredCredentialDetails. + :rtype: str + """ + return self._password_secret_id + + @password_secret_id.setter + def password_secret_id(self, password_secret_id): + """ + Sets the password_secret_id of this TestBasicPreferredCredentialDetails. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param password_secret_id: The password_secret_id of this TestBasicPreferredCredentialDetails. + :type: str + """ + self._password_secret_id = password_secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/test_preferred_credential_details.py b/src/oci/database_management/models/test_preferred_credential_details.py new file mode 100644 index 0000000000..10da5b021f --- /dev/null +++ b/src/oci/database_management/models/test_preferred_credential_details.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class TestPreferredCredentialDetails(object): + """ + The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'. + """ + + #: A constant which can be used with the type property of a TestPreferredCredentialDetails. + #: This constant has a value of "BASIC" + TYPE_BASIC = "BASIC" + + def __init__(self, **kwargs): + """ + Initializes a new TestPreferredCredentialDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.database_management.models.TestBasicPreferredCredentialDetails` + + 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 TestPreferredCredentialDetails. + Allowed values for this property are: "BASIC" + :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 == 'BASIC': + return 'TestBasicPreferredCredentialDetails' + else: + return 'TestPreferredCredentialDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this TestPreferredCredentialDetails. + The type of preferred credential. Only 'BASIC' is supported currently. + + Allowed values for this property are: "BASIC" + + + :return: The type of this TestPreferredCredentialDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this TestPreferredCredentialDetails. + The type of preferred credential. Only 'BASIC' is supported currently. + + + :param type: The type of this TestPreferredCredentialDetails. + :type: str + """ + allowed_values = ["BASIC"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + "Invalid value for `type`, must be None or one of {0}" + .format(allowed_values) + ) + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/test_preferred_credential_status.py b/src/oci/database_management/models/test_preferred_credential_status.py new file mode 100644 index 0000000000..d17c8cdda1 --- /dev/null +++ b/src/oci/database_management/models/test_preferred_credential_status.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 TestPreferredCredentialStatus(object): + """ + The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'. + """ + + #: A constant which can be used with the status property of a TestPreferredCredentialStatus. + #: This constant has a value of "SUCCEEDED" + STATUS_SUCCEEDED = "SUCCEEDED" + + #: A constant which can be used with the status property of a TestPreferredCredentialStatus. + #: This constant has a value of "FAILED" + STATUS_FAILED = "FAILED" + + def __init__(self, **kwargs): + """ + Initializes a new TestPreferredCredentialStatus object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param status: + The value to assign to the status property of this TestPreferredCredentialStatus. + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param error_code: + The value to assign to the error_code property of this TestPreferredCredentialStatus. + :type error_code: str + + :param error_message: + The value to assign to the error_message property of this TestPreferredCredentialStatus. + :type error_message: str + + """ + self.swagger_types = { + 'status': 'str', + 'error_code': 'str', + 'error_message': 'str' + } + + self.attribute_map = { + 'status': 'status', + 'error_code': 'errorCode', + 'error_message': 'errorMessage' + } + + self._status = None + self._error_code = None + self._error_message = None + + @property + def status(self): + """ + Gets the status of this TestPreferredCredentialStatus. + The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'. + + Allowed values for this property are: "SUCCEEDED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this TestPreferredCredentialStatus. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this TestPreferredCredentialStatus. + The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'. + + + :param status: The status of this TestPreferredCredentialStatus. + :type: str + """ + allowed_values = ["SUCCEEDED", "FAILED"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def error_code(self): + """ + Gets the error_code of this TestPreferredCredentialStatus. + An error code that defines the failure of the preferred credential test. The response is 'null' if the preferred credential test was successful. + + + :return: The error_code of this TestPreferredCredentialStatus. + :rtype: str + """ + return self._error_code + + @error_code.setter + def error_code(self, error_code): + """ + Sets the error_code of this TestPreferredCredentialStatus. + An error code that defines the failure of the preferred credential test. The response is 'null' if the preferred credential test was successful. + + + :param error_code: The error_code of this TestPreferredCredentialStatus. + :type: str + """ + self._error_code = error_code + + @property + def error_message(self): + """ + Gets the error_message of this TestPreferredCredentialStatus. + The error message that indicates the reason for the failure of the preferred credential test. The response is 'null' if the preferred credential test was successful. + + + :return: The error_message of this TestPreferredCredentialStatus. + :rtype: str + """ + return self._error_message + + @error_message.setter + def error_message(self, error_message): + """ + Sets the error_message of this TestPreferredCredentialStatus. + The error message that indicates the reason for the failure of the preferred credential test. The response is 'null' if the preferred credential test was successful. + + + :param error_message: The error_message of this TestPreferredCredentialStatus. + :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/database_management/models/update_basic_preferred_credential_details.py b/src/oci/database_management/models/update_basic_preferred_credential_details.py new file mode 100644 index 0000000000..8a3a765ac9 --- /dev/null +++ b/src/oci/database_management/models/update_basic_preferred_credential_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 .update_preferred_credential_details import UpdatePreferredCredentialDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdateBasicPreferredCredentialDetails(UpdatePreferredCredentialDetails): + """ + The details of the 'BASIC' preferred credential. + """ + + #: A constant which can be used with the role property of a UpdateBasicPreferredCredentialDetails. + #: This constant has a value of "NORMAL" + ROLE_NORMAL = "NORMAL" + + #: A constant which can be used with the role property of a UpdateBasicPreferredCredentialDetails. + #: This constant has a value of "SYSDBA" + ROLE_SYSDBA = "SYSDBA" + + def __init__(self, **kwargs): + """ + Initializes a new UpdateBasicPreferredCredentialDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.database_management.models.UpdateBasicPreferredCredentialDetails.type` attribute + of this class is ``BASIC`` 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 UpdateBasicPreferredCredentialDetails. + Allowed values for this property are: "BASIC" + :type type: str + + :param user_name: + The value to assign to the user_name property of this UpdateBasicPreferredCredentialDetails. + :type user_name: str + + :param role: + The value to assign to the role property of this UpdateBasicPreferredCredentialDetails. + Allowed values for this property are: "NORMAL", "SYSDBA" + :type role: str + + :param password_secret_id: + The value to assign to the password_secret_id property of this UpdateBasicPreferredCredentialDetails. + :type password_secret_id: str + + """ + self.swagger_types = { + 'type': 'str', + 'user_name': 'str', + 'role': 'str', + 'password_secret_id': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'user_name': 'userName', + 'role': 'role', + 'password_secret_id': 'passwordSecretId' + } + + self._type = None + self._user_name = None + self._role = None + self._password_secret_id = None + self._type = 'BASIC' + + @property + def user_name(self): + """ + Gets the user_name of this UpdateBasicPreferredCredentialDetails. + The user name used to connect to the database. + + + :return: The user_name of this UpdateBasicPreferredCredentialDetails. + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """ + Sets the user_name of this UpdateBasicPreferredCredentialDetails. + The user name used to connect to the database. + + + :param user_name: The user_name of this UpdateBasicPreferredCredentialDetails. + :type: str + """ + self._user_name = user_name + + @property + def role(self): + """ + Gets the role of this UpdateBasicPreferredCredentialDetails. + The role of the database user. + + Allowed values for this property are: "NORMAL", "SYSDBA" + + + :return: The role of this UpdateBasicPreferredCredentialDetails. + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """ + Sets the role of this UpdateBasicPreferredCredentialDetails. + The role of the database user. + + + :param role: The role of this UpdateBasicPreferredCredentialDetails. + :type: str + """ + allowed_values = ["NORMAL", "SYSDBA"] + if not value_allowed_none_or_none_sentinel(role, allowed_values): + raise ValueError( + "Invalid value for `role`, must be None or one of {0}" + .format(allowed_values) + ) + self._role = role + + @property + def password_secret_id(self): + """ + Gets the password_secret_id of this UpdateBasicPreferredCredentialDetails. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :return: The password_secret_id of this UpdateBasicPreferredCredentialDetails. + :rtype: str + """ + return self._password_secret_id + + @password_secret_id.setter + def password_secret_id(self, password_secret_id): + """ + Sets the password_secret_id of this UpdateBasicPreferredCredentialDetails. + The `OCID`__ of the Vault service secret that contains the database user password. + + __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm + + + :param password_secret_id: The password_secret_id of this UpdateBasicPreferredCredentialDetails. + :type: str + """ + self._password_secret_id = password_secret_id + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/database_management/models/update_preferred_credential_details.py b/src/oci/database_management/models/update_preferred_credential_details.py new file mode 100644 index 0000000000..86dd258b33 --- /dev/null +++ b/src/oci/database_management/models/update_preferred_credential_details.py @@ -0,0 +1,100 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class UpdatePreferredCredentialDetails(object): + """ + The details required to update the preferred credential. + """ + + #: A constant which can be used with the type property of a UpdatePreferredCredentialDetails. + #: This constant has a value of "BASIC" + TYPE_BASIC = "BASIC" + + def __init__(self, **kwargs): + """ + Initializes a new UpdatePreferredCredentialDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input + to a service operations then you should favor using a subclass over the base class: + + * :class:`~oci.database_management.models.UpdateBasicPreferredCredentialDetails` + + 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 UpdatePreferredCredentialDetails. + Allowed values for this property are: "BASIC" + :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 == 'BASIC': + return 'UpdateBasicPreferredCredentialDetails' + else: + return 'UpdatePreferredCredentialDetails' + + @property + def type(self): + """ + **[Required]** Gets the type of this UpdatePreferredCredentialDetails. + The type of preferred credential. + + Allowed values for this property are: "BASIC" + + + :return: The type of this UpdatePreferredCredentialDetails. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this UpdatePreferredCredentialDetails. + The type of preferred credential. + + + :param type: The type of this UpdatePreferredCredentialDetails. + :type: str + """ + allowed_values = ["BASIC"] + if not value_allowed_none_or_none_sentinel(type, allowed_values): + raise ValueError( + "Invalid value for `type`, must be None or one of {0}" + .format(allowed_values) + ) + self._type = type + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/monitoring/models/__init__.py b/src/oci/monitoring/models/__init__.py index 8955f38164..5e852b58ba 100644 --- a/src/oci/monitoring/models/__init__.py +++ b/src/oci/monitoring/models/__init__.py @@ -6,6 +6,8 @@ from .aggregated_datapoint import AggregatedDatapoint from .alarm import Alarm +from .alarm_dimension_states_collection import AlarmDimensionStatesCollection +from .alarm_dimension_states_entry import AlarmDimensionStatesEntry from .alarm_history_collection import AlarmHistoryCollection from .alarm_history_entry import AlarmHistoryEntry from .alarm_status_summary import AlarmStatusSummary @@ -20,6 +22,7 @@ from .metric_data_details import MetricDataDetails from .post_metric_data_details import PostMetricDataDetails from .post_metric_data_response_details import PostMetricDataResponseDetails +from .retrieve_dimension_states_details import RetrieveDimensionStatesDetails from .summarize_metrics_data_details import SummarizeMetricsDataDetails from .suppression import Suppression from .update_alarm_details import UpdateAlarmDetails @@ -28,6 +31,8 @@ monitoring_type_mapping = { "AggregatedDatapoint": AggregatedDatapoint, "Alarm": Alarm, + "AlarmDimensionStatesCollection": AlarmDimensionStatesCollection, + "AlarmDimensionStatesEntry": AlarmDimensionStatesEntry, "AlarmHistoryCollection": AlarmHistoryCollection, "AlarmHistoryEntry": AlarmHistoryEntry, "AlarmStatusSummary": AlarmStatusSummary, @@ -42,6 +47,7 @@ "MetricDataDetails": MetricDataDetails, "PostMetricDataDetails": PostMetricDataDetails, "PostMetricDataResponseDetails": PostMetricDataResponseDetails, + "RetrieveDimensionStatesDetails": RetrieveDimensionStatesDetails, "SummarizeMetricsDataDetails": SummarizeMetricsDataDetails, "Suppression": Suppression, "UpdateAlarmDetails": UpdateAlarmDetails diff --git a/src/oci/monitoring/models/alarm.py b/src/oci/monitoring/models/alarm.py index 148e41ae0f..0d150ba83f 100644 --- a/src/oci/monitoring/models/alarm.py +++ b/src/oci/monitoring/models/alarm.py @@ -122,6 +122,10 @@ def __init__(self, **kwargs): The value to assign to the body property of this Alarm. :type body: str + :param is_notifications_per_metric_dimension_enabled: + The value to assign to the is_notifications_per_metric_dimension_enabled property of this Alarm. + :type is_notifications_per_metric_dimension_enabled: bool + :param message_format: The value to assign to the message_format property of this Alarm. Allowed values for this property are: "RAW", "PRETTY_JSON", "ONS_OPTIMIZED", 'UNKNOWN_ENUM_VALUE'. @@ -180,6 +184,7 @@ def __init__(self, **kwargs): 'pending_duration': 'str', 'severity': 'str', 'body': 'str', + 'is_notifications_per_metric_dimension_enabled': 'bool', 'message_format': 'str', 'destinations': 'list[str]', 'repeat_notification_duration': 'str', @@ -205,6 +210,7 @@ def __init__(self, **kwargs): 'pending_duration': 'pendingDuration', 'severity': 'severity', 'body': 'body', + 'is_notifications_per_metric_dimension_enabled': 'isNotificationsPerMetricDimensionEnabled', 'message_format': 'messageFormat', 'destinations': 'destinations', 'repeat_notification_duration': 'repeatNotificationDuration', @@ -229,6 +235,7 @@ def __init__(self, **kwargs): self._pending_duration = None self._severity = None self._body = None + self._is_notifications_per_metric_dimension_enabled = None self._message_format = None self._destinations = None self._repeat_notification_duration = None @@ -674,6 +681,32 @@ def body(self, body): """ self._body = body + @property + def is_notifications_per_metric_dimension_enabled(self): + """ + Gets the is_notifications_per_metric_dimension_enabled of this Alarm. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :return: The is_notifications_per_metric_dimension_enabled of this Alarm. + :rtype: bool + """ + return self._is_notifications_per_metric_dimension_enabled + + @is_notifications_per_metric_dimension_enabled.setter + def is_notifications_per_metric_dimension_enabled(self, is_notifications_per_metric_dimension_enabled): + """ + Sets the is_notifications_per_metric_dimension_enabled of this Alarm. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :param is_notifications_per_metric_dimension_enabled: The is_notifications_per_metric_dimension_enabled of this Alarm. + :type: bool + """ + self._is_notifications_per_metric_dimension_enabled = is_notifications_per_metric_dimension_enabled + @property def message_format(self): """ diff --git a/src/oci/monitoring/models/alarm_dimension_states_collection.py b/src/oci/monitoring/models/alarm_dimension_states_collection.py new file mode 100644 index 0000000000..f180417eaa --- /dev/null +++ b/src/oci/monitoring/models/alarm_dimension_states_collection.py @@ -0,0 +1,173 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AlarmDimensionStatesCollection(object): + """ + The list of current alarm state entries for each metric stream that matches the filters. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AlarmDimensionStatesCollection object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param alarm_id: + The value to assign to the alarm_id property of this AlarmDimensionStatesCollection. + :type alarm_id: str + + :param is_enabled: + The value to assign to the is_enabled property of this AlarmDimensionStatesCollection. + :type is_enabled: bool + + :param is_notifications_per_metric_dimension_enabled: + The value to assign to the is_notifications_per_metric_dimension_enabled property of this AlarmDimensionStatesCollection. + :type is_notifications_per_metric_dimension_enabled: bool + + :param items: + The value to assign to the items property of this AlarmDimensionStatesCollection. + :type items: list[oci.monitoring.models.AlarmDimensionStatesEntry] + + """ + self.swagger_types = { + 'alarm_id': 'str', + 'is_enabled': 'bool', + 'is_notifications_per_metric_dimension_enabled': 'bool', + 'items': 'list[AlarmDimensionStatesEntry]' + } + + self.attribute_map = { + 'alarm_id': 'alarmId', + 'is_enabled': 'isEnabled', + 'is_notifications_per_metric_dimension_enabled': 'isNotificationsPerMetricDimensionEnabled', + 'items': 'items' + } + + self._alarm_id = None + self._is_enabled = None + self._is_notifications_per_metric_dimension_enabled = None + self._items = None + + @property + def alarm_id(self): + """ + **[Required]** Gets the alarm_id of this AlarmDimensionStatesCollection. + The `OCID`__ of the alarm to retrieve alarm state entries for. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :return: The alarm_id of this AlarmDimensionStatesCollection. + :rtype: str + """ + return self._alarm_id + + @alarm_id.setter + def alarm_id(self, alarm_id): + """ + Sets the alarm_id of this AlarmDimensionStatesCollection. + The `OCID`__ of the alarm to retrieve alarm state entries for. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + + :param alarm_id: The alarm_id of this AlarmDimensionStatesCollection. + :type: str + """ + self._alarm_id = alarm_id + + @property + def is_enabled(self): + """ + **[Required]** Gets the is_enabled of this AlarmDimensionStatesCollection. + Whether the alarm is enabled. + + Example: `true` + + + :return: The is_enabled of this AlarmDimensionStatesCollection. + :rtype: bool + """ + return self._is_enabled + + @is_enabled.setter + def is_enabled(self, is_enabled): + """ + Sets the is_enabled of this AlarmDimensionStatesCollection. + Whether the alarm is enabled. + + Example: `true` + + + :param is_enabled: The is_enabled of this AlarmDimensionStatesCollection. + :type: bool + """ + self._is_enabled = is_enabled + + @property + def is_notifications_per_metric_dimension_enabled(self): + """ + **[Required]** Gets the is_notifications_per_metric_dimension_enabled of this AlarmDimensionStatesCollection. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :return: The is_notifications_per_metric_dimension_enabled of this AlarmDimensionStatesCollection. + :rtype: bool + """ + return self._is_notifications_per_metric_dimension_enabled + + @is_notifications_per_metric_dimension_enabled.setter + def is_notifications_per_metric_dimension_enabled(self, is_notifications_per_metric_dimension_enabled): + """ + Sets the is_notifications_per_metric_dimension_enabled of this AlarmDimensionStatesCollection. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :param is_notifications_per_metric_dimension_enabled: The is_notifications_per_metric_dimension_enabled of this AlarmDimensionStatesCollection. + :type: bool + """ + self._is_notifications_per_metric_dimension_enabled = is_notifications_per_metric_dimension_enabled + + @property + def items(self): + """ + **[Required]** Gets the items of this AlarmDimensionStatesCollection. + Array of alarm state entries. + + + :return: The items of this AlarmDimensionStatesCollection. + :rtype: list[oci.monitoring.models.AlarmDimensionStatesEntry] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this AlarmDimensionStatesCollection. + Array of alarm state entries. + + + :param items: The items of this AlarmDimensionStatesCollection. + :type: list[oci.monitoring.models.AlarmDimensionStatesEntry] + """ + 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/monitoring/models/alarm_dimension_states_entry.py b/src/oci/monitoring/models/alarm_dimension_states_entry.py new file mode 100644 index 0000000000..48dc33f82f --- /dev/null +++ b/src/oci/monitoring/models/alarm_dimension_states_entry.py @@ -0,0 +1,156 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AlarmDimensionStatesEntry(object): + """ + A timestamped alarm state entry for a metric stream. + """ + + #: A constant which can be used with the status property of a AlarmDimensionStatesEntry. + #: This constant has a value of "FIRING" + STATUS_FIRING = "FIRING" + + #: A constant which can be used with the status property of a AlarmDimensionStatesEntry. + #: This constant has a value of "OK" + STATUS_OK = "OK" + + def __init__(self, **kwargs): + """ + Initializes a new AlarmDimensionStatesEntry object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param dimensions: + The value to assign to the dimensions property of this AlarmDimensionStatesEntry. + :type dimensions: dict(str, str) + + :param status: + The value to assign to the status property of this AlarmDimensionStatesEntry. + Allowed values for this property are: "FIRING", "OK", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type status: str + + :param timestamp: + The value to assign to the timestamp property of this AlarmDimensionStatesEntry. + :type timestamp: datetime + + """ + self.swagger_types = { + 'dimensions': 'dict(str, str)', + 'status': 'str', + 'timestamp': 'datetime' + } + + self.attribute_map = { + 'dimensions': 'dimensions', + 'status': 'status', + 'timestamp': 'timestamp' + } + + self._dimensions = None + self._status = None + self._timestamp = None + + @property + def dimensions(self): + """ + **[Required]** Gets the dimensions of this AlarmDimensionStatesEntry. + Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs. + + + :return: The dimensions of this AlarmDimensionStatesEntry. + :rtype: dict(str, str) + """ + return self._dimensions + + @dimensions.setter + def dimensions(self, dimensions): + """ + Sets the dimensions of this AlarmDimensionStatesEntry. + Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs. + + + :param dimensions: The dimensions of this AlarmDimensionStatesEntry. + :type: dict(str, str) + """ + self._dimensions = dimensions + + @property + def status(self): + """ + **[Required]** Gets the status of this AlarmDimensionStatesEntry. + Transition state (status value) associated with the alarm state entry. + + Example: `FIRING` + + Allowed values for this property are: "FIRING", "OK", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The status of this AlarmDimensionStatesEntry. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this AlarmDimensionStatesEntry. + Transition state (status value) associated with the alarm state entry. + + Example: `FIRING` + + + :param status: The status of this AlarmDimensionStatesEntry. + :type: str + """ + allowed_values = ["FIRING", "OK"] + if not value_allowed_none_or_none_sentinel(status, allowed_values): + status = 'UNKNOWN_ENUM_VALUE' + self._status = status + + @property + def timestamp(self): + """ + **[Required]** Gets the timestamp of this AlarmDimensionStatesEntry. + Transition time associated with the alarm state entry. Format defined by RFC3339. + + Example: `2022-02-01T01:02:29.600Z` + + + :return: The timestamp of this AlarmDimensionStatesEntry. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this AlarmDimensionStatesEntry. + Transition time associated with the alarm state entry. Format defined by RFC3339. + + Example: `2022-02-01T01:02:29.600Z` + + + :param timestamp: The timestamp of this AlarmDimensionStatesEntry. + :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/monitoring/models/alarm_status_summary.py b/src/oci/monitoring/models/alarm_status_summary.py index d941519006..57d6b0bd4f 100644 --- a/src/oci/monitoring/models/alarm_status_summary.py +++ b/src/oci/monitoring/models/alarm_status_summary.py @@ -239,6 +239,9 @@ def status(self): """ **[Required]** Gets the status of this AlarmStatusSummary. The status of this alarm. + Status is collective, across all metric streams in the alarm. + To list alarm status for each metric stream, use :func:`retrieve_dimension_states`. + The alarm attribute `isNotificationsPerMetricDimensionEnabled` must be set to `true`. Example: `FIRING` @@ -256,6 +259,9 @@ def status(self, status): """ Sets the status of this AlarmStatusSummary. The status of this alarm. + Status is collective, across all metric streams in the alarm. + To list alarm status for each metric stream, use :func:`retrieve_dimension_states`. + The alarm attribute `isNotificationsPerMetricDimensionEnabled` must be set to `true`. Example: `FIRING` diff --git a/src/oci/monitoring/models/create_alarm_details.py b/src/oci/monitoring/models/create_alarm_details.py index 4efb010163..6120e48ad1 100644 --- a/src/oci/monitoring/models/create_alarm_details.py +++ b/src/oci/monitoring/models/create_alarm_details.py @@ -74,6 +74,10 @@ def __init__(self, **kwargs): The value to assign to the body property of this CreateAlarmDetails. :type body: str + :param is_notifications_per_metric_dimension_enabled: + The value to assign to the is_notifications_per_metric_dimension_enabled property of this CreateAlarmDetails. + :type is_notifications_per_metric_dimension_enabled: bool + :param message_format: The value to assign to the message_format property of this CreateAlarmDetails. Allowed values for this property are: "RAW", "PRETTY_JSON", "ONS_OPTIMIZED" @@ -116,6 +120,7 @@ def __init__(self, **kwargs): 'pending_duration': 'str', 'severity': 'str', 'body': 'str', + 'is_notifications_per_metric_dimension_enabled': 'bool', 'message_format': 'str', 'destinations': 'list[str]', 'repeat_notification_duration': 'str', @@ -137,6 +142,7 @@ def __init__(self, **kwargs): 'pending_duration': 'pendingDuration', 'severity': 'severity', 'body': 'body', + 'is_notifications_per_metric_dimension_enabled': 'isNotificationsPerMetricDimensionEnabled', 'message_format': 'messageFormat', 'destinations': 'destinations', 'repeat_notification_duration': 'repeatNotificationDuration', @@ -157,6 +163,7 @@ def __init__(self, **kwargs): self._pending_duration = None self._severity = None self._body = None + self._is_notifications_per_metric_dimension_enabled = None self._message_format = None self._destinations = None self._repeat_notification_duration = None @@ -569,6 +576,32 @@ def body(self, body): """ self._body = body + @property + def is_notifications_per_metric_dimension_enabled(self): + """ + Gets the is_notifications_per_metric_dimension_enabled of this CreateAlarmDetails. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :return: The is_notifications_per_metric_dimension_enabled of this CreateAlarmDetails. + :rtype: bool + """ + return self._is_notifications_per_metric_dimension_enabled + + @is_notifications_per_metric_dimension_enabled.setter + def is_notifications_per_metric_dimension_enabled(self, is_notifications_per_metric_dimension_enabled): + """ + Sets the is_notifications_per_metric_dimension_enabled of this CreateAlarmDetails. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :param is_notifications_per_metric_dimension_enabled: The is_notifications_per_metric_dimension_enabled of this CreateAlarmDetails. + :type: bool + """ + self._is_notifications_per_metric_dimension_enabled = is_notifications_per_metric_dimension_enabled + @property def message_format(self): """ diff --git a/src/oci/monitoring/models/metric_data.py b/src/oci/monitoring/models/metric_data.py index c1c7edcdb7..c4250dcd7b 100644 --- a/src/oci/monitoring/models/metric_data.py +++ b/src/oci/monitoring/models/metric_data.py @@ -22,7 +22,7 @@ class MetricData(object): * Time range returned for 5-minute resolution: 30 days. * Time range returned for 1-minute resolution: 7 days. - *A metric stream is an individual set of aggregated data for a metric, typically specific to a single resource. + *A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see `Monitoring Concepts`__. diff --git a/src/oci/monitoring/models/metric_data_details.py b/src/oci/monitoring/models/metric_data_details.py index de67831a97..e1a1baec9a 100644 --- a/src/oci/monitoring/models/metric_data_details.py +++ b/src/oci/monitoring/models/metric_data_details.py @@ -209,8 +209,8 @@ def dimensions(self): **[Required]** Gets the dimensions of this MetricDataDetails. Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. - A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. The character limit for a dimension key is 256. - A valid dimension value includes only Unicode characters. The character limit for a dimension value is 256. + A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256. + A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512. Empty strings are not allowed for keys or values. Avoid entering confidential information. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` @@ -227,8 +227,8 @@ def dimensions(self, dimensions): Sets the dimensions of this MetricDataDetails. Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. - A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. The character limit for a dimension key is 256. - A valid dimension value includes only Unicode characters. The character limit for a dimension value is 256. + A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256. + A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512. Empty strings are not allowed for keys or values. Avoid entering confidential information. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` diff --git a/src/oci/monitoring/models/retrieve_dimension_states_details.py b/src/oci/monitoring/models/retrieve_dimension_states_details.py new file mode 100644 index 0000000000..f1201ca5f7 --- /dev/null +++ b/src/oci/monitoring/models/retrieve_dimension_states_details.py @@ -0,0 +1,108 @@ +# coding: utf-8 +# Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class RetrieveDimensionStatesDetails(object): + """ + The configuration details for retrieving the alarm state entries. + Filter retrieved alarm state entries by status value and dimension key-value pairs. + """ + + def __init__(self, **kwargs): + """ + Initializes a new RetrieveDimensionStatesDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param dimension_filters: + The value to assign to the dimension_filters property of this RetrieveDimensionStatesDetails. + :type dimension_filters: dict(str, str) + + :param status: + The value to assign to the status property of this RetrieveDimensionStatesDetails. + :type status: str + + """ + self.swagger_types = { + 'dimension_filters': 'dict(str, str)', + 'status': 'str' + } + + self.attribute_map = { + 'dimension_filters': 'dimensionFilters', + 'status': 'status' + } + + self._dimension_filters = None + self._status = None + + @property + def dimension_filters(self): + """ + Gets the dimension_filters of this RetrieveDimensionStatesDetails. + A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. + If you specify `\"availabilityDomain\": \"phx-ad-1\"` but the alarm state entry corresponds to the set `\"availabilityDomain\": \"phx-ad-1\"` + and `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"`, then no results are returned. + + + :return: The dimension_filters of this RetrieveDimensionStatesDetails. + :rtype: dict(str, str) + """ + return self._dimension_filters + + @dimension_filters.setter + def dimension_filters(self, dimension_filters): + """ + Sets the dimension_filters of this RetrieveDimensionStatesDetails. + A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. + If you specify `\"availabilityDomain\": \"phx-ad-1\"` but the alarm state entry corresponds to the set `\"availabilityDomain\": \"phx-ad-1\"` + and `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"`, then no results are returned. + + + :param dimension_filters: The dimension_filters of this RetrieveDimensionStatesDetails. + :type: dict(str, str) + """ + self._dimension_filters = dimension_filters + + @property + def status(self): + """ + Gets the status of this RetrieveDimensionStatesDetails. + A filter to return only alarm state entries that match the status value. + Example: `FIRING` + + + :return: The status of this RetrieveDimensionStatesDetails. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this RetrieveDimensionStatesDetails. + A filter to return only alarm state entries that match the status value. + Example: `FIRING` + + + :param status: The status of this RetrieveDimensionStatesDetails. + :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/monitoring/models/update_alarm_details.py b/src/oci/monitoring/models/update_alarm_details.py index 701378bada..590f952132 100644 --- a/src/oci/monitoring/models/update_alarm_details.py +++ b/src/oci/monitoring/models/update_alarm_details.py @@ -74,6 +74,10 @@ def __init__(self, **kwargs): The value to assign to the body property of this UpdateAlarmDetails. :type body: str + :param is_notifications_per_metric_dimension_enabled: + The value to assign to the is_notifications_per_metric_dimension_enabled property of this UpdateAlarmDetails. + :type is_notifications_per_metric_dimension_enabled: bool + :param message_format: The value to assign to the message_format property of this UpdateAlarmDetails. Allowed values for this property are: "RAW", "PRETTY_JSON", "ONS_OPTIMIZED" @@ -116,6 +120,7 @@ def __init__(self, **kwargs): 'pending_duration': 'str', 'severity': 'str', 'body': 'str', + 'is_notifications_per_metric_dimension_enabled': 'bool', 'message_format': 'str', 'destinations': 'list[str]', 'repeat_notification_duration': 'str', @@ -137,6 +142,7 @@ def __init__(self, **kwargs): 'pending_duration': 'pendingDuration', 'severity': 'severity', 'body': 'body', + 'is_notifications_per_metric_dimension_enabled': 'isNotificationsPerMetricDimensionEnabled', 'message_format': 'messageFormat', 'destinations': 'destinations', 'repeat_notification_duration': 'repeatNotificationDuration', @@ -157,6 +163,7 @@ def __init__(self, **kwargs): self._pending_duration = None self._severity = None self._body = None + self._is_notifications_per_metric_dimension_enabled = None self._message_format = None self._destinations = None self._repeat_notification_duration = None @@ -569,6 +576,32 @@ def body(self, body): """ self._body = body + @property + def is_notifications_per_metric_dimension_enabled(self): + """ + Gets the is_notifications_per_metric_dimension_enabled of this UpdateAlarmDetails. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :return: The is_notifications_per_metric_dimension_enabled of this UpdateAlarmDetails. + :rtype: bool + """ + return self._is_notifications_per_metric_dimension_enabled + + @is_notifications_per_metric_dimension_enabled.setter + def is_notifications_per_metric_dimension_enabled(self, is_notifications_per_metric_dimension_enabled): + """ + Sets the is_notifications_per_metric_dimension_enabled of this UpdateAlarmDetails. + When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. + Example: `true` + + + :param is_notifications_per_metric_dimension_enabled: The is_notifications_per_metric_dimension_enabled of this UpdateAlarmDetails. + :type: bool + """ + self._is_notifications_per_metric_dimension_enabled = is_notifications_per_metric_dimension_enabled + @property def message_format(self): """ diff --git a/src/oci/monitoring/monitoring_client.py b/src/oci/monitoring/monitoring_client.py index 4027f08fe6..2c04f51498 100644 --- a/src/oci/monitoring/monitoring_client.py +++ b/src/oci/monitoring/monitoring_client.py @@ -878,6 +878,9 @@ def list_alarms(self, compartment_id, **kwargs): def list_alarms_status(self, compartment_id, **kwargs): """ List the status of each alarm in the specified compartment. + Status is collective, across all metric streams in the alarm. + To list alarm status for each metric stream, use :func:`retrieve_dimension_states`. + The alarm attribute `isNotificationsPerMetricDimensionEnabled` must be set to `true`. For important limits information, see `Limits on Monitoring`__. This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. @@ -1192,7 +1195,7 @@ def post_metric_data(self, post_metric_data_details, **kwargs): *A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. - A metric stream is an individual set of aggregated data for a metric, typically specific to a resource. + A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. For more information about metric-related concepts, see `Monitoring Concepts`__. The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example: @@ -1211,6 +1214,9 @@ def post_metric_data(self, post_metric_data_details, **kwargs): Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. + :param str content_encoding: (optional) + The optional Content-Encoding header that defines the content encodings that were applied to the payload. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1238,7 +1244,8 @@ def post_metric_data(self, post_metric_data_details, **kwargs): expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "content_encoding" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1248,7 +1255,8 @@ def post_metric_data(self, post_metric_data_details, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "opc-request-id": kwargs.get("opc_request_id", missing) + "opc-request-id": kwargs.get("opc_request_id", missing), + "content-encoding": kwargs.get("content_encoding", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -1389,6 +1397,144 @@ def remove_alarm_suppression(self, alarm_id, **kwargs): operation_name=operation_name, api_reference_link=api_reference_link) + def retrieve_dimension_states(self, alarm_id, **kwargs): + """ + Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. + Optionally filter by status value and one or more dimension key-value pairs. + This operation is only valid for alarms that have notifications per dimension enabled (`isNotificationsPerMetricDimensionEnabled=true`). + If `isNotificationsPerMetricDimensionEnabled` for the alarm is false or null, then no results are returned. + + For important limits information, see `Limits on Monitoring`__. + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + + __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits + + + :param str alarm_id: (required) + The `OCID`__ of an alarm. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + + :param str opc_request_id: (optional) + Customer part of the request identifier token. If you need to contact Oracle about a particular + request, please provide the complete request ID. + + :param str page: (optional) + For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. + For important details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param int limit: (optional) + For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. + For important details about how pagination works, see `List Pagination`__. + + Default: 1000 + + Example: 500 + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param oci.monitoring.models.RetrieveDimensionStatesDetails retrieve_dimension_states_details: (optional) + The configuration details for retrieving the current alarm status of each metric stream. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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.monitoring.models.AlarmDimensionStatesCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use retrieve_dimension_states API. + """ + resource_path = "/alarms/{alarmId}/actions/retrieveDimensionStates" + method = "POST" + operation_name = "retrieve_dimension_states" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmDimensionStatesCollection/RetrieveDimensionStates" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "page", + "limit", + "retrieve_dimension_states_details" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "retrieve_dimension_states got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "alarmId": alarm_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, + body=kwargs.get('retrieve_dimension_states_details'), + response_type="AlarmDimensionStatesCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=kwargs.get('retrieve_dimension_states_details'), + response_type="AlarmDimensionStatesCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link) + def summarize_metrics_data(self, compartment_id, summarize_metrics_data_details, **kwargs): """ Returns aggregated data that match the criteria specified in the request. Compartment OCID required. diff --git a/src/oci/version.py b/src/oci/version.py index 3a7660846f..a5a45ada8b 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.80.1" +__version__ = "2.81.0"