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.

Os recursos no Knowledge Catalog incluem o seguinte:

  • Grupo de entradas

  • Entrada

  • Tipo de entrada

  • Tipo de aspecto

  • Link de entrada

  • Job de metadados

  • Feed de metadados

  • Glossário

  • Categoria do glossário

  • Termo do glossário

  • Produto de dados

  • Domínio de dados

  • Processo de linhagem

  • Execução de linhagem

  • Evento de linhagem

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

Formato de nomeação de recursos

Confira os formatos para os diferentes recursos:

  • Grupo de entradas: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • Entrada: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • Tipo de entrada: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • Tipo de aspecto: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • Link de entrada: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • Job de metadados: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • Feed de metadados: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • Glossário: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • Categoria do glossário: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • Termo do glossário: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • Produto de dados: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • Domínio de dados: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • Processo: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

  • Execução: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • Evento de linhagem: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

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

ID é o segmento final no caminho do recurso.

Para a maioria dos recursos (grupos de entradas, tipos de entradas, tipos de aspectos, links de entradas, jobs de metadados, feeds de metadados, glossários, categorias de glossários, termos de glossários, produtos de dados e domínios de dados), variáveis como {ENTRY_GROUP_ID}, {ENTRY_TYPE_ID}, {ASPECT_TYPE_ID}, {ENTRY_LINK_ID}, {METADATA_JOB_ID}, {METADATA_FEED_ID}, {GLOSSARY_ID}, {GLOSSARY_CATEGORY_ID}, {GLOSSARY_TERM_ID}, {DATA_PRODUCT_ID} e {DATA_DOMAIN_ID} precisam obedecer às seguintes diretrizes:

  • Comece com uma letra minúscula.

  • Ter entre 1 e 63 caracteres.

  • Conter apenas letras minúsculas, números, hifens e sublinhados.

  • Terminar com um número ou uma letra minúscula.

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

  • Ter até 4.000 caracteres.

  • Usar 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 de 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.

Para recursos de linhagem de dados, como processos, execuções e eventos de linhagem, as variáveis {PROCESS_ID}, {RUN_ID} e {LINEAGE_EVENT_ID} precisam obedecer às seguintes diretrizes:

  • Ter até 200 caracteres.

  • Conter apenas letras (diferenciação entre maiúsculas e minúsculas), números, hifens, sublinhados, dois-pontos e pontos.

Nomes de entrada do BigQuery

Ao interagir com recursos do BigQuery pelas APIs do Knowledge Catalog, você precisa 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_NAME}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table