Oracle Cloud Infrastructure - Dokumentation

Data Catalog-Ereignisse

Oracle Cloud Infrastructure-Ereignisse sind JSON-Dateien, die mit einigen Servicevorgängen ausgegeben werden und Informationen zu diesem Vorgang enthalten.

Sie können Regeln definieren, die bei einem bestimmten Ereignis eine bestimmte Aktion auslösen. Weitere Informationen finden Sie unter Überblick über Events und Erste Schritte mit Events. Informationen zum Verwalten von Regeln für Ereignisse finden Sie unter Regeln für Ereignisse verwalten.

Data Catalog gibt ein Ereignis in einer der folgenden Situationen aus:

  • ein Harvesting-Job beginnt.
  • ein Harvesting-Job endet.
  • ein Harvesting-Job nicht erfolgreich verläuft.
  • eine logische Datenentity aktualisiert wird.
  • ein benutzerdefinierter Eigenschaftswert aktualisiert wird.

Ereignistypen für Harvesting-Jobs

Beim Ausführen eines Harvesting-Jobs werden technische Metadaten von Data Catalog aus einer verbundenen Datenquelle in das Data Catalog-Repository extrahiert. Data Catalog gibt zum Beginn und Ende eines Harvesting-Jobs ein Ereignis aus. Beispiel: Sie können den Oracle Cloud Infrastructure Events-Service so einrichten, dass Sie bei erfolgreichem Abschluss eines Harvesting-Jobs eine E-Mail erhalten.

Benutzerfreundlicher Name Beschreibung Ereignistyp
Harvest - Begin

Beim Starten eines Harvesting-Jobs durch Data Catalog wird ein Ereignis mit Informationen zum Job wie Datenassetname, Compartment-ID und Harvesting-Status IN_PROGRESS ausgegeben.

 com.oraclecloud.datacatalog.harvestjob.begin
Harvest - End

Nachdem ein Harvesting-Job beendet wurde, gibt Data Catalog ein Ereignis mit dem Harvesting-Status SUCCEEDED oder FAILED aus.

 com.oraclecloud.datacatalog.harvestjob.end
Beispiel für Harvesting-Jobereignis

Das folgende Referenzereignis ist ein Beispiel für ein Ereignis nach erfolgreichem Abschluss eines Harvesting-Jobs:

{
    "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>"
    }
  }

Ereignistyp für logische Datenentitys

Eine logische Datenentity ist eine Gruppe von Objektspeicherdateien, die durch Erstellen und Zuweisen von Dateinamensmustern zu einem Datenasset abgeleitet werden. Data Catalog gibt Ereignisse aus, wenn eine logische Datenentity aktualisiert wird. Beispiel: Wenn Sie eine logische Datenentity erstellen, aktualisieren oder löschen, gibt Data Catalog ein Ereignis in Form einer JSON-Datei aus. Sie können den Oracle Cloud Infrastructure Events-Service so einrichten, dass Sie diese JSON-Datei per E-Mail oder Slack erhalten, wenn logische Datenentitys in einem bestimmten Compartment aktualisiert werden.

Benutzerfreundlicher Name Beschreibung Ereignistyp
Logische Entitys - Änderung

Wenn Sie eine logische Datenentity aktualisieren, gibt Data Catalog ein Ereignis über die Änderungen aus. Die JSON-Datei für das Ereignis enthält Informationen zu den erstellten, aktualisierten und gelöschten logischen Datenentitys.

 com.oraclecloud.datacatalog.changedlogicalentities
Beispiel für logisches Datenentityereignis

Das folgende Referenzereignis ist ein Beispiel für ein Update auf logische Datenentitys:

{
    "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>"
    }
  }

Ereignistyp für Aktualisierungen benutzerdefinierter Eigenschaftswerte

Mit benutzerdefinierten Eigenschaften wird der Geschäftskontext für Datenkatalogobjekte erfasst. Data Catalog gibt ein Ereignis in Form einer JSON-Datei aus, wenn der benutzerdefinierte Eigenschaftswert eines Datenkatalogobjekts aktualisiert wird.

Sie können den Oracle Cloud Infrastructure Events-Service so einrichten, dass Sie diese JSON-Datei in einer E-Mail oder über Slack erhalten, wenn ein benutzerdefinierter Eigenschaftswert in einem bestimmten Compartment aktualisiert wird.

Benutzerfreundlicher Name Beschreibung Ereignistyp

Benutzerdefinierter Eigenschaftswert - Aktualisierung

Wenn Sie den benutzerdefinierten Eigenschaftswert eines Datenkatalogobjekts hinzufügen, aktualisieren oder löschen, gibt Data Catalog ein Ereignis aus. Die JSON-Datei für das Ereignis enthält Informationen über das aktualisierte Objekt, die benutzerdefinierte Eigenschaft und den Wert der benutzerdefinierten Eigenschaft.

 com.oraclecloud.datacatalog.object.customproperty.update
Beispiel für das Aktualisierungsereignis für benutzerdefinierte Eigenschaftswerte

Im Folgenden finden Sie ein Referenzereignis für eine Aktualisierung eines benutzerdefinierten Eigenschaftswerts:

{
 "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>"
 }
}