Oracle Cloud Infrastructureドキュメント

データ・カタログ・イベント

Oracle Cloud Infrastructureイベントは、一部のサービス操作で発行され、その操作に関する情報を保持するJSONファイルです。

イベントの発生時に特定のアクションをトリガーするルールを定義できます。詳細は、イベントの概要およびイベントの開始を参照してください。イベントのルールの管理の詳細は、イベントのルールの管理を参照してください。

データ・カタログは、次のいずれか中にイベントを発行します:

  • 収集ジョブが開始されました。
  • 収集ジョブが終了しました。
  • 収集ジョブが失敗しました。
  • 論理データ・エンティティが更新されました。
  • カスタム・プロパティ値が更新されました。

収集ジョブのイベント・タイプ

収集ジョブを実行すると、データ・カタログは、接続されているデータ・ソースからデータ・カタログ・リポジトリに技術メタデータを抽出します。データ・カタログは、収集ジョブが開始および終了したときにイベントを発行します。たとえば、収集ジョブが成功したときに電子メールを送信するOracle Cloud Infrastructure Eventsサービスを設定できます。

わかりやすい名前 説明 イベント・タイプ
収集 - 開始

データ・カタログが収集ジョブを開始すると、データ・アセット名、コンパートメントID、IN_PROGRESSの収集ステータスなどのジョブに関する情報を含むイベントが生成されます。

 com.oraclecloud.datacatalog.harvestjob.begin
収集 - 終了

収集ジョブが終了すると、データ・カタログは、収集ステータスがSUCCEEDEDまたはFAILEDのイベントを発行します。

 com.oraclecloud.datacatalog.harvestjob.end
収集ジョブ・イベントの例

正常に完了した収集終了イベントのリファレンス・イベントを次に示します:

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

論理データ・エンティティのイベント・タイプ

論理データ・エンティティは、ファイル名パターンを作成してデータ・アセットに割り当てることで導出されるオブジェクト・ストレージ・ファイルのグループです。データ・カタログは、論理データ・エンティティが更新されたときにイベントを発行します。たとえば、論理データ・エンティティを作成、更新または削除すると、データ・カタログはJSONファイルの形式でイベントを発行します。Oracle Cloud Infrastructure Eventsサービスを設定して、特定のコンパートメントの論理データ・エンティティが更新されたときに、このJSONファイルを電子メールまたはSlackで送信できます。

わかりやすい名前 説明 イベント・タイプ
論理エンティティ - 変更

論理データ・エンティティを更新すると、データ・カタログは変更に関するイベントを発行します。イベントのJSONファイルには、作成、更新および削除された論理データ・エンティティに関する情報が含まれます。

 com.oraclecloud.datacatalog.changedlogicalentities
論理データ・エンティティ・イベントの例

論理データ・エンティティに対する更新のリファレンス・イベントを次に示します:

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

カスタム・プロパティ値更新のイベント・タイプ

カスタム・プロパティは、データ・カタログ・オブジェクトのビジネス・コンテキストを取得するために使用されます。データ・カタログ・オブジェクトのカスタム・プロパティの値が更新されると、データ・カタログはJSONファイルの形式でイベントを発行します。

Oracle Cloud Infrastructure Eventsサービスを設定して、カスタム・プロパティの値が特定のコンパートメントで更新されるたびに、このJSONファイルを電子メールまたはSlackを使用して送信できます。

わかりやすい名前 説明 イベント・タイプ

カスタム・プロパティ値 - 更新

データ・カタログ・オブジェクトのカスタム・プロパティ値を追加、更新または削除すると、データ・カタログによってイベントが発行されます。イベントのJSONファイルには、更新されたオブジェクト、カスタム・プロパティおよびカスタム・プロパティの値に関する情報が含まれています。

 com.oraclecloud.datacatalog.object.customproperty.update
カスタム・プロパティ値更新イベントの例

カスタム・プロパティ値に対する更新のリファレンス・イベントを次に示します:

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