Documentazione dell'infrastruttura Oracle Cloud

Eventi Data Catalog

Oracle Cloud Infrastructure Events sono file JSON emessi con alcune operazioni di servizio e che contengono informazioni su tale operazione.

È possibile definire regole che attivano un'azione specifica quando si verifica un evento. Per ulteriori informazioni, vedere Panoramica degli eventi e Guida introduttiva agli eventi. Per informazioni sulla gestione delle regole per gli eventi, vedere Gestione delle regole per gli eventi.

Data Catalog emette un evento durante uno degli eventi riportati di seguito.

  • Inizia un lavoro di raccolta.
  • Un lavoro di raccolta termina.
  • Un processo di raccolta non riesce.
  • Un'entità dati logica viene aggiornata.
  • Il valore di una proprietà personalizzata viene aggiornato.

Tipi di evento per job di raccolta

Quando si esegue un job di raccolta, Data Catalog estrae i metadati tecnici da un'origine dati connessa nel repository di Data Catalog. Data Catalog emette eventi quando inizia e termina un job di raccolta. Ad esempio, puoi impostare il servizio Oracle Cloud Infrastructure Events per l'invio di un messaggio di posta elettronica quando i job di raccolta hanno esito positivo.

Nome descrittivo descrizione; Tipo di evento
Raccolta - Inizio

Quando Data Catalog avvia un job di raccolta, emette un evento che contiene informazioni sul job, ad esempio il nome dell'asset dati, l'ID compartimento e lo stato di raccolta IN_PROGRESS.

 com.oraclecloud.datacatalog.harvestjob.begin
Raccolta - Fine

Al termine di un job di raccolta, Data Catalog emette un evento con stato di raccolta impostato su SUCCEEDED o FAILED.

 com.oraclecloud.datacatalog.harvestjob.end
Esempio di evento job di raccolta

Di seguito è riportato un evento di riferimento per un evento di fine raccolta completato correttamente.

{
    "eventType": "com.oraclecloud.datacatalog.harvestjob.end",
    "eventID": "<unique_ID>",
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "eventGroupingId": "<JobExecutionKey>",
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>",
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "SUCCEEDED",
        "jobUrl": "<Url to get the execution details of the job>"
        "HarvestedFoldersCount" : 0,
        "HarvestedEntitiesCount" : 0,
        "HarvestedLogicalEntitiesCount" : 0,
        "HarvestedPhysicalEntitiesCount" : 0,
        "HarvestedArchivedFilesCount" : 0,
        "SkippedFilesCount" : 0,
        "HarvestedUnrecognizedFilesCount" : 0,
        "HarvestedFoldersCountStr" : "0",
        "HarvestedEntitiesCountStr" : "0",
        "HarvestedLogicalEntitiesCountStr" : "0",
        "HarvestedPhysicalEntitiesCountStr" : "0",
        "HarvestedArchivedFilesCountStr" : "0",
        "SkippedFilesCountStr" : "0",
        "HarvestedUnrecognizedFilesCountStr" : "0"
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Tipo di evento per entità dati logiche

Un'entità dati logica è un gruppo di file di storage degli oggetti che vengono derivati creando e assegnando pattern di nomi file a un asset dati. Data Catalog emette eventi quando viene aggiornata un'entità dati logica. Ad esempio, quando si crea, aggiorna o elimina un'entità dati logica, Data Catalog emette un evento sotto forma di file JSON. È possibile impostare il servizio Oracle Cloud Infrastructure Events per l'invio di questo file JSON tramite posta elettronica o Slack quando le entità dati logiche vengono aggiornate in un compartimento specifico.

Nome descrittivo descrizione; Tipo di evento
Entità logiche - Modifica

Quando si aggiorna un'entità dati logica, Data Catalog emette un evento relativo alle modifiche. Il file JSON per l'evento include informazioni sulle entità dati logiche create, aggiornate ed eliminate.

 com.oraclecloud.datacatalog.changedlogicalentities
Esempio di evento entità dati logica

Di seguito è riportato un evento di riferimento per un aggiornamento alle entità dati logiche.

{
    "eventType": "com.oraclecloud.datacatalog.changedlogicalentities",
    "eventID": "<unique_ID>"
,
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>"
,
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "<IN_PROGRESS/SUCCEEDED/FAILED>",
        "createdLogicalEntities": ["LE_key1", "LE_key2"],
        "updatedLogicalEntities": ["LE_key3", "LE_key4"],
        "deletedLogicalEntities": ["LE_key5", "LE_key6"]
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Tipo di evento per aggiornamento valore proprietà personalizzata

Le proprietà personalizzate vengono utilizzate per acquisire il contesto aziendale per gli oggetti Data Catalog. Data Catalog emette un evento, sotto forma di file JSON, quando viene aggiornato il valore della proprietà personalizzata di un oggetto Data Catalog.

Puoi impostare il servizio Oracle Cloud Infrastructure Events per l'invio di questo file JSON a un indirizzo di posta elettronica o tramite Slack, ogni volta che il valore di una proprietà personalizzata viene aggiornato in un compartimento specifico.

Nome descrittivo descrizione; Tipo di evento

Valore proprietà personalizzata - Aggiorna

Quando si aggiunge, si aggiorna o si elimina il valore della proprietà personalizzata di un oggetto Data Catalog, Data Catalog emette un evento. Il file JSON per l'evento include informazioni sull'oggetto aggiornato, sulla proprietà personalizzata e sul valore della proprietà personalizzata.

 com.oraclecloud.datacatalog.object.customproperty.update
Esempio di evento di aggiornamento valore proprietà personalizzata

Di seguito è riportato un evento di riferimento per un aggiornamento a un valore di proprietà personalizzato.

{
 "eventType" : "com.oraclecloud.datacatalog.object.customproperty.update",
 "eventID" : "<unique_ID>",
 "cloudEventsVersion" : "0.1",
 "eventTypeVersion" : "2.0",
 "source" : "DataCatalog",
 "eventTime" : "2021-06-21T11:12:15Z",
 "contentType" : "application/json",
 "data" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>",
   "compartmentName" : "<CompartmentName where the user's catalog resides>",
   "resourceName" : "",
   "resourceId" : "ocid1.datacatalog.oc1.<unique_ID>",
   "additionalDetails" : {
     "associatedObjectKey" : "<AssociatedObjectKey>",
     "associatedObjectType" : "<AssociatedObjectType>",
     "customPropertyKey" : "<CustomPropertyKey>",
     "customPropertyDataType" : "<CustomPropertyDataType>",
     "associatedValue" : "<AssociatedValue>"
   }
 },
  "extensions" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>"
 }
}