En este documento, se describe cómo importar metadatos de un sistema de terceros al catálogo universal de Dataplex con los métodos de la API de importación de metadatos y tu propia canalización. Los metadatos de Dataplex Universal Catalog constan de entradas y sus aspectos.
Si, en cambio, deseas usar una canalización de orquestación administrada por Google Cloudpara extraer e importar metadatos, te sugerimos que uses unacanalización de conectividad administrada. Con una canalización de conectividad administrada, puedes traer tu propio conector que extrae metadatos y genera resultados en un formato que los métodos de la API de importación de metadatos (el archivo de importación de metadatos) pueden usar como entrada. Luego, usas Workflows para organizar las tareas de la canalización.
Puedes ejecutar los siguientes tipos de trabajos de importación de metadatos:
- Sincronización completa de las entradas con importación incremental de sus aspectos. Se admite para entradas personalizadas.
- Importación incremental solo de aspectos. Se admite para los aspectos que pertenecen a entradas personalizadas y entradas del sistema. En el caso de las entradas personalizadas, puedes modificar tanto los aspectos opcionales como los obligatorios. En el caso de las entradas del sistema, puedes modificar aspectos opcionales.
Pasos de alto nivel
Para importar metadatos con la API de importación de metadatos, sigue estos pasos generales:
Determina el alcance del trabajo.
También debes comprender cómo Dataplex Universal Catalog aplica la lógica de comparación y el modo de sincronización para las entradas y los aspectos.
Crea uno o más archivos de importación de metadatos que definan los datos que se importarán.
Guarda los archivos de importación de metadatos en un bucket de Cloud Storage.
Ejecuta un trabajo de importación de metadatos.
En los pasos de esta página, se supone que conoces los conceptos de metadatos de Dataplex Universal Catalog, incluidos los grupos de entradas, los tipos de entradas y los tipos de aspectos. Para obtener más información, consulta Acerca de la administración del catálogo de datos en Dataplex Universal Catalog.
Antes de comenzar
Antes de importar metadatos, completa las tareas de esta sección.
Roles obligatorios
Para garantizar que la cuenta de servicio de Dataplex Universal Catalog tenga los permisos necesarios para acceder al bucket de Cloud Storage, pídele a tu administrador que le otorgue a la cuenta de servicio de Dataplex Universal Catalog el rol de IAM de visualizador de objetos de almacenamiento (roles/storage.objectViewer
) y el permiso storage.buckets.get
en el bucket.
Para obtener los permisos que necesitas para administrar trabajos de importación de metadatos, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Modifica las entradas y sus aspectos en un trabajo de metadatos de sincronización de entradas completas:
-
Usuario de Tipo de entrada de Dataplex (
roles/dataplex.entryTypeUser
) en el tipo de entrada o el proyecto en el que se define el tipo de entrada -
Usuario de Tipos de aspecto de Dataplex (
roles/dataplex.aspectTypeUser
) en el tipo de aspecto o el proyecto en el que se define el tipo de aspecto
-
Usuario de Tipo de entrada de Dataplex (
-
Modifica los aspectos requeridos en un trabajo de metadatos solo de aspectos:
-
Usuario de Tipo de entrada de Dataplex (
roles/dataplex.entryTypeUser
) en el tipo de entrada o el proyecto en el que se define el tipo de entrada -
Usuario de Tipos de aspecto de Dataplex (
roles/dataplex.aspectTypeUser
) en el tipo de aspecto o el proyecto en el que se define el tipo de aspecto
-
Usuario de Tipo de entrada de Dataplex (
-
Modificar aspectos opcionales en un trabajo de metadatos solo de aspectos:
Usuario de Tipos de aspecto de Dataplex (
roles/dataplex.aspectTypeUser
) en el tipo de aspecto o el proyecto en el que se define el tipo de aspecto Ten en cuenta que, cuando modificas aspectos opcionales en un trabajo de metadatos solo de aspectos, no necesitas permisos para el tipo de entrada asociado. -
Crea trabajos de importación de metadatos:
-
Importador de grupo de entradas de Dataplex (
roles/dataplex.entryGroupImporter
) en el proyecto o el recurso -
Propietario de entrada de Dataplex (
roles/dataplex.entryOwner
) en el proyecto o el recurso
-
Importador de grupo de entradas de Dataplex (
-
Ver trabajos de metadatos:
Visualizador de trabajos de metadatos de Dataplex (
roles/dataplex.metadataJobViewer
) en el proyecto -
Crear, ver y cancelar trabajos de metadatos:
Propietario de trabajos de metadatos de Dataplex (
roles/dataplex.metadataJobOwner
) en el proyecto
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
Crea recursos Google Cloud
Prepara los siguientes Google Cloud recursos:
- Crea un grupo de entrada para las entradas que deseas importar.
- Crea tipos de aspecto para los aspectos que deseas importar.
- Crea tipos de entrada para las entradas que quieras importar.
- Si ejecutas un trabajo de metadatos solo de aspectos, crea entradas para los aspectos que quieras importar.
- Crea un bucket de Cloud Storage para almacenar tus archivos de importación de metadatos.
Componentes de un trabajo de importación de metadatos
Cuando importes metadatos, ten en cuenta los siguientes componentes de un trabajo de metadatos:
- Alcance del trabajo: Grupo de entrada, tipos de entrada y tipos de aspecto que se incluirán en el trabajo.
- Modo de sincronización: Indica cómo se actualizan las entradas y los aspectos del trabajo.
- Archivo de importación de metadatos: Es un archivo que define los valores que se deben establecer para las entradas y los aspectos del trabajo. Puedes proporcionar varios archivos de importación de metadatos en el mismo trabajo de metadatos. Guardas los archivos en Cloud Storage.
- Lógica de comparación: Indica cómo Dataplex Universal Catalog determina qué entradas y aspectos modificar.
Alcance del trabajo
El alcance del trabajo define el grupo de entradas, los tipos de entrada y los tipos de aspecto que deseas incluir en un trabajo de importación de metadatos. Cuando importas metadatos, modificas las entradas y los aspectos que pertenecen a los recursos dentro del alcance del trabajo.
Para definir el alcance del trabajo, sigue estos lineamientos:
Grupo de entradas: Especifica un solo grupo de entradas para incluir en el trabajo. El trabajo solo modifica las entradas y los aspectos que pertenecen a este grupo de entradas. El grupo de entrada y el trabajo deben estar en la misma región.
Tipos de entrada: Especifica uno o más tipos de entrada para incluir en el trabajo. El trabajo solo modifica las entradas y los aspectos que pertenecen a estos tipos de entrada. La ubicación de un tipo de entrada debe coincidir con la ubicación del trabajo o el tipo de entrada debe ser global.
Tipos de aspectos: Especifica uno o más tipos de aspectos para incluir en el trabajo. El trabajo solo modifica los aspectos que pertenecen a estos tipos de aspectos. La ubicación de un tipo de aspecto debe coincidir con la ubicación del empleo o el tipo de aspecto debe ser global.
El alcance del trabajo debe incluir todos los tipos de entrada y tipos de aspecto que especifiques en el archivo de importación de metadatos.
Especificas el alcance del trabajo cuando creas un trabajo de metadatos.
Modo de sincronización
El modo de sincronización especifica cómo se actualizan las entradas y los aspectos en un trabajo de importación de metadatos. Proporcionas un modo de sincronización para las entradas y los aspectos. Según los recursos que desees importar, se admiten las siguientes combinaciones de modos de sincronización.
Objetivo | Modo de sincronización de entrada | Modo de sincronización de aspectos | Resultados |
---|---|---|---|
Importa entradas y sus aspectos | FULL |
INCREMENTAL |
Se modifican todas las entradas del alcance del trabajo. Si una entrada existe en Dataplex Universal Catalog, pero no se incluye en el archivo de importación de metadatos, la entrada se borra cuando ejecutas el trabajo de metadatos. Un aspecto se modifica solo si el archivo de importación de metadatos incluye una referencia al aspecto en el campo |
Importar solo aspectos | NONE |
INCREMENTAL |
Los aspectos se modifican si forman parte del alcance del trabajo y si el archivo de importación de metadatos incluye una referencia a los aspectos en el campo No se modifican otros metadatos que pertenecen a las entradas del alcance del trabajo. |
Especificas el modo de sincronización cuando creas un trabajo de metadatos.
Archivo de importación de metadatos
El archivo de importación de metadatos es una colección de las entradas y los aspectos que deseas modificar. Define los valores que se establecerán para todos los campos que pertenecen a estas entradas y aspectos. Prepara el archivo antes de ejecutar un trabajo de importación de metadatos.
Se aplican los siguientes lineamientos generales:
- Puedes proporcionar varios archivos de importación de metadatos en el mismo trabajo de metadatos.
Cuando ejecutas un trabajo de metadatos de sincronización de entradas completa, las entradas que proporcionas en el archivo reemplazan por completo todas las entradas existentes para los recursos que se encuentran dentro del alcance del trabajo. Esto significa que debes incluir valores para todas las entradas de un trabajo, no solo los valores que deseas agregar o actualizar. Para obtener una lista de las entradas actuales de tu proyecto y usarla como punto de partida, usa el método de la API de
entries.list
.Debes proporcionar un archivo de importación de metadatos como parte de un trabajo de metadatos. Si deseas borrar todos los datos existentes de las entradas que se encuentran dentro del alcance del trabajo, proporciona un archivo de importación de metadatos vacío.
Todas las entradas y los aspectos que incluyas en el archivo deben pertenecer a los grupos de entradas, los tipos de entrada y los tipos de aspecto que definas en el alcance del trabajo.
Usa los lineamientos detallados de las siguientes secciones para crear un archivo de importación de metadatos.
Estructura del archivo
Cada línea del archivo de importación de metadatos contiene un objeto JSON que corresponde a un elemento de importación. Un elemento de importación es un objeto que describe los valores que se modificarán para una entrada y sus aspectos adjuntos.
Puedes proporcionar varios elementos de importación en un solo archivo de importación de metadatos. Sin embargo, no proporciones el mismo elemento de importación más de una vez en un trabajo de metadatos. Usa un carácter de salto de línea (0x0a
) para separar cada elemento de importación.
Un archivo de importación de metadatos con un carácter de nueva línea entre cada elemento de importación se ve como el siguiente ejemplo:
{ "entry": { "name": "entry 1", #Information about entry 1 }
{ "entry": { "name": "entry 2", #Information about entry 2 }
Estructura de un elemento de importación
Cada elemento de importación del archivo de importación de metadatos puede incluir los siguientes campos (consulta ImportItem
). El siguiente ejemplo tiene el formato de saltos de línea para facilitar la lectura, pero, cuando guardes el archivo, incluye un carácter de nueva línea solo después de cada elemento de importación. No incluyas saltos de línea entre los campos de un solo elemento de importación.
{
"entry": {
"name": "ENTRY_NAME",
"entryType": "ENTRY_TYPE",
"entrySource": {
"resource": "RESOURCE",
"system": "SYSTEM",
"platform": "PLATFORM",
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION",
"createTime": "ENTRY_CREATE_TIMESTAMP",
"updateTime": "ENTRY_UPDATE_TIMESTAMP"
},
"aspects": {
"ASPECT": {
"data": {
"KEY": "VALUE"
},
"aspectSource": {
"createTime": "ASPECT_CREATE_TIMESTAMP",
"updateTime": "ASPECT_UPDATE_TIMESTAMP"
}
},
# Additional aspect maps
},
"parentEntry": "PARENT_ENTRY",
"fullyQualifiedName": "FULLY_QUALIFIED_NAME"
},
"updateMask": "UPDATE_MASK_FIELDS",
"aspectKeys": [
"ASPECT_KEY",
# Additional aspect keys
],
}
Reemplaza lo siguiente:
entry
: Es información sobre una entrada y sus aspectos adjuntos. En un trabajo de importación de metadatos solo de aspectos, Dataplex Universal Catalog ignora todos los campos opcionales de una entrada, excepto los mapas de aspectos.- ENTRY_NAME: Es el nombre del recurso relativo de la entrada, en el formato
projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID
. - ENTRY_TYPE: Es el nombre del recurso relativo del tipo de entrada que se usó para crear esta entrada, en el formato
projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID
. entrySource
: Es la información del sistema fuente sobre el recurso de datos que representa la entrada:- RESOURCE: Es el nombre del recurso en el sistema de origen.
- SYSTEM: Es el nombre del sistema fuente.
- PLATFORM: Es la plataforma que contiene el sistema fuente.
- DISPLAY_NAME: Es un nombre visible fácil de usar.
- DESCRIPTION: Es una descripción de la entrada.
- ENTRY_CREATE_TIMESTAMP: Es la fecha y hora en que se creó la entrada en el sistema fuente.
- ENTRY_UPDATE_TIMESTAMP: Es la fecha y hora en que se actualizó la entrada en el sistema fuente.
aspects
: Son los aspectos adjuntos a la entrada. El objetoaspect
y sus datos se denominan mapa de aspectos.ASPECT: Es un aspecto adjunto a la entrada. Según cómo se adjunte el aspecto a la entrada, usa uno de los siguientes formatos:
- Si el aspecto está adjunto directamente a la entrada, proporciona el nombre del recurso relativo de su tipo de aspecto, en el formato
PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID
. - Si el aspecto está adjunto a la ruta de la entrada, proporciona la ruta del tipo de aspecto, en el formato
PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID@PATH
.
- Si el aspecto está adjunto directamente a la entrada, proporciona el nombre del recurso relativo de su tipo de aspecto, en el formato
KEY y VALUE: El contenido del aspecto, según su plantilla de metadatos de tipo de aspecto. El contenido debe estar codificado como UTF-8. El tamaño máximo del campo es de 120 KB. El diccionario
data
es obligatorio, incluso si está vacío.ASPECT_CREATE_TIMESTAMP: Es la fecha y hora en que se creó el aspecto en el sistema fuente.
ASPECT_UPDATE_TIMESTAMP: Es la fecha y hora en que se actualizó el aspecto en el sistema fuente.
PARENT_ENTRY: Es el nombre del recurso de la entrada principal.
FULLY_QUALIFIED_NAME: Es un nombre para la entrada al que puede hacer referencia un sistema externo. Consulta Nombres completamente calificados.
- ENTRY_NAME: Es el nombre del recurso relativo de la entrada, en el formato
UPDATE_MASK_FIELDS: Son los campos que se actualizarán, en rutas relativas al recurso
Entry
. Separa cada campo con una coma.En un trabajo de sincronización de entradas completo, Dataplex Universal Catalog incluye las rutas de todos los campos de una entrada que se pueden modificar, incluidos los aspectos. El campo
updateMask
se ignora cuando se crea o se vuelve a crear una entrada.En un trabajo de metadatos solo de aspectos, establece este valor en
aspects
.ASPECT_KEY: Son los aspectos que se modificarán. Admite las siguientes sintaxis:
ASPECT_TYPE_REFERENCE
: Coincide con el tipo de aspecto para los aspectos que se adjuntan directamente a la entrada.ASPECT_TYPE_REFERENCE@PATH
: Coincide con el tipo de aspecto y la ruta de acceso especificada.ASPECT_TYPE_REFERENCE@*
: Coincide con el tipo de aspecto para todas las rutas.*@PATH
: Coincide con todos los tipos de aspectos en la ruta de acceso especificada.
Reemplaza
ASPECT_TYPE_REFERENCE
por una referencia al tipo de aspecto, en el formatoPROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID
.En un trabajo de sincronización de entrada completa, si dejas este campo vacío, se considera que especificas exactamente los aspectos que están presentes en la entrada especificada. Dataplex Universal Catalog agrega de forma implícita las claves de todos los aspectos requeridos de una entrada.
Requisitos de los archivos
El archivo de importación de metadatos debe cumplir con los siguientes requisitos:
- El archivo debe tener el formato de un archivo de líneas JSON, que es un archivo JSON delimitado por saltos de línea. Usa un carácter de salto de línea (
0x0a
) para separar cada elemento de importación. - El archivo debe usar la codificación de caracteres UTF-8.
- Las extensiones de archivo compatibles son
.jsonl
y.json
. - El tamaño de cada archivo de importación de metadatos debe ser inferior a 1 GiB. El tamaño total máximo para todos los datos en el trabajo de metadatos es de 3 GB. Esto incluye todos los archivos y metadatos asociados con el trabajo.
- Los tipos de entrada y los tipos de aspecto que especifiques en el archivo deben formar parte del alcance del trabajo de metadatos.
- El archivo debe subirse a un bucket de Cloud Storage. No guardes el archivo en una carpeta llamada
CLOUD_STORAGE_URI/deletions/
.
Lógica de comparación
Dataplex Universal Catalog determina qué entradas y aspectos modificar comparando los valores y las marcas de tiempo que proporcionas en el archivo de importación de metadatos con los valores y las marcas de tiempo que existen en tu proyecto.
En un nivel general, Dataplex Universal Catalog actualiza los valores de tu proyecto cuando al menos un cambio propuesto en el archivo de importación de metadatos modificará el estado de tu proyecto cuando se ejecute el trabajo, sin introducir datos desactualizados. El cambio propuesto debe mencionarse en el campo de máscara de actualización o en el campo de claves de aspectos del archivo de importación de metadatos.
La lógica de comparación varía según el tipo de trabajo de importación de metadatos que ejecutes.
Trabajo de sincronización de entrada completa
En un trabajo de metadatos de sincronización de entrada completa, para cada entrada que forma parte del alcance del trabajo, Dataplex Universal Catalog realiza una de las siguientes acciones:
- Crea una entrada y aspectos adjuntos. Si el archivo de importación de metadatos incluye una entrada que no existe en tu proyecto, Dataplex Universal Catalog crea la entrada y los aspectos adjuntos.
- Borra una entrada y los aspectos adjuntos. Si existe una entrada en tu proyecto, pero el archivo de importación de metadatos no la incluye, Dataplex Universal Catalog borrará la entrada y sus aspectos adjuntos de tu proyecto.
Actualiza una entrada y los aspectos adjuntos. Si existe una entrada tanto en el archivo de importación de metadatos como en tu proyecto, Dataplex Universal Catalog evalúa las marcas de tiempo de la fuente de la entrada y las marcas de tiempo de la fuente del aspecto asociadas con la entrada para determinar qué valores modificar. Luego, Dataplex Universal Catalog realiza una o más de las siguientes acciones:
- Vuelve a crear la entrada. Si la marca de tiempo de creación de la fuente de entrada en el archivo de importación de metadatos es más reciente que la marca de tiempo correspondiente en tu proyecto, Dataplex Universal Catalog vuelve a crear la entrada en tu proyecto.
- Actualiza la entrada. Si la marca de tiempo de actualización de la fuente de entrada en el archivo de importación de metadatos es más reciente que la marca de tiempo correspondiente en tu proyecto, Dataplex Universal Catalog actualizará la entrada en tu proyecto.
- Crea un aspecto. Si un aspecto no existe en tu proyecto y se incluye en un mapa de aspectos, el campo de máscara de actualización y el campo de claves de aspectos en el archivo de importación de metadatos, Dataplex Universal Catalog crea el aspecto.
- Borra un aspecto. Si un aspecto existe en tu proyecto y se incluye en el campo de máscara de actualización y en el campo de claves de aspecto del archivo de importación de metadatos, pero no se incluye en un mapa de aspectos, Dataplex Universal Catalog borra el aspecto.
Actualiza un aspecto. Si un aspecto existe en tu proyecto y se incluye en un mapa de aspectos, el campo de máscara de actualización y el campo de claves de aspectos en el archivo de importación de metadatos, y la marca de tiempo de actualización de la fuente del aspecto en el archivo de importación de metadatos es más reciente que la marca de tiempo correspondiente en tu proyecto, Dataplex Universal Catalog actualiza el aspecto.
Si no se proporciona una marca de tiempo de actualización de la fuente del aspecto en el archivo de importación de metadatos, pero la entrada correspondiente está marcada para una actualización, Dataplex Universal Catalog también actualiza el aspecto.
Sin embargo, si al menos un aspecto del archivo de importación de metadatos tiene una marca de tiempo anterior a la marca de tiempo correspondiente de tu proyecto, Dataplex Universal Catalog no realizará ninguna actualización para la entrada adjunta.
Trabajo solo de aspecto
En un trabajo de metadatos solo de aspectos, para cada aspecto que forma parte del alcance del trabajo, Dataplex Universal Catalog realiza una de las siguientes acciones:
- Crea un aspecto. Si un aspecto no existe en tu proyecto y se incluye en un mapa de aspectos, el campo de máscara de actualización y el campo de claves de aspectos en el archivo de importación de metadatos, Dataplex Universal Catalog crea el aspecto.
Borra un aspecto. En el caso de los aspectos opcionales, si el aspecto existe en tu proyecto y se incluye en el campo de máscara de actualización y en el campo de claves de aspecto del archivo de importación de metadatos, pero no se incluye en un mapa de aspectos, Dataplex Universal Catalog borra el aspecto.
No se pueden borrar los aspectos obligatorios.
Actualiza un aspecto. Si un aspecto existe en tu proyecto y se incluye en un mapa de aspectos, el campo de máscara de actualización y el campo de claves de aspectos en el archivo de importación de metadatos, y la marca de tiempo de actualización de la fuente del aspecto en el archivo de importación de metadatos es más reciente que la marca de tiempo correspondiente en tu proyecto, Dataplex Universal Catalog actualiza el aspecto.
Si no se proporciona una marca de tiempo de actualización de la fuente del aspecto en el archivo de importación de metadatos, Dataplex Universal Catalog también actualiza el aspecto.
Dataplex Universal Catalog actualiza los aspectos según la marca de tiempo de actualización de la fuente del aspecto, independientemente de la marca de tiempo de actualización de la fuente de la entrada correspondiente.
Crea un archivo de importación de metadatos
Antes de importar metadatos, crea un archivo de importación de metadatos para tu trabajo. Sigue estos pasos:
- Prepara un archivo de importación de metadatos siguiendo los lineamientos que se describieron anteriormente en este documento.
- Sube el archivo a un bucket de Cloud Storage.
Puedes proporcionar varios archivos de importación de metadatos en el mismo trabajo de metadatos. Para proporcionar varios archivos, guárdalos en el mismo bucket de Cloud Storage. Cuando ejecutas el trabajo, especificas un bucket, no un archivo específico. Dataplex Universal Catalog importa metadatos de todos los archivos guardados en el bucket, incluidos los que se encuentran en subcarpetas.
Ejecuta un trabajo de importación de metadatos
Después de crear un archivo de importación de metadatos, ejecuta un trabajo de importación de metadatos con la API.
REST
Para importar metadatos, usa el método metadataJobs.create
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_NUMBER: Tu número de proyecto o ID del proyecto de Google Cloud .
- LOCATION_ID: La ubicación Google Cloud , como
us-central1
. - METADATA_JOB_ID: es opcional. Es el ID del trabajo de metadatos.
CLOUD_STORAGE_URI: Es el URI del bucket o la carpeta de Cloud Storage que contiene los archivos de importación de metadatos. Para obtener más información sobre los requisitos del archivo, consulta Archivo de importación de metadatos.
- ENTRY_GROUP: Es el nombre del recurso relativo del grupo de entradas que está dentro del alcance del trabajo, en el formato
projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID
. Proporciona solo un grupo de entrada. Para obtener más información, consulta Alcance del trabajo. ENTRY_TYPE: Es el nombre del recurso relativo de un tipo de entrada que está dentro del alcance del trabajo, en el formato
projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID
. Para obtener más información, consulta Alcance del trabajo.- ASPECT_TYPE: Es el nombre del recurso relativo de un tipo de aspecto que está dentro del alcance del trabajo, en el formato
projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/aspectTypes/ASPECT_TYPE_ID
. Es opcional cuando se crea un trabajo de sincronización de entrada completa y obligatorio cuando se crea un trabajo solo de aspectos. Para obtener más información, consulta Alcance del trabajo. - ENTRY_SYNC_MODE: Es el modo de sincronización de la entrada, como
FULL
oNONE
. Para obtener más información, consulta Modo de sincronización. - LOG_LEVEL: Es el nivel de registros que se capturarán, como
INFO
oDEBUG
. Para obtener más información, consulta Visualiza los registros de trabajos y soluciona problemas.
Método HTTP y URL:
POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs?metadataJobId=METADATA_JOB_ID
Cuerpo JSON de la solicitud:
{ "type": IMPORT, "import_spec": { "source_storage_uri": "gs://CLOUD_STORAGE_URI/", "scope": { "entryGroups": [ "ENTRY_GROUP" ], "entry_types": [ "ENTRY_TYPE" ], "aspect_types": [ "ASPECT_TYPE" ] }, "entry_sync_mode": ENTRY_SYNC_MODE, "aspect_sync_mode": INCREMENTAL, "log_level": LOG_LEVEL } }
Para enviar tu solicitud, expande una de estas opciones:
La respuesta identifica una operación de larga duración.
Obtén detalles sobre un trabajo de metadatos
Para obtener información sobre un trabajo de metadatos, como el estado del trabajo y la cantidad de entradas que se modificaron, sigue estos pasos. Para obtener más información sobre cómo solucionar problemas de un trabajo fallido, consulta la sección Consulta los registros de trabajos y soluciona problemas de este documento.
REST
Para obtener información sobre un trabajo de metadatos, usa el método metadataJobs.get
.
Obtén una lista de trabajos de metadatos
Puedes obtener una lista de los trabajos de metadatos más recientes. Los trabajos más antiguos que alcanzaron un estado final se borran periódicamente del sistema.
REST
Para obtener una lista de los trabajos de metadatos más recientes, usa el método metadataJobs.list
.
Cancela un trabajo de metadatos
Puedes cancelar un trabajo de metadatos que no quieras ejecutar.
REST
Para cancelar un trabajo de metadatos, usa el método metadataJobs.cancel
.
Visualiza los registros de trabajos y soluciona problemas
Usa Cloud Logging para ver los registros de un trabajo de metadatos. Para obtener más información, consulta Supervisa los registros de Dataplex Universal Catalog.
El nivel de registro se configura cuando creas un trabajo de metadatos. Están disponibles los siguientes niveles de registro:
INFO
: Proporciona registros a nivel general del trabajo. Incluye registros agregados sobre los elementos de importación, pero no especifica qué elemento de importación tiene un error.DEBUG
: Proporciona registros detallados para cada elemento de importación. Usa el registro a nivel de depuración para solucionar problemas con elementos de importación específicos. Por ejemplo, usa el registro de nivel de depuración para identificar los recursos que faltan en el alcance del trabajo, las entradas o los aspectos que no se ajustan al tipo de entrada o al tipo de aspecto asociados, o bien otras configuraciones incorrectas con el archivo de importación de metadatos.
Errores de validación
Dataplex Universal Catalog valida los archivos de importación de metadatos en función de los metadatos actuales de tu proyecto. Si hay un problema de validación, el estado del trabajo puede devolver uno de los siguientes estados:
FAILED
: Se produce cuando el archivo de importación de metadatos tiene un error. Dataplex Universal Catalog no importa ningún metadato y el trabajo falla. Estos son algunos ejemplos de errores en el archivo de importación de metadatos:- No se puede analizar un elemento del archivo para convertirlo en un elemento de importación válido
- Una entrada o un aspecto del archivo pertenece a un grupo de entradas, un tipo de entrada o un tipo de aspecto que no forma parte del alcance del trabajo.
- El mismo nombre de entrada se especifica más de una vez en el trabajo.
- Un tipo de aspecto que se especifica en un mapa de aspectos o en las claves de aspectos no usa el formato PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID@OPTIONAL_PATH.
- Se marcó un aspecto obligatorio para su eliminación
SUCCEEDED_WITH_ERRORS
: Se produce cuando el archivo de importación de metadatos se puede analizar correctamente, pero la importación de un elemento del archivo haría que una entrada de tu proyecto se encuentre en un estado incoherente. Dataplex Universal Catalog ignora esas entradas, pero importa el resto de los metadatos del archivo.
Usa los registros de trabajos para solucionar el error.
¿Qué sigue?
- Cómo buscar recursos de datos en Dataplex Universal Catalog
- Administra aspectos y enriquece los metadatos
- Administra entradas y procesa fuentes personalizadas
- Exportar metadatos