Documentação do Oracle Cloud Infrastructure

Eventos do Serviço Data Catalog

Oracle Cloud Infrastructure Events são arquivos JSON emitidos com algumas operações de serviço que carregam informações sobre essa operação.

Você pode definir regras que acionem uma ação específica quando um evento ocorrer. Para obter mais informações, consulte Visão Geral do Serviço Events e Conceitos Básicos do Serviço Events. Para obter informações sobre como gerenciar regras de eventos, consulte Gerenciando Regras de Eventos.

O serviço Data Catalog emite um evento durante um dos seguintes eventos:

  • Um job de coleta começa.
  • Um job de coleta termina.
  • Um job de coleta falha.
  • Uma entidade de dados lógica é atualizada.
  • Um valor de propriedade personalizada é atualizado.

Tipos de Evento para Jobs de Coleta

Quando você executa um job de coleta, o serviço Data Catalog extrai metadados técnicos de uma origem de dados conectada para o repositório do catálogo de dados. O serviço Data Catalog emite eventos quando um job de coleta começa e termina. Por exemplo, você pode configurar o serviço Oracle Cloud Infrastructure Events para enviar um e-mail quando jobs de coleta forem bem-sucedidos.

Nome Simples Descrição Tipo de Evento
Coleta - Início

Quando o serviço Data Catalog inicia um job de coleta, ele emite um evento com informações sobre o job, como o nome do ativo de dados, o id do compartimento e o status IN_PROGRESS da coleta.

 com.oraclecloud.datacatalog.harvestjob.begin
Coleta - Fim

Depois que um job de coleta termina, o serviço Data Catalog emite um evento com o status de coleta SUCCEEDED ou FAILED.

 com.oraclecloud.datacatalog.harvestjob.end
Exemplo de Evento de Job de Coleta

Este é um evento de referência para um evento de fim da coleta concluído com sucesso:

{
    "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 de Evento para Entidades de Dados Lógicas

Entidade de dados lógica é um grupo de arquivos de Armazenamento de Objetos que são derivados da criação e designação de padrões de nome de arquivo a um ativo de dados. O serviço Data Catalog emite eventos quando uma entidade de dados lógica é atualizada. Por exemplo, quando você cria, atualiza ou exclui uma entidade de dados lógica, o serviço Data Catalog emite um evento, na forma de um arquivo JSON. Você poderá configurar o serviço Oracle Cloud Infrastructure Events para enviar a você esse arquivo JSON por e-mail ou Slack quando as entidades de dados lógicas forem atualizadas em um compartimento específico.

Nome Simples Descrição Tipo de Evento
Entidades Lógicas - Alteração

Quando você atualiza uma entidade de dados lógica, o serviço Data Catalog emite um evento sobre as alterações. O arquivo JSON do evento inclui informações sobre as entidades de dados lógicas criadas, atualizadas e excluídas.

 com.oraclecloud.datacatalog.changedlogicalentities
Exemplo de Evento de Entidade de Dados Lógica

Este é um evento de referência para uma atualização de entidades de dados lógicas:

{
    "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 de Evento para Atualização do Valor da Propriedade Personalizada

As propriedades personalizadas são usadas para capturar o contexto de negócios dos objetos do catálogo de dados. O serviço Data Catalog emite um evento, na forma de um arquivo JSON, quando o valor da propriedade personalizada de um objeto do catálogo de dados é atualizado.

É possível configurar o Oracle Cloud Infrastructure Events para enviar a você esse arquivo JSON por e-mail ou por meio do Slack sempre que o valor de uma propriedade personalizada for atualizado em um compartimento específico.

Nome Simples Descrição Tipo de Evento

Valor da Propriedade Personalizada - Atualizar

Quando você adiciona, atualiza ou exclui o valor de propriedade personalizada de um objeto do catálogo de dados, o serviço Data Catalog emite um evento. O arquivo JSON do evento inclui informações sobre o objeto atualizado, a propriedade personalizada e o valor da propriedade personalizada.

 com.oraclecloud.datacatalog.object.customproperty.update
Exemplo de Evento de Atualização do Valor da Propriedade Personalizada

Este é um evento de referência para uma atualização do valor de uma propriedade personalizada:

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