From 6787f7e8108abbea181101ac6817ddb8e4e2b2af Mon Sep 17 00:00:00 2001 From: oci-dex-release-bot Date: Tue, 5 Sep 2023 15:36:40 +0000 Subject: [PATCH] Releasing version 2.112.0 --- CHANGELOG.rst | 23 + docs/api/cims.rst | 5 +- .../models/oci.cims.models.AccountItem.rst | 11 + ...i.cims.models.CreateAccountItemDetails.rst | 11 + .../oci.cims.models.ServiceCategories.rst | 11 + docs/api/data_catalog.rst | 11 + ...dels.AsynchronousExportGlossaryDetails.rst | 11 + ...odels.AsynchronousExportGlossaryResult.rst | 11 + ...odels.AsynchronousExportRequestDetails.rst | 11 + ...atalog.models.AsynchronousExportResult.rst | 11 + .../oci.data_catalog.models.EntityLineage.rst | 11 + ...talog.models.FetchEntityLineageDetails.rst | 11 + .../oci.data_catalog.models.LineageObject.rst | 11 + ...ata_catalog.models.LineageRelationship.rst | 11 + .../oci.data_catalog.models.ObjectLineage.rst | 11 + ...log.models.ObjectLineageRequestDetails.rst | 11 + ...og.models.ObjectStorageObjectReference.rst | 11 + docs/api/landing.rst | 1 - docs/api/queue.rst | 2 + .../oci.queue.models.ChannelCollection.rst | 11 + .../oci.queue.models.MessageMetadata.rst | 11 + src/oci/cims/__init__.py | 4 +- src/oci/cims/incident_client.py | 435 ++++++++++++++---- src/oci/cims/models/__init__.py | 6 + src/oci/cims/models/account_item.py | 85 ++++ src/oci/cims/models/activity_item.py | 126 ++++- src/oci/cims/models/category.py | 10 +- src/oci/cims/models/contact.py | 33 +- src/oci/cims/models/contextual_data.py | 18 +- .../models/create_account_item_details.py | 78 ++++ .../cims/models/create_category_details.py | 6 +- src/oci/cims/models/create_incident.py | 22 +- .../cims/models/create_issue_type_details.py | 2 - src/oci/cims/models/create_item_details.py | 16 +- .../cims/models/create_limit_item_details.py | 6 +- .../cims/models/create_resource_details.py | 291 +----------- .../models/create_sub_category_details.py | 8 +- .../create_tech_support_item_details.py | 4 +- src/oci/cims/models/create_ticket_details.py | 24 +- src/oci/cims/models/create_user_details.py | 101 ++-- src/oci/cims/models/incident.py | 16 +- src/oci/cims/models/incident_resource_type.py | 70 ++- src/oci/cims/models/incident_summary.py | 14 +- src/oci/cims/models/incident_type.py | 2 +- src/oci/cims/models/issue_type.py | 35 +- src/oci/cims/models/item.py | 12 +- src/oci/cims/models/limit_item.py | 14 +- src/oci/cims/models/resource.py | 287 +----------- src/oci/cims/models/service_categories.py | 134 ++++++ src/oci/cims/models/service_category.py | 2 +- src/oci/cims/models/sub_category.py | 10 +- src/oci/cims/models/tenancy_information.py | 6 +- src/oci/cims/models/ticket.py | 10 +- .../models/update_activity_item_details.py | 14 +- src/oci/cims/models/update_incident.py | 64 ++- src/oci/cims/models/update_item_details.py | 8 +- .../cims/models/update_resource_details.py | 2 - src/oci/cims/models/update_ticket_details.py | 2 - src/oci/cims/models/user.py | 98 +++- .../container_instance_client.py | 117 ++++- src/oci/data_catalog/data_catalog_client.py | 300 +++++++++++- src/oci/data_catalog/models/__init__.py | 22 + .../asynchronous_export_glossary_details.py | 68 +++ .../asynchronous_export_glossary_result.py | 196 ++++++++ .../asynchronous_export_request_details.py | 68 +++ .../models/asynchronous_export_result.py | 196 ++++++++ src/oci/data_catalog/models/attribute.py | 33 ++ .../data_catalog/models/attribute_summary.py | 33 ++ .../models/create_job_definition_details.py | 45 +- .../data_catalog/models/create_job_details.py | 2 + .../models/create_job_execution_details.py | 14 +- src/oci/data_catalog/models/data_asset.py | 33 ++ .../data_catalog/models/data_asset_summary.py | 37 +- src/oci/data_catalog/models/entity.py | 33 ++ src/oci/data_catalog/models/entity_lineage.py | 222 +++++++++ src/oci/data_catalog/models/entity_summary.py | 33 ++ .../faceted_search_date_filter_request.py | 4 +- .../faceted_search_string_filter_request.py | 10 +- .../models/fetch_entity_lineage_details.py | 190 ++++++++ src/oci/data_catalog/models/folder.py | 33 ++ src/oci/data_catalog/models/folder_summary.py | 37 +- src/oci/data_catalog/models/job.py | 47 +- src/oci/data_catalog/models/job_definition.py | 45 +- .../models/job_definition_summary.py | 49 +- src/oci/data_catalog/models/job_execution.py | 14 +- .../models/job_execution_summary.py | 14 +- src/oci/data_catalog/models/job_summary.py | 47 +- src/oci/data_catalog/models/lineage_object.py | 400 ++++++++++++++++ .../models/lineage_relationship.py | 134 ++++++ src/oci/data_catalog/models/object_lineage.py | 223 +++++++++ .../models/object_lineage_request_details.py | 190 ++++++++ .../models/object_storage_object_reference.py | 134 ++++++ .../models/update_job_definition_details.py | 31 ++ .../data_catalog/models/update_job_details.py | 2 + src/oci/queue/models/__init__.py | 4 + src/oci/queue/models/channel_collection.py | 72 +++ src/oci/queue/models/create_queue_details.py | 61 ++- .../models/delete_messages_details_entry.py | 4 +- src/oci/queue/models/get_message.py | 67 ++- src/oci/queue/models/message_metadata.py | 103 +++++ src/oci/queue/models/purge_queue_details.py | 51 +- src/oci/queue/models/put_message.py | 49 +- src/oci/queue/models/put_messages.py | 6 +- .../models/put_messages_details_entry.py | 31 +- src/oci/queue/models/queue.py | 97 +++- src/oci/queue/models/queue_stats.py | 37 +- src/oci/queue/models/queue_summary.py | 54 ++- src/oci/queue/models/stats.py | 4 +- .../queue/models/update_messages_details.py | 2 +- .../models/update_messages_details_entry.py | 4 +- .../queue/models/update_messages_result.py | 4 +- .../models/update_messages_result_entry.py | 16 +- src/oci/queue/models/update_queue_details.py | 55 ++- src/oci/queue/models/updated_message.py | 16 +- src/oci/queue/models/work_request.py | 8 +- src/oci/queue/models/work_request_error.py | 8 +- .../queue/models/work_request_log_entry.py | 8 +- src/oci/queue/models/work_request_summary.py | 12 +- src/oci/queue/queue_admin_client.py | 91 ++-- ...queue_admin_client_composite_operations.py | 8 +- src/oci/queue/queue_client.py | 231 ++++++++-- src/oci/version.py | 2 +- 122 files changed, 5359 insertions(+), 1095 deletions(-) create mode 100644 docs/api/cims/models/oci.cims.models.AccountItem.rst create mode 100644 docs/api/cims/models/oci.cims.models.CreateAccountItemDetails.rst create mode 100644 docs/api/cims/models/oci.cims.models.ServiceCategories.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryDetails.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryResult.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportRequestDetails.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportResult.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.EntityLineage.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.FetchEntityLineageDetails.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.LineageObject.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.LineageRelationship.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineage.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineageRequestDetails.rst create mode 100644 docs/api/data_catalog/models/oci.data_catalog.models.ObjectStorageObjectReference.rst create mode 100644 docs/api/queue/models/oci.queue.models.ChannelCollection.rst create mode 100644 docs/api/queue/models/oci.queue.models.MessageMetadata.rst create mode 100644 src/oci/cims/models/account_item.py create mode 100644 src/oci/cims/models/create_account_item_details.py create mode 100644 src/oci/cims/models/service_categories.py create mode 100644 src/oci/data_catalog/models/asynchronous_export_glossary_details.py create mode 100644 src/oci/data_catalog/models/asynchronous_export_glossary_result.py create mode 100644 src/oci/data_catalog/models/asynchronous_export_request_details.py create mode 100644 src/oci/data_catalog/models/asynchronous_export_result.py create mode 100644 src/oci/data_catalog/models/entity_lineage.py create mode 100644 src/oci/data_catalog/models/fetch_entity_lineage_details.py create mode 100644 src/oci/data_catalog/models/lineage_object.py create mode 100644 src/oci/data_catalog/models/lineage_relationship.py create mode 100644 src/oci/data_catalog/models/object_lineage.py create mode 100644 src/oci/data_catalog/models/object_lineage_request_details.py create mode 100644 src/oci/data_catalog/models/object_storage_object_reference.py create mode 100644 src/oci/queue/models/channel_collection.py create mode 100644 src/oci/queue/models/message_metadata.py diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5731864037..a4b06c27cb 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,28 @@ Change Log All notable changes to this project will be documented in this file. The format is based on `Keep a Changelog `_. +==================== +2.112.0 - 2023-09-05 +==================== + +Added +----- +* Support for queue channels in the Queue Service +* Support for entity lineage retrieval and asynchronous glossary export in the Data Catalog service +* Support for filtering and sorting while listing work requests in the Container Instances service +* Support for the ability to create support requests for various support ticket types (TECH, LIMIT, ACCOUNT) in the Customer Incident Management Service +* Endpoint changed from https://incidentmanagement.{region}.{domainAndTopLevelDomain} to https://incidentmanagement.{region}.oci.{domainAndTopLevelDomain} (e.g. https://incidentmanagement.us-phoenix-1.oraclecloud.com to https://incidentmanagement.us-phoenix-1.oci.oraclecloud.com) in the Customer Incident Management Service + +Breaking +-------- +* The models `UserClient` and `UserClientCompositeOperations` were removed in the Customer Incident Management Service +* The parameter `availability_domain` was removed from models `Resource` and `CreateResourceDetails` in the Customer Incident Management Service +* The constants `REGION_DEV`, `REGION_SEA`, `REGION_INTEG_NEXT`, `REGION_INTEG_STABLE`, `REGION_PHX`, `REGION_IAD`, `REGION_FRA`, `REGION_EU_FRANKFURT_1`, `REGION_LHR`, `REGION_YYZ`, `REGION_NRT`, `REGION_ICN`, `REGION_BOM`, `REGION_GRU`, `REGION_SYD`, `REGION_ZRH`, `REGION_JED`, `REGION_AMS`, `REGION_KIX`, `REGION_MEL`, `REGION_YUL`, `REGION_HYD`, `REGION_YNY` were removed from the models `Resource` and `CreateResourceDetails` in the Customer Incident Management Service +* The constants `AVAILABILITY_DOMAIN_DEV_1`, `AVAILABILITY_DOMAIN_DEV_2`, `AVAILABILITY_DOMAIN_DEV_3`, `AVAILABILITY_DOMAIN_INTEG_NEXT_1`, `AVAILABILITY_DOMAIN_INTEG_STABLE_1`, `AVAILABILITY_DOMAIN_SEA_AD_1`, `AVAILABILITY_DOMAIN_SEA_AD_2`, `AVAILABILITY_DOMAIN_SEA_AD_3`, `AVAILABILITY_DOMAIN_PHX_AD_1`, `AVAILABILITY_DOMAIN_PHX_AD_2`, `AVAILABILITY_DOMAIN_PHX_AD_3`, `AVAILABILITY_DOMAIN_US_ASHBURN_AD_1`, `AVAILABILITY_DOMAIN_US_ASHBURN_AD_2`, `AVAILABILITY_DOMAIN_US_ASHBURN_AD_3`, `AVAILABILITY_DOMAIN_US_ASHBURN_AD_4`, `AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_1`, `AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_2`, `AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_3`, `AVAILABILITY_DOMAIN_UK_LONDON_1_AD_1`, `AVAILABILITY_DOMAIN_UK_LONDON_1_AD_2`, `AVAILABILITY_DOMAIN_UK_LONDON_1_AD_3`, `AVAILABILITY_DOMAIN_CA_TORONTO_1_AD_1`, `AVAILABILITY_DOMAIN_AP_TOKYO_1_AD_1`, `AVAILABILITY_DOMAIN_AP_SEOUL_1_AD_1`, `AVAILABILITY_DOMAIN_AP_MUMBAI_1_AD_1`, `AVAILABILITY_DOMAIN_SA_SAOPAULO_1_AD_1`, `AVAILABILITY_DOMAIN_ME_JEDDAH_1_AD_1`, `AVAILABILITY_DOMAIN_AP_OSAKA_1_AD_1`, `AVAILABILITY_DOMAIN_AP_SYDNEY_1_AD_1`, `AVAILABILITY_DOMAIN_EU_ZURICH_1_AD_1`, `AVAILABILITY_DOMAIN_EU_AMSTERDAM_1_AD_1`, `AVAILABILITY_DOMAIN_AP_MELBOURNE_1_AD_1`, `AVAILABILITY_DOMAIN_CA_MONTREAL_1_AD_1`, `AVAILABILITY_DOMAIN_AP_HYDERABAD_1_AD_1`, `AVAILABILITY_DOMAIN_AP_CHUNCHEON_1_AD_1`, `AVAILABILITY_DOMAIN_NO_AD` were removed from the models `Resource` and `CreateResourceDetails` in the Customer Incident Management Service +* The parameter `region` was modified to accept any string in the models `Resource` and `CreateResourceDetails` in the Customer Incident Management Service +* The parameter `country` was removed from the model `CreateUserDetails` in the Customer Incident Management Service +* The parameter `source` was removed from the operation `get_status` in `IncidentClient` the Customer Incident Management Service + ==================== 2.111.0 - 2023-08-29 ==================== @@ -20,6 +42,7 @@ Added * Support for additional parameters on dynamic routing gateway create and update operations in the Network Monitoring service * Support for assigning an IPv6 address to a compute instance during instance launch or secondary VNIC attach in the Compute service * Support for Resource Principals v3.0 +* Support for OKE Workload Auth Provider Breaking -------- diff --git a/docs/api/cims.rst b/docs/api/cims.rst index 47a32efe49..91e68274f8 100644 --- a/docs/api/cims.rst +++ b/docs/api/cims.rst @@ -7,9 +7,7 @@ Cims :template: autosummary/service_client.rst oci.cims.IncidentClient - oci.cims.UserClient oci.cims.IncidentClientCompositeOperations - oci.cims.UserClientCompositeOperations -------- Models @@ -20,12 +18,14 @@ Cims :nosignatures: :template: autosummary/model_class.rst + oci.cims.models.AccountItem oci.cims.models.ActivityItem oci.cims.models.Category oci.cims.models.Classifier oci.cims.models.Contact oci.cims.models.ContactList oci.cims.models.ContextualData + oci.cims.models.CreateAccountItemDetails oci.cims.models.CreateCategoryDetails oci.cims.models.CreateIncident oci.cims.models.CreateIssueTypeDetails @@ -44,6 +44,7 @@ Cims oci.cims.models.Item oci.cims.models.LimitItem oci.cims.models.Resource + oci.cims.models.ServiceCategories oci.cims.models.ServiceCategory oci.cims.models.Status oci.cims.models.SubCategory diff --git a/docs/api/cims/models/oci.cims.models.AccountItem.rst b/docs/api/cims/models/oci.cims.models.AccountItem.rst new file mode 100644 index 0000000000..db8bbdfc19 --- /dev/null +++ b/docs/api/cims/models/oci.cims.models.AccountItem.rst @@ -0,0 +1,11 @@ +AccountItem +=========== + +.. currentmodule:: oci.cims.models + +.. autoclass:: AccountItem + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cims/models/oci.cims.models.CreateAccountItemDetails.rst b/docs/api/cims/models/oci.cims.models.CreateAccountItemDetails.rst new file mode 100644 index 0000000000..1e90fead5a --- /dev/null +++ b/docs/api/cims/models/oci.cims.models.CreateAccountItemDetails.rst @@ -0,0 +1,11 @@ +CreateAccountItemDetails +======================== + +.. currentmodule:: oci.cims.models + +.. autoclass:: CreateAccountItemDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/cims/models/oci.cims.models.ServiceCategories.rst b/docs/api/cims/models/oci.cims.models.ServiceCategories.rst new file mode 100644 index 0000000000..70fc210955 --- /dev/null +++ b/docs/api/cims/models/oci.cims.models.ServiceCategories.rst @@ -0,0 +1,11 @@ +ServiceCategories +================= + +.. currentmodule:: oci.cims.models + +.. autoclass:: ServiceCategories + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog.rst b/docs/api/data_catalog.rst index 5dec0e48e8..0620b3ffc1 100644 --- a/docs/api/data_catalog.rst +++ b/docs/api/data_catalog.rst @@ -18,6 +18,10 @@ Data Catalog :nosignatures: :template: autosummary/model_class.rst + oci.data_catalog.models.AsynchronousExportGlossaryDetails + oci.data_catalog.models.AsynchronousExportGlossaryResult + oci.data_catalog.models.AsynchronousExportRequestDetails + oci.data_catalog.models.AsynchronousExportResult oci.data_catalog.models.AttachCatalogPrivateEndpointDetails oci.data_catalog.models.Attribute oci.data_catalog.models.AttributeCollection @@ -77,6 +81,7 @@ Data Catalog oci.data_catalog.models.DetachCatalogPrivateEndpointDetails oci.data_catalog.models.Entity oci.data_catalog.models.EntityCollection + oci.data_catalog.models.EntityLineage oci.data_catalog.models.EntitySummary oci.data_catalog.models.EntityTag oci.data_catalog.models.EntityTagCollection @@ -89,6 +94,7 @@ Data Catalog oci.data_catalog.models.FacetedSearchFilterRequest oci.data_catalog.models.FacetedSearchSortRequest oci.data_catalog.models.FacetedSearchStringFilterRequest + oci.data_catalog.models.FetchEntityLineageDetails oci.data_catalog.models.Folder oci.data_catalog.models.FolderCollection oci.data_catalog.models.FolderSummary @@ -121,12 +127,17 @@ Data Catalog oci.data_catalog.models.JobMetricCollection oci.data_catalog.models.JobMetricSummary oci.data_catalog.models.JobSummary + oci.data_catalog.models.LineageObject + oci.data_catalog.models.LineageRelationship oci.data_catalog.models.Metastore oci.data_catalog.models.MetastoreSummary oci.data_catalog.models.Namespace oci.data_catalog.models.NamespaceCollection oci.data_catalog.models.NamespaceSummary + oci.data_catalog.models.ObjectLineage + oci.data_catalog.models.ObjectLineageRequestDetails oci.data_catalog.models.ObjectRelationship + oci.data_catalog.models.ObjectStorageObjectReference oci.data_catalog.models.ParseConnectionDetails oci.data_catalog.models.Pattern oci.data_catalog.models.PatternCollection diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryDetails.rst b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryDetails.rst new file mode 100644 index 0000000000..590208f396 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryDetails.rst @@ -0,0 +1,11 @@ +AsynchronousExportGlossaryDetails +================================= + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: AsynchronousExportGlossaryDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryResult.rst b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryResult.rst new file mode 100644 index 0000000000..08008c0e91 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportGlossaryResult.rst @@ -0,0 +1,11 @@ +AsynchronousExportGlossaryResult +================================ + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: AsynchronousExportGlossaryResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportRequestDetails.rst b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportRequestDetails.rst new file mode 100644 index 0000000000..92fb4db1d6 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportRequestDetails.rst @@ -0,0 +1,11 @@ +AsynchronousExportRequestDetails +================================ + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: AsynchronousExportRequestDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportResult.rst b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportResult.rst new file mode 100644 index 0000000000..6d236858d0 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.AsynchronousExportResult.rst @@ -0,0 +1,11 @@ +AsynchronousExportResult +======================== + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: AsynchronousExportResult + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.EntityLineage.rst b/docs/api/data_catalog/models/oci.data_catalog.models.EntityLineage.rst new file mode 100644 index 0000000000..3d7f3348c3 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.EntityLineage.rst @@ -0,0 +1,11 @@ +EntityLineage +============= + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: EntityLineage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.FetchEntityLineageDetails.rst b/docs/api/data_catalog/models/oci.data_catalog.models.FetchEntityLineageDetails.rst new file mode 100644 index 0000000000..8d3e87da7b --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.FetchEntityLineageDetails.rst @@ -0,0 +1,11 @@ +FetchEntityLineageDetails +========================= + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: FetchEntityLineageDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.LineageObject.rst b/docs/api/data_catalog/models/oci.data_catalog.models.LineageObject.rst new file mode 100644 index 0000000000..633325f4b9 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.LineageObject.rst @@ -0,0 +1,11 @@ +LineageObject +============= + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: LineageObject + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.LineageRelationship.rst b/docs/api/data_catalog/models/oci.data_catalog.models.LineageRelationship.rst new file mode 100644 index 0000000000..76ef0a8dbc --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.LineageRelationship.rst @@ -0,0 +1,11 @@ +LineageRelationship +=================== + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: LineageRelationship + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineage.rst b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineage.rst new file mode 100644 index 0000000000..f6493b6d8d --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineage.rst @@ -0,0 +1,11 @@ +ObjectLineage +============= + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: ObjectLineage + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineageRequestDetails.rst b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineageRequestDetails.rst new file mode 100644 index 0000000000..a6dee6af27 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectLineageRequestDetails.rst @@ -0,0 +1,11 @@ +ObjectLineageRequestDetails +=========================== + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: ObjectLineageRequestDetails + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/data_catalog/models/oci.data_catalog.models.ObjectStorageObjectReference.rst b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectStorageObjectReference.rst new file mode 100644 index 0000000000..094a9329f3 --- /dev/null +++ b/docs/api/data_catalog/models/oci.data_catalog.models.ObjectStorageObjectReference.rst @@ -0,0 +1,11 @@ +ObjectStorageObjectReference +============================ + +.. currentmodule:: oci.data_catalog.models + +.. autoclass:: ObjectStorageObjectReference + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/landing.rst b/docs/api/landing.rst index 0e53bd4e90..9467abdc93 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -200,7 +200,6 @@ API Reference * :doc:`Usage Plans ` * :doc:`Usageapi ` * :doc:`Usagelimits ` -* :doc:`User ` * :doc:`Vaults ` * :doc:`Vb Instance ` * :doc:`Vbs Instance ` diff --git a/docs/api/queue.rst b/docs/api/queue.rst index ba08f08ee3..ac8d06fc09 100644 --- a/docs/api/queue.rst +++ b/docs/api/queue.rst @@ -21,6 +21,7 @@ Queue :template: autosummary/model_class.rst oci.queue.models.ChangeQueueCompartmentDetails + oci.queue.models.ChannelCollection oci.queue.models.CreateQueueDetails oci.queue.models.DeleteMessagesDetails oci.queue.models.DeleteMessagesDetailsEntry @@ -28,6 +29,7 @@ Queue oci.queue.models.DeleteMessagesResultEntry oci.queue.models.GetMessage oci.queue.models.GetMessages + oci.queue.models.MessageMetadata oci.queue.models.PurgeQueueDetails oci.queue.models.PutMessage oci.queue.models.PutMessages diff --git a/docs/api/queue/models/oci.queue.models.ChannelCollection.rst b/docs/api/queue/models/oci.queue.models.ChannelCollection.rst new file mode 100644 index 0000000000..6831cf2032 --- /dev/null +++ b/docs/api/queue/models/oci.queue.models.ChannelCollection.rst @@ -0,0 +1,11 @@ +ChannelCollection +================= + +.. currentmodule:: oci.queue.models + +.. autoclass:: ChannelCollection + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/docs/api/queue/models/oci.queue.models.MessageMetadata.rst b/docs/api/queue/models/oci.queue.models.MessageMetadata.rst new file mode 100644 index 0000000000..26a205afb3 --- /dev/null +++ b/docs/api/queue/models/oci.queue.models.MessageMetadata.rst @@ -0,0 +1,11 @@ +MessageMetadata +=============== + +.. currentmodule:: oci.queue.models + +.. autoclass:: MessageMetadata + :show-inheritance: + :special-members: __init__ + :members: + :undoc-members: + :inherited-members: \ No newline at end of file diff --git a/src/oci/cims/__init__.py b/src/oci/cims/__init__.py index d214af3e29..d87fa49c70 100644 --- a/src/oci/cims/__init__.py +++ b/src/oci/cims/__init__.py @@ -9,8 +9,6 @@ from .incident_client import IncidentClient from .incident_client_composite_operations import IncidentClientCompositeOperations -from .user_client import UserClient -from .user_client_composite_operations import UserClientCompositeOperations from . import models -__all__ = ["IncidentClient", "IncidentClientCompositeOperations", "UserClient", "UserClientCompositeOperations", "models"] +__all__ = ["IncidentClient", "IncidentClientCompositeOperations", "models"] diff --git a/src/oci/cims/incident_client.py b/src/oci/cims/incident_client.py index 0e761e2da0..e4520b6199 100644 --- a/src/oci/cims/incident_client.py +++ b/src/oci/cims/incident_client.py @@ -20,7 +20,12 @@ class IncidentClient(object): """ - Use the Support Management API to manage support requests. For more information, see [Getting Help and Contacting Support](/iaas/Content/GSG/Tasks/contactingsupport.htm). **Note**: Before you can create service requests with this API, you need to have an Oracle Single Sign On (SSO) account, and you need to register your Customer Support Identifier (CSI) with My Oracle Support. + Use the Support Management API to manage support requests. + For more information, see [Getting Help and Contacting Support](/iaas/Content/GSG/Tasks/contactingsupport.htm). + + **Note**: Before you can create service requests with this API, + you need to have an Oracle Single Sign On (SSO) account, + and you need to register your Customer Support Identifier (CSI) with My Oracle Support. """ def __init__(self, config, **kwargs): @@ -95,7 +100,7 @@ def __init__(self, config, **kwargs): 'regional_client': True, 'service_endpoint': kwargs.get('service_endpoint'), 'base_path': '/20181231', - 'service_endpoint_template': 'https://incidentmanagement.{region}.{secondLevelDomain}', + 'service_endpoint_template': 'https://incidentmanagement.{region}.oci.{secondLevelDomain}', 'service_endpoint_template_per_realm': { }, # noqa: E201 E202 'skip_deserialization': kwargs.get('skip_deserialization', False), 'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY), @@ -111,23 +116,35 @@ def __init__(self, config, **kwargs): self.retry_strategy = kwargs.get('retry_strategy') self.circuit_breaker_callback = kwargs.get('circuit_breaker_callback') - def create_incident(self, create_incident_details, ocid, **kwargs): + def create_incident(self, create_incident_details, **kwargs): """ - Enables the customer to create an support ticket. + Operation to create a support ticket. :param oci.cims.models.CreateIncident create_incident_details: (required) Incident information - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. - :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 ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -158,7 +175,12 @@ def create_incident(self, create_incident_details, ocid, **kwargs): "allow_control_chars", "retry_strategy", "opc_request_id", - "homeregion" + "ocid", + "homeregion", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -169,8 +191,12 @@ def create_incident(self, create_incident_details, ocid, **kwargs): "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "ocid": ocid, - "homeregion": kwargs.get("homeregion", missing) + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -206,29 +232,169 @@ def create_incident(self, create_incident_details, ocid, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_incident(self, incident_key, csi, ocid, **kwargs): + def get_csi_number(self, tenant_id, region, **kwargs): """ - Gets the details of the support ticket. + Fetches csi number of the user. - :param str incident_key: (required) - Unique identifier for the support ticket. + :param str tenant_id: (required) + Tenancy Ocid in oracle cloud Infrastructure + + :param str region: (required) + Home region of the customer which is part of oracle cloud infrastructure regions - :param str csi: (required) - The Customer Support Identifier associated with the support account. + :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 ocid: (required) + :param str ocid: (optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) + The region of the tenancy. + + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry 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 str + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use get_csi_number API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['tenantId', 'region'] + resource_path = "/v2/incidents/getCsiNumber" + method = "GET" + operation_name = "get_csi_number" + api_reference_link = "" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "ocid", + "homeregion", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "get_csi_number got unknown kwargs: {!r}".format(extra_kwargs)) + + query_params = { + "tenantId": tenant_id, + "region": region + } + 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), + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="str", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + query_params=query_params, + header_params=header_params, + response_type="str", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + + def get_incident(self, incident_key, **kwargs): + """ + Gets details about the specified support ticket. + + + :param str incident_key: (required) + Unique identifier for the support ticket. + :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 csi: (optional) + The Customer Support Identifier (CSI) associated with the support account. + + :param str ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. - :param str problem_type: (optional) + :param str compartment_id: (optional) + The OCID of the tenancy. + + :param str problemtype: (optional) The kind of support request. + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -259,8 +425,15 @@ def get_incident(self, incident_key, csi, ocid, **kwargs): "allow_control_chars", "retry_strategy", "opc_request_id", + "csi", + "ocid", "homeregion", - "problem_type" + "compartment_id", + "problemtype", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -277,14 +450,23 @@ def get_incident(self, incident_key, csi, ocid, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + query_params = { + "compartmentId": kwargs.get("compartment_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), - "csi": csi, - "ocid": ocid, + "csi": kwargs.get("csi", missing), + "ocid": kwargs.get("ocid", missing), "homeregion": kwargs.get("homeregion", missing), - "problem-type": kwargs.get("problem_type", missing) + "problemtype": kwargs.get("problemtype", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -302,6 +484,7 @@ def get_incident(self, incident_key, csi, ocid, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="Incident", allow_control_chars=kwargs.get('allow_control_chars'), @@ -313,6 +496,7 @@ def get_incident(self, incident_key, csi, ocid, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="Incident", allow_control_chars=kwargs.get('allow_control_chars'), @@ -320,20 +504,17 @@ def get_incident(self, incident_key, csi, ocid, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def get_status(self, source, ocid, **kwargs): + def get_status(self, **kwargs): """ Gets the status of the service. - :param str source: (required) - The system that generated the support ticket, such as My Oracle Support. - - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. - :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 ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. @@ -356,8 +537,8 @@ def get_status(self, source, ocid, **kwargs): Click `here `__ to see an example of how to use get_status API. """ # Required path and query arguments. These are in camelCase to replace values in service endpoints. - required_arguments = ['source'] - resource_path = "/v2/incidents/status/{source}" + required_arguments = [] + resource_path = "/v2/incidents/status" method = "GET" operation_name = "get_status" api_reference_link = "https://docs.oracle.com/iaas/api/#/en/incidentmanagement/20181231/Status/GetStatus" @@ -367,6 +548,7 @@ def get_status(self, source, ocid, **kwargs): "allow_control_chars", "retry_strategy", "opc_request_id", + "ocid", "homeregion" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] @@ -374,21 +556,11 @@ def get_status(self, source, ocid, **kwargs): raise ValueError( "get_status got unknown kwargs: {!r}".format(extra_kwargs)) - path_params = { - "source": source - } - - 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), - "ocid": ocid, + "ocid": kwargs.get("ocid", missing), "homeregion": kwargs.get("homeregion", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -406,7 +578,6 @@ def get_status(self, source, ocid, **kwargs): self.base_client.call_api, resource_path=resource_path, method=method, - path_params=path_params, header_params=header_params, response_type="Status", allow_control_chars=kwargs.get('allow_control_chars'), @@ -417,7 +588,6 @@ def get_status(self, source, ocid, **kwargs): return self.base_client.call_api( resource_path=resource_path, method=method, - path_params=path_params, header_params=header_params, response_type="Status", allow_control_chars=kwargs.get('allow_control_chars'), @@ -425,7 +595,7 @@ def get_status(self, source, ocid, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, **kwargs): + def list_incident_resource_types(self, problem_type, compartment_id, **kwargs): """ During support ticket creation, returns the list of all possible products that Oracle Cloud Infrastructure supports. @@ -436,12 +606,6 @@ def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, :param str compartment_id: (required) The OCID of the tenancy. - :param str csi: (required) - The Customer Support Identifier associated with the support account. - - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. - :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. @@ -466,11 +630,20 @@ def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, Allowed values are: "ASC", "DESC" :param str name: (optional) - The user-friendly name of the incident type. + The user-friendly name of the support ticket type. + + :param str csi: (optional) + The Customer Support Identifier (CSI) associated with the support account. + + :param str ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. :param str homeregion: (optional) The region of the tenancy. + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -506,7 +679,10 @@ def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, "sort_by", "sort_order", "name", - "homeregion" + "csi", + "ocid", + "homeregion", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -542,9 +718,10 @@ def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, "accept": "application/json", "content-type": "application/json", "opc-request-id": kwargs.get("opc_request_id", missing), - "csi": csi, - "ocid": ocid, - "homeregion": kwargs.get("homeregion", missing) + "csi": kwargs.get("csi", missing), + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -580,19 +757,16 @@ def list_incident_resource_types(self, problem_type, compartment_id, csi, ocid, api_reference_link=api_reference_link, required_arguments=required_arguments) - def list_incidents(self, csi, compartment_id, ocid, **kwargs): + def list_incidents(self, compartment_id, **kwargs): """ Returns the list of support tickets raised by the tenancy. - :param str csi: (required) - The Customer Support Identifier associated with the support account. - :param str compartment_id: (required) The OCID of the tenancy. - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str csi: (optional) + The Customer Support Identifier (CSI) associated with the support account. :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`__. @@ -622,12 +796,27 @@ def list_incidents(self, csi, compartment_id, ocid, **kwargs): :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 ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. :param str problem_type: (optional) The kind of support request. + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -657,14 +846,20 @@ def list_incidents(self, csi, compartment_id, ocid, **kwargs): expected_kwargs = [ "allow_control_chars", "retry_strategy", + "csi", "limit", "sort_by", "sort_order", "lifecycle_state", "page", "opc_request_id", + "ocid", "homeregion", - "problem_type" + "problem_type", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -706,10 +901,14 @@ def list_incidents(self, csi, compartment_id, ocid, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "csi": csi, + "csi": kwargs.get("csi", missing), "opc-request-id": kwargs.get("opc_request_id", missing), - "ocid": ocid, - "homeregion": kwargs.get("homeregion", missing) + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -745,7 +944,7 @@ def list_incidents(self, csi, compartment_id, ocid, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) - def update_incident(self, incident_key, csi, update_incident_details, ocid, **kwargs): + def update_incident(self, incident_key, update_incident_details, **kwargs): """ Updates the specified support ticket's information. @@ -753,24 +952,39 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **kw :param str incident_key: (required) Unique identifier for the support ticket. - :param str csi: (required) - The Customer Support Identifier associated with the support account. - :param oci.cims.models.UpdateIncident update_incident_details: (required) Details about the support ticket being updated. - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str csi: (optional) + The Customer Support Identifier (CSI) associated with the support account. :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 compartment_id: (optional) + The OCID of the tenancy. + :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. + :param str ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -800,9 +1014,16 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **kw expected_kwargs = [ "allow_control_chars", "retry_strategy", + "csi", "opc_request_id", + "compartment_id", "if_match", - "homeregion" + "ocid", + "homeregion", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -819,14 +1040,23 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **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 = { + "compartmentId": kwargs.get("compartment_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", - "csi": csi, + "csi": kwargs.get("csi", missing), "opc-request-id": kwargs.get("opc_request_id", missing), "if-match": kwargs.get("if_match", missing), - "ocid": ocid, - "homeregion": kwargs.get("homeregion", missing) + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} @@ -844,6 +1074,7 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **kw resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, body=update_incident_details, response_type="Incident", @@ -856,6 +1087,7 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **kw resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, body=update_incident_details, response_type="Incident", @@ -864,16 +1096,13 @@ def update_incident(self, incident_key, csi, update_incident_details, ocid, **kw api_reference_link=api_reference_link, required_arguments=required_arguments) - def validate_user(self, csi, ocid, **kwargs): + def validate_user(self, **kwargs): """ Checks whether the requested user is valid. - :param str csi: (required) - The Customer Support Identifier number for the support account. - - :param str ocid: (required) - User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str csi: (optional) + The Customer Support Identifier (CSI) associated with the support account. :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. @@ -881,9 +1110,26 @@ def validate_user(self, csi, ocid, **kwargs): :param str problem_type: (optional) The kind of support request. + Allowed values are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + + :param str ocid: (optional) + User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. + :param str homeregion: (optional) The region of the tenancy. + :param str bearertokentype: (optional) + Token type that determine which cloud provider the request come from. + + :param str bearertoken: (optional) + Token that provided by multi cloud provider, which help to validate the email. + + :param str idtoken: (optional) + IdToken that provided by multi cloud provider, which help to validate the email. + + :param str domainid: (optional) + The OCID of identity domain. + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -913,15 +1159,28 @@ def validate_user(self, csi, ocid, **kwargs): expected_kwargs = [ "allow_control_chars", "retry_strategy", + "csi", "opc_request_id", "problem_type", - "homeregion" + "ocid", + "homeregion", + "bearertokentype", + "bearertoken", + "idtoken", + "domainid" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( "validate_user got unknown kwargs: {!r}".format(extra_kwargs)) + if 'problem_type' in kwargs: + problem_type_allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] + if kwargs['problem_type'] not in problem_type_allowed_values: + raise ValueError( + "Invalid value for `problem_type`, must be one of {0}".format(problem_type_allowed_values) + ) + query_params = { "problemType": kwargs.get("problem_type", missing) } @@ -930,10 +1189,14 @@ def validate_user(self, csi, ocid, **kwargs): header_params = { "accept": "application/json", "content-type": "application/json", - "csi": csi, + "csi": kwargs.get("csi", missing), "opc-request-id": kwargs.get("opc_request_id", missing), - "ocid": ocid, - "homeregion": kwargs.get("homeregion", missing) + "ocid": kwargs.get("ocid", missing), + "homeregion": kwargs.get("homeregion", missing), + "bearertokentype": kwargs.get("bearertokentype", missing), + "bearertoken": kwargs.get("bearertoken", missing), + "idtoken": kwargs.get("idtoken", missing), + "domainid": kwargs.get("domainid", missing) } header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} diff --git a/src/oci/cims/models/__init__.py b/src/oci/cims/models/__init__.py index d18de2ccfc..7dd23ef8a0 100644 --- a/src/oci/cims/models/__init__.py +++ b/src/oci/cims/models/__init__.py @@ -6,12 +6,14 @@ from __future__ import absolute_import +from .account_item import AccountItem from .activity_item import ActivityItem from .category import Category from .classifier import Classifier from .contact import Contact from .contact_list import ContactList from .contextual_data import ContextualData +from .create_account_item_details import CreateAccountItemDetails from .create_category_details import CreateCategoryDetails from .create_incident import CreateIncident from .create_issue_type_details import CreateIssueTypeDetails @@ -30,6 +32,7 @@ from .item import Item from .limit_item import LimitItem from .resource import Resource +from .service_categories import ServiceCategories from .service_category import ServiceCategory from .status import Status from .sub_category import SubCategory @@ -46,12 +49,14 @@ # Maps type names to classes for cims services. cims_type_mapping = { + "AccountItem": AccountItem, "ActivityItem": ActivityItem, "Category": Category, "Classifier": Classifier, "Contact": Contact, "ContactList": ContactList, "ContextualData": ContextualData, + "CreateAccountItemDetails": CreateAccountItemDetails, "CreateCategoryDetails": CreateCategoryDetails, "CreateIncident": CreateIncident, "CreateIssueTypeDetails": CreateIssueTypeDetails, @@ -70,6 +75,7 @@ "Item": Item, "LimitItem": LimitItem, "Resource": Resource, + "ServiceCategories": ServiceCategories, "ServiceCategory": ServiceCategory, "Status": Status, "SubCategory": SubCategory, diff --git a/src/oci/cims/models/account_item.py b/src/oci/cims/models/account_item.py new file mode 100644 index 0000000000..e2f81eedb3 --- /dev/null +++ b/src/oci/cims/models/account_item.py @@ -0,0 +1,85 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20181231 + +from .item import Item +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AccountItem(Item): + """ + Details about the AccountItem object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AccountItem object with values from keyword arguments. The default value of the :py:attr:`~oci.cims.models.AccountItem.type` attribute + of this class is ``account`` and it should not be changed. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param item_key: + The value to assign to the item_key property of this AccountItem. + :type item_key: str + + :param name: + The value to assign to the name property of this AccountItem. + :type name: str + + :param type: + The value to assign to the type property of this AccountItem. + :type type: str + + :param category: + The value to assign to the category property of this AccountItem. + :type category: oci.cims.models.Category + + :param sub_category: + The value to assign to the sub_category property of this AccountItem. + :type sub_category: oci.cims.models.SubCategory + + :param issue_type: + The value to assign to the issue_type property of this AccountItem. + :type issue_type: oci.cims.models.IssueType + + """ + self.swagger_types = { + 'item_key': 'str', + 'name': 'str', + 'type': 'str', + 'category': 'Category', + 'sub_category': 'SubCategory', + 'issue_type': 'IssueType' + } + + self.attribute_map = { + 'item_key': 'itemKey', + 'name': 'name', + 'type': 'type', + 'category': 'category', + 'sub_category': 'subCategory', + 'issue_type': 'issueType' + } + + self._item_key = None + self._name = None + self._type = None + self._category = None + self._sub_category = None + self._issue_type = None + self._type = 'account' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/cims/models/activity_item.py b/src/oci/cims/models/activity_item.py index dfb43f8a7e..cb93c81e22 100644 --- a/src/oci/cims/models/activity_item.py +++ b/src/oci/cims/models/activity_item.py @@ -31,6 +31,10 @@ class ActivityItem(Item): #: This constant has a value of "CLOSE" ACTIVITY_TYPE_CLOSE = "CLOSE" + #: A constant which can be used with the activity_type property of a ActivityItem. + #: This constant has a value of "REOPEN" + ACTIVITY_TYPE_REOPEN = "REOPEN" + #: A constant which can be used with the activity_author property of a ActivityItem. #: This constant has a value of "CUSTOMER" ACTIVITY_AUTHOR_CUSTOMER = "CUSTOMER" @@ -39,6 +43,30 @@ class ActivityItem(Item): #: This constant has a value of "ORACLE" ACTIVITY_AUTHOR_ORACLE = "ORACLE" + #: A constant which can be used with the item_type property of a ActivityItem. + #: This constant has a value of "ATTACHMENTS" + ITEM_TYPE_ATTACHMENTS = "ATTACHMENTS" + + #: A constant which can be used with the item_type property of a ActivityItem. + #: This constant has a value of "COMMENTS" + ITEM_TYPE_COMMENTS = "COMMENTS" + + #: A constant which can be used with the item_status property of a ActivityItem. + #: This constant has a value of "PROCESSING" + ITEM_STATUS_PROCESSING = "PROCESSING" + + #: A constant which can be used with the item_status property of a ActivityItem. + #: This constant has a value of "ATTACHED" + ITEM_STATUS_ATTACHED = "ATTACHED" + + #: A constant which can be used with the item_status property of a ActivityItem. + #: This constant has a value of "REMOVED" + ITEM_STATUS_REMOVED = "REMOVED" + + #: A constant which can be used with the item_status property of a ActivityItem. + #: This constant has a value of "FAILED" + ITEM_STATUS_FAILED = "FAILED" + def __init__(self, **kwargs): """ Initializes a new ActivityItem object with values from keyword arguments. The default value of the :py:attr:`~oci.cims.models.ActivityItem.type` attribute @@ -83,7 +111,7 @@ def __init__(self, **kwargs): :param activity_type: The value to assign to the activity_type property of this ActivityItem. - Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type activity_type: str @@ -93,6 +121,18 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type activity_author: str + :param item_type: + The value to assign to the item_type property of this ActivityItem. + Allowed values for this property are: "ATTACHMENTS", "COMMENTS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type item_type: str + + :param item_status: + The value to assign to the item_status property of this ActivityItem. + Allowed values for this property are: "PROCESSING", "ATTACHED", "REMOVED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type item_status: str + """ self.swagger_types = { 'item_key': 'str', @@ -105,7 +145,9 @@ def __init__(self, **kwargs): 'time_created': 'int', 'time_updated': 'int', 'activity_type': 'str', - 'activity_author': 'str' + 'activity_author': 'str', + 'item_type': 'str', + 'item_status': 'str' } self.attribute_map = { @@ -119,7 +161,9 @@ def __init__(self, **kwargs): 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'activity_type': 'activityType', - 'activity_author': 'activityAuthor' + 'activity_author': 'activityAuthor', + 'item_type': 'itemType', + 'item_status': 'itemStatus' } self._item_key = None @@ -133,12 +177,14 @@ def __init__(self, **kwargs): self._time_updated = None self._activity_type = None self._activity_author = None + self._item_type = None + self._item_status = None self._type = 'activity' @property def comments(self): """ - Gets the comments of this ActivityItem. + **[Required]** Gets the comments of this ActivityItem. Comments added with the activity on the support ticket. @@ -162,7 +208,7 @@ def comments(self, comments): @property def time_created(self): """ - Gets the time_created of this ActivityItem. + **[Required]** Gets the time_created of this ActivityItem. The time when the activity was created, in milliseconds since epoch time. @@ -186,7 +232,7 @@ def time_created(self, time_created): @property def time_updated(self): """ - Gets the time_updated of this ActivityItem. + **[Required]** Gets the time_updated of this ActivityItem. The time when the activity was updated, in milliseconds since epoch time. @@ -210,10 +256,10 @@ def time_updated(self, time_updated): @property def activity_type(self): """ - Gets the activity_type of this ActivityItem. + **[Required]** Gets the activity_type of this ActivityItem. The type of activity occuring on the support ticket. - Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -232,7 +278,7 @@ def activity_type(self, activity_type): :param activity_type: The activity_type of this ActivityItem. :type: str """ - allowed_values = ["NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE"] + allowed_values = ["NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN"] if not value_allowed_none_or_none_sentinel(activity_type, allowed_values): activity_type = 'UNKNOWN_ENUM_VALUE' self._activity_type = activity_type @@ -240,9 +286,7 @@ def activity_type(self, activity_type): @property def activity_author(self): """ - Gets the activity_author of this ActivityItem. - The person who updates the activity on the support ticket. - + **[Required]** Gets the activity_author of this ActivityItem. Allowed values for this property are: "CUSTOMER", "ORACLE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -256,8 +300,6 @@ def activity_author(self): def activity_author(self, activity_author): """ Sets the activity_author of this ActivityItem. - The person who updates the activity on the support ticket. - :param activity_author: The activity_author of this ActivityItem. :type: str @@ -267,6 +309,62 @@ def activity_author(self, activity_author): activity_author = 'UNKNOWN_ENUM_VALUE' self._activity_author = activity_author + @property + def item_type(self): + """ + Gets the item_type of this ActivityItem. + Allowed values for this property are: "ATTACHMENTS", "COMMENTS", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The item_type of this ActivityItem. + :rtype: str + """ + return self._item_type + + @item_type.setter + def item_type(self, item_type): + """ + Sets the item_type of this ActivityItem. + + :param item_type: The item_type of this ActivityItem. + :type: str + """ + allowed_values = ["ATTACHMENTS", "COMMENTS"] + if not value_allowed_none_or_none_sentinel(item_type, allowed_values): + item_type = 'UNKNOWN_ENUM_VALUE' + self._item_type = item_type + + @property + def item_status(self): + """ + Gets the item_status of this ActivityItem. + Who updates the activity on the support ticket. + + Allowed values for this property are: "PROCESSING", "ATTACHED", "REMOVED", "FAILED", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The item_status of this ActivityItem. + :rtype: str + """ + return self._item_status + + @item_status.setter + def item_status(self, item_status): + """ + Sets the item_status of this ActivityItem. + Who updates the activity on the support ticket. + + + :param item_status: The item_status of this ActivityItem. + :type: str + """ + allowed_values = ["PROCESSING", "ATTACHED", "REMOVED", "FAILED"] + if not value_allowed_none_or_none_sentinel(item_status, allowed_values): + item_status = 'UNKNOWN_ENUM_VALUE' + self._item_status = item_status + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/category.py b/src/oci/cims/models/category.py index a8a5b3e309..c730e661b4 100644 --- a/src/oci/cims/models/category.py +++ b/src/oci/cims/models/category.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class Category(object): """ - Details about the category associated with the support ticket. + Details about the service category associated with the support ticket. """ def __init__(self, **kwargs): @@ -46,7 +46,7 @@ def __init__(self, **kwargs): def category_key(self): """ Gets the category_key of this Category. - Unique identifier for the category. + Unique identifier for the service category. :return: The category_key of this Category. @@ -58,7 +58,7 @@ def category_key(self): def category_key(self, category_key): """ Sets the category_key of this Category. - Unique identifier for the category. + Unique identifier for the service category. :param category_key: The category_key of this Category. @@ -70,7 +70,7 @@ def category_key(self, category_key): def name(self): """ Gets the name of this Category. - The name of the category. For example, `Compute` or `Identity`. + The name of the service category. For example, `Compute` or `Identity`. :return: The name of this Category. @@ -82,7 +82,7 @@ def name(self): def name(self, name): """ Sets the name of this Category. - The name of the category. For example, `Compute` or `Identity`. + The name of the service category. For example, `Compute` or `Identity`. :param name: The name of this Category. diff --git a/src/oci/cims/models/contact.py b/src/oci/cims/models/contact.py index 3ba2673eb9..f4f8be0e59 100644 --- a/src/oci/cims/models/contact.py +++ b/src/oci/cims/models/contact.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class Contact(object): """ - Contact details for the customer. + Contact details for the customer. Avoid entering confidential information. """ #: A constant which can be used with the contact_type property of a Contact. @@ -48,6 +48,10 @@ def __init__(self, **kwargs): The value to assign to the contact_email property of this Contact. :type contact_email: str + :param email: + The value to assign to the email property of this Contact. + :type email: str + :param contact_phone: The value to assign to the contact_phone property of this Contact. :type contact_phone: str @@ -62,6 +66,7 @@ def __init__(self, **kwargs): self.swagger_types = { 'contact_name': 'str', 'contact_email': 'str', + 'email': 'str', 'contact_phone': 'str', 'contact_type': 'str' } @@ -69,12 +74,14 @@ def __init__(self, **kwargs): self.attribute_map = { 'contact_name': 'contactName', 'contact_email': 'contactEmail', + 'email': 'email', 'contact_phone': 'contactPhone', 'contact_type': 'contactType' } self._contact_name = None self._contact_email = None + self._email = None self._contact_phone = None self._contact_type = None @@ -126,6 +133,30 @@ def contact_email(self, contact_email): """ self._contact_email = contact_email + @property + def email(self): + """ + Gets the email of this Contact. + The email of the contact person. + + + :return: The email of this Contact. + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """ + Sets the email of this Contact. + The email of the contact person. + + + :param email: The email of this Contact. + :type: str + """ + self._email = email + @property def contact_phone(self): """ diff --git a/src/oci/cims/models/contextual_data.py b/src/oci/cims/models/contextual_data.py index c75fa7fa86..82b88a132b 100644 --- a/src/oci/cims/models/contextual_data.py +++ b/src/oci/cims/models/contextual_data.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ContextualData(object): """ - ContextualData model. + Information collected from user context during ticket creation. """ def __init__(self, **kwargs): @@ -60,7 +60,7 @@ def __init__(self, **kwargs): def client_id(self): """ **[Required]** Gets the client_id of this ContextualData. - The unique client identifier + The unique identifier for the client. :return: The client_id of this ContextualData. @@ -72,7 +72,7 @@ def client_id(self): def client_id(self, client_id): """ Sets the client_id of this ContextualData. - The unique client identifier + The unique identifier for the client. :param client_id: The client_id of this ContextualData. @@ -84,7 +84,7 @@ def client_id(self, client_id): def schema_name(self): """ **[Required]** Gets the schema_name of this ContextualData. - The schema name + The name assigned to the schema. :return: The schema_name of this ContextualData. @@ -96,7 +96,7 @@ def schema_name(self): def schema_name(self, schema_name): """ Sets the schema_name of this ContextualData. - The schema name + The name assigned to the schema. :param schema_name: The schema_name of this ContextualData. @@ -108,7 +108,7 @@ def schema_name(self, schema_name): def schema_version(self): """ **[Required]** Gets the schema_version of this ContextualData. - The schema version + The version of the schema. :return: The schema_version of this ContextualData. @@ -120,7 +120,7 @@ def schema_version(self): def schema_version(self, schema_version): """ Sets the schema_version of this ContextualData. - The schema version + The version of the schema. :param schema_version: The schema_version of this ContextualData. @@ -132,7 +132,7 @@ def schema_version(self, schema_version): def payload(self): """ **[Required]** Gets the payload of this ContextualData. - The context data payload + The payload for the contextual data. :return: The payload of this ContextualData. @@ -144,7 +144,7 @@ def payload(self): def payload(self, payload): """ Sets the payload of this ContextualData. - The context data payload + The payload for the contextual data. :param payload: The payload of this ContextualData. diff --git a/src/oci/cims/models/create_account_item_details.py b/src/oci/cims/models/create_account_item_details.py new file mode 100644 index 0000000000..be8555df66 --- /dev/null +++ b/src/oci/cims/models/create_account_item_details.py @@ -0,0 +1,78 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20181231 + +from .create_item_details import CreateItemDetails +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class CreateAccountItemDetails(CreateItemDetails): + """ + Details about the issue that the account support ticket relates to. Avoid entering confidential information. + """ + + def __init__(self, **kwargs): + """ + Initializes a new CreateAccountItemDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.cims.models.CreateAccountItemDetails.type` attribute + of this class is ``account`` 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 CreateAccountItemDetails. + :type type: str + + :param category: + The value to assign to the category property of this CreateAccountItemDetails. + :type category: oci.cims.models.CreateCategoryDetails + + :param sub_category: + The value to assign to the sub_category property of this CreateAccountItemDetails. + :type sub_category: oci.cims.models.CreateSubCategoryDetails + + :param issue_type: + The value to assign to the issue_type property of this CreateAccountItemDetails. + :type issue_type: oci.cims.models.CreateIssueTypeDetails + + :param name: + The value to assign to the name property of this CreateAccountItemDetails. + :type name: str + + """ + self.swagger_types = { + 'type': 'str', + 'category': 'CreateCategoryDetails', + 'sub_category': 'CreateSubCategoryDetails', + 'issue_type': 'CreateIssueTypeDetails', + 'name': 'str' + } + + self.attribute_map = { + 'type': 'type', + 'category': 'category', + 'sub_category': 'subCategory', + 'issue_type': 'issueType', + 'name': 'name' + } + + self._type = None + self._category = None + self._sub_category = None + self._issue_type = None + self._name = None + self._type = 'account' + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/cims/models/create_category_details.py b/src/oci/cims/models/create_category_details.py index 6326919597..fa9dfd7fa1 100644 --- a/src/oci/cims/models/create_category_details.py +++ b/src/oci/cims/models/create_category_details.py @@ -13,8 +13,6 @@ class CreateCategoryDetails(object): """ Details for creating the category of the support ticket. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): @@ -41,7 +39,7 @@ def __init__(self, **kwargs): def category_key(self): """ Gets the category_key of this CreateCategoryDetails. - Unique identifier for the category. + Unique identifier for the service category. :return: The category_key of this CreateCategoryDetails. @@ -53,7 +51,7 @@ def category_key(self): def category_key(self, category_key): """ Sets the category_key of this CreateCategoryDetails. - Unique identifier for the category. + Unique identifier for the service category. :param category_key: The category_key of this CreateCategoryDetails. diff --git a/src/oci/cims/models/create_incident.py b/src/oci/cims/models/create_incident.py index 0e485d6a77..743d8737ba 100644 --- a/src/oci/cims/models/create_incident.py +++ b/src/oci/cims/models/create_incident.py @@ -13,8 +13,6 @@ class CreateIncident(object): """ Details gathered during the creation of the support ticket. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the problem_type property of a CreateIncident. @@ -33,6 +31,10 @@ class CreateIncident(object): #: This constant has a value of "ACCOUNT" PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + #: A constant which can be used with the problem_type property of a CreateIncident. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new CreateIncident object with values from keyword arguments. @@ -52,7 +54,7 @@ def __init__(self, **kwargs): :param problem_type: The value to assign to the problem_type property of this CreateIncident. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT" + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" :type problem_type: str :param contacts: @@ -137,7 +139,8 @@ def ticket(self, ticket): def csi(self): """ Gets the csi of this CreateIncident. - The Customer Support Identifier number for the support account. + The Customer Support Identifier (CSI) number associated with the support account. + The CSI is required for technical support tickets and optional for limits and billing tickets. :return: The csi of this CreateIncident. @@ -149,7 +152,8 @@ def csi(self): def csi(self, csi): """ Sets the csi of this CreateIncident. - The Customer Support Identifier number for the support account. + The Customer Support Identifier (CSI) number associated with the support account. + The CSI is required for technical support tickets and optional for limits and billing tickets. :param csi: The csi of this CreateIncident. @@ -161,9 +165,9 @@ def csi(self, csi): def problem_type(self): """ **[Required]** Gets the problem_type of this CreateIncident. - The kind of support ticket, such as a technical issue request. + The kind of support ticket, such as a technical support request or a limit increase request. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT" + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" :return: The problem_type of this CreateIncident. @@ -175,13 +179,13 @@ def problem_type(self): def problem_type(self, problem_type): """ Sets the problem_type of this CreateIncident. - The kind of support ticket, such as a technical issue request. + The kind of support ticket, such as a technical support request or a limit increase request. :param problem_type: The problem_type of this CreateIncident. :type: str """ - allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT"] + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): raise ValueError( "Invalid value for `problem_type`, must be None or one of {0}" diff --git a/src/oci/cims/models/create_issue_type_details.py b/src/oci/cims/models/create_issue_type_details.py index 09e12c97d0..a4e62080aa 100644 --- a/src/oci/cims/models/create_issue_type_details.py +++ b/src/oci/cims/models/create_issue_type_details.py @@ -13,8 +13,6 @@ class CreateIssueTypeDetails(object): """ Details for creating the issue type of the support ticket. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/cims/models/create_item_details.py b/src/oci/cims/models/create_item_details.py index d0d04e3eaf..092c1334a2 100644 --- a/src/oci/cims/models/create_item_details.py +++ b/src/oci/cims/models/create_item_details.py @@ -12,9 +12,7 @@ @init_model_state_from_kwargs class CreateItemDetails(object): """ - Details gathered during item creation. - - **Caution:** Avoid using any confidential information when you supply string values using the API. + Details gathered during ticket creation. """ def __init__(self, **kwargs): @@ -24,6 +22,7 @@ def __init__(self, **kwargs): * :class:`~oci.cims.models.CreateTechSupportItemDetails` * :class:`~oci.cims.models.CreateLimitItemDetails` + * :class:`~oci.cims.models.CreateAccountItemDetails` The following keyword arguments are supported (corresponding to the getters/setters of this class): @@ -83,6 +82,9 @@ def get_subtype(object_dictionary): if type == 'limit': return 'CreateLimitItemDetails' + + if type == 'account': + return 'CreateAccountItemDetails' else: return 'CreateItemDetails' @@ -90,7 +92,7 @@ def get_subtype(object_dictionary): def type(self): """ Gets the type of this CreateItemDetails. - The type of the item. + The type of the ticket. :return: The type of this CreateItemDetails. @@ -102,7 +104,7 @@ def type(self): def type(self, type): """ Sets the type of this CreateItemDetails. - The type of the item. + The type of the ticket. :param type: The type of this CreateItemDetails. @@ -174,7 +176,7 @@ def issue_type(self, issue_type): def name(self): """ Gets the name of this CreateItemDetails. - The display name of the item. + The display name of the ticket. Avoid entering confidential information. :return: The name of this CreateItemDetails. @@ -186,7 +188,7 @@ def name(self): def name(self, name): """ Sets the name of this CreateItemDetails. - The display name of the item. + The display name of the ticket. Avoid entering confidential information. :param name: The name of this CreateItemDetails. diff --git a/src/oci/cims/models/create_limit_item_details.py b/src/oci/cims/models/create_limit_item_details.py index cc47524e46..8d94e065cf 100644 --- a/src/oci/cims/models/create_limit_item_details.py +++ b/src/oci/cims/models/create_limit_item_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class CreateLimitItemDetails(CreateItemDetails): """ - Reserved for future use. + Details about the service limit increase request. Avoid entering confidential information. """ #: A constant which can be used with the limit_status property of a CreateLimitItemDetails. @@ -158,7 +158,7 @@ def current_usage(self, current_usage): def requested_limit(self): """ Gets the requested_limit of this CreateLimitItemDetails. - Reserved for future use. + The new service limit being requested. :return: The requested_limit of this CreateLimitItemDetails. @@ -170,7 +170,7 @@ def requested_limit(self): def requested_limit(self, requested_limit): """ Sets the requested_limit of this CreateLimitItemDetails. - Reserved for future use. + The new service limit being requested. :param requested_limit: The requested_limit of this CreateLimitItemDetails. diff --git a/src/oci/cims/models/create_resource_details.py b/src/oci/cims/models/create_resource_details.py index 07dcfa68be..f73c460e38 100644 --- a/src/oci/cims/models/create_resource_details.py +++ b/src/oci/cims/models/create_resource_details.py @@ -13,246 +13,8 @@ class CreateResourceDetails(object): """ Details about the resource that the support ticket relates to. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "DEV" - REGION_DEV = "DEV" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "SEA" - REGION_SEA = "SEA" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "INTEG_NEXT" - REGION_INTEG_NEXT = "INTEG_NEXT" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "INTEG_STABLE" - REGION_INTEG_STABLE = "INTEG_STABLE" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "PHX" - REGION_PHX = "PHX" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "IAD" - REGION_IAD = "IAD" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "FRA" - REGION_FRA = "FRA" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "EU_FRANKFURT_1" - REGION_EU_FRANKFURT_1 = "EU_FRANKFURT_1" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "LHR" - REGION_LHR = "LHR" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "YYZ" - REGION_YYZ = "YYZ" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "NRT" - REGION_NRT = "NRT" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "ICN" - REGION_ICN = "ICN" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "BOM" - REGION_BOM = "BOM" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "GRU" - REGION_GRU = "GRU" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "SYD" - REGION_SYD = "SYD" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "ZRH" - REGION_ZRH = "ZRH" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "JED" - REGION_JED = "JED" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "AMS" - REGION_AMS = "AMS" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "KIX" - REGION_KIX = "KIX" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "MEL" - REGION_MEL = "MEL" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "YUL" - REGION_YUL = "YUL" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "HYD" - REGION_HYD = "HYD" - - #: A constant which can be used with the region property of a CreateResourceDetails. - #: This constant has a value of "YNY" - REGION_YNY = "YNY" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "DEV_1" - AVAILABILITY_DOMAIN_DEV_1 = "DEV_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "DEV_2" - AVAILABILITY_DOMAIN_DEV_2 = "DEV_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "DEV_3" - AVAILABILITY_DOMAIN_DEV_3 = "DEV_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "INTEG_NEXT_1" - AVAILABILITY_DOMAIN_INTEG_NEXT_1 = "INTEG_NEXT_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "INTEG_STABLE_1" - AVAILABILITY_DOMAIN_INTEG_STABLE_1 = "INTEG_STABLE_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "SEA_AD_1" - AVAILABILITY_DOMAIN_SEA_AD_1 = "SEA_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "SEA_AD_2" - AVAILABILITY_DOMAIN_SEA_AD_2 = "SEA_AD_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "SEA_AD_3" - AVAILABILITY_DOMAIN_SEA_AD_3 = "SEA_AD_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "PHX_AD_1" - AVAILABILITY_DOMAIN_PHX_AD_1 = "PHX_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "PHX_AD_2" - AVAILABILITY_DOMAIN_PHX_AD_2 = "PHX_AD_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "PHX_AD_3" - AVAILABILITY_DOMAIN_PHX_AD_3 = "PHX_AD_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "US_ASHBURN_AD_1" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_1 = "US_ASHBURN_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "US_ASHBURN_AD_2" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_2 = "US_ASHBURN_AD_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "US_ASHBURN_AD_3" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_3 = "US_ASHBURN_AD_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "US_ASHBURN_AD_4" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_4 = "US_ASHBURN_AD_4" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "EU_FRANKFURT_1_AD_1" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_1 = "EU_FRANKFURT_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "EU_FRANKFURT_1_AD_2" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_2 = "EU_FRANKFURT_1_AD_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "EU_FRANKFURT_1_AD_3" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_3 = "EU_FRANKFURT_1_AD_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "UK_LONDON_1_AD_1" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_1 = "UK_LONDON_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "UK_LONDON_1_AD_2" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_2 = "UK_LONDON_1_AD_2" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "UK_LONDON_1_AD_3" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_3 = "UK_LONDON_1_AD_3" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "CA_TORONTO_1_AD_1" - AVAILABILITY_DOMAIN_CA_TORONTO_1_AD_1 = "CA_TORONTO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_TOKYO_1_AD_1" - AVAILABILITY_DOMAIN_AP_TOKYO_1_AD_1 = "AP_TOKYO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_SEOUL_1_AD_1" - AVAILABILITY_DOMAIN_AP_SEOUL_1_AD_1 = "AP_SEOUL_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_MUMBAI_1_AD_1" - AVAILABILITY_DOMAIN_AP_MUMBAI_1_AD_1 = "AP_MUMBAI_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "SA_SAOPAULO_1_AD_1" - AVAILABILITY_DOMAIN_SA_SAOPAULO_1_AD_1 = "SA_SAOPAULO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "ME_JEDDAH_1_AD_1" - AVAILABILITY_DOMAIN_ME_JEDDAH_1_AD_1 = "ME_JEDDAH_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_OSAKA_1_AD_1" - AVAILABILITY_DOMAIN_AP_OSAKA_1_AD_1 = "AP_OSAKA_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_SYDNEY_1_AD_1" - AVAILABILITY_DOMAIN_AP_SYDNEY_1_AD_1 = "AP_SYDNEY_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "EU_ZURICH_1_AD_1" - AVAILABILITY_DOMAIN_EU_ZURICH_1_AD_1 = "EU_ZURICH_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "EU_AMSTERDAM_1_AD_1" - AVAILABILITY_DOMAIN_EU_AMSTERDAM_1_AD_1 = "EU_AMSTERDAM_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_MELBOURNE_1_AD_1" - AVAILABILITY_DOMAIN_AP_MELBOURNE_1_AD_1 = "AP_MELBOURNE_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "CA_MONTREAL_1_AD_1" - AVAILABILITY_DOMAIN_CA_MONTREAL_1_AD_1 = "CA_MONTREAL_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_HYDERABAD_1_AD_1" - AVAILABILITY_DOMAIN_AP_HYDERABAD_1_AD_1 = "AP_HYDERABAD_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "AP_CHUNCHEON_1_AD_1" - AVAILABILITY_DOMAIN_AP_CHUNCHEON_1_AD_1 = "AP_CHUNCHEON_1_AD_1" - - #: A constant which can be used with the availability_domain property of a CreateResourceDetails. - #: This constant has a value of "NO_AD" - AVAILABILITY_DOMAIN_NO_AD = "NO_AD" - def __init__(self, **kwargs): """ Initializes a new CreateResourceDetails object with values from keyword arguments. @@ -264,30 +26,21 @@ def __init__(self, **kwargs): :param region: The value to assign to the region property of this CreateResourceDetails. - Allowed values for this property are: "DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY" :type region: str - :param availability_domain: - The value to assign to the availability_domain property of this CreateResourceDetails. - Allowed values for this property are: "DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD" - :type availability_domain: str - """ self.swagger_types = { 'item': 'CreateItemDetails', - 'region': 'str', - 'availability_domain': 'str' + 'region': 'str' } self.attribute_map = { 'item': 'item', - 'region': 'region', - 'availability_domain': 'availabilityDomain' + 'region': 'region' } self._item = None self._region = None - self._availability_domain = None @property def item(self): @@ -315,8 +68,6 @@ def region(self): Gets the region of this CreateResourceDetails. The list of available Oracle Cloud Infrastructure regions. - Allowed values for this property are: "DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY" - :return: The region of this CreateResourceDetails. :rtype: str @@ -333,46 +84,8 @@ def region(self, region): :param region: The region of this CreateResourceDetails. :type: str """ - allowed_values = ["DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY"] - if not value_allowed_none_or_none_sentinel(region, allowed_values): - raise ValueError( - "Invalid value for `region`, must be None or one of {0}" - .format(allowed_values) - ) self._region = region - @property - def availability_domain(self): - """ - Gets the availability_domain of this CreateResourceDetails. - The list of available Oracle Cloud Infrastructure availability domains. - - Allowed values for this property are: "DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD" - - - :return: The availability_domain of this CreateResourceDetails. - :rtype: str - """ - return self._availability_domain - - @availability_domain.setter - def availability_domain(self, availability_domain): - """ - Sets the availability_domain of this CreateResourceDetails. - The list of available Oracle Cloud Infrastructure availability domains. - - - :param availability_domain: The availability_domain of this CreateResourceDetails. - :type: str - """ - allowed_values = ["DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD"] - if not value_allowed_none_or_none_sentinel(availability_domain, allowed_values): - raise ValueError( - "Invalid value for `availability_domain`, must be None or one of {0}" - .format(allowed_values) - ) - self._availability_domain = availability_domain - def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/create_sub_category_details.py b/src/oci/cims/models/create_sub_category_details.py index 6dce6636f2..e1d8b0a610 100644 --- a/src/oci/cims/models/create_sub_category_details.py +++ b/src/oci/cims/models/create_sub_category_details.py @@ -12,9 +12,7 @@ @init_model_state_from_kwargs class CreateSubCategoryDetails(object): """ - Details for creating the subcategory of the support ticket. - - **Caution:** Avoid using any confidential information when you supply string values using the API. + Details for creating the service subcategory of the support ticket. """ def __init__(self, **kwargs): @@ -41,7 +39,7 @@ def __init__(self, **kwargs): def sub_category_key(self): """ Gets the sub_category_key of this CreateSubCategoryDetails. - Unique identifier for the subcategory. + Unique identifier for the service subcategory. :return: The sub_category_key of this CreateSubCategoryDetails. @@ -53,7 +51,7 @@ def sub_category_key(self): def sub_category_key(self, sub_category_key): """ Sets the sub_category_key of this CreateSubCategoryDetails. - Unique identifier for the subcategory. + Unique identifier for the service subcategory. :param sub_category_key: The sub_category_key of this CreateSubCategoryDetails. diff --git a/src/oci/cims/models/create_tech_support_item_details.py b/src/oci/cims/models/create_tech_support_item_details.py index 3dd9468640..d566afae26 100644 --- a/src/oci/cims/models/create_tech_support_item_details.py +++ b/src/oci/cims/models/create_tech_support_item_details.py @@ -12,9 +12,7 @@ @init_model_state_from_kwargs class CreateTechSupportItemDetails(CreateItemDetails): """ - Details about the issue that the technical support request relates to. - - **Caution:** Avoid using any confidential information when you supply string values using the API. + Details about the issue that the technical support ticket relates to. Avoid entering confidential information. """ def __init__(self, **kwargs): diff --git a/src/oci/cims/models/create_ticket_details.py b/src/oci/cims/models/create_ticket_details.py index 227d646a7c..6dbf4f25e5 100644 --- a/src/oci/cims/models/create_ticket_details.py +++ b/src/oci/cims/models/create_ticket_details.py @@ -13,8 +13,6 @@ class CreateTicketDetails(object): """ Details relevant to the support ticket. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ #: A constant which can be used with the severity property of a CreateTicketDetails. @@ -29,6 +27,10 @@ class CreateTicketDetails(object): #: This constant has a value of "MEDIUM" SEVERITY_MEDIUM = "MEDIUM" + #: A constant which can be used with the severity property of a CreateTicketDetails. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + def __init__(self, **kwargs): """ Initializes a new CreateTicketDetails object with values from keyword arguments. @@ -36,7 +38,7 @@ def __init__(self, **kwargs): :param severity: The value to assign to the severity property of this CreateTicketDetails. - Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM" + Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", "LOW" :type severity: str :param resource_list: @@ -84,7 +86,7 @@ def severity(self): **[Required]** Gets the severity of this CreateTicketDetails. The severity of the support ticket. - Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM" + Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", "LOW" :return: The severity of this CreateTicketDetails. @@ -102,7 +104,7 @@ def severity(self, severity): :param severity: The severity of this CreateTicketDetails. :type: str """ - allowed_values = ["HIGHEST", "HIGH", "MEDIUM"] + allowed_values = ["HIGHEST", "HIGH", "MEDIUM", "LOW"] if not value_allowed_none_or_none_sentinel(severity, allowed_values): raise ValueError( "Invalid value for `severity`, must be None or one of {0}" @@ -138,7 +140,7 @@ def resource_list(self, resource_list): def title(self): """ **[Required]** Gets the title of this CreateTicketDetails. - The title of the support ticket. + The title of the support ticket. Avoid entering confidential information. :return: The title of this CreateTicketDetails. @@ -150,7 +152,7 @@ def title(self): def title(self, title): """ Sets the title of this CreateTicketDetails. - The title of the support ticket. + The title of the support ticket. Avoid entering confidential information. :param title: The title of this CreateTicketDetails. @@ -162,7 +164,7 @@ def title(self, title): def description(self): """ **[Required]** Gets the description of this CreateTicketDetails. - The description of the support ticket. + The description of the support ticket. Avoid entering confidential information. :return: The description of this CreateTicketDetails. @@ -174,7 +176,7 @@ def description(self): def description(self, description): """ Sets the description of this CreateTicketDetails. - The description of the support ticket. + The description of the support ticket. Avoid entering confidential information. :param description: The description of this CreateTicketDetails. @@ -186,8 +188,6 @@ def description(self, description): def contextual_data(self): """ Gets the contextual_data of this CreateTicketDetails. - The context from where the ticket is getting created. - :return: The contextual_data of this CreateTicketDetails. :rtype: oci.cims.models.ContextualData @@ -198,8 +198,6 @@ def contextual_data(self): def contextual_data(self, contextual_data): """ Sets the contextual_data of this CreateTicketDetails. - The context from where the ticket is getting created. - :param contextual_data: The contextual_data of this CreateTicketDetails. :type: oci.cims.models.ContextualData diff --git a/src/oci/cims/models/create_user_details.py b/src/oci/cims/models/create_user_details.py index 6169c47ee9..0409aa59af 100644 --- a/src/oci/cims/models/create_user_details.py +++ b/src/oci/cims/models/create_user_details.py @@ -12,9 +12,29 @@ @init_model_state_from_kwargs class CreateUserDetails(object): """ - Details about creation of user. + Details for creating a new user. """ + #: A constant which can be used with the problem_type property of a CreateUserDetails. + #: This constant has a value of "LIMIT" + PROBLEM_TYPE_LIMIT = "LIMIT" + + #: A constant which can be used with the problem_type property of a CreateUserDetails. + #: This constant has a value of "LEGACY_LIMIT" + PROBLEM_TYPE_LEGACY_LIMIT = "LEGACY_LIMIT" + + #: A constant which can be used with the problem_type property of a CreateUserDetails. + #: This constant has a value of "TECH" + PROBLEM_TYPE_TECH = "TECH" + + #: A constant which can be used with the problem_type property of a CreateUserDetails. + #: This constant has a value of "ACCOUNT" + PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + + #: A constant which can be used with the problem_type property of a CreateUserDetails. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new CreateUserDetails object with values from keyword arguments. @@ -32,10 +52,6 @@ def __init__(self, **kwargs): The value to assign to the last_name property of this CreateUserDetails. :type last_name: str - :param country: - The value to assign to the country property of this CreateUserDetails. - :type country: str - :param csi: The value to assign to the csi property of this CreateUserDetails. :type csi: str @@ -52,37 +68,42 @@ def __init__(self, **kwargs): The value to assign to the organization_name property of this CreateUserDetails. :type organization_name: str + :param problem_type: + The value to assign to the problem_type property of this CreateUserDetails. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + :type problem_type: str + """ self.swagger_types = { 'compartment_id': 'str', 'first_name': 'str', 'last_name': 'str', - 'country': 'str', 'csi': 'str', 'phone': 'str', 'timezone': 'str', - 'organization_name': 'str' + 'organization_name': 'str', + 'problem_type': 'str' } self.attribute_map = { 'compartment_id': 'compartmentId', 'first_name': 'firstName', 'last_name': 'lastName', - 'country': 'country', 'csi': 'csi', 'phone': 'phone', 'timezone': 'timezone', - 'organization_name': 'organizationName' + 'organization_name': 'organizationName', + 'problem_type': 'problemType' } self._compartment_id = None self._first_name = None self._last_name = None - self._country = None self._csi = None self._phone = None self._timezone = None self._organization_name = None + self._problem_type = None @property def compartment_id(self): @@ -156,35 +177,11 @@ def last_name(self, last_name): """ self._last_name = last_name - @property - def country(self): - """ - **[Required]** Gets the country of this CreateUserDetails. - Country of the user. - - - :return: The country of this CreateUserDetails. - :rtype: str - """ - return self._country - - @country.setter - def country(self, country): - """ - Sets the country of this CreateUserDetails. - Country of the user. - - - :param country: The country of this CreateUserDetails. - :type: str - """ - self._country = country - @property def csi(self): """ **[Required]** Gets the csi of this CreateUserDetails. - CSI to be associated to the user. + CSI associated with the user. :return: The csi of this CreateUserDetails. @@ -196,7 +193,7 @@ def csi(self): def csi(self, csi): """ Sets the csi of this CreateUserDetails. - CSI to be associated to the user. + CSI associated with the user. :param csi: The csi of this CreateUserDetails. @@ -276,6 +273,38 @@ def organization_name(self, organization_name): """ self._organization_name = organization_name + @property + def problem_type(self): + """ + **[Required]** Gets the problem_type of this CreateUserDetails. + The kind of support ticket, such as a technical support request or a limit increase request. + + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + + + :return: The problem_type of this CreateUserDetails. + :rtype: str + """ + return self._problem_type + + @problem_type.setter + def problem_type(self, problem_type): + """ + Sets the problem_type of this CreateUserDetails. + The kind of support ticket, such as a technical support request or a limit increase request. + + + :param problem_type: The problem_type of this CreateUserDetails. + :type: str + """ + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] + if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): + raise ValueError( + "Invalid value for `problem_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._problem_type = problem_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/incident.py b/src/oci/cims/models/incident.py index 26c4586718..68302328ea 100644 --- a/src/oci/cims/models/incident.py +++ b/src/oci/cims/models/incident.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class Incident(object): """ - Details of about the incident object. + Details about the support ticket. """ #: A constant which can be used with the problem_type property of a Incident. @@ -31,6 +31,10 @@ class Incident(object): #: This constant has a value of "ACCOUNT" PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + #: A constant which can be used with the problem_type property of a Incident. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new Incident object with values from keyword arguments. @@ -62,7 +66,7 @@ def __init__(self, **kwargs): :param problem_type: The value to assign to the problem_type property of this Incident. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type problem_type: str @@ -234,9 +238,9 @@ def incident_type(self, incident_type): def problem_type(self): """ Gets the problem_type of this Incident. - The kind of support ticket, such as a technical support request. + The kind of support ticket, such as a technical support request or a limit increase request. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -249,13 +253,13 @@ def problem_type(self): def problem_type(self, problem_type): """ Sets the problem_type of this Incident. - The kind of support ticket, such as a technical support request. + The kind of support ticket, such as a technical support request or a limit increase request. :param problem_type: The problem_type of this Incident. :type: str """ - allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT"] + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): problem_type = 'UNKNOWN_ENUM_VALUE' self._problem_type = problem_type diff --git a/src/oci/cims/models/incident_resource_type.py b/src/oci/cims/models/incident_resource_type.py index f2b6412ca5..1358105265 100644 --- a/src/oci/cims/models/incident_resource_type.py +++ b/src/oci/cims/models/incident_resource_type.py @@ -40,13 +40,23 @@ def __init__(self, **kwargs): The value to assign to the service_category_list property of this IncidentResourceType. :type service_category_list: list[oci.cims.models.ServiceCategory] + :param service: + The value to assign to the service property of this IncidentResourceType. + :type service: dict(str, str) + + :param service_categories: + The value to assign to the service_categories property of this IncidentResourceType. + :type service_categories: list[oci.cims.models.ServiceCategories] + """ self.swagger_types = { 'resource_type_key': 'str', 'name': 'str', 'label': 'str', 'description': 'str', - 'service_category_list': 'list[ServiceCategory]' + 'service_category_list': 'list[ServiceCategory]', + 'service': 'dict(str, str)', + 'service_categories': 'list[ServiceCategories]' } self.attribute_map = { @@ -54,7 +64,9 @@ def __init__(self, **kwargs): 'name': 'name', 'label': 'label', 'description': 'description', - 'service_category_list': 'serviceCategoryList' + 'service_category_list': 'serviceCategoryList', + 'service': 'service', + 'service_categories': 'serviceCategories' } self._resource_type_key = None @@ -62,12 +74,14 @@ def __init__(self, **kwargs): self._label = None self._description = None self._service_category_list = None + self._service = None + self._service_categories = None @property def resource_type_key(self): """ Gets the resource_type_key of this IncidentResourceType. - Unique identifier of the resource. + A unique identifier for the resource. :return: The resource_type_key of this IncidentResourceType. @@ -79,7 +93,7 @@ def resource_type_key(self): def resource_type_key(self, resource_type_key): """ Sets the resource_type_key of this IncidentResourceType. - Unique identifier of the resource. + A unique identifier for the resource. :param resource_type_key: The resource_type_key of this IncidentResourceType. @@ -183,6 +197,54 @@ def service_category_list(self, service_category_list): """ self._service_category_list = service_category_list + @property + def service(self): + """ + Gets the service of this IncidentResourceType. + The map of services for MOS Taxonomy. + + + :return: The service of this IncidentResourceType. + :rtype: dict(str, str) + """ + return self._service + + @service.setter + def service(self, service): + """ + Sets the service of this IncidentResourceType. + The map of services for MOS Taxonomy. + + + :param service: The service of this IncidentResourceType. + :type: dict(str, str) + """ + self._service = service + + @property + def service_categories(self): + """ + Gets the service_categories of this IncidentResourceType. + The service categories list for MOS Taxonomy. + + + :return: The service_categories of this IncidentResourceType. + :rtype: list[oci.cims.models.ServiceCategories] + """ + return self._service_categories + + @service_categories.setter + def service_categories(self, service_categories): + """ + Sets the service_categories of this IncidentResourceType. + The service categories list for MOS Taxonomy. + + + :param service_categories: The service_categories of this IncidentResourceType. + :type: list[oci.cims.models.ServiceCategories] + """ + self._service_categories = service_categories + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/incident_summary.py b/src/oci/cims/models/incident_summary.py index 5bd6deeb9f..ccf69bf93d 100644 --- a/src/oci/cims/models/incident_summary.py +++ b/src/oci/cims/models/incident_summary.py @@ -31,6 +31,10 @@ class IncidentSummary(object): #: This constant has a value of "ACCOUNT" PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + #: A constant which can be used with the problem_type property of a IncidentSummary. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new IncidentSummary object with values from keyword arguments. @@ -62,7 +66,7 @@ def __init__(self, **kwargs): :param problem_type: The value to assign to the problem_type property of this IncidentSummary. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type problem_type: str @@ -227,9 +231,9 @@ def incident_type(self, incident_type): def problem_type(self): """ **[Required]** Gets the problem_type of this IncidentSummary. - The kind of support ticket, such as a technical support request. + The kind of support ticket, such as a technical support request or a limit increase request. - Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -242,13 +246,13 @@ def problem_type(self): def problem_type(self, problem_type): """ Sets the problem_type of this IncidentSummary. - The kind of support ticket, such as a technical support request. + The kind of support ticket, such as a technical support request or a limit increase request. :param problem_type: The problem_type of this IncidentSummary. :type: str """ - allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT"] + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): problem_type = 'UNKNOWN_ENUM_VALUE' self._problem_type = problem_type diff --git a/src/oci/cims/models/incident_type.py b/src/oci/cims/models/incident_type.py index cff2ce8631..9c29d3b501 100644 --- a/src/oci/cims/models/incident_type.py +++ b/src/oci/cims/models/incident_type.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class IncidentType(object): """ - Details about the incident type object. + Details about the incident type associated with the support ticket. """ def __init__(self, **kwargs): diff --git a/src/oci/cims/models/issue_type.py b/src/oci/cims/models/issue_type.py index 6dee12f33a..4ad82ceff8 100644 --- a/src/oci/cims/models/issue_type.py +++ b/src/oci/cims/models/issue_type.py @@ -28,19 +28,26 @@ def __init__(self, **kwargs): The value to assign to the label property of this IssueType. :type label: str + :param name: + The value to assign to the name property of this IssueType. + :type name: str + """ self.swagger_types = { 'issue_type_key': 'str', - 'label': 'str' + 'label': 'str', + 'name': 'str' } self.attribute_map = { 'issue_type_key': 'issueTypeKey', - 'label': 'label' + 'label': 'label', + 'name': 'name' } self._issue_type_key = None self._label = None + self._name = None @property def issue_type_key(self): @@ -90,6 +97,30 @@ def label(self, label): """ self._label = label + @property + def name(self): + """ + Gets the name of this IssueType. + The URL for the contextual documentation. + + + :return: The name of this IssueType. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this IssueType. + The URL for the contextual documentation. + + + :param name: The name of this IssueType. + :type: str + """ + self._name = name + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/item.py b/src/oci/cims/models/item.py index 89831fb4e7..8368753e05 100644 --- a/src/oci/cims/models/item.py +++ b/src/oci/cims/models/item.py @@ -20,6 +20,7 @@ def __init__(self, **kwargs): Initializes a new Item 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.cims.models.AccountItem` * :class:`~oci.cims.models.LimitItem` * :class:`~oci.cims.models.TechSupportItem` * :class:`~oci.cims.models.ActivityItem` @@ -84,6 +85,9 @@ def get_subtype(object_dictionary): """ type = object_dictionary['type'] + if type == 'account': + return 'AccountItem' + if type == 'limit': return 'LimitItem' @@ -123,7 +127,7 @@ def item_key(self, item_key): def name(self): """ Gets the name of this Item. - The display name of the item. + The display name of the item. Avoid entering confidential information. :return: The name of this Item. @@ -135,7 +139,7 @@ def name(self): def name(self, name): """ Sets the name of this Item. - The display name of the item. + The display name of the item. Avoid entering confidential information. :param name: The name of this Item. @@ -147,7 +151,7 @@ def name(self, name): def type(self): """ Gets the type of this Item. - The type of the support request. + The type of the item. :return: The type of this Item. @@ -159,7 +163,7 @@ def type(self): def type(self, type): """ Sets the type of this Item. - The type of the support request. + The type of the item. :param type: The type of this Item. diff --git a/src/oci/cims/models/limit_item.py b/src/oci/cims/models/limit_item.py index 55037a9869..a3935458c1 100644 --- a/src/oci/cims/models/limit_item.py +++ b/src/oci/cims/models/limit_item.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class LimitItem(Item): """ - Reserved for future use. + Details about the LimitItem object. """ #: A constant which can be used with the limit_status property of a LimitItem. @@ -118,7 +118,7 @@ def __init__(self, **kwargs): def current_limit(self): """ Gets the current_limit of this LimitItem. - The currently available limit of the resource. + The current service limit for the resource. :return: The current_limit of this LimitItem. @@ -130,7 +130,7 @@ def current_limit(self): def current_limit(self, current_limit): """ Sets the current_limit of this LimitItem. - The currently available limit of the resource. + The current service limit for the resource. :param current_limit: The current_limit of this LimitItem. @@ -142,7 +142,7 @@ def current_limit(self, current_limit): def current_usage(self): """ Gets the current_usage of this LimitItem. - The current usage of the resource. + The current resource usage. :return: The current_usage of this LimitItem. @@ -154,7 +154,7 @@ def current_usage(self): def current_usage(self, current_usage): """ Sets the current_usage of this LimitItem. - The current usage of the resource. + The current resource usage. :param current_usage: The current_usage of this LimitItem. @@ -166,7 +166,7 @@ def current_usage(self, current_usage): def requested_limit(self): """ Gets the requested_limit of this LimitItem. - The requested limit for the resource. + The new service limit being requested for the resource. :return: The requested_limit of this LimitItem. @@ -178,7 +178,7 @@ def requested_limit(self): def requested_limit(self, requested_limit): """ Sets the requested_limit of this LimitItem. - The requested limit for the resource. + The new service limit being requested for the resource. :param requested_limit: The requested_limit of this LimitItem. diff --git a/src/oci/cims/models/resource.py b/src/oci/cims/models/resource.py index 0ed2ed4a1a..357217d875 100644 --- a/src/oci/cims/models/resource.py +++ b/src/oci/cims/models/resource.py @@ -15,242 +15,6 @@ class Resource(object): Details about the ticket item object. """ - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "DEV" - REGION_DEV = "DEV" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "SEA" - REGION_SEA = "SEA" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "INTEG_NEXT" - REGION_INTEG_NEXT = "INTEG_NEXT" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "INTEG_STABLE" - REGION_INTEG_STABLE = "INTEG_STABLE" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "PHX" - REGION_PHX = "PHX" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "IAD" - REGION_IAD = "IAD" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "FRA" - REGION_FRA = "FRA" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "EU_FRANKFURT_1" - REGION_EU_FRANKFURT_1 = "EU_FRANKFURT_1" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "LHR" - REGION_LHR = "LHR" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "YYZ" - REGION_YYZ = "YYZ" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "NRT" - REGION_NRT = "NRT" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "ICN" - REGION_ICN = "ICN" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "BOM" - REGION_BOM = "BOM" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "GRU" - REGION_GRU = "GRU" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "SYD" - REGION_SYD = "SYD" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "ZRH" - REGION_ZRH = "ZRH" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "JED" - REGION_JED = "JED" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "AMS" - REGION_AMS = "AMS" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "KIX" - REGION_KIX = "KIX" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "MEL" - REGION_MEL = "MEL" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "YUL" - REGION_YUL = "YUL" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "HYD" - REGION_HYD = "HYD" - - #: A constant which can be used with the region property of a Resource. - #: This constant has a value of "YNY" - REGION_YNY = "YNY" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "DEV_1" - AVAILABILITY_DOMAIN_DEV_1 = "DEV_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "DEV_2" - AVAILABILITY_DOMAIN_DEV_2 = "DEV_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "DEV_3" - AVAILABILITY_DOMAIN_DEV_3 = "DEV_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "INTEG_NEXT_1" - AVAILABILITY_DOMAIN_INTEG_NEXT_1 = "INTEG_NEXT_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "INTEG_STABLE_1" - AVAILABILITY_DOMAIN_INTEG_STABLE_1 = "INTEG_STABLE_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "SEA_AD_1" - AVAILABILITY_DOMAIN_SEA_AD_1 = "SEA_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "SEA_AD_2" - AVAILABILITY_DOMAIN_SEA_AD_2 = "SEA_AD_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "SEA_AD_3" - AVAILABILITY_DOMAIN_SEA_AD_3 = "SEA_AD_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "PHX_AD_1" - AVAILABILITY_DOMAIN_PHX_AD_1 = "PHX_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "PHX_AD_2" - AVAILABILITY_DOMAIN_PHX_AD_2 = "PHX_AD_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "PHX_AD_3" - AVAILABILITY_DOMAIN_PHX_AD_3 = "PHX_AD_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "US_ASHBURN_AD_1" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_1 = "US_ASHBURN_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "US_ASHBURN_AD_2" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_2 = "US_ASHBURN_AD_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "US_ASHBURN_AD_3" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_3 = "US_ASHBURN_AD_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "US_ASHBURN_AD_4" - AVAILABILITY_DOMAIN_US_ASHBURN_AD_4 = "US_ASHBURN_AD_4" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "EU_FRANKFURT_1_AD_1" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_1 = "EU_FRANKFURT_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "EU_FRANKFURT_1_AD_2" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_2 = "EU_FRANKFURT_1_AD_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "EU_FRANKFURT_1_AD_3" - AVAILABILITY_DOMAIN_EU_FRANKFURT_1_AD_3 = "EU_FRANKFURT_1_AD_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "UK_LONDON_1_AD_1" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_1 = "UK_LONDON_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "UK_LONDON_1_AD_2" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_2 = "UK_LONDON_1_AD_2" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "UK_LONDON_1_AD_3" - AVAILABILITY_DOMAIN_UK_LONDON_1_AD_3 = "UK_LONDON_1_AD_3" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "CA_TORONTO_1_AD_1" - AVAILABILITY_DOMAIN_CA_TORONTO_1_AD_1 = "CA_TORONTO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_TOKYO_1_AD_1" - AVAILABILITY_DOMAIN_AP_TOKYO_1_AD_1 = "AP_TOKYO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_SEOUL_1_AD_1" - AVAILABILITY_DOMAIN_AP_SEOUL_1_AD_1 = "AP_SEOUL_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_MUMBAI_1_AD_1" - AVAILABILITY_DOMAIN_AP_MUMBAI_1_AD_1 = "AP_MUMBAI_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "SA_SAOPAULO_1_AD_1" - AVAILABILITY_DOMAIN_SA_SAOPAULO_1_AD_1 = "SA_SAOPAULO_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "ME_JEDDAH_1_AD_1" - AVAILABILITY_DOMAIN_ME_JEDDAH_1_AD_1 = "ME_JEDDAH_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_OSAKA_1_AD_1" - AVAILABILITY_DOMAIN_AP_OSAKA_1_AD_1 = "AP_OSAKA_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_SYDNEY_1_AD_1" - AVAILABILITY_DOMAIN_AP_SYDNEY_1_AD_1 = "AP_SYDNEY_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "EU_ZURICH_1_AD_1" - AVAILABILITY_DOMAIN_EU_ZURICH_1_AD_1 = "EU_ZURICH_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "EU_AMSTERDAM_1_AD_1" - AVAILABILITY_DOMAIN_EU_AMSTERDAM_1_AD_1 = "EU_AMSTERDAM_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_MELBOURNE_1_AD_1" - AVAILABILITY_DOMAIN_AP_MELBOURNE_1_AD_1 = "AP_MELBOURNE_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "CA_MONTREAL_1_AD_1" - AVAILABILITY_DOMAIN_CA_MONTREAL_1_AD_1 = "CA_MONTREAL_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_HYDERABAD_1_AD_1" - AVAILABILITY_DOMAIN_AP_HYDERABAD_1_AD_1 = "AP_HYDERABAD_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "AP_CHUNCHEON_1_AD_1" - AVAILABILITY_DOMAIN_AP_CHUNCHEON_1_AD_1 = "AP_CHUNCHEON_1_AD_1" - - #: A constant which can be used with the availability_domain property of a Resource. - #: This constant has a value of "NO_AD" - AVAILABILITY_DOMAIN_NO_AD = "NO_AD" - def __init__(self, **kwargs): """ Initializes a new Resource object with values from keyword arguments. @@ -262,32 +26,21 @@ def __init__(self, **kwargs): :param region: The value to assign to the region property of this Resource. - Allowed values for this property are: "DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type region: str - :param availability_domain: - The value to assign to the availability_domain property of this Resource. - Allowed values for this property are: "DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :type availability_domain: str - """ self.swagger_types = { 'item': 'Item', - 'region': 'str', - 'availability_domain': 'str' + 'region': 'str' } self.attribute_map = { 'item': 'item', - 'region': 'region', - 'availability_domain': 'availabilityDomain' + 'region': 'region' } self._item = None self._region = None - self._availability_domain = None @property def item(self): @@ -315,9 +68,6 @@ def region(self): Gets the region of this Resource. The list of available Oracle Cloud Infrastructure regions. - Allowed values for this property are: "DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - :return: The region of this Resource. :rtype: str @@ -334,41 +84,8 @@ def region(self, region): :param region: The region of this Resource. :type: str """ - allowed_values = ["DEV", "SEA", "INTEG_NEXT", "INTEG_STABLE", "PHX", "IAD", "FRA", "EU_FRANKFURT_1", "LHR", "YYZ", "NRT", "ICN", "BOM", "GRU", "SYD", "ZRH", "JED", "AMS", "KIX", "MEL", "YUL", "HYD", "YNY"] - if not value_allowed_none_or_none_sentinel(region, allowed_values): - region = 'UNKNOWN_ENUM_VALUE' self._region = region - @property - def availability_domain(self): - """ - Gets the availability_domain of this Resource. - The list of available Oracle Cloud Infrastructure availability domains. - - Allowed values for this property are: "DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD", 'UNKNOWN_ENUM_VALUE'. - Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. - - - :return: The availability_domain of this Resource. - :rtype: str - """ - return self._availability_domain - - @availability_domain.setter - def availability_domain(self, availability_domain): - """ - Sets the availability_domain of this Resource. - The list of available Oracle Cloud Infrastructure availability domains. - - - :param availability_domain: The availability_domain of this Resource. - :type: str - """ - allowed_values = ["DEV_1", "DEV_2", "DEV_3", "INTEG_NEXT_1", "INTEG_STABLE_1", "SEA_AD_1", "SEA_AD_2", "SEA_AD_3", "PHX_AD_1", "PHX_AD_2", "PHX_AD_3", "US_ASHBURN_AD_1", "US_ASHBURN_AD_2", "US_ASHBURN_AD_3", "US_ASHBURN_AD_4", "EU_FRANKFURT_1_AD_1", "EU_FRANKFURT_1_AD_2", "EU_FRANKFURT_1_AD_3", "UK_LONDON_1_AD_1", "UK_LONDON_1_AD_2", "UK_LONDON_1_AD_3", "CA_TORONTO_1_AD_1", "AP_TOKYO_1_AD_1", "AP_SEOUL_1_AD_1", "AP_MUMBAI_1_AD_1", "SA_SAOPAULO_1_AD_1", "ME_JEDDAH_1_AD_1", "AP_OSAKA_1_AD_1", "AP_SYDNEY_1_AD_1", "EU_ZURICH_1_AD_1", "EU_AMSTERDAM_1_AD_1", "AP_MELBOURNE_1_AD_1", "CA_MONTREAL_1_AD_1", "AP_HYDERABAD_1_AD_1", "AP_CHUNCHEON_1_AD_1", "NO_AD"] - if not value_allowed_none_or_none_sentinel(availability_domain, allowed_values): - availability_domain = 'UNKNOWN_ENUM_VALUE' - self._availability_domain = availability_domain - def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/service_categories.py b/src/oci/cims/models/service_categories.py new file mode 100644 index 0000000000..80d13d7ba7 --- /dev/null +++ b/src/oci/cims/models/service_categories.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20181231 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ServiceCategories(object): + """ + List of Service Categories of a Service for MOS Taxonomy. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ServiceCategories object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param service_category: + The value to assign to the service_category property of this ServiceCategories. + :type service_category: dict(str, str) + + :param schema: + The value to assign to the schema property of this ServiceCategories. + :type schema: str + + :param issue_type: + The value to assign to the issue_type property of this ServiceCategories. + :type issue_type: dict(str, str) + + """ + self.swagger_types = { + 'service_category': 'dict(str, str)', + 'schema': 'str', + 'issue_type': 'dict(str, str)' + } + + self.attribute_map = { + 'service_category': 'serviceCategory', + 'schema': 'schema', + 'issue_type': 'issueType' + } + + self._service_category = None + self._schema = None + self._issue_type = None + + @property + def service_category(self): + """ + Gets the service_category of this ServiceCategories. + Service Category list. + + + :return: The service_category of this ServiceCategories. + :rtype: dict(str, str) + """ + return self._service_category + + @service_category.setter + def service_category(self, service_category): + """ + Sets the service_category of this ServiceCategories. + Service Category list. + + + :param service_category: The service_category of this ServiceCategories. + :type: dict(str, str) + """ + self._service_category = service_category + + @property + def schema(self): + """ + Gets the schema of this ServiceCategories. + Schema of a Service Category. + + + :return: The schema of this ServiceCategories. + :rtype: str + """ + return self._schema + + @schema.setter + def schema(self, schema): + """ + Sets the schema of this ServiceCategories. + Schema of a Service Category. + + + :param schema: The schema of this ServiceCategories. + :type: str + """ + self._schema = schema + + @property + def issue_type(self): + """ + Gets the issue_type of this ServiceCategories. + Issue type list. + + + :return: The issue_type of this ServiceCategories. + :rtype: dict(str, str) + """ + return self._issue_type + + @issue_type.setter + def issue_type(self, issue_type): + """ + Sets the issue_type of this ServiceCategories. + Issue type list. + + + :param issue_type: The issue_type of this ServiceCategories. + :type: dict(str, str) + """ + self._issue_type = issue_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/cims/models/service_category.py b/src/oci/cims/models/service_category.py index 8e40d97ce7..711c865965 100644 --- a/src/oci/cims/models/service_category.py +++ b/src/oci/cims/models/service_category.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class ServiceCategory(object): """ - Information about the incident classifier. + Information about the support ticket classifier. """ #: A constant which can be used with the scope property of a ServiceCategory. diff --git a/src/oci/cims/models/sub_category.py b/src/oci/cims/models/sub_category.py index b164628671..02b3d3c43a 100644 --- a/src/oci/cims/models/sub_category.py +++ b/src/oci/cims/models/sub_category.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class SubCategory(object): """ - Details about the subcategory associated with the support ticket. + Details about the service subcategory associated with the support ticket. """ def __init__(self, **kwargs): @@ -46,7 +46,7 @@ def __init__(self, **kwargs): def sub_category_key(self): """ Gets the sub_category_key of this SubCategory. - Unique identifier for the subcategory. + Unique identifier for the service subcategory. :return: The sub_category_key of this SubCategory. @@ -58,7 +58,7 @@ def sub_category_key(self): def sub_category_key(self, sub_category_key): """ Sets the sub_category_key of this SubCategory. - Unique identifier for the subcategory. + Unique identifier for the service subcategory. :param sub_category_key: The sub_category_key of this SubCategory. @@ -70,7 +70,7 @@ def sub_category_key(self, sub_category_key): def name(self): """ Gets the name of this SubCategory. - The name of the subcategory. For example, `Backup Count` or `Custom Image Count`. + The name of the service subcategory. For example, `Backup Count` or `Custom Image Count`. :return: The name of this SubCategory. @@ -82,7 +82,7 @@ def name(self): def name(self, name): """ Sets the name of this SubCategory. - The name of the subcategory. For example, `Backup Count` or `Custom Image Count`. + The name of the service subcategory. For example, `Backup Count` or `Custom Image Count`. :param name: The name of this SubCategory. diff --git a/src/oci/cims/models/tenancy_information.py b/src/oci/cims/models/tenancy_information.py index 5f02faebf3..102c5ee2be 100644 --- a/src/oci/cims/models/tenancy_information.py +++ b/src/oci/cims/models/tenancy_information.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class TenancyInformation(object): """ - Details about the customer's tenancy. + Details about the tenancy. """ def __init__(self, **kwargs): @@ -46,7 +46,7 @@ def __init__(self, **kwargs): def customer_support_key(self): """ **[Required]** Gets the customer_support_key of this TenancyInformation. - The Customer Support Identifier number associated with the tenancy. + The Customer Support Identifier (CSI) number associated with the tenancy. :return: The customer_support_key of this TenancyInformation. @@ -58,7 +58,7 @@ def customer_support_key(self): def customer_support_key(self, customer_support_key): """ Sets the customer_support_key of this TenancyInformation. - The Customer Support Identifier number associated with the tenancy. + The Customer Support Identifier (CSI) number associated with the tenancy. :param customer_support_key: The customer_support_key of this TenancyInformation. diff --git a/src/oci/cims/models/ticket.py b/src/oci/cims/models/ticket.py index 07157bc1da..cec01137e7 100644 --- a/src/oci/cims/models/ticket.py +++ b/src/oci/cims/models/ticket.py @@ -27,6 +27,10 @@ class Ticket(object): #: This constant has a value of "MEDIUM" SEVERITY_MEDIUM = "MEDIUM" + #: A constant which can be used with the severity property of a Ticket. + #: This constant has a value of "LOW" + SEVERITY_LOW = "LOW" + #: A constant which can be used with the lifecycle_state property of a Ticket. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" @@ -62,7 +66,7 @@ def __init__(self, **kwargs): :param severity: The value to assign to the severity property of this Ticket. - Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", "LOW", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type severity: str @@ -163,7 +167,7 @@ def severity(self): **[Required]** Gets the severity of this Ticket. The severity assigned to the ticket. - Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HIGHEST", "HIGH", "MEDIUM", "LOW", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -182,7 +186,7 @@ def severity(self, severity): :param severity: The severity of this Ticket. :type: str """ - allowed_values = ["HIGHEST", "HIGH", "MEDIUM"] + allowed_values = ["HIGHEST", "HIGH", "MEDIUM", "LOW"] if not value_allowed_none_or_none_sentinel(severity, allowed_values): severity = 'UNKNOWN_ENUM_VALUE' self._severity = severity diff --git a/src/oci/cims/models/update_activity_item_details.py b/src/oci/cims/models/update_activity_item_details.py index 280037ebbf..58a843554f 100644 --- a/src/oci/cims/models/update_activity_item_details.py +++ b/src/oci/cims/models/update_activity_item_details.py @@ -12,9 +12,7 @@ @init_model_state_from_kwargs class UpdateActivityItemDetails(UpdateItemDetails): """ - Details for udpating the support ticket activity. - - **Caution:** Avoid using any confidential information when you supply string values using the API. + Details for updating the support ticket activity. """ #: A constant which can be used with the activity_type property of a UpdateActivityItemDetails. @@ -33,6 +31,10 @@ class UpdateActivityItemDetails(UpdateItemDetails): #: This constant has a value of "CLOSE" ACTIVITY_TYPE_CLOSE = "CLOSE" + #: A constant which can be used with the activity_type property of a UpdateActivityItemDetails. + #: This constant has a value of "REOPEN" + ACTIVITY_TYPE_REOPEN = "REOPEN" + def __init__(self, **kwargs): """ Initializes a new UpdateActivityItemDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.cims.models.UpdateActivityItemDetails.type` attribute @@ -49,7 +51,7 @@ def __init__(self, **kwargs): :param activity_type: The value to assign to the activity_type property of this UpdateActivityItemDetails. - Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE" + Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN" :type activity_type: str """ @@ -100,7 +102,7 @@ def activity_type(self): Gets the activity_type of this UpdateActivityItemDetails. The type of activity occurring. - Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE" + Allowed values for this property are: "NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN" :return: The activity_type of this UpdateActivityItemDetails. @@ -118,7 +120,7 @@ def activity_type(self, activity_type): :param activity_type: The activity_type of this UpdateActivityItemDetails. :type: str """ - allowed_values = ["NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE"] + allowed_values = ["NOTES", "PROBLEM_DESCRIPTION", "UPDATE", "CLOSE", "REOPEN"] if not value_allowed_none_or_none_sentinel(activity_type, allowed_values): raise ValueError( "Invalid value for `activity_type`, must be None or one of {0}" diff --git a/src/oci/cims/models/update_incident.py b/src/oci/cims/models/update_incident.py index 6e22d54e01..8a05f61179 100644 --- a/src/oci/cims/models/update_incident.py +++ b/src/oci/cims/models/update_incident.py @@ -15,6 +15,26 @@ class UpdateIncident(object): Details about the support ticket being updated. """ + #: A constant which can be used with the problem_type property of a UpdateIncident. + #: This constant has a value of "LIMIT" + PROBLEM_TYPE_LIMIT = "LIMIT" + + #: A constant which can be used with the problem_type property of a UpdateIncident. + #: This constant has a value of "LEGACY_LIMIT" + PROBLEM_TYPE_LEGACY_LIMIT = "LEGACY_LIMIT" + + #: A constant which can be used with the problem_type property of a UpdateIncident. + #: This constant has a value of "TECH" + PROBLEM_TYPE_TECH = "TECH" + + #: A constant which can be used with the problem_type property of a UpdateIncident. + #: This constant has a value of "ACCOUNT" + PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + + #: A constant which can be used with the problem_type property of a UpdateIncident. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new UpdateIncident object with values from keyword arguments. @@ -24,16 +44,24 @@ def __init__(self, **kwargs): The value to assign to the ticket property of this UpdateIncident. :type ticket: oci.cims.models.UpdateTicketDetails + :param problem_type: + The value to assign to the problem_type property of this UpdateIncident. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + :type problem_type: str + """ self.swagger_types = { - 'ticket': 'UpdateTicketDetails' + 'ticket': 'UpdateTicketDetails', + 'problem_type': 'str' } self.attribute_map = { - 'ticket': 'ticket' + 'ticket': 'ticket', + 'problem_type': 'problemType' } self._ticket = None + self._problem_type = None @property def ticket(self): @@ -55,6 +83,38 @@ def ticket(self, ticket): """ self._ticket = ticket + @property + def problem_type(self): + """ + Gets the problem_type of this UpdateIncident. + The kind of support ticket, such as a technical support request or a limit increase request. + + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + + + :return: The problem_type of this UpdateIncident. + :rtype: str + """ + return self._problem_type + + @problem_type.setter + def problem_type(self, problem_type): + """ + Sets the problem_type of this UpdateIncident. + The kind of support ticket, such as a technical support request or a limit increase request. + + + :param problem_type: The problem_type of this UpdateIncident. + :type: str + """ + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] + if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): + raise ValueError( + "Invalid value for `problem_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._problem_type = problem_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/cims/models/update_item_details.py b/src/oci/cims/models/update_item_details.py index 6b3a95248b..e14ad1e7c6 100644 --- a/src/oci/cims/models/update_item_details.py +++ b/src/oci/cims/models/update_item_details.py @@ -12,9 +12,7 @@ @init_model_state_from_kwargs class UpdateItemDetails(object): """ - Details for udpating an item. - - **Caution:** Avoid using any confidential information when you supply string values using the API. + Details for updating an item. """ def __init__(self, **kwargs): @@ -58,7 +56,7 @@ def get_subtype(object_dictionary): def type(self): """ Gets the type of this UpdateItemDetails. - The type of the item. + The type of the ticket. :return: The type of this UpdateItemDetails. @@ -70,7 +68,7 @@ def type(self): def type(self, type): """ Sets the type of this UpdateItemDetails. - The type of the item. + The type of the ticket. :param type: The type of this UpdateItemDetails. diff --git a/src/oci/cims/models/update_resource_details.py b/src/oci/cims/models/update_resource_details.py index dc12eb9e32..df7de43207 100644 --- a/src/oci/cims/models/update_resource_details.py +++ b/src/oci/cims/models/update_resource_details.py @@ -13,8 +13,6 @@ class UpdateResourceDetails(object): """ Details about updates to the resource. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/cims/models/update_ticket_details.py b/src/oci/cims/models/update_ticket_details.py index c16c620121..fecec20213 100644 --- a/src/oci/cims/models/update_ticket_details.py +++ b/src/oci/cims/models/update_ticket_details.py @@ -13,8 +13,6 @@ class UpdateTicketDetails(object): """ Details about the ticket updated. - - **Caution:** Avoid using any confidential information when you supply string values using the API. """ def __init__(self, **kwargs): diff --git a/src/oci/cims/models/user.py b/src/oci/cims/models/user.py index c94aed3131..c5eee5a4e7 100644 --- a/src/oci/cims/models/user.py +++ b/src/oci/cims/models/user.py @@ -12,9 +12,29 @@ @init_model_state_from_kwargs class User(object): """ - Details about the user object. + Details about the user. """ + #: A constant which can be used with the problem_type property of a User. + #: This constant has a value of "LIMIT" + PROBLEM_TYPE_LIMIT = "LIMIT" + + #: A constant which can be used with the problem_type property of a User. + #: This constant has a value of "LEGACY_LIMIT" + PROBLEM_TYPE_LEGACY_LIMIT = "LEGACY_LIMIT" + + #: A constant which can be used with the problem_type property of a User. + #: This constant has a value of "TECH" + PROBLEM_TYPE_TECH = "TECH" + + #: A constant which can be used with the problem_type property of a User. + #: This constant has a value of "ACCOUNT" + PROBLEM_TYPE_ACCOUNT = "ACCOUNT" + + #: A constant which can be used with the problem_type property of a User. + #: This constant has a value of "TAXONOMY" + PROBLEM_TYPE_TAXONOMY = "TAXONOMY" + def __init__(self, **kwargs): """ Initializes a new User object with values from keyword arguments. @@ -60,6 +80,11 @@ def __init__(self, **kwargs): The value to assign to the contact_email property of this User. :type contact_email: str + :param problem_type: + The value to assign to the problem_type property of this User. + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + :type problem_type: str + """ self.swagger_types = { 'key': 'str', @@ -71,7 +96,8 @@ def __init__(self, **kwargs): 'timezone': 'str', 'organization_name': 'str', 'compartment_id': 'str', - 'contact_email': 'str' + 'contact_email': 'str', + 'problem_type': 'str' } self.attribute_map = { @@ -84,7 +110,8 @@ def __init__(self, **kwargs): 'timezone': 'timezone', 'organization_name': 'organizationName', 'compartment_id': 'compartmentId', - 'contact_email': 'contactEmail' + 'contact_email': 'contactEmail', + 'problem_type': 'problemType' } self._key = None @@ -97,12 +124,13 @@ def __init__(self, **kwargs): self._organization_name = None self._compartment_id = None self._contact_email = None + self._problem_type = None @property def key(self): """ **[Required]** Gets the key of this User. - Unique identifier for the user. + A unique identifier for the user. :return: The key of this User. @@ -114,7 +142,7 @@ def key(self): def key(self, key): """ Sets the key of this User. - Unique identifier for the user. + A unique identifier for the user. :param key: The key of this User. @@ -126,7 +154,7 @@ def key(self, key): def first_name(self): """ Gets the first_name of this User. - First name of the user. + The user's first name. :return: The first_name of this User. @@ -138,7 +166,7 @@ def first_name(self): def first_name(self, first_name): """ Sets the first_name of this User. - First name of the user. + The user's first name. :param first_name: The first_name of this User. @@ -150,7 +178,7 @@ def first_name(self, first_name): def last_name(self): """ Gets the last_name of this User. - Last name of the user. + The user's last name. :return: The last_name of this User. @@ -162,7 +190,7 @@ def last_name(self): def last_name(self, last_name): """ Sets the last_name of this User. - Last name of the user. + The user's last name. :param last_name: The last_name of this User. @@ -174,7 +202,7 @@ def last_name(self, last_name): def country(self): """ Gets the country of this User. - Country of the user. + The country of the user. :return: The country of this User. @@ -186,7 +214,7 @@ def country(self): def country(self, country): """ Sets the country of this User. - Country of the user. + The country of the user. :param country: The country of this User. @@ -198,7 +226,7 @@ def country(self, country): def csi(self): """ Gets the csi of this User. - CSI to be associated to the user. + The CSI associated with the user. :return: The csi of this User. @@ -210,7 +238,7 @@ def csi(self): def csi(self, csi): """ Sets the csi of this User. - CSI to be associated to the user. + The CSI associated with the user. :param csi: The csi of this User. @@ -222,7 +250,7 @@ def csi(self, csi): def phone(self): """ Gets the phone of this User. - Contact number of the user. + The user's contact phone number. :return: The phone of this User. @@ -234,7 +262,7 @@ def phone(self): def phone(self, phone): """ Sets the phone of this User. - Contact number of the user. + The user's contact phone number. :param phone: The phone of this User. @@ -246,7 +274,7 @@ def phone(self, phone): def timezone(self): """ Gets the timezone of this User. - Timezone of the user. + The timezone of the user. :return: The timezone of this User. @@ -258,7 +286,7 @@ def timezone(self): def timezone(self, timezone): """ Sets the timezone of this User. - Timezone of the user. + The timezone of the user. :param timezone: The timezone of this User. @@ -270,7 +298,7 @@ def timezone(self, timezone): def organization_name(self): """ Gets the organization_name of this User. - Organization of the user. + The company that the user belongs to. :return: The organization_name of this User. @@ -282,7 +310,7 @@ def organization_name(self): def organization_name(self, organization_name): """ Sets the organization_name of this User. - Organization of the user. + The company that the user belongs to. :param organization_name: The organization_name of this User. @@ -338,6 +366,38 @@ def contact_email(self, contact_email): """ self._contact_email = contact_email + @property + def problem_type(self): + """ + Gets the problem_type of this User. + The kind of support ticket, such as a technical support request or a limit increase request. + + Allowed values for this property are: "LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY" + + + :return: The problem_type of this User. + :rtype: str + """ + return self._problem_type + + @problem_type.setter + def problem_type(self, problem_type): + """ + Sets the problem_type of this User. + The kind of support ticket, such as a technical support request or a limit increase request. + + + :param problem_type: The problem_type of this User. + :type: str + """ + allowed_values = ["LIMIT", "LEGACY_LIMIT", "TECH", "ACCOUNT", "TAXONOMY"] + if not value_allowed_none_or_none_sentinel(problem_type, allowed_values): + raise ValueError( + "Invalid value for `problem_type`, must be None or one of {0}" + .format(allowed_values) + ) + self._problem_type = problem_type + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/container_instances/container_instance_client.py b/src/oci/container_instances/container_instance_client.py index 1ffefd00fd..e4354bffd8 100644 --- a/src/oci/container_instances/container_instance_client.py +++ b/src/oci/container_instances/container_instance_client.py @@ -1196,6 +1196,16 @@ def list_work_request_errors(self, work_request_id, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. + + Allowed values are: "timestamp" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1227,7 +1237,9 @@ def list_work_request_errors(self, work_request_id, **kwargs): "retry_strategy", "opc_request_id", "page", - "limit" + "limit", + "sort_by", + "sort_order" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1244,9 +1256,25 @@ def list_work_request_errors(self, work_request_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timestamp"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + query_params = { "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -1314,6 +1342,16 @@ def list_work_request_logs(self, work_request_id, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. + + Allowed values are: "timestamp" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1345,7 +1383,9 @@ def list_work_request_logs(self, work_request_id, **kwargs): "retry_strategy", "opc_request_id", "page", - "limit" + "limit", + "sort_by", + "sort_order" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -1362,9 +1402,25 @@ def list_work_request_logs(self, work_request_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timestamp"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + query_params = { "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -1437,6 +1493,26 @@ def list_work_requests(self, compartment_id, **kwargs): __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + :param str availability_domain: (optional) + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + + :param str status: (optional) + A filter to return only resources their lifecycleState matches the given OperationStatus. + + Allowed values are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" + + :param str sort_by: (optional) + The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. + + Allowed values are: "timeAccepted" + + :param str sort_order: (optional) + The sort order to use, either 'ASC' or 'DESC'. + + Allowed values are: "ASC", "DESC" + :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1469,18 +1545,47 @@ def list_work_requests(self, compartment_id, **kwargs): "work_request_id", "opc_request_id", "page", - "limit" + "limit", + "availability_domain", + "status", + "sort_by", + "sort_order" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: raise ValueError( "list_work_requests got unknown kwargs: {!r}".format(extra_kwargs)) + if 'status' in kwargs: + status_allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"] + if kwargs['status'] not in status_allowed_values: + raise ValueError( + "Invalid value for `status`, must be one of {0}".format(status_allowed_values) + ) + + if 'sort_by' in kwargs: + sort_by_allowed_values = ["timeAccepted"] + if kwargs['sort_by'] not in sort_by_allowed_values: + raise ValueError( + "Invalid value for `sort_by`, must be one of {0}".format(sort_by_allowed_values) + ) + + if 'sort_order' in kwargs: + sort_order_allowed_values = ["ASC", "DESC"] + if kwargs['sort_order'] not in sort_order_allowed_values: + raise ValueError( + "Invalid value for `sort_order`, must be one of {0}".format(sort_order_allowed_values) + ) + query_params = { "compartmentId": compartment_id, "workRequestId": kwargs.get("work_request_id", missing), "page": kwargs.get("page", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "availabilityDomain": kwargs.get("availability_domain", missing), + "status": kwargs.get("status", missing), + "sortBy": kwargs.get("sort_by", missing), + "sortOrder": kwargs.get("sort_order", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} diff --git a/src/oci/data_catalog/data_catalog_client.py b/src/oci/data_catalog/data_catalog_client.py index e5c58aa27e..b578923822 100644 --- a/src/oci/data_catalog/data_catalog_client.py +++ b/src/oci/data_catalog/data_catalog_client.py @@ -360,6 +360,121 @@ def associate_custom_property(self, catalog_id, type_key, associate_custom_prope api_reference_link=api_reference_link, required_arguments=required_arguments) + def asynchronous_export_glossary(self, catalog_id, glossary_key, asynchronous_export_glossary_details, **kwargs): + """ + Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export. + + + :param str catalog_id: (required) + Unique catalog identifier. + + :param str glossary_key: (required) + Unique glossary key. + + :param oci.data_catalog.models.AsynchronousExportGlossaryDetails asynchronous_export_glossary_details: (required) + Details needed by the glossary export request. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str opc_retry_token: (optional) + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_catalog.models.AsynchronousExportGlossaryResult` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use asynchronous_export_glossary API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['catalogId', 'glossaryKey'] + resource_path = "/catalogs/{catalogId}/glossaries/{glossaryKey}/actions/asynchronousExport" + method = "POST" + operation_name = "asynchronous_export_glossary" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-catalog/20190325/Glossary/AsynchronousExportGlossary" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "opc_retry_token" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "asynchronous_export_glossary got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "catalogId": catalog_id, + "glossaryKey": glossary_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "opc-retry-token": kwargs.get("opc_retry_token", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_retry_token_if_needed(header_params) + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=asynchronous_export_glossary_details, + response_type="AsynchronousExportGlossaryResult", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + header_params=header_params, + body=asynchronous_export_glossary_details, + response_type="AsynchronousExportGlossaryResult", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def attach_catalog_private_endpoint(self, attach_catalog_private_endpoint_details, catalog_id, **kwargs): """ Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource. @@ -5816,6 +5931,142 @@ def export_glossary(self, catalog_id, glossary_key, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def fetch_entity_lineage(self, catalog_id, data_asset_key, entity_key, fetch_entity_lineage_details, **kwargs): + """ + Returns lineage for a given entity object. + + + :param str catalog_id: (required) + Unique catalog identifier. + + :param str data_asset_key: (required) + Unique data asset key. + + :param str entity_key: (required) + Unique entity key. + + :param oci.data_catalog.models.FetchEntityLineageDetails fetch_entity_lineage_details: (required) + The information needed to obtain desired lineage. + + :param int limit: (optional) + The maximum number of items to return. + + :param str page: (optional) + The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + + :param str opc_request_id: (optional) + The client request ID for tracing. + + :param str if_match: (optional) + For optimistic concurrency control. In the PUT or DELETE call + for a resource, set the `if-match` parameter to the value of the + etag from a previous GET or POST response for that resource. + The resource will be updated or deleted only if the etag you + provide matches the resource's current etag value. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.data_catalog.models.EntityLineage` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use fetch_entity_lineage API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['catalogId', 'dataAssetKey', 'entityKey'] + resource_path = "/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/fetchLineage" + method = "POST" + operation_name = "fetch_entity_lineage" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/data-catalog/20190325/Entity/FetchEntityLineage" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "limit", + "page", + "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( + "fetch_entity_lineage got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "catalogId": catalog_id, + "dataAssetKey": data_asset_key, + "entityKey": entity_key + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing), + "if-match": kwargs.get("if_match", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=fetch_entity_lineage_details, + response_type="EntityLineage", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=fetch_entity_lineage_details, + response_type="EntityLineage", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def get_attribute(self, catalog_id, data_asset_key, entity_key, attribute_key, **kwargs): """ Gets a specific entity attribute by key. @@ -9752,9 +10003,10 @@ def list_attributes(self, catalog_id, data_asset_key, entity_key, **kwargs): Allowed values are: "key", "displayName", "description", "entityKey", "lifecycleState", "timeCreated", "externalDataType", "externalKey", "length", "precision", "scale", "isNullable", "uri", "path", "minCollectionCount", "maxCollectionCount", "datatypeEntityKey", "externalDatatypeEntityKey", "parentAttributeKey", "externalParentAttributeKey", "position", "typeKey" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for POSITION is ascending. If no value is specified POSITION is default. + The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. + Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default. - Allowed values are: "TIMECREATED", "DISPLAYNAME", "POSITION" + Allowed values are: "TIMECREATED", "DISPLAYNAME", "POSITION", "DISPLAYORBUSINESSNAME" :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. @@ -9857,7 +10109,7 @@ def list_attributes(self, catalog_id, data_asset_key, entity_key, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME", "POSITION"] + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME", "POSITION", "DISPLAYORBUSINESSNAME"] 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) @@ -11391,9 +11643,10 @@ def list_entities(self, catalog_id, data_asset_key, **kwargs): Allowed values are: "key", "displayName", "description", "dataAssetKey", "timeCreated", "timeUpdated", "updatedById", "lifecycleState", "folderKey", "folderName", "externalKey", "path", "uri" :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. + The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. + Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. - Allowed values are: "TIMECREATED", "DISPLAYNAME" + Allowed values are: "TIMECREATED", "DISPLAYNAME", "DISPLAYORBUSINESSNAME" :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. @@ -11504,7 +11757,7 @@ def list_entities(self, catalog_id, data_asset_key, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME", "DISPLAYORBUSINESSNAME"] 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) @@ -12071,10 +12324,14 @@ def list_folders(self, catalog_id, data_asset_key, **kwargs): Allowed values are: "key", "displayName", "description", "parentFolderKey", "path", "dataAssetKey", "externalKey", "timeExternal", "timeCreated", "lifecycleState", "uri" + :param str type_key: (optional) + The key of the object type. + :param str sort_by: (optional) - The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. + The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. + Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. - Allowed values are: "TIMECREATED", "DISPLAYNAME" + Allowed values are: "TIMECREATED", "DISPLAYNAME", "DISPLAYORBUSINESSNAME" :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. @@ -12134,6 +12391,7 @@ def list_folders(self, catalog_id, data_asset_key, **kwargs): "harvest_status", "last_job_key", "fields", + "type_key", "sort_by", "sort_order", "limit", @@ -12179,7 +12437,7 @@ def list_folders(self, catalog_id, data_asset_key, **kwargs): ) if 'sort_by' in kwargs: - sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME"] + sort_by_allowed_values = ["TIMECREATED", "DISPLAYNAME", "DISPLAYORBUSINESSNAME"] 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) @@ -12208,6 +12466,7 @@ def list_folders(self, catalog_id, data_asset_key, **kwargs): "harvestStatus": kwargs.get("harvest_status", missing), "lastJobKey": kwargs.get("last_job_key", missing), "fields": self.base_client.generate_collection_format_param(kwargs.get("fields", missing), 'multi'), + "typeKey": kwargs.get("type_key", missing), "sortBy": kwargs.get("sort_by", missing), "sortOrder": kwargs.get("sort_order", missing), "limit": kwargs.get("limit", missing), @@ -12494,7 +12753,7 @@ def list_job_definitions(self, catalog_id, **kwargs): :param str job_type: (optional) Job type. - Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :param bool is_incremental: (optional) Whether job definition is an incremental harvest (true) or a full harvest (false). @@ -12502,6 +12761,9 @@ def list_job_definitions(self, catalog_id, **kwargs): :param str data_asset_key: (optional) Unique data asset key. + :param str glossary_key: (optional) + Unique glossary key. + :param str connection_key: (optional) Unique connection key. @@ -12584,6 +12846,7 @@ def list_job_definitions(self, catalog_id, **kwargs): "job_type", "is_incremental", "data_asset_key", + "glossary_key", "connection_key", "time_created", "time_updated", @@ -12627,7 +12890,7 @@ def list_job_definitions(self, catalog_id, **kwargs): ) if 'job_type' in kwargs: - job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if kwargs['job_type'] not in job_type_allowed_values: raise ValueError( "Invalid value for `job_type`, must be one of {0}".format(job_type_allowed_values) @@ -12663,6 +12926,7 @@ def list_job_definitions(self, catalog_id, **kwargs): "jobType": kwargs.get("job_type", missing), "isIncremental": kwargs.get("is_incremental", missing), "dataAssetKey": kwargs.get("data_asset_key", missing), + "glossaryKey": kwargs.get("glossary_key", missing), "connectionKey": kwargs.get("connection_key", missing), "timeCreated": kwargs.get("time_created", missing), "timeUpdated": kwargs.get("time_updated", missing), @@ -12755,7 +13019,7 @@ def list_job_executions(self, catalog_id, job_key, **kwargs): :param str job_type: (optional) Job type. - Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :param str sub_type: (optional) Sub-type of this job execution. @@ -12893,7 +13157,7 @@ def list_job_executions(self, catalog_id, job_key, **kwargs): ) if 'job_type' in kwargs: - job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if kwargs['job_type'] not in job_type_allowed_values: raise ValueError( "Invalid value for `job_type`, must be one of {0}".format(job_type_allowed_values) @@ -13471,7 +13735,7 @@ def list_jobs(self, catalog_id, **kwargs): :param str job_type: (optional) Job type. - Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :param str job_definition_key: (optional) Unique job definition key. @@ -13479,9 +13743,13 @@ def list_jobs(self, catalog_id, **kwargs): :param str data_asset_key: (optional) Unique data asset key. + :param str glossary_key: (optional) + Unique glossary key. + :param str schedule_cron_expression: (optional) Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :param datetime time_schedule_begin: (optional) Date that the schedule should be operational. An `RFC3339`__ formatted datetime string. @@ -13573,6 +13841,7 @@ def list_jobs(self, catalog_id, **kwargs): "job_type", "job_definition_key", "data_asset_key", + "glossary_key", "schedule_cron_expression", "time_schedule_begin", "time_schedule_end", @@ -13610,7 +13879,7 @@ def list_jobs(self, catalog_id, **kwargs): ) if 'job_type' in kwargs: - job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + job_type_allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if kwargs['job_type'] not in job_type_allowed_values: raise ValueError( "Invalid value for `job_type`, must be one of {0}".format(job_type_allowed_values) @@ -13656,6 +13925,7 @@ def list_jobs(self, catalog_id, **kwargs): "jobType": kwargs.get("job_type", missing), "jobDefinitionKey": kwargs.get("job_definition_key", missing), "dataAssetKey": kwargs.get("data_asset_key", missing), + "glossaryKey": kwargs.get("glossary_key", missing), "scheduleCronExpression": kwargs.get("schedule_cron_expression", missing), "timeScheduleBegin": kwargs.get("time_schedule_begin", missing), "timeScheduleEnd": kwargs.get("time_schedule_end", missing), diff --git a/src/oci/data_catalog/models/__init__.py b/src/oci/data_catalog/models/__init__.py index 72e5a93e13..dffa97aa7d 100644 --- a/src/oci/data_catalog/models/__init__.py +++ b/src/oci/data_catalog/models/__init__.py @@ -6,6 +6,10 @@ from __future__ import absolute_import +from .asynchronous_export_glossary_details import AsynchronousExportGlossaryDetails +from .asynchronous_export_glossary_result import AsynchronousExportGlossaryResult +from .asynchronous_export_request_details import AsynchronousExportRequestDetails +from .asynchronous_export_result import AsynchronousExportResult from .attach_catalog_private_endpoint_details import AttachCatalogPrivateEndpointDetails from .attribute import Attribute from .attribute_collection import AttributeCollection @@ -65,6 +69,7 @@ from .detach_catalog_private_endpoint_details import DetachCatalogPrivateEndpointDetails from .entity import Entity from .entity_collection import EntityCollection +from .entity_lineage import EntityLineage from .entity_summary import EntitySummary from .entity_tag import EntityTag from .entity_tag_collection import EntityTagCollection @@ -77,6 +82,7 @@ from .faceted_search_filter_request import FacetedSearchFilterRequest from .faceted_search_sort_request import FacetedSearchSortRequest from .faceted_search_string_filter_request import FacetedSearchStringFilterRequest +from .fetch_entity_lineage_details import FetchEntityLineageDetails from .folder import Folder from .folder_collection import FolderCollection from .folder_summary import FolderSummary @@ -109,12 +115,17 @@ from .job_metric_collection import JobMetricCollection from .job_metric_summary import JobMetricSummary from .job_summary import JobSummary +from .lineage_object import LineageObject +from .lineage_relationship import LineageRelationship from .metastore import Metastore from .metastore_summary import MetastoreSummary from .namespace import Namespace from .namespace_collection import NamespaceCollection from .namespace_summary import NamespaceSummary +from .object_lineage import ObjectLineage +from .object_lineage_request_details import ObjectLineageRequestDetails from .object_relationship import ObjectRelationship +from .object_storage_object_reference import ObjectStorageObjectReference from .parse_connection_details import ParseConnectionDetails from .pattern import Pattern from .pattern_collection import PatternCollection @@ -172,6 +183,10 @@ # Maps type names to classes for data_catalog services. data_catalog_type_mapping = { + "AsynchronousExportGlossaryDetails": AsynchronousExportGlossaryDetails, + "AsynchronousExportGlossaryResult": AsynchronousExportGlossaryResult, + "AsynchronousExportRequestDetails": AsynchronousExportRequestDetails, + "AsynchronousExportResult": AsynchronousExportResult, "AttachCatalogPrivateEndpointDetails": AttachCatalogPrivateEndpointDetails, "Attribute": Attribute, "AttributeCollection": AttributeCollection, @@ -231,6 +246,7 @@ "DetachCatalogPrivateEndpointDetails": DetachCatalogPrivateEndpointDetails, "Entity": Entity, "EntityCollection": EntityCollection, + "EntityLineage": EntityLineage, "EntitySummary": EntitySummary, "EntityTag": EntityTag, "EntityTagCollection": EntityTagCollection, @@ -243,6 +259,7 @@ "FacetedSearchFilterRequest": FacetedSearchFilterRequest, "FacetedSearchSortRequest": FacetedSearchSortRequest, "FacetedSearchStringFilterRequest": FacetedSearchStringFilterRequest, + "FetchEntityLineageDetails": FetchEntityLineageDetails, "Folder": Folder, "FolderCollection": FolderCollection, "FolderSummary": FolderSummary, @@ -275,12 +292,17 @@ "JobMetricCollection": JobMetricCollection, "JobMetricSummary": JobMetricSummary, "JobSummary": JobSummary, + "LineageObject": LineageObject, + "LineageRelationship": LineageRelationship, "Metastore": Metastore, "MetastoreSummary": MetastoreSummary, "Namespace": Namespace, "NamespaceCollection": NamespaceCollection, "NamespaceSummary": NamespaceSummary, + "ObjectLineage": ObjectLineage, + "ObjectLineageRequestDetails": ObjectLineageRequestDetails, "ObjectRelationship": ObjectRelationship, + "ObjectStorageObjectReference": ObjectStorageObjectReference, "ParseConnectionDetails": ParseConnectionDetails, "Pattern": Pattern, "PatternCollection": PatternCollection, diff --git a/src/oci/data_catalog/models/asynchronous_export_glossary_details.py b/src/oci/data_catalog/models/asynchronous_export_glossary_details.py new file mode 100644 index 0000000000..a5849bf55c --- /dev/null +++ b/src/oci/data_catalog/models/asynchronous_export_glossary_details.py @@ -0,0 +1,68 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AsynchronousExportGlossaryDetails(object): + """ + Details needed by the glossary export request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AsynchronousExportGlossaryDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param object_storage_target: + The value to assign to the object_storage_target property of this AsynchronousExportGlossaryDetails. + :type object_storage_target: oci.data_catalog.models.ObjectStorageObjectReference + + """ + self.swagger_types = { + 'object_storage_target': 'ObjectStorageObjectReference' + } + + self.attribute_map = { + 'object_storage_target': 'objectStorageTarget' + } + + self._object_storage_target = None + + @property + def object_storage_target(self): + """ + Gets the object_storage_target of this AsynchronousExportGlossaryDetails. + + :return: The object_storage_target of this AsynchronousExportGlossaryDetails. + :rtype: oci.data_catalog.models.ObjectStorageObjectReference + """ + return self._object_storage_target + + @object_storage_target.setter + def object_storage_target(self, object_storage_target): + """ + Sets the object_storage_target of this AsynchronousExportGlossaryDetails. + + :param object_storage_target: The object_storage_target of this AsynchronousExportGlossaryDetails. + :type: oci.data_catalog.models.ObjectStorageObjectReference + """ + self._object_storage_target = object_storage_target + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_catalog/models/asynchronous_export_glossary_result.py b/src/oci/data_catalog/models/asynchronous_export_glossary_result.py new file mode 100644 index 0000000000..27888dbb31 --- /dev/null +++ b/src/oci/data_catalog/models/asynchronous_export_glossary_result.py @@ -0,0 +1,196 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AsynchronousExportGlossaryResult(object): + """ + Details about the job which performs an export. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AsynchronousExportGlossaryResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param job_definition_name: + The value to assign to the job_definition_name property of this AsynchronousExportGlossaryResult. + :type job_definition_name: str + + :param job_definition_key: + The value to assign to the job_definition_key property of this AsynchronousExportGlossaryResult. + :type job_definition_key: str + + :param job_key: + The value to assign to the job_key property of this AsynchronousExportGlossaryResult. + :type job_key: str + + :param job_execution_key: + The value to assign to the job_execution_key property of this AsynchronousExportGlossaryResult. + :type job_execution_key: str + + :param source_key: + The value to assign to the source_key property of this AsynchronousExportGlossaryResult. + :type source_key: str + + """ + self.swagger_types = { + 'job_definition_name': 'str', + 'job_definition_key': 'str', + 'job_key': 'str', + 'job_execution_key': 'str', + 'source_key': 'str' + } + + self.attribute_map = { + 'job_definition_name': 'jobDefinitionName', + 'job_definition_key': 'jobDefinitionKey', + 'job_key': 'jobKey', + 'job_execution_key': 'jobExecutionKey', + 'source_key': 'sourceKey' + } + + self._job_definition_name = None + self._job_definition_key = None + self._job_key = None + self._job_execution_key = None + self._source_key = None + + @property + def job_definition_name(self): + """ + Gets the job_definition_name of this AsynchronousExportGlossaryResult. + Display name of the export job. + + + :return: The job_definition_name of this AsynchronousExportGlossaryResult. + :rtype: str + """ + return self._job_definition_name + + @job_definition_name.setter + def job_definition_name(self, job_definition_name): + """ + Sets the job_definition_name of this AsynchronousExportGlossaryResult. + Display name of the export job. + + + :param job_definition_name: The job_definition_name of this AsynchronousExportGlossaryResult. + :type: str + """ + self._job_definition_name = job_definition_name + + @property + def job_definition_key(self): + """ + Gets the job_definition_key of this AsynchronousExportGlossaryResult. + Unique key of the export job definition. + + + :return: The job_definition_key of this AsynchronousExportGlossaryResult. + :rtype: str + """ + return self._job_definition_key + + @job_definition_key.setter + def job_definition_key(self, job_definition_key): + """ + Sets the job_definition_key of this AsynchronousExportGlossaryResult. + Unique key of the export job definition. + + + :param job_definition_key: The job_definition_key of this AsynchronousExportGlossaryResult. + :type: str + """ + self._job_definition_key = job_definition_key + + @property + def job_key(self): + """ + Gets the job_key of this AsynchronousExportGlossaryResult. + Unique key of the export job. + + + :return: The job_key of this AsynchronousExportGlossaryResult. + :rtype: str + """ + return self._job_key + + @job_key.setter + def job_key(self, job_key): + """ + Sets the job_key of this AsynchronousExportGlossaryResult. + Unique key of the export job. + + + :param job_key: The job_key of this AsynchronousExportGlossaryResult. + :type: str + """ + self._job_key = job_key + + @property + def job_execution_key(self): + """ + Gets the job_execution_key of this AsynchronousExportGlossaryResult. + Unique key of the job execution. + + + :return: The job_execution_key of this AsynchronousExportGlossaryResult. + :rtype: str + """ + return self._job_execution_key + + @job_execution_key.setter + def job_execution_key(self, job_execution_key): + """ + Sets the job_execution_key of this AsynchronousExportGlossaryResult. + Unique key of the job execution. + + + :param job_execution_key: The job_execution_key of this AsynchronousExportGlossaryResult. + :type: str + """ + self._job_execution_key = job_execution_key + + @property + def source_key(self): + """ + Gets the source_key of this AsynchronousExportGlossaryResult. + Unique key of the object being exported. + + + :return: The source_key of this AsynchronousExportGlossaryResult. + :rtype: str + """ + return self._source_key + + @source_key.setter + def source_key(self, source_key): + """ + Sets the source_key of this AsynchronousExportGlossaryResult. + Unique key of the object being exported. + + + :param source_key: The source_key of this AsynchronousExportGlossaryResult. + :type: str + """ + self._source_key = source_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_catalog/models/asynchronous_export_request_details.py b/src/oci/data_catalog/models/asynchronous_export_request_details.py new file mode 100644 index 0000000000..90fc70c4de --- /dev/null +++ b/src/oci/data_catalog/models/asynchronous_export_request_details.py @@ -0,0 +1,68 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AsynchronousExportRequestDetails(object): + """ + Details for an export request. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AsynchronousExportRequestDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param object_storage_target: + The value to assign to the object_storage_target property of this AsynchronousExportRequestDetails. + :type object_storage_target: oci.data_catalog.models.ObjectStorageObjectReference + + """ + self.swagger_types = { + 'object_storage_target': 'ObjectStorageObjectReference' + } + + self.attribute_map = { + 'object_storage_target': 'objectStorageTarget' + } + + self._object_storage_target = None + + @property + def object_storage_target(self): + """ + Gets the object_storage_target of this AsynchronousExportRequestDetails. + + :return: The object_storage_target of this AsynchronousExportRequestDetails. + :rtype: oci.data_catalog.models.ObjectStorageObjectReference + """ + return self._object_storage_target + + @object_storage_target.setter + def object_storage_target(self, object_storage_target): + """ + Sets the object_storage_target of this AsynchronousExportRequestDetails. + + :param object_storage_target: The object_storage_target of this AsynchronousExportRequestDetails. + :type: oci.data_catalog.models.ObjectStorageObjectReference + """ + self._object_storage_target = object_storage_target + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_catalog/models/asynchronous_export_result.py b/src/oci/data_catalog/models/asynchronous_export_result.py new file mode 100644 index 0000000000..40423f2037 --- /dev/null +++ b/src/oci/data_catalog/models/asynchronous_export_result.py @@ -0,0 +1,196 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class AsynchronousExportResult(object): + """ + Details about the job which performs an export. + """ + + def __init__(self, **kwargs): + """ + Initializes a new AsynchronousExportResult object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param job_definition_name: + The value to assign to the job_definition_name property of this AsynchronousExportResult. + :type job_definition_name: str + + :param job_definition_key: + The value to assign to the job_definition_key property of this AsynchronousExportResult. + :type job_definition_key: str + + :param job_key: + The value to assign to the job_key property of this AsynchronousExportResult. + :type job_key: str + + :param job_execution_key: + The value to assign to the job_execution_key property of this AsynchronousExportResult. + :type job_execution_key: str + + :param source_key: + The value to assign to the source_key property of this AsynchronousExportResult. + :type source_key: str + + """ + self.swagger_types = { + 'job_definition_name': 'str', + 'job_definition_key': 'str', + 'job_key': 'str', + 'job_execution_key': 'str', + 'source_key': 'str' + } + + self.attribute_map = { + 'job_definition_name': 'jobDefinitionName', + 'job_definition_key': 'jobDefinitionKey', + 'job_key': 'jobKey', + 'job_execution_key': 'jobExecutionKey', + 'source_key': 'sourceKey' + } + + self._job_definition_name = None + self._job_definition_key = None + self._job_key = None + self._job_execution_key = None + self._source_key = None + + @property + def job_definition_name(self): + """ + Gets the job_definition_name of this AsynchronousExportResult. + Display name of the export job. + + + :return: The job_definition_name of this AsynchronousExportResult. + :rtype: str + """ + return self._job_definition_name + + @job_definition_name.setter + def job_definition_name(self, job_definition_name): + """ + Sets the job_definition_name of this AsynchronousExportResult. + Display name of the export job. + + + :param job_definition_name: The job_definition_name of this AsynchronousExportResult. + :type: str + """ + self._job_definition_name = job_definition_name + + @property + def job_definition_key(self): + """ + Gets the job_definition_key of this AsynchronousExportResult. + Unique key of the export job definition. + + + :return: The job_definition_key of this AsynchronousExportResult. + :rtype: str + """ + return self._job_definition_key + + @job_definition_key.setter + def job_definition_key(self, job_definition_key): + """ + Sets the job_definition_key of this AsynchronousExportResult. + Unique key of the export job definition. + + + :param job_definition_key: The job_definition_key of this AsynchronousExportResult. + :type: str + """ + self._job_definition_key = job_definition_key + + @property + def job_key(self): + """ + Gets the job_key of this AsynchronousExportResult. + Unique key of the export job. + + + :return: The job_key of this AsynchronousExportResult. + :rtype: str + """ + return self._job_key + + @job_key.setter + def job_key(self, job_key): + """ + Sets the job_key of this AsynchronousExportResult. + Unique key of the export job. + + + :param job_key: The job_key of this AsynchronousExportResult. + :type: str + """ + self._job_key = job_key + + @property + def job_execution_key(self): + """ + Gets the job_execution_key of this AsynchronousExportResult. + Unique key of the job execution. + + + :return: The job_execution_key of this AsynchronousExportResult. + :rtype: str + """ + return self._job_execution_key + + @job_execution_key.setter + def job_execution_key(self, job_execution_key): + """ + Sets the job_execution_key of this AsynchronousExportResult. + Unique key of the job execution. + + + :param job_execution_key: The job_execution_key of this AsynchronousExportResult. + :type: str + """ + self._job_execution_key = job_execution_key + + @property + def source_key(self): + """ + Gets the source_key of this AsynchronousExportResult. + Unique key of the object being exported. + + + :return: The source_key of this AsynchronousExportResult. + :rtype: str + """ + return self._source_key + + @source_key.setter + def source_key(self, source_key): + """ + Sets the source_key of this AsynchronousExportResult. + Unique key of the object being exported. + + + :param source_key: The source_key of this AsynchronousExportResult. + :type: str + """ + self._source_key = source_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_catalog/models/attribute.py b/src/oci/data_catalog/models/attribute.py index 586a2318a3..6c1fc217c4 100644 --- a/src/oci/data_catalog/models/attribute.py +++ b/src/oci/data_catalog/models/attribute.py @@ -91,6 +91,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Attribute. + :type lifecycle_details: str + :param time_created: The value to assign to the time_created property of this Attribute. :type time_created: datetime @@ -213,6 +217,7 @@ def __init__(self, **kwargs): 'description': 'str', 'entity_key': 'str', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'time_created': 'datetime', 'time_updated': 'datetime', 'created_by_id': 'str', @@ -250,6 +255,7 @@ def __init__(self, **kwargs): 'description': 'description', 'entity_key': 'entityKey', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'created_by_id': 'createdById', @@ -286,6 +292,7 @@ def __init__(self, **kwargs): self._description = None self._entity_key = None self._lifecycle_state = None + self._lifecycle_details = None self._time_created = None self._time_updated = None self._created_by_id = None @@ -467,6 +474,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Attribute. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this Attribute. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Attribute. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this Attribute. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def time_created(self): """ diff --git a/src/oci/data_catalog/models/attribute_summary.py b/src/oci/data_catalog/models/attribute_summary.py index 05b19a4434..eff0232731 100644 --- a/src/oci/data_catalog/models/attribute_summary.py +++ b/src/oci/data_catalog/models/attribute_summary.py @@ -118,6 +118,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this AttributeSummary. + :type lifecycle_details: str + :param time_created: The value to assign to the time_created property of this AttributeSummary. :type time_created: datetime @@ -195,6 +199,7 @@ def __init__(self, **kwargs): 'is_nullable': 'bool', 'uri': 'str', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'time_created': 'datetime', 'external_data_type': 'str', 'type_key': 'str', @@ -226,6 +231,7 @@ def __init__(self, **kwargs): 'is_nullable': 'isNullable', 'uri': 'uri', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'time_created': 'timeCreated', 'external_data_type': 'externalDataType', 'type_key': 'typeKey', @@ -256,6 +262,7 @@ def __init__(self, **kwargs): self._is_nullable = None self._uri = None self._lifecycle_state = None + self._lifecycle_details = None self._time_created = None self._external_data_type = None self._type_key = None @@ -592,6 +599,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this AttributeSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this AttributeSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this AttributeSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this AttributeSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def time_created(self): """ diff --git a/src/oci/data_catalog/models/create_job_definition_details.py b/src/oci/data_catalog/models/create_job_definition_details.py index 804150edc3..3503a60c8d 100644 --- a/src/oci/data_catalog/models/create_job_definition_details.py +++ b/src/oci/data_catalog/models/create_job_definition_details.py @@ -85,6 +85,14 @@ class CreateJobDefinitionDetails(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a CreateJobDefinitionDetails. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a CreateJobDefinitionDetails. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + def __init__(self, **kwargs): """ Initializes a new CreateJobDefinitionDetails object with values from keyword arguments. @@ -100,7 +108,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this CreateJobDefinitionDetails. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :type job_type: str :param is_incremental: @@ -111,6 +119,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this CreateJobDefinitionDetails. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this CreateJobDefinitionDetails. + :type glossary_key: str + :param connection_key: The value to assign to the connection_key property of this CreateJobDefinitionDetails. :type connection_key: str @@ -134,6 +146,7 @@ def __init__(self, **kwargs): 'job_type': 'str', 'is_incremental': 'bool', 'data_asset_key': 'str', + 'glossary_key': 'str', 'connection_key': 'str', 'is_sample_data_extracted': 'bool', 'sample_data_size_in_mbs': 'int', @@ -146,6 +159,7 @@ def __init__(self, **kwargs): 'job_type': 'jobType', 'is_incremental': 'isIncremental', 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey', 'connection_key': 'connectionKey', 'is_sample_data_extracted': 'isSampleDataExtracted', 'sample_data_size_in_mbs': 'sampleDataSizeInMBs', @@ -157,6 +171,7 @@ def __init__(self, **kwargs): self._job_type = None self._is_incremental = None self._data_asset_key = None + self._glossary_key = None self._connection_key = None self._is_sample_data_extracted = None self._sample_data_size_in_mbs = None @@ -218,7 +233,7 @@ def job_type(self): **[Required]** Gets the job_type of this CreateJobDefinitionDetails. Type of the job definition. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :return: The job_type of this CreateJobDefinitionDetails. @@ -236,7 +251,7 @@ def job_type(self, job_type): :param job_type: The job_type of this CreateJobDefinitionDetails. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): raise ValueError( "Invalid value for `job_type`, must be None or one of {0}" @@ -292,6 +307,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this CreateJobDefinitionDetails. + Unique key of the glossary to which this job applies. + + + :return: The glossary_key of this CreateJobDefinitionDetails. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this CreateJobDefinitionDetails. + Unique key of the glossary to which this job applies. + + + :param glossary_key: The glossary_key of this CreateJobDefinitionDetails. + :type: str + """ + self._glossary_key = glossary_key + @property def connection_key(self): """ diff --git a/src/oci/data_catalog/models/create_job_details.py b/src/oci/data_catalog/models/create_job_details.py index 1c165e91aa..6f96e0d80b 100644 --- a/src/oci/data_catalog/models/create_job_details.py +++ b/src/oci/data_catalog/models/create_job_details.py @@ -133,6 +133,7 @@ def schedule_cron_expression(self): Gets the schedule_cron_expression of this CreateJobDetails. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :return: The schedule_cron_expression of this CreateJobDetails. @@ -146,6 +147,7 @@ def schedule_cron_expression(self, schedule_cron_expression): Sets the schedule_cron_expression of this CreateJobDetails. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :param schedule_cron_expression: The schedule_cron_expression of this CreateJobDetails. diff --git a/src/oci/data_catalog/models/create_job_execution_details.py b/src/oci/data_catalog/models/create_job_execution_details.py index 2481feb286..c7a79727b6 100644 --- a/src/oci/data_catalog/models/create_job_execution_details.py +++ b/src/oci/data_catalog/models/create_job_execution_details.py @@ -83,6 +83,14 @@ class CreateJobExecutionDetails(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a CreateJobExecutionDetails. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a CreateJobExecutionDetails. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the lifecycle_state property of a CreateJobExecutionDetails. #: This constant has a value of "CREATED" LIFECYCLE_STATE_CREATED = "CREATED" @@ -122,7 +130,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this CreateJobExecutionDetails. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :type job_type: str :param parent_key: @@ -254,7 +262,7 @@ def job_type(self): Gets the job_type of this CreateJobExecutionDetails. Type of the job execution. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET" + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY" :return: The job_type of this CreateJobExecutionDetails. @@ -272,7 +280,7 @@ def job_type(self, job_type): :param job_type: The job_type of this CreateJobExecutionDetails. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): raise ValueError( "Invalid value for `job_type`, must be None or one of {0}" diff --git a/src/oci/data_catalog/models/data_asset.py b/src/oci/data_catalog/models/data_asset.py index dcd50f59c9..63f8be9832 100644 --- a/src/oci/data_catalog/models/data_asset.py +++ b/src/oci/data_catalog/models/data_asset.py @@ -84,6 +84,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this DataAsset. + :type lifecycle_details: str + :param time_created: The value to assign to the time_created property of this DataAsset. :type time_created: datetime @@ -129,6 +133,7 @@ def __init__(self, **kwargs): 'external_key': 'str', 'type_key': 'str', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'time_created': 'datetime', 'time_updated': 'datetime', 'time_harvested': 'datetime', @@ -148,6 +153,7 @@ def __init__(self, **kwargs): 'external_key': 'externalKey', 'type_key': 'typeKey', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'time_harvested': 'timeHarvested', @@ -166,6 +172,7 @@ def __init__(self, **kwargs): self._external_key = None self._type_key = None self._lifecycle_state = None + self._lifecycle_details = None self._time_created = None self._time_updated = None self._time_harvested = None @@ -352,6 +359,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this DataAsset. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this DataAsset. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this DataAsset. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this DataAsset. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def time_created(self): """ diff --git a/src/oci/data_catalog/models/data_asset_summary.py b/src/oci/data_catalog/models/data_asset_summary.py index 8b3f5f75f0..67f0b28dfb 100644 --- a/src/oci/data_catalog/models/data_asset_summary.py +++ b/src/oci/data_catalog/models/data_asset_summary.py @@ -92,6 +92,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this DataAssetSummary. + :type lifecycle_details: str + """ self.swagger_types = { 'key': 'str', @@ -102,7 +106,8 @@ def __init__(self, **kwargs): 'uri': 'str', 'time_created': 'datetime', 'type_key': 'str', - 'lifecycle_state': 'str' + 'lifecycle_state': 'str', + 'lifecycle_details': 'str' } self.attribute_map = { @@ -114,7 +119,8 @@ def __init__(self, **kwargs): 'uri': 'uri', 'time_created': 'timeCreated', 'type_key': 'typeKey', - 'lifecycle_state': 'lifecycleState' + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails' } self._key = None @@ -126,6 +132,7 @@ def __init__(self, **kwargs): self._time_created = None self._type_key = None self._lifecycle_state = None + self._lifecycle_details = None @property def key(self): @@ -357,6 +364,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this DataAssetSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this DataAssetSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this DataAssetSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this DataAssetSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_catalog/models/entity.py b/src/oci/data_catalog/models/entity.py index de5fd12982..628b891414 100644 --- a/src/oci/data_catalog/models/entity.py +++ b/src/oci/data_catalog/models/entity.py @@ -108,6 +108,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Entity. + :type lifecycle_details: str + :param external_key: The value to assign to the external_key property of this Entity. :type external_key: str @@ -201,6 +205,7 @@ def __init__(self, **kwargs): 'created_by_id': 'str', 'updated_by_id': 'str', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'external_key': 'str', 'pattern_key': 'str', 'realized_expression': 'str', @@ -233,6 +238,7 @@ def __init__(self, **kwargs): 'created_by_id': 'createdById', 'updated_by_id': 'updatedById', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'external_key': 'externalKey', 'pattern_key': 'patternKey', 'realized_expression': 'realizedExpression', @@ -264,6 +270,7 @@ def __init__(self, **kwargs): self._created_by_id = None self._updated_by_id = None self._lifecycle_state = None + self._lifecycle_details = None self._external_key = None self._pattern_key = None self._realized_expression = None @@ -519,6 +526,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Entity. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this Entity. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Entity. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this Entity. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def external_key(self): """ diff --git a/src/oci/data_catalog/models/entity_lineage.py b/src/oci/data_catalog/models/entity_lineage.py new file mode 100644 index 0000000000..88b1936a51 --- /dev/null +++ b/src/oci/data_catalog/models/entity_lineage.py @@ -0,0 +1,222 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class EntityLineage(object): + """ + Lineage for a data entity. + """ + + #: A constant which can be used with the direction property of a EntityLineage. + #: This constant has a value of "UPSTREAM" + DIRECTION_UPSTREAM = "UPSTREAM" + + #: A constant which can be used with the direction property of a EntityLineage. + #: This constant has a value of "BOTH" + DIRECTION_BOTH = "BOTH" + + #: A constant which can be used with the direction property of a EntityLineage. + #: This constant has a value of "DOWNSTREAM" + DIRECTION_DOWNSTREAM = "DOWNSTREAM" + + def __init__(self, **kwargs): + """ + Initializes a new EntityLineage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level: + The value to assign to the level property of this EntityLineage. + :type level: int + + :param direction: + The value to assign to the direction property of this EntityLineage. + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + :type direction: str + + :param objects: + The value to assign to the objects property of this EntityLineage. + :type objects: list[oci.data_catalog.models.LineageObject] + + :param relationships: + The value to assign to the relationships property of this EntityLineage. + :type relationships: list[oci.data_catalog.models.LineageRelationship] + + :param annotations: + The value to assign to the annotations property of this EntityLineage. + :type annotations: dict(str, dict(str, str)) + + """ + self.swagger_types = { + 'level': 'int', + 'direction': 'str', + 'objects': 'list[LineageObject]', + 'relationships': 'list[LineageRelationship]', + 'annotations': 'dict(str, dict(str, str))' + } + + self.attribute_map = { + 'level': 'level', + 'direction': 'direction', + 'objects': 'objects', + 'relationships': 'relationships', + 'annotations': 'annotations' + } + + self._level = None + self._direction = None + self._objects = None + self._relationships = None + self._annotations = None + + @property + def level(self): + """ + **[Required]** Gets the level of this EntityLineage. + Object level at which the lineage is returned. + + + :return: The level of this EntityLineage. + :rtype: int + """ + return self._level + + @level.setter + def level(self, level): + """ + Sets the level of this EntityLineage. + Object level at which the lineage is returned. + + + :param level: The level of this EntityLineage. + :type: int + """ + self._level = level + + @property + def direction(self): + """ + **[Required]** Gets the direction of this EntityLineage. + Direction of the lineage returned. + + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM", 'UNKNOWN_ENUM_VALUE'. + Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. + + + :return: The direction of this EntityLineage. + :rtype: str + """ + return self._direction + + @direction.setter + def direction(self, direction): + """ + Sets the direction of this EntityLineage. + Direction of the lineage returned. + + + :param direction: The direction of this EntityLineage. + :type: str + """ + allowed_values = ["UPSTREAM", "BOTH", "DOWNSTREAM"] + if not value_allowed_none_or_none_sentinel(direction, allowed_values): + direction = 'UNKNOWN_ENUM_VALUE' + self._direction = direction + + @property + def objects(self): + """ + Gets the objects of this EntityLineage. + Set of objects that are involved in the lineage. + + + :return: The objects of this EntityLineage. + :rtype: list[oci.data_catalog.models.LineageObject] + """ + return self._objects + + @objects.setter + def objects(self, objects): + """ + Sets the objects of this EntityLineage. + Set of objects that are involved in the lineage. + + + :param objects: The objects of this EntityLineage. + :type: list[oci.data_catalog.models.LineageObject] + """ + self._objects = objects + + @property + def relationships(self): + """ + Gets the relationships of this EntityLineage. + Set of relationships between the objects in the 'objects' set. + + + :return: The relationships of this EntityLineage. + :rtype: list[oci.data_catalog.models.LineageRelationship] + """ + return self._relationships + + @relationships.setter + def relationships(self, relationships): + """ + Sets the relationships of this EntityLineage. + Set of relationships between the objects in the 'objects' set. + + + :param relationships: The relationships of this EntityLineage. + :type: list[oci.data_catalog.models.LineageRelationship] + """ + self._relationships = relationships + + @property + def annotations(self): + """ + Gets the annotations of this EntityLineage. + A map of maps that contains additional information in explanation of the lineage returned. The map keys are + categories of information and the values are maps of annotation names to their corresponding values. + Every annotation is contained inside a category. + Example: `{\"annotations\": { \"category\": { \"key\": \"value\"}}}` + + + :return: The annotations of this EntityLineage. + :rtype: dict(str, dict(str, str)) + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this EntityLineage. + A map of maps that contains additional information in explanation of the lineage returned. The map keys are + categories of information and the values are maps of annotation names to their corresponding values. + Every annotation is contained inside a category. + Example: `{\"annotations\": { \"category\": { \"key\": \"value\"}}}` + + + :param annotations: The annotations of this EntityLineage. + :type: dict(str, dict(str, str)) + """ + self._annotations = annotations + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_catalog/models/entity_summary.py b/src/oci/data_catalog/models/entity_summary.py index e4aa6c4ff3..76f3e42c57 100644 --- a/src/oci/data_catalog/models/entity_summary.py +++ b/src/oci/data_catalog/models/entity_summary.py @@ -136,6 +136,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this EntitySummary. + :type lifecycle_details: str + :param properties: The value to assign to the properties property of this EntitySummary. :type properties: dict(str, dict(str, str)) @@ -162,6 +166,7 @@ def __init__(self, **kwargs): 'uri': 'str', 'object_storage_url': 'str', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'properties': 'dict(str, dict(str, str))' } @@ -186,6 +191,7 @@ def __init__(self, **kwargs): 'uri': 'uri', 'object_storage_url': 'objectStorageUrl', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'properties': 'properties' } @@ -209,6 +215,7 @@ def __init__(self, **kwargs): self._uri = None self._object_storage_url = None self._lifecycle_state = None + self._lifecycle_details = None self._properties = None @property @@ -711,6 +718,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this EntitySummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this EntitySummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this EntitySummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this EntitySummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def properties(self): """ diff --git a/src/oci/data_catalog/models/faceted_search_date_filter_request.py b/src/oci/data_catalog/models/faceted_search_date_filter_request.py index cb80a65f3b..93ebbb9b9e 100644 --- a/src/oci/data_catalog/models/faceted_search_date_filter_request.py +++ b/src/oci/data_catalog/models/faceted_search_date_filter_request.py @@ -53,7 +53,7 @@ def __init__(self, **kwargs): def field_name(self): """ Gets the field_name of this FacetedSearchDateFilterRequest. - Date field name that needs to be filtered by. + Date field name that needs to be filtered by. Acceptable fields include TimeCreated and TimeUpdated. :return: The field_name of this FacetedSearchDateFilterRequest. @@ -65,7 +65,7 @@ def field_name(self): def field_name(self, field_name): """ Sets the field_name of this FacetedSearchDateFilterRequest. - Date field name that needs to be filtered by. + Date field name that needs to be filtered by. Acceptable fields include TimeCreated and TimeUpdated. :param field_name: The field_name of this FacetedSearchDateFilterRequest. diff --git a/src/oci/data_catalog/models/faceted_search_string_filter_request.py b/src/oci/data_catalog/models/faceted_search_string_filter_request.py index be1f6b6097..053bde39f1 100644 --- a/src/oci/data_catalog/models/faceted_search_string_filter_request.py +++ b/src/oci/data_catalog/models/faceted_search_string_filter_request.py @@ -46,7 +46,8 @@ def __init__(self, **kwargs): def field(self): """ Gets the field of this FacetedSearchStringFilterRequest. - String/boolean/numerical field name that needs to filtered with + String/boolean/numerical field name that needs to be filtered by. + Acceptable field names: CatalogType, AttributeType, FolderType, DataAssetType, CreatedBy, UpdatedBy, Term, Tag, DataAssetName, LifeCycleState. :return: The field of this FacetedSearchStringFilterRequest. @@ -58,7 +59,8 @@ def field(self): def field(self, field): """ Sets the field of this FacetedSearchStringFilterRequest. - String/boolean/numerical field name that needs to filtered with + String/boolean/numerical field name that needs to be filtered by. + Acceptable field names: CatalogType, AttributeType, FolderType, DataAssetType, CreatedBy, UpdatedBy, Term, Tag, DataAssetName, LifeCycleState. :param field: The field of this FacetedSearchStringFilterRequest. @@ -71,6 +73,8 @@ def values(self): """ Gets the values of this FacetedSearchStringFilterRequest. Array of values that the search results needs to be filtered by. + Acceptable values for field 'CatalogType': DataAsset, Folder, DataEntity, Attribute, Term, Category, Glossary, Pattern, Job, Schedule, CustomProperty. + For other fields, acceptable values can be derived by inspecting the data object. :return: The values of this FacetedSearchStringFilterRequest. @@ -83,6 +87,8 @@ def values(self, values): """ Sets the values of this FacetedSearchStringFilterRequest. Array of values that the search results needs to be filtered by. + Acceptable values for field 'CatalogType': DataAsset, Folder, DataEntity, Attribute, Term, Category, Glossary, Pattern, Job, Schedule, CustomProperty. + For other fields, acceptable values can be derived by inspecting the data object. :param values: The values of this FacetedSearchStringFilterRequest. diff --git a/src/oci/data_catalog/models/fetch_entity_lineage_details.py b/src/oci/data_catalog/models/fetch_entity_lineage_details.py new file mode 100644 index 0000000000..e60970bd84 --- /dev/null +++ b/src/oci/data_catalog/models/fetch_entity_lineage_details.py @@ -0,0 +1,190 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class FetchEntityLineageDetails(object): + """ + The information needed to obtain desired lineage. + """ + + #: A constant which can be used with the direction property of a FetchEntityLineageDetails. + #: This constant has a value of "UPSTREAM" + DIRECTION_UPSTREAM = "UPSTREAM" + + #: A constant which can be used with the direction property of a FetchEntityLineageDetails. + #: This constant has a value of "BOTH" + DIRECTION_BOTH = "BOTH" + + #: A constant which can be used with the direction property of a FetchEntityLineageDetails. + #: This constant has a value of "DOWNSTREAM" + DIRECTION_DOWNSTREAM = "DOWNSTREAM" + + def __init__(self, **kwargs): + """ + Initializes a new FetchEntityLineageDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level: + The value to assign to the level property of this FetchEntityLineageDetails. + :type level: int + + :param direction: + The value to assign to the direction property of this FetchEntityLineageDetails. + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + :type direction: str + + :param is_intra_lineage: + The value to assign to the is_intra_lineage property of this FetchEntityLineageDetails. + :type is_intra_lineage: bool + + :param intra_lineage_object_key: + The value to assign to the intra_lineage_object_key property of this FetchEntityLineageDetails. + :type intra_lineage_object_key: str + + """ + self.swagger_types = { + 'level': 'int', + 'direction': 'str', + 'is_intra_lineage': 'bool', + 'intra_lineage_object_key': 'str' + } + + self.attribute_map = { + 'level': 'level', + 'direction': 'direction', + 'is_intra_lineage': 'isIntraLineage', + 'intra_lineage_object_key': 'intraLineageObjectKey' + } + + self._level = None + self._direction = None + self._is_intra_lineage = None + self._intra_lineage_object_key = None + + @property + def level(self): + """ + Gets the level of this FetchEntityLineageDetails. + Object level at which the lineage is returned. + + + :return: The level of this FetchEntityLineageDetails. + :rtype: int + """ + return self._level + + @level.setter + def level(self, level): + """ + Sets the level of this FetchEntityLineageDetails. + Object level at which the lineage is returned. + + + :param level: The level of this FetchEntityLineageDetails. + :type: int + """ + self._level = level + + @property + def direction(self): + """ + Gets the direction of this FetchEntityLineageDetails. + Direction of the lineage returned. + + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + + + :return: The direction of this FetchEntityLineageDetails. + :rtype: str + """ + return self._direction + + @direction.setter + def direction(self, direction): + """ + Sets the direction of this FetchEntityLineageDetails. + Direction of the lineage returned. + + + :param direction: The direction of this FetchEntityLineageDetails. + :type: str + """ + allowed_values = ["UPSTREAM", "BOTH", "DOWNSTREAM"] + if not value_allowed_none_or_none_sentinel(direction, allowed_values): + raise ValueError( + "Invalid value for `direction`, must be None or one of {0}" + .format(allowed_values) + ) + self._direction = direction + + @property + def is_intra_lineage(self): + """ + Gets the is_intra_lineage of this FetchEntityLineageDetails. + Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be + expanded inline in the lineage returned. + + + :return: The is_intra_lineage of this FetchEntityLineageDetails. + :rtype: bool + """ + return self._is_intra_lineage + + @is_intra_lineage.setter + def is_intra_lineage(self, is_intra_lineage): + """ + Sets the is_intra_lineage of this FetchEntityLineageDetails. + Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be + expanded inline in the lineage returned. + + + :param is_intra_lineage: The is_intra_lineage of this FetchEntityLineageDetails. + :type: bool + """ + self._is_intra_lineage = is_intra_lineage + + @property + def intra_lineage_object_key(self): + """ + Gets the intra_lineage_object_key of this FetchEntityLineageDetails. + Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding + to the object whose object key is passed is returned. + + + :return: The intra_lineage_object_key of this FetchEntityLineageDetails. + :rtype: str + """ + return self._intra_lineage_object_key + + @intra_lineage_object_key.setter + def intra_lineage_object_key(self, intra_lineage_object_key): + """ + Sets the intra_lineage_object_key of this FetchEntityLineageDetails. + Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding + to the object whose object key is passed is returned. + + + :param intra_lineage_object_key: The intra_lineage_object_key of this FetchEntityLineageDetails. + :type: str + """ + self._intra_lineage_object_key = intra_lineage_object_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_catalog/models/folder.py b/src/oci/data_catalog/models/folder.py index f8af6a9f61..f80a0f5312 100644 --- a/src/oci/data_catalog/models/folder.py +++ b/src/oci/data_catalog/models/folder.py @@ -149,6 +149,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this Folder. + :type lifecycle_details: str + :param harvest_status: The value to assign to the harvest_status property of this Folder. Allowed values for this property are: "COMPLETE", "ERROR", "IN_PROGRESS", "DEFERRED", 'UNKNOWN_ENUM_VALUE'. @@ -188,6 +192,7 @@ def __init__(self, **kwargs): 'updated_by_id': 'str', 'time_external': 'datetime', 'lifecycle_state': 'str', + 'lifecycle_details': 'str', 'harvest_status': 'str', 'last_job_key': 'str', 'uri': 'str', @@ -214,6 +219,7 @@ def __init__(self, **kwargs): 'updated_by_id': 'updatedById', 'time_external': 'timeExternal', 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails', 'harvest_status': 'harvestStatus', 'last_job_key': 'lastJobKey', 'uri': 'uri', @@ -239,6 +245,7 @@ def __init__(self, **kwargs): self._updated_by_id = None self._time_external = None self._lifecycle_state = None + self._lifecycle_details = None self._harvest_status = None self._last_job_key = None self._uri = None @@ -730,6 +737,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this Folder. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this Folder. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this Folder. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this Folder. + :type: str + """ + self._lifecycle_details = lifecycle_details + @property def harvest_status(self): """ diff --git a/src/oci/data_catalog/models/folder_summary.py b/src/oci/data_catalog/models/folder_summary.py index 3e35824aaa..94685097a0 100644 --- a/src/oci/data_catalog/models/folder_summary.py +++ b/src/oci/data_catalog/models/folder_summary.py @@ -118,6 +118,10 @@ def __init__(self, **kwargs): Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str + :param lifecycle_details: + The value to assign to the lifecycle_details property of this FolderSummary. + :type lifecycle_details: str + """ self.swagger_types = { 'key': 'str', @@ -134,7 +138,8 @@ def __init__(self, **kwargs): 'time_updated': 'datetime', 'uri': 'str', 'object_storage_url': 'str', - 'lifecycle_state': 'str' + 'lifecycle_state': 'str', + 'lifecycle_details': 'str' } self.attribute_map = { @@ -152,7 +157,8 @@ def __init__(self, **kwargs): 'time_updated': 'timeUpdated', 'uri': 'uri', 'object_storage_url': 'objectStorageUrl', - 'lifecycle_state': 'lifecycleState' + 'lifecycle_state': 'lifecycleState', + 'lifecycle_details': 'lifecycleDetails' } self._key = None @@ -170,6 +176,7 @@ def __init__(self, **kwargs): self._uri = None self._object_storage_url = None self._lifecycle_state = None + self._lifecycle_details = None @property def key(self): @@ -549,6 +556,32 @@ def lifecycle_state(self, lifecycle_state): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state + @property + def lifecycle_details(self): + """ + Gets the lifecycle_details of this FolderSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :return: The lifecycle_details of this FolderSummary. + :rtype: str + """ + return self._lifecycle_details + + @lifecycle_details.setter + def lifecycle_details(self, lifecycle_details): + """ + Sets the lifecycle_details of this FolderSummary. + A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, + see service documentation for details. + + + :param lifecycle_details: The lifecycle_details of this FolderSummary. + :type: str + """ + self._lifecycle_details = lifecycle_details + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_catalog/models/job.py b/src/oci/data_catalog/models/job.py index 23b2bf65f8..abbd57bab4 100644 --- a/src/oci/data_catalog/models/job.py +++ b/src/oci/data_catalog/models/job.py @@ -95,6 +95,14 @@ class Job(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a Job. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a Job. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the schedule_type property of a Job. #: This constant has a value of "SCHEDULED" SCHEDULE_TYPE_SCHEDULED = "SCHEDULED" @@ -140,7 +148,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this Job. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -198,6 +206,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this Job. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this Job. + :type glossary_key: str + :param error_code: The value to assign to the error_code property of this Job. :type error_code: str @@ -233,6 +245,7 @@ def __init__(self, **kwargs): 'updated_by_id': 'str', 'job_definition_name': 'str', 'data_asset_key': 'str', + 'glossary_key': 'str', 'error_code': 'str', 'error_message': 'str', 'uri': 'str' @@ -260,6 +273,7 @@ def __init__(self, **kwargs): 'updated_by_id': 'updatedById', 'job_definition_name': 'jobDefinitionName', 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey', 'error_code': 'errorCode', 'error_message': 'errorMessage', 'uri': 'uri' @@ -286,6 +300,7 @@ def __init__(self, **kwargs): self._updated_by_id = None self._job_definition_name = None self._data_asset_key = None + self._glossary_key = None self._error_code = None self._error_message = None self._uri = None @@ -482,7 +497,7 @@ def job_type(self): Gets the job_type of this Job. Type of the job. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -501,7 +516,7 @@ def job_type(self, job_type): :param job_type: The job_type of this Job. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type @@ -512,6 +527,7 @@ def schedule_cron_expression(self): Gets the schedule_cron_expression of this Job. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :return: The schedule_cron_expression of this Job. @@ -525,6 +541,7 @@ def schedule_cron_expression(self, schedule_cron_expression): Sets the schedule_cron_expression of this Job. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :param schedule_cron_expression: The schedule_cron_expression of this Job. @@ -842,6 +859,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this Job. + Unique key of the glossary to which this job applies. + + + :return: The glossary_key of this Job. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this Job. + Unique key of the glossary to which this job applies. + + + :param glossary_key: The glossary_key of this Job. + :type: str + """ + self._glossary_key = glossary_key + @property def error_code(self): """ diff --git a/src/oci/data_catalog/models/job_definition.py b/src/oci/data_catalog/models/job_definition.py index 6e7d3b1021..8c8112e947 100644 --- a/src/oci/data_catalog/models/job_definition.py +++ b/src/oci/data_catalog/models/job_definition.py @@ -85,6 +85,14 @@ class JobDefinition(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a JobDefinition. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a JobDefinition. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the lifecycle_state property of a JobDefinition. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -172,7 +180,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this JobDefinition. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -184,6 +192,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this JobDefinition. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this JobDefinition. + :type glossary_key: str + :param description: The value to assign to the description property of this JobDefinition. :type description: str @@ -262,6 +274,7 @@ def __init__(self, **kwargs): 'job_type': 'str', 'is_incremental': 'bool', 'data_asset_key': 'str', + 'glossary_key': 'str', 'description': 'str', 'connection_key': 'str', 'internal_version': 'str', @@ -287,6 +300,7 @@ def __init__(self, **kwargs): 'job_type': 'jobType', 'is_incremental': 'isIncremental', 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey', 'description': 'description', 'connection_key': 'connectionKey', 'internal_version': 'internalVersion', @@ -311,6 +325,7 @@ def __init__(self, **kwargs): self._job_type = None self._is_incremental = None self._data_asset_key = None + self._glossary_key = None self._description = None self._connection_key = None self._internal_version = None @@ -408,7 +423,7 @@ def job_type(self): Gets the job_type of this JobDefinition. Type of the job definition. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -427,7 +442,7 @@ def job_type(self, job_type): :param job_type: The job_type of this JobDefinition. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type @@ -480,6 +495,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this JobDefinition. + Unique key of the glossary to which this job applies. + + + :return: The glossary_key of this JobDefinition. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this JobDefinition. + Unique key of the glossary to which this job applies. + + + :param glossary_key: The glossary_key of this JobDefinition. + :type: str + """ + self._glossary_key = glossary_key + @property def description(self): """ diff --git a/src/oci/data_catalog/models/job_definition_summary.py b/src/oci/data_catalog/models/job_definition_summary.py index 1428b4ada9..238523a77d 100644 --- a/src/oci/data_catalog/models/job_definition_summary.py +++ b/src/oci/data_catalog/models/job_definition_summary.py @@ -85,6 +85,14 @@ class JobDefinitionSummary(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a JobDefinitionSummary. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a JobDefinitionSummary. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the lifecycle_state property of a JobDefinitionSummary. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" @@ -180,7 +188,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this JobDefinitionSummary. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -226,6 +234,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this JobDefinitionSummary. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this JobDefinitionSummary. + :type glossary_key: str + """ self.swagger_types = { 'key': 'str', @@ -242,7 +254,8 @@ def __init__(self, **kwargs): 'time_latest_execution_ended': 'datetime', 'job_execution_state': 'str', 'schedule_type': 'str', - 'data_asset_key': 'str' + 'data_asset_key': 'str', + 'glossary_key': 'str' } self.attribute_map = { @@ -260,7 +273,8 @@ def __init__(self, **kwargs): 'time_latest_execution_ended': 'timeLatestExecutionEnded', 'job_execution_state': 'jobExecutionState', 'schedule_type': 'scheduleType', - 'data_asset_key': 'dataAssetKey' + 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey' } self._key = None @@ -278,6 +292,7 @@ def __init__(self, **kwargs): self._job_execution_state = None self._schedule_type = None self._data_asset_key = None + self._glossary_key = None @property def key(self): @@ -407,7 +422,7 @@ def job_type(self): Gets the job_type of this JobDefinitionSummary. Type of the job definition. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -426,7 +441,7 @@ def job_type(self, job_type): :param job_type: The job_type of this JobDefinitionSummary. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type @@ -681,6 +696,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this JobDefinitionSummary. + Unique key of the glossary to which this job applies, if the job involves a glossary. + + + :return: The glossary_key of this JobDefinitionSummary. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this JobDefinitionSummary. + Unique key of the glossary to which this job applies, if the job involves a glossary. + + + :param glossary_key: The glossary_key of this JobDefinitionSummary. + :type: str + """ + self._glossary_key = glossary_key + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/data_catalog/models/job_execution.py b/src/oci/data_catalog/models/job_execution.py index dc68e8fe8f..ac262ec41c 100644 --- a/src/oci/data_catalog/models/job_execution.py +++ b/src/oci/data_catalog/models/job_execution.py @@ -83,6 +83,14 @@ class JobExecution(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a JobExecution. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a JobExecution. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the lifecycle_state property of a JobExecution. #: This constant has a value of "CREATED" LIFECYCLE_STATE_CREATED = "CREATED" @@ -126,7 +134,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this JobExecution. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -322,7 +330,7 @@ def job_type(self): Gets the job_type of this JobExecution. Type of the job execution. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -341,7 +349,7 @@ def job_type(self, job_type): :param job_type: The job_type of this JobExecution. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type diff --git a/src/oci/data_catalog/models/job_execution_summary.py b/src/oci/data_catalog/models/job_execution_summary.py index 859ab64ca0..968f154910 100644 --- a/src/oci/data_catalog/models/job_execution_summary.py +++ b/src/oci/data_catalog/models/job_execution_summary.py @@ -83,6 +83,14 @@ class JobExecutionSummary(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a JobExecutionSummary. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a JobExecutionSummary. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + #: A constant which can be used with the lifecycle_state property of a JobExecutionSummary. #: This constant has a value of "CREATED" LIFECYCLE_STATE_CREATED = "CREATED" @@ -126,7 +134,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this JobExecutionSummary. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -252,7 +260,7 @@ def job_type(self): Gets the job_type of this JobExecutionSummary. Type of the job execution. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -271,7 +279,7 @@ def job_type(self, job_type): :param job_type: The job_type of this JobExecutionSummary. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type diff --git a/src/oci/data_catalog/models/job_summary.py b/src/oci/data_catalog/models/job_summary.py index d8f32a6a38..2515563901 100644 --- a/src/oci/data_catalog/models/job_summary.py +++ b/src/oci/data_catalog/models/job_summary.py @@ -95,6 +95,14 @@ class JobSummary(object): #: This constant has a value of "IMPORT_DATA_ASSET" JOB_TYPE_IMPORT_DATA_ASSET = "IMPORT_DATA_ASSET" + #: A constant which can be used with the job_type property of a JobSummary. + #: This constant has a value of "CREATE_SCAN_PROXY" + JOB_TYPE_CREATE_SCAN_PROXY = "CREATE_SCAN_PROXY" + + #: A constant which can be used with the job_type property of a JobSummary. + #: This constant has a value of "ASYNC_EXPORT_GLOSSARY" + JOB_TYPE_ASYNC_EXPORT_GLOSSARY = "ASYNC_EXPORT_GLOSSARY" + def __init__(self, **kwargs): """ Initializes a new JobSummary object with values from keyword arguments. @@ -128,7 +136,7 @@ def __init__(self, **kwargs): :param job_type: The value to assign to the job_type property of this JobSummary. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type job_type: str @@ -180,6 +188,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this JobSummary. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this JobSummary. + :type glossary_key: str + :param error_code: The value to assign to the error_code property of this JobSummary. :type error_code: str @@ -213,6 +225,7 @@ def __init__(self, **kwargs): 'time_of_latest_execution': 'datetime', 'job_definition_name': 'str', 'data_asset_key': 'str', + 'glossary_key': 'str', 'error_code': 'str', 'error_message': 'str', 'executions': 'list[JobExecutionSummary]' @@ -238,6 +251,7 @@ def __init__(self, **kwargs): 'time_of_latest_execution': 'timeOfLatestExecution', 'job_definition_name': 'jobDefinitionName', 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey', 'error_code': 'errorCode', 'error_message': 'errorMessage', 'executions': 'executions' @@ -262,6 +276,7 @@ def __init__(self, **kwargs): self._time_of_latest_execution = None self._job_definition_name = None self._data_asset_key = None + self._glossary_key = None self._error_code = None self._error_message = None self._executions = None @@ -424,7 +439,7 @@ def job_type(self): Gets the job_type of this JobSummary. Type of the job. - Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", 'UNKNOWN_ENUM_VALUE'. + Allowed values for this property are: "HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -443,7 +458,7 @@ def job_type(self, job_type): :param job_type: The job_type of this JobSummary. :type: str """ - allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET"] + allowed_values = ["HARVEST", "PROFILING", "SAMPLING", "PREVIEW", "IMPORT", "EXPORT", "IMPORT_GLOSSARY", "EXPORT_GLOSSARY", "INTERNAL", "PURGE", "IMMEDIATE", "SCHEDULED", "IMMEDIATE_EXECUTION", "SCHEDULED_EXECUTION", "SCHEDULED_EXECUTION_INSTANCE", "ASYNC_DELETE", "IMPORT_DATA_ASSET", "CREATE_SCAN_PROXY", "ASYNC_EXPORT_GLOSSARY"] if not value_allowed_none_or_none_sentinel(job_type, allowed_values): job_type = 'UNKNOWN_ENUM_VALUE' self._job_type = job_type @@ -608,6 +623,7 @@ def schedule_cron_expression(self): Gets the schedule_cron_expression of this JobSummary. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :return: The schedule_cron_expression of this JobSummary. @@ -621,6 +637,7 @@ def schedule_cron_expression(self, schedule_cron_expression): Sets the schedule_cron_expression of this JobSummary. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :param schedule_cron_expression: The schedule_cron_expression of this JobSummary. @@ -758,6 +775,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this JobSummary. + Unique key of the glossary to which this job applies. + + + :return: The glossary_key of this JobSummary. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this JobSummary. + Unique key of the glossary to which this job applies. + + + :param glossary_key: The glossary_key of this JobSummary. + :type: str + """ + self._glossary_key = glossary_key + @property def error_code(self): """ diff --git a/src/oci/data_catalog/models/lineage_object.py b/src/oci/data_catalog/models/lineage_object.py new file mode 100644 index 0000000000..e835c21b13 --- /dev/null +++ b/src/oci/data_catalog/models/lineage_object.py @@ -0,0 +1,400 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LineageObject(object): + """ + Object describing an individual element of object lineage. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LineageObject object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param object_key: + The value to assign to the object_key property of this LineageObject. + :type object_key: str + + :param display_name: + The value to assign to the display_name property of this LineageObject. + :type display_name: str + + :param description: + The value to assign to the description property of this LineageObject. + :type description: str + + :param is_intra_lineage_available: + The value to assign to the is_intra_lineage_available property of this LineageObject. + :type is_intra_lineage_available: bool + + :param parent_key: + The value to assign to the parent_key property of this LineageObject. + :type parent_key: str + + :param parent_path: + The value to assign to the parent_path property of this LineageObject. + :type parent_path: str + + :param time_created: + The value to assign to the time_created property of this LineageObject. + :type time_created: datetime + + :param time_updated: + The value to assign to the time_updated property of this LineageObject. + :type time_updated: datetime + + :param type_name: + The value to assign to the type_name property of this LineageObject. + :type type_name: str + + :param type_key: + The value to assign to the type_key property of this LineageObject. + :type type_key: str + + :param properties: + The value to assign to the properties property of this LineageObject. + :type properties: dict(str, dict(str, str)) + + """ + self.swagger_types = { + 'object_key': 'str', + 'display_name': 'str', + 'description': 'str', + 'is_intra_lineage_available': 'bool', + 'parent_key': 'str', + 'parent_path': 'str', + 'time_created': 'datetime', + 'time_updated': 'datetime', + 'type_name': 'str', + 'type_key': 'str', + 'properties': 'dict(str, dict(str, str))' + } + + self.attribute_map = { + 'object_key': 'objectKey', + 'display_name': 'displayName', + 'description': 'description', + 'is_intra_lineage_available': 'isIntraLineageAvailable', + 'parent_key': 'parentKey', + 'parent_path': 'parentPath', + 'time_created': 'timeCreated', + 'time_updated': 'timeUpdated', + 'type_name': 'typeName', + 'type_key': 'typeKey', + 'properties': 'properties' + } + + self._object_key = None + self._display_name = None + self._description = None + self._is_intra_lineage_available = None + self._parent_key = None + self._parent_path = None + self._time_created = None + self._time_updated = None + self._type_name = None + self._type_key = None + self._properties = None + + @property + def object_key(self): + """ + Gets the object_key of this LineageObject. + Key of the object, such as an entity, about which this lineage applies. + + + :return: The object_key of this LineageObject. + :rtype: str + """ + return self._object_key + + @object_key.setter + def object_key(self, object_key): + """ + Sets the object_key of this LineageObject. + Key of the object, such as an entity, about which this lineage applies. + + + :param object_key: The object_key of this LineageObject. + :type: str + """ + self._object_key = object_key + + @property + def display_name(self): + """ + Gets the display_name of this LineageObject. + Display name of the object. + + + :return: The display_name of this LineageObject. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this LineageObject. + Display name of the object. + + + :param display_name: The display_name of this LineageObject. + :type: str + """ + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this LineageObject. + Detailed description of the object. + + + :return: The description of this LineageObject. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this LineageObject. + Detailed description of the object. + + + :param description: The description of this LineageObject. + :type: str + """ + self._description = description + + @property + def is_intra_lineage_available(self): + """ + Gets the is_intra_lineage_available of this LineageObject. + Indicates if intra-lineage is available for this given object. If yes, drill-down can be requested for + this object. + + + :return: The is_intra_lineage_available of this LineageObject. + :rtype: bool + """ + return self._is_intra_lineage_available + + @is_intra_lineage_available.setter + def is_intra_lineage_available(self, is_intra_lineage_available): + """ + Sets the is_intra_lineage_available of this LineageObject. + Indicates if intra-lineage is available for this given object. If yes, drill-down can be requested for + this object. + + + :param is_intra_lineage_available: The is_intra_lineage_available of this LineageObject. + :type: bool + """ + self._is_intra_lineage_available = is_intra_lineage_available + + @property + def parent_key(self): + """ + Gets the parent_key of this LineageObject. + Key of the parent object for this object. + + + :return: The parent_key of this LineageObject. + :rtype: str + """ + return self._parent_key + + @parent_key.setter + def parent_key(self, parent_key): + """ + Sets the parent_key of this LineageObject. + Key of the parent object for this object. + + + :param parent_key: The parent_key of this LineageObject. + :type: str + """ + self._parent_key = parent_key + + @property + def parent_path(self): + """ + Gets the parent_path of this LineageObject. + Full path of the parent object. + + + :return: The parent_path of this LineageObject. + :rtype: str + """ + return self._parent_path + + @parent_path.setter + def parent_path(self, parent_path): + """ + Sets the parent_path of this LineageObject. + Full path of the parent object. + + + :param parent_path: The parent_path of this LineageObject. + :type: str + """ + self._parent_path = parent_path + + @property + def time_created(self): + """ + Gets the time_created of this LineageObject. + The time that this object was created. An `RFC3339`__ formatted datetime string. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_created of this LineageObject. + :rtype: datetime + """ + return self._time_created + + @time_created.setter + def time_created(self, time_created): + """ + Sets the time_created of this LineageObject. + The time that this object was created. An `RFC3339`__ formatted datetime string. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_created: The time_created of this LineageObject. + :type: datetime + """ + self._time_created = time_created + + @property + def time_updated(self): + """ + Gets the time_updated of this LineageObject. + The time that this object was updated. An `RFC3339`__ formatted datetime string. + + __ https://tools.ietf.org/html/rfc3339 + + + :return: The time_updated of this LineageObject. + :rtype: datetime + """ + return self._time_updated + + @time_updated.setter + def time_updated(self, time_updated): + """ + Sets the time_updated of this LineageObject. + The time that this object was updated. An `RFC3339`__ formatted datetime string. + + __ https://tools.ietf.org/html/rfc3339 + + + :param time_updated: The time_updated of this LineageObject. + :type: datetime + """ + self._time_updated = time_updated + + @property + def type_name(self): + """ + Gets the type_name of this LineageObject. + Type name of the object. Type keys can be found via the '/types' endpoint. + + + :return: The type_name of this LineageObject. + :rtype: str + """ + return self._type_name + + @type_name.setter + def type_name(self, type_name): + """ + Sets the type_name of this LineageObject. + Type name of the object. Type keys can be found via the '/types' endpoint. + + + :param type_name: The type_name of this LineageObject. + :type: str + """ + self._type_name = type_name + + @property + def type_key(self): + """ + Gets the type_key of this LineageObject. + Type key of the object. Type keys can be found via the '/types' endpoint. + + + :return: The type_key of this LineageObject. + :rtype: str + """ + return self._type_key + + @type_key.setter + def type_key(self, type_key): + """ + Sets the type_key of this LineageObject. + Type key of the object. Type keys can be found via the '/types' endpoint. + + + :param type_key: The type_key of this LineageObject. + :type: str + """ + self._type_key = type_key + + @property + def properties(self): + """ + Gets the properties of this LineageObject. + A map of maps that contains the properties which are specific to the entity type. Each entity type + definition defines it's set of required and optional properties. The map keys are category names and the + values are maps of property name to property value. Every property is contained inside of a category. Most + data entities have required properties within the \"default\" category. + Example: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}` + + + :return: The properties of this LineageObject. + :rtype: dict(str, dict(str, str)) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this LineageObject. + A map of maps that contains the properties which are specific to the entity type. Each entity type + definition defines it's set of required and optional properties. The map keys are category names and the + values are maps of property name to property value. Every property is contained inside of a category. Most + data entities have required properties within the \"default\" category. + Example: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}` + + + :param properties: The properties of this LineageObject. + :type: dict(str, dict(str, str)) + """ + self._properties = properties + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_catalog/models/lineage_relationship.py b/src/oci/data_catalog/models/lineage_relationship.py new file mode 100644 index 0000000000..c808796647 --- /dev/null +++ b/src/oci/data_catalog/models/lineage_relationship.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class LineageRelationship(object): + """ + Declares how two elements of object lineage are related. + """ + + def __init__(self, **kwargs): + """ + Initializes a new LineageRelationship object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param from_object_key: + The value to assign to the from_object_key property of this LineageRelationship. + :type from_object_key: str + + :param to_object_key: + The value to assign to the to_object_key property of this LineageRelationship. + :type to_object_key: str + + :param relationship_type: + The value to assign to the relationship_type property of this LineageRelationship. + :type relationship_type: str + + """ + self.swagger_types = { + 'from_object_key': 'str', + 'to_object_key': 'str', + 'relationship_type': 'str' + } + + self.attribute_map = { + 'from_object_key': 'fromObjectKey', + 'to_object_key': 'toObjectKey', + 'relationship_type': 'relationshipType' + } + + self._from_object_key = None + self._to_object_key = None + self._relationship_type = None + + @property + def from_object_key(self): + """ + Gets the from_object_key of this LineageRelationship. + Object key of source lineage element. + + + :return: The from_object_key of this LineageRelationship. + :rtype: str + """ + return self._from_object_key + + @from_object_key.setter + def from_object_key(self, from_object_key): + """ + Sets the from_object_key of this LineageRelationship. + Object key of source lineage element. + + + :param from_object_key: The from_object_key of this LineageRelationship. + :type: str + """ + self._from_object_key = from_object_key + + @property + def to_object_key(self): + """ + Gets the to_object_key of this LineageRelationship. + Object key of target lineage element. + + + :return: The to_object_key of this LineageRelationship. + :rtype: str + """ + return self._to_object_key + + @to_object_key.setter + def to_object_key(self, to_object_key): + """ + Sets the to_object_key of this LineageRelationship. + Object key of target lineage element. + + + :param to_object_key: The to_object_key of this LineageRelationship. + :type: str + """ + self._to_object_key = to_object_key + + @property + def relationship_type(self): + """ + Gets the relationship_type of this LineageRelationship. + Type of the relationship. + + + :return: The relationship_type of this LineageRelationship. + :rtype: str + """ + return self._relationship_type + + @relationship_type.setter + def relationship_type(self, relationship_type): + """ + Sets the relationship_type of this LineageRelationship. + Type of the relationship. + + + :param relationship_type: The relationship_type of this LineageRelationship. + :type: str + """ + self._relationship_type = relationship_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_catalog/models/object_lineage.py b/src/oci/data_catalog/models/object_lineage.py new file mode 100644 index 0000000000..6c1899ca35 --- /dev/null +++ b/src/oci/data_catalog/models/object_lineage.py @@ -0,0 +1,223 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectLineage(object): + """ + Lineage for an object. + """ + + #: A constant which can be used with the direction property of a ObjectLineage. + #: This constant has a value of "UPSTREAM" + DIRECTION_UPSTREAM = "UPSTREAM" + + #: A constant which can be used with the direction property of a ObjectLineage. + #: This constant has a value of "BOTH" + DIRECTION_BOTH = "BOTH" + + #: A constant which can be used with the direction property of a ObjectLineage. + #: This constant has a value of "DOWNSTREAM" + DIRECTION_DOWNSTREAM = "DOWNSTREAM" + + def __init__(self, **kwargs): + """ + Initializes a new ObjectLineage object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level: + The value to assign to the level property of this ObjectLineage. + :type level: int + + :param direction: + The value to assign to the direction property of this ObjectLineage. + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + :type direction: str + + :param objects: + The value to assign to the objects property of this ObjectLineage. + :type objects: list[oci.data_catalog.models.LineageObject] + + :param relationships: + The value to assign to the relationships property of this ObjectLineage. + :type relationships: list[oci.data_catalog.models.LineageRelationship] + + :param annotations: + The value to assign to the annotations property of this ObjectLineage. + :type annotations: dict(str, dict(str, str)) + + """ + self.swagger_types = { + 'level': 'int', + 'direction': 'str', + 'objects': 'list[LineageObject]', + 'relationships': 'list[LineageRelationship]', + 'annotations': 'dict(str, dict(str, str))' + } + + self.attribute_map = { + 'level': 'level', + 'direction': 'direction', + 'objects': 'objects', + 'relationships': 'relationships', + 'annotations': 'annotations' + } + + self._level = None + self._direction = None + self._objects = None + self._relationships = None + self._annotations = None + + @property + def level(self): + """ + **[Required]** Gets the level of this ObjectLineage. + Object level at which the lineage is returned. + + + :return: The level of this ObjectLineage. + :rtype: int + """ + return self._level + + @level.setter + def level(self, level): + """ + Sets the level of this ObjectLineage. + Object level at which the lineage is returned. + + + :param level: The level of this ObjectLineage. + :type: int + """ + self._level = level + + @property + def direction(self): + """ + **[Required]** Gets the direction of this ObjectLineage. + Direction of the lineage returned. + + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + + + :return: The direction of this ObjectLineage. + :rtype: str + """ + return self._direction + + @direction.setter + def direction(self, direction): + """ + Sets the direction of this ObjectLineage. + Direction of the lineage returned. + + + :param direction: The direction of this ObjectLineage. + :type: str + """ + allowed_values = ["UPSTREAM", "BOTH", "DOWNSTREAM"] + if not value_allowed_none_or_none_sentinel(direction, allowed_values): + raise ValueError( + "Invalid value for `direction`, must be None or one of {0}" + .format(allowed_values) + ) + self._direction = direction + + @property + def objects(self): + """ + Gets the objects of this ObjectLineage. + Set of objects that are involved in the lineage. + + + :return: The objects of this ObjectLineage. + :rtype: list[oci.data_catalog.models.LineageObject] + """ + return self._objects + + @objects.setter + def objects(self, objects): + """ + Sets the objects of this ObjectLineage. + Set of objects that are involved in the lineage. + + + :param objects: The objects of this ObjectLineage. + :type: list[oci.data_catalog.models.LineageObject] + """ + self._objects = objects + + @property + def relationships(self): + """ + Gets the relationships of this ObjectLineage. + Set of relationships between the objects in the 'objects' set. + + + :return: The relationships of this ObjectLineage. + :rtype: list[oci.data_catalog.models.LineageRelationship] + """ + return self._relationships + + @relationships.setter + def relationships(self, relationships): + """ + Sets the relationships of this ObjectLineage. + Set of relationships between the objects in the 'objects' set. + + + :param relationships: The relationships of this ObjectLineage. + :type: list[oci.data_catalog.models.LineageRelationship] + """ + self._relationships = relationships + + @property + def annotations(self): + """ + Gets the annotations of this ObjectLineage. + A map of maps that contains additional information in explanation of the lineage returned. The map keys are + categories of information and the values are maps of annotation names to their corresponding values. + Every annotation is contained inside a category. + Example: `{\"annotations\": { \"category\": { \"key\": \"value\"}}}` + + + :return: The annotations of this ObjectLineage. + :rtype: dict(str, dict(str, str)) + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this ObjectLineage. + A map of maps that contains additional information in explanation of the lineage returned. The map keys are + categories of information and the values are maps of annotation names to their corresponding values. + Every annotation is contained inside a category. + Example: `{\"annotations\": { \"category\": { \"key\": \"value\"}}}` + + + :param annotations: The annotations of this ObjectLineage. + :type: dict(str, dict(str, str)) + """ + self._annotations = annotations + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + 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_catalog/models/object_lineage_request_details.py b/src/oci/data_catalog/models/object_lineage_request_details.py new file mode 100644 index 0000000000..d26d80d377 --- /dev/null +++ b/src/oci/data_catalog/models/object_lineage_request_details.py @@ -0,0 +1,190 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectLineageRequestDetails(object): + """ + Details needed by a lineage fetch request. + """ + + #: A constant which can be used with the direction property of a ObjectLineageRequestDetails. + #: This constant has a value of "UPSTREAM" + DIRECTION_UPSTREAM = "UPSTREAM" + + #: A constant which can be used with the direction property of a ObjectLineageRequestDetails. + #: This constant has a value of "BOTH" + DIRECTION_BOTH = "BOTH" + + #: A constant which can be used with the direction property of a ObjectLineageRequestDetails. + #: This constant has a value of "DOWNSTREAM" + DIRECTION_DOWNSTREAM = "DOWNSTREAM" + + def __init__(self, **kwargs): + """ + Initializes a new ObjectLineageRequestDetails object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param level: + The value to assign to the level property of this ObjectLineageRequestDetails. + :type level: int + + :param direction: + The value to assign to the direction property of this ObjectLineageRequestDetails. + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + :type direction: str + + :param is_intra_lineage: + The value to assign to the is_intra_lineage property of this ObjectLineageRequestDetails. + :type is_intra_lineage: bool + + :param intra_lineage_object_key: + The value to assign to the intra_lineage_object_key property of this ObjectLineageRequestDetails. + :type intra_lineage_object_key: str + + """ + self.swagger_types = { + 'level': 'int', + 'direction': 'str', + 'is_intra_lineage': 'bool', + 'intra_lineage_object_key': 'str' + } + + self.attribute_map = { + 'level': 'level', + 'direction': 'direction', + 'is_intra_lineage': 'isIntraLineage', + 'intra_lineage_object_key': 'intraLineageObjectKey' + } + + self._level = None + self._direction = None + self._is_intra_lineage = None + self._intra_lineage_object_key = None + + @property + def level(self): + """ + Gets the level of this ObjectLineageRequestDetails. + Object level at which the lineage is returned. + + + :return: The level of this ObjectLineageRequestDetails. + :rtype: int + """ + return self._level + + @level.setter + def level(self, level): + """ + Sets the level of this ObjectLineageRequestDetails. + Object level at which the lineage is returned. + + + :param level: The level of this ObjectLineageRequestDetails. + :type: int + """ + self._level = level + + @property + def direction(self): + """ + Gets the direction of this ObjectLineageRequestDetails. + Direction of the lineage returned. + + Allowed values for this property are: "UPSTREAM", "BOTH", "DOWNSTREAM" + + + :return: The direction of this ObjectLineageRequestDetails. + :rtype: str + """ + return self._direction + + @direction.setter + def direction(self, direction): + """ + Sets the direction of this ObjectLineageRequestDetails. + Direction of the lineage returned. + + + :param direction: The direction of this ObjectLineageRequestDetails. + :type: str + """ + allowed_values = ["UPSTREAM", "BOTH", "DOWNSTREAM"] + if not value_allowed_none_or_none_sentinel(direction, allowed_values): + raise ValueError( + "Invalid value for `direction`, must be None or one of {0}" + .format(allowed_values) + ) + self._direction = direction + + @property + def is_intra_lineage(self): + """ + Gets the is_intra_lineage of this ObjectLineageRequestDetails. + Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be + expanded inline in the lineage returned. + + + :return: The is_intra_lineage of this ObjectLineageRequestDetails. + :rtype: bool + """ + return self._is_intra_lineage + + @is_intra_lineage.setter + def is_intra_lineage(self, is_intra_lineage): + """ + Sets the is_intra_lineage of this ObjectLineageRequestDetails. + Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be + expanded inline in the lineage returned. + + + :param is_intra_lineage: The is_intra_lineage of this ObjectLineageRequestDetails. + :type: bool + """ + self._is_intra_lineage = is_intra_lineage + + @property + def intra_lineage_object_key(self): + """ + Gets the intra_lineage_object_key of this ObjectLineageRequestDetails. + Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding + to the object whose object key is passed is returned. + + + :return: The intra_lineage_object_key of this ObjectLineageRequestDetails. + :rtype: str + """ + return self._intra_lineage_object_key + + @intra_lineage_object_key.setter + def intra_lineage_object_key(self, intra_lineage_object_key): + """ + Sets the intra_lineage_object_key of this ObjectLineageRequestDetails. + Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding + to the object whose object key is passed is returned. + + + :param intra_lineage_object_key: The intra_lineage_object_key of this ObjectLineageRequestDetails. + :type: str + """ + self._intra_lineage_object_key = intra_lineage_object_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_catalog/models/object_storage_object_reference.py b/src/oci/data_catalog/models/object_storage_object_reference.py new file mode 100644 index 0000000000..1fa186a884 --- /dev/null +++ b/src/oci/data_catalog/models/object_storage_object_reference.py @@ -0,0 +1,134 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190325 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ObjectStorageObjectReference(object): + """ + A reference to an Object Storage object. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ObjectStorageObjectReference object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param namespace_name: + The value to assign to the namespace_name property of this ObjectStorageObjectReference. + :type namespace_name: str + + :param bucket_name: + The value to assign to the bucket_name property of this ObjectStorageObjectReference. + :type bucket_name: str + + :param object_name: + The value to assign to the object_name property of this ObjectStorageObjectReference. + :type object_name: str + + """ + self.swagger_types = { + 'namespace_name': 'str', + 'bucket_name': 'str', + 'object_name': 'str' + } + + self.attribute_map = { + 'namespace_name': 'namespaceName', + 'bucket_name': 'bucketName', + 'object_name': 'objectName' + } + + self._namespace_name = None + self._bucket_name = None + self._object_name = None + + @property + def namespace_name(self): + """ + **[Required]** Gets the namespace_name of this ObjectStorageObjectReference. + Object Storage namespace. + + + :return: The namespace_name of this ObjectStorageObjectReference. + :rtype: str + """ + return self._namespace_name + + @namespace_name.setter + def namespace_name(self, namespace_name): + """ + Sets the namespace_name of this ObjectStorageObjectReference. + Object Storage namespace. + + + :param namespace_name: The namespace_name of this ObjectStorageObjectReference. + :type: str + """ + self._namespace_name = namespace_name + + @property + def bucket_name(self): + """ + **[Required]** Gets the bucket_name of this ObjectStorageObjectReference. + Object Storage bucket name. + + + :return: The bucket_name of this ObjectStorageObjectReference. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ObjectStorageObjectReference. + Object Storage bucket name. + + + :param bucket_name: The bucket_name of this ObjectStorageObjectReference. + :type: str + """ + self._bucket_name = bucket_name + + @property + def object_name(self): + """ + **[Required]** Gets the object_name of this ObjectStorageObjectReference. + Object Storage object name. + + + :return: The object_name of this ObjectStorageObjectReference. + :rtype: str + """ + return self._object_name + + @object_name.setter + def object_name(self, object_name): + """ + Sets the object_name of this ObjectStorageObjectReference. + Object Storage object name. + + + :param object_name: The object_name of this ObjectStorageObjectReference. + :type: str + """ + self._object_name = object_name + + def __repr__(self): + return formatted_flat_dict(self) + + def __eq__(self, other): + if other is None: + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + return not self == other diff --git a/src/oci/data_catalog/models/update_job_definition_details.py b/src/oci/data_catalog/models/update_job_definition_details.py index ff0bbdc707..63033475f0 100644 --- a/src/oci/data_catalog/models/update_job_definition_details.py +++ b/src/oci/data_catalog/models/update_job_definition_details.py @@ -32,6 +32,10 @@ def __init__(self, **kwargs): The value to assign to the data_asset_key property of this UpdateJobDefinitionDetails. :type data_asset_key: str + :param glossary_key: + The value to assign to the glossary_key property of this UpdateJobDefinitionDetails. + :type glossary_key: str + :param description: The value to assign to the description property of this UpdateJobDefinitionDetails. :type description: str @@ -57,6 +61,7 @@ def __init__(self, **kwargs): 'display_name': 'str', 'is_incremental': 'bool', 'data_asset_key': 'str', + 'glossary_key': 'str', 'description': 'str', 'connection_key': 'str', 'is_sample_data_extracted': 'bool', @@ -68,6 +73,7 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'is_incremental': 'isIncremental', 'data_asset_key': 'dataAssetKey', + 'glossary_key': 'glossaryKey', 'description': 'description', 'connection_key': 'connectionKey', 'is_sample_data_extracted': 'isSampleDataExtracted', @@ -78,6 +84,7 @@ def __init__(self, **kwargs): self._display_name = None self._is_incremental = None self._data_asset_key = None + self._glossary_key = None self._description = None self._connection_key = None self._is_sample_data_extracted = None @@ -158,6 +165,30 @@ def data_asset_key(self, data_asset_key): """ self._data_asset_key = data_asset_key + @property + def glossary_key(self): + """ + Gets the glossary_key of this UpdateJobDefinitionDetails. + Unique key of the glossary to which this job applies. + + + :return: The glossary_key of this UpdateJobDefinitionDetails. + :rtype: str + """ + return self._glossary_key + + @glossary_key.setter + def glossary_key(self, glossary_key): + """ + Sets the glossary_key of this UpdateJobDefinitionDetails. + Unique key of the glossary to which this job applies. + + + :param glossary_key: The glossary_key of this UpdateJobDefinitionDetails. + :type: str + """ + self._glossary_key = glossary_key + @property def description(self): """ diff --git a/src/oci/data_catalog/models/update_job_details.py b/src/oci/data_catalog/models/update_job_details.py index be70d84930..ee80999726 100644 --- a/src/oci/data_catalog/models/update_job_details.py +++ b/src/oci/data_catalog/models/update_job_details.py @@ -126,6 +126,7 @@ def schedule_cron_expression(self): Gets the schedule_cron_expression of this UpdateJobDetails. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :return: The schedule_cron_expression of this UpdateJobDetails. @@ -139,6 +140,7 @@ def schedule_cron_expression(self, schedule_cron_expression): Sets the schedule_cron_expression of this UpdateJobDetails. Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. + For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. :param schedule_cron_expression: The schedule_cron_expression of this UpdateJobDetails. diff --git a/src/oci/queue/models/__init__.py b/src/oci/queue/models/__init__.py index db7c5caaea..b76f1e3552 100644 --- a/src/oci/queue/models/__init__.py +++ b/src/oci/queue/models/__init__.py @@ -7,6 +7,7 @@ from __future__ import absolute_import from .change_queue_compartment_details import ChangeQueueCompartmentDetails +from .channel_collection import ChannelCollection from .create_queue_details import CreateQueueDetails from .delete_messages_details import DeleteMessagesDetails from .delete_messages_details_entry import DeleteMessagesDetailsEntry @@ -14,6 +15,7 @@ from .delete_messages_result_entry import DeleteMessagesResultEntry from .get_message import GetMessage from .get_messages import GetMessages +from .message_metadata import MessageMetadata from .purge_queue_details import PurgeQueueDetails from .put_message import PutMessage from .put_messages import PutMessages @@ -43,6 +45,7 @@ # Maps type names to classes for queue services. queue_type_mapping = { "ChangeQueueCompartmentDetails": ChangeQueueCompartmentDetails, + "ChannelCollection": ChannelCollection, "CreateQueueDetails": CreateQueueDetails, "DeleteMessagesDetails": DeleteMessagesDetails, "DeleteMessagesDetailsEntry": DeleteMessagesDetailsEntry, @@ -50,6 +53,7 @@ "DeleteMessagesResultEntry": DeleteMessagesResultEntry, "GetMessage": GetMessage, "GetMessages": GetMessages, + "MessageMetadata": MessageMetadata, "PurgeQueueDetails": PurgeQueueDetails, "PutMessage": PutMessage, "PutMessages": PutMessages, diff --git a/src/oci/queue/models/channel_collection.py b/src/oci/queue/models/channel_collection.py new file mode 100644 index 0000000000..874243038c --- /dev/null +++ b/src/oci/queue/models/channel_collection.py @@ -0,0 +1,72 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class ChannelCollection(object): + """ + List of IDs of non-empty channels. + """ + + def __init__(self, **kwargs): + """ + Initializes a new ChannelCollection 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 ChannelCollection. + :type items: list[str] + + """ + self.swagger_types = { + 'items': 'list[str]' + } + + self.attribute_map = { + 'items': 'items' + } + + self._items = None + + @property + def items(self): + """ + **[Required]** Gets the items of this ChannelCollection. + The approximate list of IDs of non-empty channels. + + + :return: The items of this ChannelCollection. + :rtype: list[str] + """ + return self._items + + @items.setter + def items(self, items): + """ + Sets the items of this ChannelCollection. + The approximate list of IDs of non-empty channels. + + + :param items: The items of this ChannelCollection. + :type: list[str] + """ + 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/queue/models/create_queue_details.py b/src/oci/queue/models/create_queue_details.py index d9125f14c1..0f73b978c2 100644 --- a/src/oci/queue/models/create_queue_details.py +++ b/src/oci/queue/models/create_queue_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class CreateQueueDetails(object): """ - The information about new Queue. + The information about a new queue. """ def __init__(self, **kwargs): @@ -40,6 +40,10 @@ def __init__(self, **kwargs): The value to assign to the timeout_in_seconds property of this CreateQueueDetails. :type timeout_in_seconds: int + :param channel_consumption_limit: + The value to assign to the channel_consumption_limit property of this CreateQueueDetails. + :type channel_consumption_limit: int + :param dead_letter_queue_delivery_count: The value to assign to the dead_letter_queue_delivery_count property of this CreateQueueDetails. :type dead_letter_queue_delivery_count: int @@ -63,6 +67,7 @@ def __init__(self, **kwargs): 'retention_in_seconds': 'int', 'visibility_in_seconds': 'int', 'timeout_in_seconds': 'int', + 'channel_consumption_limit': 'int', 'dead_letter_queue_delivery_count': 'int', 'custom_encryption_key_id': 'str', 'freeform_tags': 'dict(str, str)', @@ -75,6 +80,7 @@ def __init__(self, **kwargs): 'retention_in_seconds': 'retentionInSeconds', 'visibility_in_seconds': 'visibilityInSeconds', 'timeout_in_seconds': 'timeoutInSeconds', + 'channel_consumption_limit': 'channelConsumptionLimit', 'dead_letter_queue_delivery_count': 'deadLetterQueueDeliveryCount', 'custom_encryption_key_id': 'customEncryptionKeyId', 'freeform_tags': 'freeformTags', @@ -86,6 +92,7 @@ def __init__(self, **kwargs): self._retention_in_seconds = None self._visibility_in_seconds = None self._timeout_in_seconds = None + self._channel_consumption_limit = None self._dead_letter_queue_delivery_count = None self._custom_encryption_key_id = None self._freeform_tags = None @@ -95,7 +102,7 @@ def __init__(self, **kwargs): def display_name(self): """ **[Required]** Gets the display_name of this CreateQueueDetails. - Queue Identifier + The user-friendly name of the queue. :return: The display_name of this CreateQueueDetails. @@ -107,7 +114,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this CreateQueueDetails. - Queue Identifier + The user-friendly name of the queue. :param display_name: The display_name of this CreateQueueDetails. @@ -119,7 +126,9 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this CreateQueueDetails. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The compartment_id of this CreateQueueDetails. @@ -131,7 +140,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this CreateQueueDetails. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this CreateQueueDetails. @@ -143,7 +154,7 @@ def compartment_id(self, compartment_id): def retention_in_seconds(self): """ Gets the retention_in_seconds of this CreateQueueDetails. - The retention period of the messages in the queue, in seconds. + The retention period of messages in the queue, in seconds. :return: The retention_in_seconds of this CreateQueueDetails. @@ -155,7 +166,7 @@ def retention_in_seconds(self): def retention_in_seconds(self, retention_in_seconds): """ Sets the retention_in_seconds of this CreateQueueDetails. - The retention period of the messages in the queue, in seconds. + The retention period of messages in the queue, in seconds. :param retention_in_seconds: The retention_in_seconds of this CreateQueueDetails. @@ -167,7 +178,7 @@ def retention_in_seconds(self, retention_in_seconds): def visibility_in_seconds(self): """ Gets the visibility_in_seconds of this CreateQueueDetails. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :return: The visibility_in_seconds of this CreateQueueDetails. @@ -179,7 +190,7 @@ def visibility_in_seconds(self): def visibility_in_seconds(self, visibility_in_seconds): """ Sets the visibility_in_seconds of this CreateQueueDetails. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :param visibility_in_seconds: The visibility_in_seconds of this CreateQueueDetails. @@ -211,6 +222,30 @@ def timeout_in_seconds(self, timeout_in_seconds): """ self._timeout_in_seconds = timeout_in_seconds + @property + def channel_consumption_limit(self): + """ + Gets the channel_consumption_limit of this CreateQueueDetails. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :return: The channel_consumption_limit of this CreateQueueDetails. + :rtype: int + """ + return self._channel_consumption_limit + + @channel_consumption_limit.setter + def channel_consumption_limit(self, channel_consumption_limit): + """ + Sets the channel_consumption_limit of this CreateQueueDetails. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :param channel_consumption_limit: The channel_consumption_limit of this CreateQueueDetails. + :type: int + """ + self._channel_consumption_limit = channel_consumption_limit + @property def dead_letter_queue_delivery_count(self): """ @@ -239,7 +274,9 @@ def dead_letter_queue_delivery_count(self, dead_letter_queue_delivery_count): def custom_encryption_key_id(self): """ Gets the custom_encryption_key_id of this CreateQueueDetails. - Id of the custom master encryption key which will be used to encrypt messages content + The `OCID`__ of the custom encryption key to be used to encrypt messages content. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The custom_encryption_key_id of this CreateQueueDetails. @@ -251,7 +288,9 @@ def custom_encryption_key_id(self): def custom_encryption_key_id(self, custom_encryption_key_id): """ Sets the custom_encryption_key_id of this CreateQueueDetails. - Id of the custom master encryption key which will be used to encrypt messages content + The `OCID`__ of the custom encryption key to be used to encrypt messages content. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param custom_encryption_key_id: The custom_encryption_key_id of this CreateQueueDetails. diff --git a/src/oci/queue/models/delete_messages_details_entry.py b/src/oci/queue/models/delete_messages_details_entry.py index 8a91bc3722..8093fd7818 100644 --- a/src/oci/queue/models/delete_messages_details_entry.py +++ b/src/oci/queue/models/delete_messages_details_entry.py @@ -39,7 +39,7 @@ def __init__(self, **kwargs): def receipt(self): """ **[Required]** Gets the receipt of this DeleteMessagesDetailsEntry. - The receipt of the message to delete + The receipt of the message to delete. :return: The receipt of this DeleteMessagesDetailsEntry. @@ -51,7 +51,7 @@ def receipt(self): def receipt(self, receipt): """ Sets the receipt of this DeleteMessagesDetailsEntry. - The receipt of the message to delete + The receipt of the message to delete. :param receipt: The receipt of this DeleteMessagesDetailsEntry. diff --git a/src/oci/queue/models/get_message.py b/src/oci/queue/models/get_message.py index f509003608..642e7c58eb 100644 --- a/src/oci/queue/models/get_message.py +++ b/src/oci/queue/models/get_message.py @@ -44,6 +44,10 @@ def __init__(self, **kwargs): The value to assign to the expire_after property of this GetMessage. :type expire_after: datetime + :param metadata: + The value to assign to the metadata property of this GetMessage. + :type metadata: oci.queue.models.MessageMetadata + """ self.swagger_types = { 'id': 'int', @@ -51,7 +55,8 @@ def __init__(self, **kwargs): 'receipt': 'str', 'delivery_count': 'int', 'visible_after': 'datetime', - 'expire_after': 'datetime' + 'expire_after': 'datetime', + 'metadata': 'MessageMetadata' } self.attribute_map = { @@ -60,7 +65,8 @@ def __init__(self, **kwargs): 'receipt': 'receipt', 'delivery_count': 'deliveryCount', 'visible_after': 'visibleAfter', - 'expire_after': 'expireAfter' + 'expire_after': 'expireAfter', + 'metadata': 'metadata' } self._id = None @@ -69,12 +75,13 @@ def __init__(self, **kwargs): self._delivery_count = None self._visible_after = None self._expire_after = None + self._metadata = None @property def id(self): """ **[Required]** Gets the id of this GetMessage. - The id of the message - this is only used for tracing and debugging purposes and isn't used as a parameter in any request. + The ID of the message. This ID is only used for tracing and debugging purposes and isn't used as a parameter in any request. :return: The id of this GetMessage. @@ -86,7 +93,7 @@ def id(self): def id(self, id): """ Sets the id of this GetMessage. - The id of the message - this is only used for tracing and debugging purposes and isn't used as a parameter in any request. + The ID of the message. This ID is only used for tracing and debugging purposes and isn't used as a parameter in any request. :param id: The id of this GetMessage. @@ -98,7 +105,7 @@ def id(self, id): def content(self): """ **[Required]** Gets the content of this GetMessage. - The content of the message + The content of the message. :return: The content of this GetMessage. @@ -110,7 +117,7 @@ def content(self): def content(self, content): """ Sets the content of this GetMessage. - The content of the message + The content of the message. :param content: The content of this GetMessage. @@ -148,7 +155,7 @@ def receipt(self, receipt): def delivery_count(self): """ **[Required]** Gets the delivery_count of this GetMessage. - The number of time the message has been delivered to a consumer. + The number of times that the message has been delivered to a consumer. :return: The delivery_count of this GetMessage. @@ -160,7 +167,7 @@ def delivery_count(self): def delivery_count(self, delivery_count): """ Sets the delivery_count of this GetMessage. - The number of time the message has been delivered to a consumer. + The number of times that the message has been delivered to a consumer. :param delivery_count: The delivery_count of this GetMessage. @@ -172,7 +179,11 @@ def delivery_count(self, delivery_count): def visible_after(self): """ **[Required]** Gets the visible_after of this GetMessage. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The visible_after of this GetMessage. @@ -184,7 +195,11 @@ def visible_after(self): def visible_after(self, visible_after): """ Sets the visible_after of this GetMessage. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param visible_after: The visible_after of this GetMessage. @@ -196,7 +211,11 @@ def visible_after(self, visible_after): def expire_after(self): """ **[Required]** Gets the expire_after of this GetMessage. - The time after which the message will be automatically deleted. An RFC3339 formatted datetime string + The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The expire_after of this GetMessage. @@ -208,7 +227,11 @@ def expire_after(self): def expire_after(self, expire_after): """ Sets the expire_after of this GetMessage. - The time after which the message will be automatically deleted. An RFC3339 formatted datetime string + The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param expire_after: The expire_after of this GetMessage. @@ -216,6 +239,26 @@ def expire_after(self, expire_after): """ self._expire_after = expire_after + @property + def metadata(self): + """ + Gets the metadata of this GetMessage. + + :return: The metadata of this GetMessage. + :rtype: oci.queue.models.MessageMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this GetMessage. + + :param metadata: The metadata of this GetMessage. + :type: oci.queue.models.MessageMetadata + """ + self._metadata = metadata + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/message_metadata.py b/src/oci/queue/models/message_metadata.py new file mode 100644 index 0000000000..0af5237b74 --- /dev/null +++ b/src/oci/queue/models/message_metadata.py @@ -0,0 +1,103 @@ +# coding: utf-8 +# Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. +# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. + +# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201 + + +from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 +from oci.decorators import init_model_state_from_kwargs + + +@init_model_state_from_kwargs +class MessageMetadata(object): + """ + Object that represents metadata for message. + """ + + def __init__(self, **kwargs): + """ + Initializes a new MessageMetadata object with values from keyword arguments. + The following keyword arguments are supported (corresponding to the getters/setters of this class): + + :param channel_id: + The value to assign to the channel_id property of this MessageMetadata. + :type channel_id: str + + :param custom_properties: + The value to assign to the custom_properties property of this MessageMetadata. + :type custom_properties: dict(str, str) + + """ + self.swagger_types = { + 'channel_id': 'str', + 'custom_properties': 'dict(str, str)' + } + + self.attribute_map = { + 'channel_id': 'channelId', + 'custom_properties': 'customProperties' + } + + self._channel_id = None + self._custom_properties = None + + @property + def channel_id(self): + """ + **[Required]** Gets the channel_id of this MessageMetadata. + The channel ID which specifies the channel to publish or retrieve messages. + + + :return: The channel_id of this MessageMetadata. + :rtype: str + """ + return self._channel_id + + @channel_id.setter + def channel_id(self, channel_id): + """ + Sets the channel_id of this MessageMetadata. + The channel ID which specifies the channel to publish or retrieve messages. + + + :param channel_id: The channel_id of this MessageMetadata. + :type: str + """ + self._channel_id = channel_id + + @property + def custom_properties(self): + """ + Gets the custom_properties of this MessageMetadata. + Additional message properties + + + :return: The custom_properties of this MessageMetadata. + :rtype: dict(str, str) + """ + return self._custom_properties + + @custom_properties.setter + def custom_properties(self, custom_properties): + """ + Sets the custom_properties of this MessageMetadata. + Additional message properties + + + :param custom_properties: The custom_properties of this MessageMetadata. + :type: dict(str, str) + """ + self._custom_properties = custom_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/queue/models/purge_queue_details.py b/src/oci/queue/models/purge_queue_details.py index 4422e8ed65..f7c50d8688 100644 --- a/src/oci/queue/models/purge_queue_details.py +++ b/src/oci/queue/models/purge_queue_details.py @@ -37,25 +37,32 @@ def __init__(self, **kwargs): Allowed values for this property are: "NORMAL", "DLQ", "BOTH" :type purge_type: str + :param channel_ids: + The value to assign to the channel_ids property of this PurgeQueueDetails. + :type channel_ids: list[str] + """ self.swagger_types = { - 'purge_type': 'str' + 'purge_type': 'str', + 'channel_ids': 'list[str]' } self.attribute_map = { - 'purge_type': 'purgeType' + 'purge_type': 'purgeType', + 'channel_ids': 'channelIds' } self._purge_type = None + self._channel_ids = None @property def purge_type(self): """ **[Required]** Gets the purge_type of this PurgeQueueDetails. Type of the purge to perform: - - NORMAL - purge only normal queue - - DLQ - purge only DLQ - - BOTH - purge both normal queue and DLQ + - NORMAL - purge only the normal queue + - DLQ - purge only the dead letter queue + - BOTH - purge both the normal queue and the dead letter queue Allowed values for this property are: "NORMAL", "DLQ", "BOTH" @@ -70,9 +77,9 @@ def purge_type(self, purge_type): """ Sets the purge_type of this PurgeQueueDetails. Type of the purge to perform: - - NORMAL - purge only normal queue - - DLQ - purge only DLQ - - BOTH - purge both normal queue and DLQ + - NORMAL - purge only the normal queue + - DLQ - purge only the dead letter queue + - BOTH - purge both the normal queue and the dead letter queue :param purge_type: The purge_type of this PurgeQueueDetails. @@ -86,6 +93,34 @@ def purge_type(self, purge_type): ) self._purge_type = purge_type + @property + def channel_ids(self): + """ + Gets the channel_ids of this PurgeQueueDetails. + Optional parameter to specify the destination of purge operation. + If the channel ID is specified, the purge operation will delete all the messages in the specific channels. + If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels. + + + :return: The channel_ids of this PurgeQueueDetails. + :rtype: list[str] + """ + return self._channel_ids + + @channel_ids.setter + def channel_ids(self, channel_ids): + """ + Sets the channel_ids of this PurgeQueueDetails. + Optional parameter to specify the destination of purge operation. + If the channel ID is specified, the purge operation will delete all the messages in the specific channels. + If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels. + + + :param channel_ids: The channel_ids of this PurgeQueueDetails. + :type: list[str] + """ + self._channel_ids = channel_ids + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/put_message.py b/src/oci/queue/models/put_message.py index 4a08c3ef60..0074f77158 100644 --- a/src/oci/queue/models/put_message.py +++ b/src/oci/queue/models/put_message.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class PutMessage(object): """ - A message that has been published in a queue. + A message that has been published to a queue. """ def __init__(self, **kwargs): @@ -24,22 +24,29 @@ def __init__(self, **kwargs): The value to assign to the id property of this PutMessage. :type id: int + :param expire_after: + The value to assign to the expire_after property of this PutMessage. + :type expire_after: datetime + """ self.swagger_types = { - 'id': 'int' + 'id': 'int', + 'expire_after': 'datetime' } self.attribute_map = { - 'id': 'id' + 'id': 'id', + 'expire_after': 'expireAfter' } self._id = None + self._expire_after = None @property def id(self): """ **[Required]** Gets the id of this PutMessage. - The id of the message + The ID of the message. :return: The id of this PutMessage. @@ -51,7 +58,7 @@ def id(self): def id(self, id): """ Sets the id of this PutMessage. - The id of the message + The ID of the message. :param id: The id of this PutMessage. @@ -59,6 +66,38 @@ def id(self, id): """ self._id = id + @property + def expire_after(self): + """ + Gets the expire_after of this PutMessage. + The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 + + + :return: The expire_after of this PutMessage. + :rtype: datetime + """ + return self._expire_after + + @expire_after.setter + def expire_after(self, expire_after): + """ + Sets the expire_after of this PutMessage. + The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 + + + :param expire_after: The expire_after of this PutMessage. + :type: datetime + """ + self._expire_after = expire_after + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/put_messages.py b/src/oci/queue/models/put_messages.py index 100e6938c7..a30ab20504 100644 --- a/src/oci/queue/models/put_messages.py +++ b/src/oci/queue/models/put_messages.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class PutMessages(object): """ - A list of the messages published in a queue. + A list of the messages published to a queue. """ def __init__(self, **kwargs): @@ -39,7 +39,7 @@ def __init__(self, **kwargs): def messages(self): """ **[Required]** Gets the messages of this PutMessages. - The messages that have been published in a queue. + The messages that have been published to a queue. :return: The messages of this PutMessages. @@ -51,7 +51,7 @@ def messages(self): def messages(self, messages): """ Sets the messages of this PutMessages. - The messages that have been published in a queue. + The messages that have been published to a queue. :param messages: The messages of this PutMessages. diff --git a/src/oci/queue/models/put_messages_details_entry.py b/src/oci/queue/models/put_messages_details_entry.py index 6aa4b38bab..865a38bdbd 100644 --- a/src/oci/queue/models/put_messages_details_entry.py +++ b/src/oci/queue/models/put_messages_details_entry.py @@ -24,16 +24,23 @@ def __init__(self, **kwargs): The value to assign to the content property of this PutMessagesDetailsEntry. :type content: str + :param metadata: + The value to assign to the metadata property of this PutMessagesDetailsEntry. + :type metadata: oci.queue.models.MessageMetadata + """ self.swagger_types = { - 'content': 'str' + 'content': 'str', + 'metadata': 'MessageMetadata' } self.attribute_map = { - 'content': 'content' + 'content': 'content', + 'metadata': 'metadata' } self._content = None + self._metadata = None @property def content(self): @@ -59,6 +66,26 @@ def content(self, content): """ self._content = content + @property + def metadata(self): + """ + Gets the metadata of this PutMessagesDetailsEntry. + + :return: The metadata of this PutMessagesDetailsEntry. + :rtype: oci.queue.models.MessageMetadata + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """ + Sets the metadata of this PutMessagesDetailsEntry. + + :param metadata: The metadata of this PutMessagesDetailsEntry. + :type: oci.queue.models.MessageMetadata + """ + self._metadata = metadata + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/queue.py b/src/oci/queue/models/queue.py index f7d1cdf989..fe5bca6e45 100644 --- a/src/oci/queue/models/queue.py +++ b/src/oci/queue/models/queue.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class Queue(object): """ - Description of Queue. + A detailed representation of a queue and its configuration. """ #: A constant which can be used with the lifecycle_state property of a Queue. @@ -110,6 +110,10 @@ def __init__(self, **kwargs): The value to assign to the system_tags property of this Queue. :type system_tags: dict(str, dict(str, object)) + :param channel_consumption_limit: + The value to assign to the channel_consumption_limit property of this Queue. + :type channel_consumption_limit: int + """ self.swagger_types = { 'id': 'str', @@ -127,7 +131,8 @@ def __init__(self, **kwargs): 'custom_encryption_key_id': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', - 'system_tags': 'dict(str, dict(str, object))' + 'system_tags': 'dict(str, dict(str, object))', + 'channel_consumption_limit': 'int' } self.attribute_map = { @@ -146,7 +151,8 @@ def __init__(self, **kwargs): 'custom_encryption_key_id': 'customEncryptionKeyId', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', - 'system_tags': 'systemTags' + 'system_tags': 'systemTags', + 'channel_consumption_limit': 'channelConsumptionLimit' } self._id = None @@ -165,12 +171,13 @@ def __init__(self, **kwargs): self._freeform_tags = None self._defined_tags = None self._system_tags = None + self._channel_consumption_limit = None @property def id(self): """ **[Required]** Gets the id of this Queue. - Unique identifier that is immutable on creation + A unique identifier for the queue that is immutable on creation. :return: The id of this Queue. @@ -182,7 +189,7 @@ def id(self): def id(self, id): """ Sets the id of this Queue. - Unique identifier that is immutable on creation + A unique identifier for the queue that is immutable on creation. :param id: The id of this Queue. @@ -194,7 +201,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this Queue. - Queue Identifier, can be renamed + A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. :return: The display_name of this Queue. @@ -206,7 +213,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this Queue. - Queue Identifier, can be renamed + A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. :param display_name: The display_name of this Queue. @@ -218,7 +225,9 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this Queue. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The compartment_id of this Queue. @@ -230,7 +239,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this Queue. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this Queue. @@ -242,7 +253,11 @@ def compartment_id(self, compartment_id): def time_created(self): """ **[Required]** Gets the time_created of this Queue. - The time the the Queue was created. An RFC3339 formatted datetime string + The time that the queue was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The time_created of this Queue. @@ -254,7 +269,11 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this Queue. - The time the the Queue was created. An RFC3339 formatted datetime string + The time that the queue was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param time_created: The time_created of this Queue. @@ -266,7 +285,11 @@ def time_created(self, time_created): def time_updated(self): """ **[Required]** Gets the time_updated of this Queue. - The time the Queue was updated. An RFC3339 formatted datetime string + The time that the queue was updated, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The time_updated of this Queue. @@ -278,7 +301,11 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this Queue. - The time the Queue was updated. An RFC3339 formatted datetime string + The time that the queue was updated, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param time_updated: The time_updated of this Queue. @@ -290,7 +317,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this Queue. - The current state of the Queue. + The current state of the queue. Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. @@ -305,7 +332,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this Queue. - The current state of the Queue. + The current state of the queue. :param lifecycle_state: The lifecycle_state of this Queue. @@ -320,7 +347,7 @@ def lifecycle_state(self, lifecycle_state): def lifecycle_details(self): """ Gets the lifecycle_details of this Queue. - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + Any additional details about the current state of the queue. :return: The lifecycle_details of this Queue. @@ -332,7 +359,7 @@ def lifecycle_details(self): def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this Queue. - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + Any additional details about the current state of the queue. :param lifecycle_details: The lifecycle_details of this Queue. @@ -392,7 +419,7 @@ def retention_in_seconds(self, retention_in_seconds): def visibility_in_seconds(self): """ **[Required]** Gets the visibility_in_seconds of this Queue. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :return: The visibility_in_seconds of this Queue. @@ -404,7 +431,7 @@ def visibility_in_seconds(self): def visibility_in_seconds(self, visibility_in_seconds): """ Sets the visibility_in_seconds of this Queue. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :param visibility_in_seconds: The visibility_in_seconds of this Queue. @@ -464,7 +491,9 @@ def dead_letter_queue_delivery_count(self, dead_letter_queue_delivery_count): def custom_encryption_key_id(self): """ Gets the custom_encryption_key_id of this Queue. - Id of the custom master encryption key which will be used to encrypt messages content + The `OCID`__ of the custom encryption key to be used to encrypt messages content. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The custom_encryption_key_id of this Queue. @@ -476,7 +505,9 @@ def custom_encryption_key_id(self): def custom_encryption_key_id(self, custom_encryption_key_id): """ Sets the custom_encryption_key_id of this Queue. - Id of the custom master encryption key which will be used to encrypt messages content + The `OCID`__ of the custom encryption key to be used to encrypt messages content. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param custom_encryption_key_id: The custom_encryption_key_id of this Queue. @@ -562,6 +593,30 @@ def system_tags(self, system_tags): """ self._system_tags = system_tags + @property + def channel_consumption_limit(self): + """ + Gets the channel_consumption_limit of this Queue. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :return: The channel_consumption_limit of this Queue. + :rtype: int + """ + return self._channel_consumption_limit + + @channel_consumption_limit.setter + def channel_consumption_limit(self, channel_consumption_limit): + """ + Sets the channel_consumption_limit of this Queue. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :param channel_consumption_limit: The channel_consumption_limit of this Queue. + :type: int + """ + self._channel_consumption_limit = channel_consumption_limit + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/queue_stats.py b/src/oci/queue/models/queue_stats.py index ecdd97b695..72aa1e7e6d 100644 --- a/src/oci/queue/models/queue_stats.py +++ b/src/oci/queue/models/queue_stats.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class QueueStats(object): """ - The stats for a queue and its dead letter queue. + The stats for a queue and its dead letter queue. If channelId is specified in request field, it will return channel specific stats response. """ def __init__(self, **kwargs): @@ -28,19 +28,26 @@ def __init__(self, **kwargs): The value to assign to the dlq property of this QueueStats. :type dlq: oci.queue.models.Stats + :param channel_id: + The value to assign to the channel_id property of this QueueStats. + :type channel_id: str + """ self.swagger_types = { 'queue': 'Stats', - 'dlq': 'Stats' + 'dlq': 'Stats', + 'channel_id': 'str' } self.attribute_map = { 'queue': 'queue', - 'dlq': 'dlq' + 'dlq': 'dlq', + 'channel_id': 'channelId' } self._queue = None self._dlq = None + self._channel_id = None @property def queue(self): @@ -82,6 +89,30 @@ def dlq(self, dlq): """ self._dlq = dlq + @property + def channel_id(self): + """ + Gets the channel_id of this QueueStats. + If channelId is presented in GetStats call, the channel id will be returned in the GetStats response. + + + :return: The channel_id of this QueueStats. + :rtype: str + """ + return self._channel_id + + @channel_id.setter + def channel_id(self, channel_id): + """ + Sets the channel_id of this QueueStats. + If channelId is presented in GetStats call, the channel id will be returned in the GetStats response. + + + :param channel_id: The channel_id of this QueueStats. + :type: str + """ + self._channel_id = channel_id + def __repr__(self): return formatted_flat_dict(self) diff --git a/src/oci/queue/models/queue_summary.py b/src/oci/queue/models/queue_summary.py index a5735cc37d..19b580c7df 100644 --- a/src/oci/queue/models/queue_summary.py +++ b/src/oci/queue/models/queue_summary.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class QueueSummary(object): """ - Summary of the Queue. + Summary of the queue. """ def __init__(self, **kwargs): @@ -109,7 +109,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this QueueSummary. - Unique identifier that is immutable on creation + A unique identifier for the queue that is immutable on creation. :return: The id of this QueueSummary. @@ -121,7 +121,7 @@ def id(self): def id(self, id): """ Sets the id of this QueueSummary. - Unique identifier that is immutable on creation + A unique identifier for the queue that is immutable on creation. :param id: The id of this QueueSummary. @@ -133,7 +133,7 @@ def id(self, id): def display_name(self): """ Gets the display_name of this QueueSummary. - Queue Identifier, can be renamed + A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. :return: The display_name of this QueueSummary. @@ -145,7 +145,7 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this QueueSummary. - Queue Identifier, can be renamed + A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information. :param display_name: The display_name of this QueueSummary. @@ -157,7 +157,9 @@ def display_name(self, display_name): def compartment_id(self): """ **[Required]** Gets the compartment_id of this QueueSummary. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The compartment_id of this QueueSummary. @@ -169,7 +171,9 @@ def compartment_id(self): def compartment_id(self, compartment_id): """ Sets the compartment_id of this QueueSummary. - Compartment Identifier + The `OCID`__ of the compartment containing the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this QueueSummary. @@ -181,7 +185,11 @@ def compartment_id(self, compartment_id): def time_created(self): """ **[Required]** Gets the time_created of this QueueSummary. - The time the the Queue was created. An RFC3339 formatted datetime string + The time that the queue was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The time_created of this QueueSummary. @@ -193,7 +201,11 @@ def time_created(self): def time_created(self, time_created): """ Sets the time_created of this QueueSummary. - The time the the Queue was created. An RFC3339 formatted datetime string + The time that the queue was created, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param time_created: The time_created of this QueueSummary. @@ -205,7 +217,11 @@ def time_created(self, time_created): def time_updated(self): """ **[Required]** Gets the time_updated of this QueueSummary. - The time the Queue was updated. An RFC3339 formatted datetime string + The time that the queue was updated, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The time_updated of this QueueSummary. @@ -217,7 +233,11 @@ def time_updated(self): def time_updated(self, time_updated): """ Sets the time_updated of this QueueSummary. - The time the Queue was updated. An RFC3339 formatted datetime string + The time that the queue was updated, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param time_updated: The time_updated of this QueueSummary. @@ -229,7 +249,7 @@ def time_updated(self, time_updated): def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this QueueSummary. - The current state of the Queue. + The current state of the queue. :return: The lifecycle_state of this QueueSummary. @@ -241,7 +261,7 @@ def lifecycle_state(self): def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this QueueSummary. - The current state of the Queue. + The current state of the queue. :param lifecycle_state: The lifecycle_state of this QueueSummary. @@ -253,7 +273,7 @@ def lifecycle_state(self, lifecycle_state): def lifecycle_details(self): """ Gets the lifecycle_details of this QueueSummary. - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + Any additional details about the current state of the queue. :return: The lifecycle_details of this QueueSummary. @@ -265,7 +285,7 @@ def lifecycle_details(self): def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this QueueSummary. - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. + Any additional details about the current state of the queue. :param lifecycle_details: The lifecycle_details of this QueueSummary. @@ -277,7 +297,7 @@ def lifecycle_details(self, lifecycle_details): def messages_endpoint(self): """ **[Required]** Gets the messages_endpoint of this QueueSummary. - The endpoint to use to get or put messages in the queue. + The endpoint to use to consume or publish messages in the queue. :return: The messages_endpoint of this QueueSummary. @@ -289,7 +309,7 @@ def messages_endpoint(self): def messages_endpoint(self, messages_endpoint): """ Sets the messages_endpoint of this QueueSummary. - The endpoint to use to get or put messages in the queue. + The endpoint to use to consume or publish messages in the queue. :param messages_endpoint: The messages_endpoint of this QueueSummary. diff --git a/src/oci/queue/models/stats.py b/src/oci/queue/models/stats.py index 9e738bedb3..3e7221bfe2 100644 --- a/src/oci/queue/models/stats.py +++ b/src/oci/queue/models/stats.py @@ -101,7 +101,7 @@ def in_flight_messages(self, in_flight_messages): def size_in_bytes(self): """ **[Required]** Gets the size_in_bytes of this Stats. - The approximate size of the queue in bytes. Sum of the size of visible of in-flight messages. + The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages. :return: The size_in_bytes of this Stats. @@ -113,7 +113,7 @@ def size_in_bytes(self): def size_in_bytes(self, size_in_bytes): """ Sets the size_in_bytes of this Stats. - The approximate size of the queue in bytes. Sum of the size of visible of in-flight messages. + The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages. :param size_in_bytes: The size_in_bytes of this Stats. diff --git a/src/oci/queue/models/update_messages_details.py b/src/oci/queue/models/update_messages_details.py index afacd3f1b0..6f8d4b04f8 100644 --- a/src/oci/queue/models/update_messages_details.py +++ b/src/oci/queue/models/update_messages_details.py @@ -12,7 +12,7 @@ @init_model_state_from_kwargs class UpdateMessagesDetails(object): """ - The details of a UpdateMessages request. + The details of an UpdateMessages request. """ def __init__(self, **kwargs): diff --git a/src/oci/queue/models/update_messages_details_entry.py b/src/oci/queue/models/update_messages_details_entry.py index 4179824804..fec3db3a4e 100644 --- a/src/oci/queue/models/update_messages_details_entry.py +++ b/src/oci/queue/models/update_messages_details_entry.py @@ -46,7 +46,7 @@ def __init__(self, **kwargs): def receipt(self): """ **[Required]** Gets the receipt of this UpdateMessagesDetailsEntry. - The receipt of the message to update + The receipt of the message to update. :return: The receipt of this UpdateMessagesDetailsEntry. @@ -58,7 +58,7 @@ def receipt(self): def receipt(self, receipt): """ Sets the receipt of this UpdateMessagesDetailsEntry. - The receipt of the message to update + The receipt of the message to update. :param receipt: The receipt of this UpdateMessagesDetailsEntry. diff --git a/src/oci/queue/models/update_messages_result.py b/src/oci/queue/models/update_messages_result.py index b0dc9a5f08..96fcef0408 100644 --- a/src/oci/queue/models/update_messages_result.py +++ b/src/oci/queue/models/update_messages_result.py @@ -77,7 +77,7 @@ def server_failures(self, server_failures): def client_failures(self): """ **[Required]** Gets the client_failures of this UpdateMessagesResult. - The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid visibilityInSeconds. + The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid `visibilityInSeconds`. :return: The client_failures of this UpdateMessagesResult. @@ -89,7 +89,7 @@ def client_failures(self): def client_failures(self, client_failures): """ Sets the client_failures of this UpdateMessagesResult. - The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid visibilityInSeconds. + The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid `visibilityInSeconds`. :param client_failures: The client_failures of this UpdateMessagesResult. diff --git a/src/oci/queue/models/update_messages_result_entry.py b/src/oci/queue/models/update_messages_result_entry.py index 39341c4e66..202ec54674 100644 --- a/src/oci/queue/models/update_messages_result_entry.py +++ b/src/oci/queue/models/update_messages_result_entry.py @@ -62,7 +62,7 @@ def __init__(self, **kwargs): def id(self): """ Gets the id of this UpdateMessagesResultEntry. - The id of the message that's been updated. + The ID of the message that's been updated. :return: The id of this UpdateMessagesResultEntry. @@ -74,7 +74,7 @@ def id(self): def id(self, id): """ Sets the id of this UpdateMessagesResultEntry. - The id of the message that's been updated. + The ID of the message that's been updated. :param id: The id of this UpdateMessagesResultEntry. @@ -86,7 +86,11 @@ def id(self, id): def visible_after(self): """ Gets the visible_after of this UpdateMessagesResultEntry. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The visible_after of this UpdateMessagesResultEntry. @@ -98,7 +102,11 @@ def visible_after(self): def visible_after(self, visible_after): """ Sets the visible_after of this UpdateMessagesResultEntry. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param visible_after: The visible_after of this UpdateMessagesResultEntry. diff --git a/src/oci/queue/models/update_queue_details.py b/src/oci/queue/models/update_queue_details.py index d53fcaac7c..ff38ff838a 100644 --- a/src/oci/queue/models/update_queue_details.py +++ b/src/oci/queue/models/update_queue_details.py @@ -32,6 +32,10 @@ def __init__(self, **kwargs): The value to assign to the timeout_in_seconds property of this UpdateQueueDetails. :type timeout_in_seconds: int + :param channel_consumption_limit: + The value to assign to the channel_consumption_limit property of this UpdateQueueDetails. + :type channel_consumption_limit: int + :param dead_letter_queue_delivery_count: The value to assign to the dead_letter_queue_delivery_count property of this UpdateQueueDetails. :type dead_letter_queue_delivery_count: int @@ -53,6 +57,7 @@ def __init__(self, **kwargs): 'display_name': 'str', 'visibility_in_seconds': 'int', 'timeout_in_seconds': 'int', + 'channel_consumption_limit': 'int', 'dead_letter_queue_delivery_count': 'int', 'custom_encryption_key_id': 'str', 'freeform_tags': 'dict(str, str)', @@ -63,6 +68,7 @@ def __init__(self, **kwargs): 'display_name': 'displayName', 'visibility_in_seconds': 'visibilityInSeconds', 'timeout_in_seconds': 'timeoutInSeconds', + 'channel_consumption_limit': 'channelConsumptionLimit', 'dead_letter_queue_delivery_count': 'deadLetterQueueDeliveryCount', 'custom_encryption_key_id': 'customEncryptionKeyId', 'freeform_tags': 'freeformTags', @@ -72,6 +78,7 @@ def __init__(self, **kwargs): self._display_name = None self._visibility_in_seconds = None self._timeout_in_seconds = None + self._channel_consumption_limit = None self._dead_letter_queue_delivery_count = None self._custom_encryption_key_id = None self._freeform_tags = None @@ -81,7 +88,9 @@ def __init__(self, **kwargs): def display_name(self): """ Gets the display_name of this UpdateQueueDetails. - Queue Identifier + The `OCID`__ of the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The display_name of this UpdateQueueDetails. @@ -93,7 +102,9 @@ def display_name(self): def display_name(self, display_name): """ Sets the display_name of this UpdateQueueDetails. - Queue Identifier + The `OCID`__ of the queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param display_name: The display_name of this UpdateQueueDetails. @@ -105,7 +116,7 @@ def display_name(self, display_name): def visibility_in_seconds(self): """ Gets the visibility_in_seconds of this UpdateQueueDetails. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :return: The visibility_in_seconds of this UpdateQueueDetails. @@ -117,7 +128,7 @@ def visibility_in_seconds(self): def visibility_in_seconds(self, visibility_in_seconds): """ Sets the visibility_in_seconds of this UpdateQueueDetails. - The default visibility of the messages consumed from the queue. + The default visibility timeout of the messages consumed from the queue, in seconds. :param visibility_in_seconds: The visibility_in_seconds of this UpdateQueueDetails. @@ -149,13 +160,37 @@ def timeout_in_seconds(self, timeout_in_seconds): """ self._timeout_in_seconds = timeout_in_seconds + @property + def channel_consumption_limit(self): + """ + Gets the channel_consumption_limit of this UpdateQueueDetails. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :return: The channel_consumption_limit of this UpdateQueueDetails. + :rtype: int + """ + return self._channel_consumption_limit + + @channel_consumption_limit.setter + def channel_consumption_limit(self, channel_consumption_limit): + """ + Sets the channel_consumption_limit of this UpdateQueueDetails. + The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. + + + :param channel_consumption_limit: The channel_consumption_limit of this UpdateQueueDetails. + :type: int + """ + self._channel_consumption_limit = channel_consumption_limit + @property def dead_letter_queue_delivery_count(self): """ Gets the dead_letter_queue_delivery_count of this UpdateQueueDetails. The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. - Changing that value to a lower threshold does not retro-actively move in-flight messages in the dead letter queue. + Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue. :return: The dead_letter_queue_delivery_count of this UpdateQueueDetails. @@ -169,7 +204,7 @@ def dead_letter_queue_delivery_count(self, dead_letter_queue_delivery_count): Sets the dead_letter_queue_delivery_count of this UpdateQueueDetails. The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. - Changing that value to a lower threshold does not retro-actively move in-flight messages in the dead letter queue. + Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue. :param dead_letter_queue_delivery_count: The dead_letter_queue_delivery_count of this UpdateQueueDetails. @@ -181,7 +216,9 @@ def dead_letter_queue_delivery_count(self, dead_letter_queue_delivery_count): def custom_encryption_key_id(self): """ Gets the custom_encryption_key_id of this UpdateQueueDetails. - Id of the custom master encryption key which will be used to encrypt messages content. String of length 0 means the custom key should be removed from queue + The `OCID`__ of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The custom_encryption_key_id of this UpdateQueueDetails. @@ -193,7 +230,9 @@ def custom_encryption_key_id(self): def custom_encryption_key_id(self, custom_encryption_key_id): """ Sets the custom_encryption_key_id of this UpdateQueueDetails. - Id of the custom master encryption key which will be used to encrypt messages content. String of length 0 means the custom key should be removed from queue + The `OCID`__ of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param custom_encryption_key_id: The custom_encryption_key_id of this UpdateQueueDetails. diff --git a/src/oci/queue/models/updated_message.py b/src/oci/queue/models/updated_message.py index 429d24ae4d..4deac4da9f 100644 --- a/src/oci/queue/models/updated_message.py +++ b/src/oci/queue/models/updated_message.py @@ -46,7 +46,7 @@ def __init__(self, **kwargs): def id(self): """ **[Required]** Gets the id of this UpdatedMessage. - The id of the message that's been updated. + The ID of the message that's been updated. :return: The id of this UpdatedMessage. @@ -58,7 +58,7 @@ def id(self): def id(self, id): """ Sets the id of this UpdatedMessage. - The id of the message that's been updated. + The ID of the message that's been updated. :param id: The id of this UpdatedMessage. @@ -70,7 +70,11 @@ def id(self, id): def visible_after(self): """ **[Required]** Gets the visible_after of this UpdatedMessage. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :return: The visible_after of this UpdatedMessage. @@ -82,7 +86,11 @@ def visible_after(self): def visible_after(self, visible_after): """ Sets the visible_after of this UpdatedMessage. - The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string + The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + + __ https://tools.ietf.org/rfc/rfc3339 :param visible_after: The visible_after of this UpdatedMessage. diff --git a/src/oci/queue/models/work_request.py b/src/oci/queue/models/work_request.py index 82403e5df5..00a5616ff6 100644 --- a/src/oci/queue/models/work_request.py +++ b/src/oci/queue/models/work_request.py @@ -227,11 +227,13 @@ 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 + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :return: The compartment_id of this WorkRequest. :rtype: str @@ -242,11 +244,13 @@ 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 + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param compartment_id: The compartment_id of this WorkRequest. :type: str diff --git a/src/oci/queue/models/work_request_error.py b/src/oci/queue/models/work_request_error.py index 897569d999..cbcf227ea1 100644 --- a/src/oci/queue/models/work_request_error.py +++ b/src/oci/queue/models/work_request_error.py @@ -103,7 +103,9 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestError. - The time the error occured. An RFC3339 formatted datetime string. + The time the error occured. An `RFC 3339`__ formatted datetime string. + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestError. @@ -115,7 +117,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestError. - The time the error occured. An RFC3339 formatted datetime string. + The time the error occured. An `RFC 3339`__ formatted datetime string. + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestError. diff --git a/src/oci/queue/models/work_request_log_entry.py b/src/oci/queue/models/work_request_log_entry.py index ce128a1b97..0b264a6765 100644 --- a/src/oci/queue/models/work_request_log_entry.py +++ b/src/oci/queue/models/work_request_log_entry.py @@ -70,7 +70,9 @@ def message(self, message): def timestamp(self): """ **[Required]** Gets the timestamp of this WorkRequestLogEntry. - The time the log message was written. An RFC3339 formatted datetime string + The time the log message was written. An `RFC 3339`__ formatted datetime string + + __ https://tools.ietf.org/rfc/rfc3339 :return: The timestamp of this WorkRequestLogEntry. @@ -82,7 +84,9 @@ def timestamp(self): def timestamp(self, timestamp): """ Sets the timestamp of this WorkRequestLogEntry. - The time the log message was written. An RFC3339 formatted datetime string + The time the log message was written. An `RFC 3339`__ formatted datetime string + + __ https://tools.ietf.org/rfc/rfc3339 :param timestamp: The timestamp of this WorkRequestLogEntry. diff --git a/src/oci/queue/models/work_request_summary.py b/src/oci/queue/models/work_request_summary.py index 6a97072a69..68dc613b4a 100644 --- a/src/oci/queue/models/work_request_summary.py +++ b/src/oci/queue/models/work_request_summary.py @@ -203,7 +203,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. @@ -215,7 +215,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. @@ -227,11 +227,13 @@ 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 + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :return: The compartment_id of this WorkRequestSummary. :rtype: str @@ -242,11 +244,13 @@ 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 + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm + :param compartment_id: The compartment_id of this WorkRequestSummary. :type: str diff --git a/src/oci/queue/queue_admin_client.py b/src/oci/queue/queue_admin_client.py index e692667647..d3f24deae3 100644 --- a/src/oci/queue/queue_admin_client.py +++ b/src/oci/queue/queue_admin_client.py @@ -20,7 +20,7 @@ class QueueAdminClient(object): """ - A description of the Queue API + Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm). """ def __init__(self, config, **kwargs): @@ -113,11 +113,11 @@ def __init__(self, config, **kwargs): def change_queue_compartment(self, queue_id, change_queue_compartment_details, **kwargs): """ - Moves a Queue resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. + Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource. :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.ChangeQueueCompartmentDetails change_queue_compartment_details: (required) The information to be updated. @@ -130,7 +130,7 @@ def change_queue_compartment(self, queue_id, change_queue_compartment_details, * provide matches the resource's current etag value. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -223,7 +223,7 @@ def change_queue_compartment(self, queue_id, change_queue_compartment_details, * def create_queue(self, create_queue_details, **kwargs): """ - Creates a new Queue. + Creates a new queue. :param oci.queue.models.CreateQueueDetails create_queue_details: (required) @@ -237,7 +237,7 @@ def create_queue(self, create_queue_details, **kwargs): might be rejected. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -319,11 +319,11 @@ def create_queue(self, create_queue_details, **kwargs): def delete_queue(self, queue_id, **kwargs): """ - Deletes a Queue resource by identifier + Deletes a queue resource by identifier. :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call @@ -333,7 +333,7 @@ def delete_queue(self, queue_id, **kwargs): provide matches the resource's current etag value. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -424,14 +424,14 @@ def delete_queue(self, queue_id, **kwargs): def get_queue(self, queue_id, **kwargs): """ - Gets a Queue by identifier + Gets a queue by identifier. :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -529,7 +529,7 @@ def get_work_request(self, work_request_id, **kwargs): The ID of the asynchronous request. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -620,11 +620,13 @@ def get_work_request(self, work_request_id, **kwargs): def list_queues(self, **kwargs): """ - Returns a list of Queues. + Returns a list of queues. :param str compartment_id: (optional) - The ID of the compartment in which to list resources. + The `OCID`__ of the compartment in which to list resources. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str lifecycle_state: (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. @@ -635,13 +637,17 @@ def list_queues(self, **kwargs): A filter to return only resources that match the entire display name given. :param str id: (optional) - unique Queue identifier + The unique queue identifier. :param int limit: (optional) - The maximum number of items to return. + 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`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. @@ -654,7 +660,7 @@ def list_queues(self, **kwargs): Allowed values are: "timeCreated", "displayName" :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -783,13 +789,17 @@ def list_work_request_errors(self, work_request_id, **kwargs): The ID of the asynchronous request. :param str opc_request_id: (optional) - The client request ID for tracing. + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + 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) - The maximum number of items to return. + 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`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -897,13 +907,17 @@ def list_work_request_logs(self, work_request_id, **kwargs): The ID of the asynchronous request. :param str opc_request_id: (optional) - The client request ID for tracing. + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + 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) - The maximum number of items to return. + 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`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1008,19 +1022,25 @@ def list_work_requests(self, **kwargs): :param str compartment_id: (optional) - The ID of the compartment in which to list resources. + The `OCID`__ of the compartment in which to list resources. + + __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str work_request_id: (optional) The ID of the asynchronous work request. :param str opc_request_id: (optional) - The client request ID for tracing. + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str page: (optional) - The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. + 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) - The maximum number of items to return. + 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`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -1113,12 +1133,13 @@ def list_work_requests(self, **kwargs): def purge_queue(self, queue_id, purge_queue_details, **kwargs): """ - Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue. + Deletes all messages present in the queue, or deletes all the messages in the specific channel at the time of invocation. Only one concurrent purge operation is supported for any given queue. However multiple concurrent purge operations are supported for different queues. + Purge request without specification of target channels will clean up all messages in the queue and in the child channels. :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.PurgeQueueDetails purge_queue_details: (required) The information to be updated. @@ -1131,7 +1152,7 @@ def purge_queue(self, queue_id, purge_queue_details, **kwargs): provide matches the resource's current etag value. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -1224,11 +1245,11 @@ def purge_queue(self, queue_id, purge_queue_details, **kwargs): def update_queue(self, queue_id, update_queue_details, **kwargs): """ - Updates the Queue + Updates the specified queue. :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.UpdateQueueDetails update_queue_details: (required) The information to be updated. @@ -1241,7 +1262,7 @@ def update_queue(self, queue_id, update_queue_details, **kwargs): provide matches the resource's current etag value. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. diff --git a/src/oci/queue/queue_admin_client_composite_operations.py b/src/oci/queue/queue_admin_client_composite_operations.py index b37caece1c..e643c94ab2 100644 --- a/src/oci/queue/queue_admin_client_composite_operations.py +++ b/src/oci/queue/queue_admin_client_composite_operations.py @@ -31,7 +31,7 @@ def change_queue_compartment_and_wait_for_state(self, queue_id, change_queue_com to enter the given state(s). :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.ChangeQueueCompartmentDetails change_queue_compartment_details: (required) The information to be updated. @@ -110,7 +110,7 @@ def delete_queue_and_wait_for_state(self, queue_id, wait_for_states=[], operatio to enter the given state(s). :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param list[str] wait_for_states: An array of states to wait on. These should be valid values for :py:attr:`~oci.queue.models.WorkRequest.status` @@ -156,7 +156,7 @@ def purge_queue_and_wait_for_state(self, queue_id, purge_queue_details, wait_for to enter the given state(s). :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.PurgeQueueDetails purge_queue_details: (required) The information to be updated. @@ -197,7 +197,7 @@ def update_queue_and_wait_for_state(self, queue_id, update_queue_details, wait_f to enter the given state(s). :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.UpdateQueueDetails update_queue_details: (required) The information to be updated. diff --git a/src/oci/queue/queue_client.py b/src/oci/queue/queue_client.py index e23066b89b..cd4e4ef0c9 100644 --- a/src/oci/queue/queue_client.py +++ b/src/oci/queue/queue_client.py @@ -20,7 +20,7 @@ class QueueClient(object): """ - A description of the Queue API + Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm). """ def __init__(self, config, **kwargs): @@ -113,17 +113,21 @@ def __init__(self, config, **kwargs): def delete_message(self, queue_id, message_receipt, **kwargs): """ - Deletes from the queue the message represented by the receipt. + Deletes the message represented by the receipt from the queue. + You must use the `messages endpoint`__ to delete messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param str message_receipt: (required) The receipt of the message retrieved from a GetMessages call. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -214,16 +218,20 @@ def delete_message(self, queue_id, message_receipt, **kwargs): def delete_messages(self, queue_id, delete_messages_details, **kwargs): """ Deletes multiple messages from the queue. + You must use the `messages endpoint`__ to delete messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.DeleteMessagesDetails delete_messages_details: (required) Details for the messages to delete. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -316,30 +324,40 @@ def delete_messages(self, queue_id, delete_messages_details, **kwargs): def get_messages(self, queue_id, **kwargs): """ - Consumes message from the queue. + Consumes messages from the queue. + You must use the `messages endpoint`__ to consume messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages. + When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter. + When filter is not specified, messages will be returned from a random non-empty channel within a queue. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param int visibility_in_seconds: (optional) - If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won't be consumable by other consumers during that time. - If it isn't set it defaults to the value set at the queue level. The minimum is 0 and the maximum is 43,200 (12 hours). - Using a visibilityInSeconds of 0, effectively acts as a peek functionality. - Messages retrieved that way, aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one. + If the `visibilityInSeconds` parameter is set, messages will be hidden for `visibilityInSeconds` seconds and won't be consumable by other consumers during that time. + If it isn't set it defaults to the value set at the queue level. + + Using a `visibilityInSeconds` value of 0 effectively acts as a peek functionality. + Messages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one. :param int timeout_in_seconds: (optional) - If the timeoutInSeconds parameter isn't set or set to a value greater than zero, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response) whichever comes first. - If the parameter is set to zero, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not. + If the `timeoutInSeconds parameter` isn't set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after `timeoutInSeconds` seconds (in which case it will return an empty response), whichever comes first. + + If the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not. In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout. - The minimum is 0 (long polling disabled), the maximum is 30 seconds and default is 30 seconds. :param int limit: (optional) The limit parameter controls how many messages is returned at-most. - The default is 1, the minimum is 1 and the maximum is 32. :param str opc_request_id: (optional) - The client request ID for tracing. + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + + :param str channel_filter: (optional) + Optional parameter to filter the channels. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -373,7 +391,8 @@ def get_messages(self, queue_id, **kwargs): "visibility_in_seconds", "timeout_in_seconds", "limit", - "opc_request_id" + "opc_request_id", + "channel_filter" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -393,7 +412,8 @@ def get_messages(self, queue_id, **kwargs): query_params = { "visibilityInSeconds": kwargs.get("visibility_in_seconds", missing), "timeoutInSeconds": kwargs.get("timeout_in_seconds", missing), - "limit": kwargs.get("limit", missing) + "limit": kwargs.get("limit", missing), + "channelFilter": kwargs.get("channel_filter", missing) } query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} @@ -441,13 +461,20 @@ def get_messages(self, queue_id, **kwargs): def get_stats(self, queue_id, **kwargs): """ Gets the statistics for the queue and its dead letter queue. + You must use the `messages endpoint`__ to get a queue's statistics. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param str opc_request_id: (optional) - The client request ID for tracing. + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. + + :param str channel_id: (optional) + Id to specify channel. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. @@ -478,7 +505,8 @@ def get_stats(self, queue_id, **kwargs): expected_kwargs = [ "allow_control_chars", "retry_strategy", - "opc_request_id" + "opc_request_id", + "channel_id" ] extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] if extra_kwargs: @@ -495,6 +523,11 @@ def get_stats(self, queue_id, **kwargs): if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + query_params = { + "channelId": kwargs.get("channel_id", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + header_params = { "accept": "application/json", "content-type": "application/json", @@ -518,6 +551,7 @@ def get_stats(self, queue_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="QueueStats", allow_control_chars=kwargs.get('allow_control_chars'), @@ -529,6 +563,7 @@ def get_stats(self, queue_id, **kwargs): resource_path=resource_path, method=method, path_params=path_params, + query_params=query_params, header_params=header_params, response_type="QueueStats", allow_control_chars=kwargs.get('allow_control_chars'), @@ -536,19 +571,149 @@ def get_stats(self, queue_id, **kwargs): api_reference_link=api_reference_link, required_arguments=required_arguments) + def list_channels(self, queue_id, **kwargs): + """ + Gets the list of IDs of non-empty channels. + It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics. + API supports optional channelFilter parameter which will filter the returned results according to the specified filter. + List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated. + + + :param str queue_id: (required) + The unique queue identifier. + + :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 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`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str page: (optional) + For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see `List Pagination`__. + + __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine + + :param str channel_filter: (optional) + Optional parameter to filter the channels. + + :param obj retry_strategy: (optional) + A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. + + This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. + The specifics of the default retry strategy are described `here `__. + + To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. + + :param bool allow_control_chars: (optional) + allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. + By default, the response will not allow control characters in strings + + :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.queue.models.ChannelCollection` + :rtype: :class:`~oci.response.Response` + + :example: + Click `here `__ to see an example of how to use list_channels API. + """ + # Required path and query arguments. These are in camelCase to replace values in service endpoints. + required_arguments = ['queueId'] + resource_path = "/queues/{queueId}/channels" + method = "GET" + operation_name = "list_channels" + api_reference_link = "https://docs.oracle.com/iaas/api/#/en/queue/20210201/ChannelCollection/ListChannels" + + # Don't accept unknown kwargs + expected_kwargs = [ + "allow_control_chars", + "retry_strategy", + "opc_request_id", + "limit", + "page", + "channel_filter" + ] + extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs] + if extra_kwargs: + raise ValueError( + "list_channels got unknown kwargs: {!r}".format(extra_kwargs)) + + path_params = { + "queueId": queue_id + } + + path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing} + + for (k, v) in six.iteritems(path_params): + if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0): + raise ValueError('Parameter {} cannot be None, whitespace or empty string'.format(k)) + + query_params = { + "limit": kwargs.get("limit", missing), + "page": kwargs.get("page", missing), + "channelFilter": kwargs.get("channel_filter", missing) + } + query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None} + + header_params = { + "accept": "application/json", + "content-type": "application/json", + "opc-request-id": kwargs.get("opc_request_id", missing) + } + header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None} + + retry_strategy = self.base_client.get_preferred_retry_strategy( + operation_retry_strategy=kwargs.get('retry_strategy'), + client_retry_strategy=self.retry_strategy + ) + if retry_strategy is None: + retry_strategy = retry.DEFAULT_RETRY_STRATEGY + + if retry_strategy: + if not isinstance(retry_strategy, retry.NoneRetryStrategy): + self.base_client.add_opc_client_retries_header(header_params) + retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback) + return retry_strategy.make_retrying_call( + self.base_client.call_api, + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ChannelCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + else: + return self.base_client.call_api( + resource_path=resource_path, + method=method, + path_params=path_params, + query_params=query_params, + header_params=header_params, + response_type="ChannelCollection", + allow_control_chars=kwargs.get('allow_control_chars'), + operation_name=operation_name, + api_reference_link=api_reference_link, + required_arguments=required_arguments) + def put_messages(self, queue_id, put_messages_details, **kwargs): """ - Puts messages in the queue + Puts messages into the queue. + You must use the `messages endpoint`__ to produce messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.PutMessagesDetails put_messages_details: (required) Details for the messages to publish. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -640,10 +805,14 @@ def put_messages(self, queue_id, put_messages_details, **kwargs): def update_message(self, queue_id, message_receipt, update_message_details, **kwargs): """ Updates the visibility of the message represented by the receipt. + You must use the `messages endpoint`__ to update messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param str message_receipt: (required) The receipt of the message retrieved from a GetMessages call. @@ -652,7 +821,7 @@ def update_message(self, queue_id, message_receipt, update_message_details, **kw Details for the message to update. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. @@ -747,16 +916,20 @@ def update_message(self, queue_id, message_receipt, update_message_details, **kw def update_messages(self, queue_id, update_messages_details, **kwargs): """ Updates multiple messages in the queue. + You must use the `messages endpoint`__ to update messages. + The messages endpoint may be different for different queues. Use :func:`get_queue` to find the queue's `messagesEndpoint`. + + __ https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint :param str queue_id: (required) - unique Queue identifier + The unique queue identifier. :param oci.queue.models.UpdateMessagesDetails update_messages_details: (required) Details for the messages to update. :param str opc_request_id: (optional) - The client request ID for tracing. + 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. diff --git a/src/oci/version.py b/src/oci/version.py index 52dff8d268..162d608856 100644 --- a/src/oci/version.py +++ b/src/oci/version.py @@ -2,4 +2,4 @@ # Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.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.111.0" +__version__ = "2.112.0"