Diretrizes para nomear um recurso do Knowledge Catalog

Um Google Cloud recurso é qualquer componente que você cria ou usa no Google Cloud. Esses recursos formam os blocos de construção dos aplicativos e sistemas em execução na plataforma.

Para mais informações sobre a nomeação geral de recursos Google Cloud , consulte Nomes de recursos.

Formato de nomeação de recursos

A tabela a seguir lista os formatos de nome de recurso completo para recursos do Knowledge Catalog:

Recurso Formato de nome de recurso completo
Grupo de entradas projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entrada 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}
Link de entrada projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
Job de metadados projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
Feed de metadados projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
Glossário projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
Categoria do glossário projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
Termo do glossário projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
Produto de dados projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
Domínio de dados projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
Processo de linhagem projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
Execução de linhagem projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
Evento de linhagem projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

Componentes do nome do recurso

As seções a seguir fornecem um detalhamento de cada componente.

ID do projeto

O valor precisa ser o ID do projeto ou o número do projeto, disponível em o Google Cloud console. Por exemplo, my-cool-project é um ID do projeto, enquanto 123456789123 é um número de projeto.

Local

O valor precisa ser um dos locais compatíveis do Knowledge Catalog. Para uma lista de locais disponíveis, consulte Locais do Knowledge Catalog.

ID do recurso

Os caminhos de recursos contêm segmentos de identificador exclusivo (ID) para cada recurso e os recursos pai na hierarquia. As seções a seguir explicam as diretrizes de nomenclatura e os requisitos de formatação para cada tipo de ID de recurso.

IDs de recursos padrão

Com exceção dos IDs de entrada e dos IDs de recursos de linhagem de dados, todas as variáveis de ID de recurso, como {ENTRY_GROUP_ID} e {GLOSSARY_ID}, precisam obedecer às seguintes diretrizes:

  • Comece com uma letra minúscula.
  • Contenha entre 1 e 63 caracteres.
  • Contenha apenas letras minúsculas, números, hifens e sublinhados.
  • Termine com um número ou uma letra minúscula.

Grupos de entradas do sistema

IDs de entrada

As diretrizes de nomenclatura para um {ENTRY_ID} são diferentes:

  • Contenha até 4.000 caracteres.

  • Use um formato de ID de entrada com base no Google Cloud nome completo do recurso. O formato é o nome completo do recurso sem as barras duplas de prefixo na parte do nome do serviço da API. Isso permite a recuperação de entradas usando o nome do recurso associado.

    Exemplo:

    • Se o nome completo do recurso de uma instância do Looker for //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, o {ENTRY_ID} sugerido será looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

IDs de recursos de linhagem de dados

Os recursos de linhagem de dados representam uma hierarquia de operações de transformação de dados:

  • ID do processo ({PROCESS_ID}): identifica a definição de uma transformação de dados (como uma consulta SQL específica ou um pipeline de ETL).
  • ID da execução ({RUN_ID}): identifica uma única instância de execução de um processo pai.
  • ID do evento de linhagem ({LINEAGE_EVENT_ID}): identifica um evento de movimentação de dados discreto entre origens e destinos que ocorreu durante uma execução.

Ao criar recursos de linhagem personalizados pela API, as variáveis {PROCESS_ID}, {RUN_ID} e {LINEAGE_EVENT_ID} precisam obedecer às seguintes diretrizes:

  • Contenha até 200 caracteres.
  • Contenha apenas letras (diferenciação de maiúsculas e minúsculas), números, hifens, sublinhados, dois-pontos e pontos.

Para linhagem automatizada (como consultas do BigQuery, Serviço Gerenciado para Apache Spark ou ingestão do OpenLineage), o Knowledge Catalog gera esses IDs automaticamente.

Nomes de entrada do BigQuery

Ao interagir com recursos do BigQuery pelas APIs do Knowledge Catalog, é necessário usar uma formatação específica para o ID do grupo de entradas e o ID da entrada.

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

Exemplo

Se a tabela do BigQuery for projects/test-project/datasets/test_dataset/tables/test_table, o nome de entrada totalmente qualificado do Knowledge Catalog será o seguinte:

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