Lineamientos para asignar un nombre a un recurso de Knowledge Catalog

Un recurso de Google Cloud es cualquier componente que crees o uses en Google Cloud. Estos recursos forman los componentes básicos de tus aplicaciones y sistemas que se ejecutan en la plataforma.

Para obtener más información sobre la asignación de nombres de recursos Google Cloud generales, consulta Nombres de recursos.

Formato de asignación de nombres de recursos

En la siguiente tabla, se enumeran los formatos de nombres de recursos completos para los recursos de Knowledge Catalog:

Recurso Formato de nombre de recurso completo
Grupo de entradas projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entry projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
Tipo de entrada projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
Tipo de aspecto projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
Vínculo de entrada projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Trabajo de metadatos projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Feed de metadatos projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glosario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Categoría del glosario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Término del glosario projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Producto de datos projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Dominio de datos projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Proceso de linaje projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Ejecución de linaje projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Evento de linaje projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Componentes del nombre del recurso

En las siguientes secciones, se proporciona un desglose de cada componente.

ID del proyecto

El valor debe ser el ID del proyecto o el número del proyecto, disponible en la consola de Google Cloud . Por ejemplo, my-cool-project es un ID del proyecto, mientras que 123456789123 es un número de proyecto.

Ubicación

El valor debe ser una de las ubicaciones admitidas de Knowledge Catalog. Para obtener una lista de las ubicaciones disponibles, consulta Ubicaciones de Knowledge Catalog.

ID de recurso

Las rutas de acceso de los recursos contienen segmentos de identificadores únicos (ID) para cada recurso y sus recursos superiores en la jerarquía. En las siguientes secciones, se explican los lineamientos de nombres y los requisitos de formato para cada tipo de ID de recurso.

IDs de recursos estándar

Excepto por los IDs de entrada y los IDs de recursos de linaje de datos, todas las variables de ID de recursos, como {ENTRY_GROUP_ID} y {GLOSSARY_ID}, deben cumplir con los siguientes lineamientos:

  • Comienza con una letra en minúscula.
  • Tener entre 1 y 63 caracteres
  • Contener solo letras minúsculas, números, guiones y guiones bajos
  • Terminar con un número o una letra minúscula

Grupos de entradas del sistema

IDs de entrada

Los lineamientos para asignar nombres a un {ENTRY_ID} son diferentes:

  • Debe incluir hasta 4,000 caracteres.

  • Usa un formato de ID de entrada basado en el Google Cloud nombre completo del recurso. El formato es el nombre completo del recurso sin las barras dobles de prefijo en la parte del nombre del servicio de la API. Esto permite recuperar entradas con su nombre de recurso asociado.

    Por ejemplo:

    • Si el nombre completo del recurso de una instancia de Looker es //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, entonces el {ENTRY_ID} sugerido es looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

IDs de recursos de linaje de datos

Los recursos de linaje de datos representan una jerarquía de operaciones de transformación de datos:

  • ID de proceso ({PROCESS_ID}): Identifica la definición de una transformación de datos (como una consulta en SQL o una canalización de ETL específicas).
  • ID de ejecución ({RUN_ID}): Identifica una sola instancia de ejecución de un proceso superior.
  • ID del evento de linaje ({LINEAGE_EVENT_ID}): Identifica un evento de movimiento de datos discreto entre fuentes y destinos que se produjo durante una ejecución.

Cuando creas recursos de linaje personalizados a través de la API, las variables {PROCESS_ID}, {RUN_ID} y {LINEAGE_EVENT_ID} deben cumplir con los siguientes lineamientos:

  • Debe incluir hasta 200 caracteres.
  • Contener solo letras (distingue mayúsculas de minúsculas), números, guiones, guiones bajos, dos puntos y puntos.

Para el linaje automatizado (como las consultas de BigQuery, Managed Service para Apache Spark o la transferencia de OpenLineage), Knowledge Catalog genera estos IDs de forma automática.

Nombres de las entradas de BigQuery

Cuando interactúas con los recursos de BigQuery a través de la API de Dataplex, debes usar un formato específico para el ID del grupo de entradas y el ID de la entrada.

  • ID del grupo de entradas: @bigquery
  • ID de entrada: bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Ejemplo

Si tu tabla de BigQuery es projects/test-project/datasets/test_dataset/tables/test_table, el nombre de la entrada de Knowledge Catalog completamente calificado es el siguiente:

projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table