Gerenciar um glossário de negócios

Os glossários empresariais no Knowledge Catalog (antigo Dataplex Universal Catalog) permitem estabelecer um vocabulário padronizado para os recursos de dados em toda a organização. É possível criar e gerenciar categorias e termos para ajudar a reduzir a ambiguidade e melhorar a descoberta e a governança de dados. Se esta for a primeira vez que você cria um glossário empresarial, consulte o guia de início rápido Criar e usar um glossário empresarial.

Casos de uso do glossário empresarial do Knowledge Catalog

Ao criar uma linguagem comum para dados usando o glossário empresarial do Knowledge Catalog, é possível:

• Defina uma hierarquia clara de categorias de negócios e termos.
• Vincule conceitos usando sinônimos e mostre as relações entre os termos.
• Pesquise recursos de dados com base em conceitos de negócios, não apenas em nomes técnicos.

O glossário empresarial do Knowledge Catalog ajuda a simplificar a descoberta de dados e reduzir a ambiguidade, resultando em uma melhor governança, análises mais precisas e insights mais rápidos.

Elementos de um glossário empresarial

Nesta seção, descrevemos os principais elementos que podem ser usados para estruturar um glossário empresarial.

Glossário

Um glossário tem as seguintes propriedades:

• Visão geral. Descreve a finalidade e o conteúdo do glossário empresarial. É possível adicionar imagens, links e tabelas. Embora a formatação HTML não seja compatível, é possível incluir código HTML formatado como código ou adicionar um link para uma página HTML. Também é possível usar opções de formatação Rich Text, como negrito, itálico, sublinhado, listas com marcadores, parágrafos, títulos e blocos de código. O tamanho máximo permitido é 120 KB.

• Descrição. Descreve o glossário. O texto neste campo é indexado para pesquisa. O tamanho máximo permitido é 1 KB.

• Region. Especifica a região em que o glossário está localizado.

Categoria

Uma categoria permite organizar e estruturar várias categorias e termos. As categorias são definidas em um glossário empresarial. É possível aninhar categorias em até três níveis.

Uma categoria tem as propriedades de um glossário, além das seguintes:

• Contatos. Especifica a pessoa responsável por manter a categoria. Essa propriedade é descritiva e não afeta as permissões da categoria.
• Familiar responsável. Especifica uma relação usada para estabelecer o pai da categoria atual. É possível aninhar até três categorias.

A região de uma categoria é a mesma do glossário que a contém.

Termo

Um termo (abreviação de "termo do glossário") descreve um conceito usado em um ramo específico de negócios na sua empresa. Por exemplo, o departamento de marketing de uma empresa pode criar um termo que descreve o custo por clique. Os termos são definidos em um glossário empresarial, seja diretamente no glossário ou em qualquer categoria encontrada nele.

Um termo tem as propriedades de uma categoria, além das seguintes propriedades:

• Sinônimos. Especifica links entre termos que têm o mesmo significado. Consulte Termos de sinônimos.
• Termos relacionados. Especifica links entre termos que estão conceitualmente relacionados entre si, mas que têm significados diferentes. Consulte Termos relacionados.
• Entradas relacionadas. Especifica links entre termos e recursos de dados ou entre termos e colunas em recursos de dados.
• Regras de qualidade de dados. Especifica os requisitos de qualidade de dados para o termo. Para mais informações, consulte Reutilizar regras de qualidade de dados.
• Contatos. Especifica a pessoa responsável por manter o termo. Os termos não herdam os contatos definidos nas categorias.

A região de um termo é a mesma do glossário que o contém.

Termos sinônimos

Um sinônimo é uma relação que indica equivalência entre dois termos diferentes. Use sinônimos quando dois termos com o mesmo significado forem definidos por equipes diferentes em glossários diferentes. Por exemplo, você pode criar um sinônimo para vincular os termos "lucro" e "ganhos".

Termos relacionados

Um termo relacionado é uma relação que indica que dois termos estão associados entre si, mas têm significados diferentes. Por exemplo, é possível criar um termo relacionado para vincular os termos "receita" e "lucro".

Limitações

• Os glossários empresariais ficam em projetos e locais. As limitações para projetos e locais se aplicam aos glossários.
• Ao usar um glossário empresarial com um agente de dados do BigQuery, o agente pode importar no máximo 10 termos de glossário por tabela. Se você anexar mais de 10 termos a uma tabela, o agente de dados vai ignorar os termos adicionais. Para otimizar o desempenho do agente de dados, forneça descrições abrangentes no nível da tabela e da coluna.

Funções exigidas

Para receber as permissões necessárias para criar e gerenciar glossários, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

• Para administradores de dados, tenha acesso total a glossários, categorias, termos, sinônimos e termos relacionados, além de definir políticas do IAM: Administrador de catálogo do Dataplex (roles/dataplex.catalogAdmin)
• Para administradores ou proprietários de dados, tenha acesso à criação, edição ou exclusão de glossários, categorias, termos, links entre termos, links entre termos e recursos de dados e pesquisa: Editor do Dataplex Catalog (roles/dataplex.catalogEditor)
• Para analistas de dados ou consumidores de dados, tenha acesso somente leitura a glossários, categorias, termos, links entre termos e entre termos e recursos de dados, além de pesquisa: Leitor do Dataplex Catalog (roles/dataplex.catalogViewer)

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para criar e gerenciar glossários. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para criar e gerenciar glossários:

• Criar, ler, atualizar e excluir um glossário empresarial, uma categoria e termos no seu projeto:
  • dataplex.glossaries.list em desconhecido

  • dataplex.glossaries.create
  • dataplex.glossaries.get
  • dataplex.glossaries.update
  • dataplex.glossaries.delete
  • dataplex.glossaryCategories.create
  • dataplex.glossaryCategories.list
  • dataplex.glossaryCategories.get
  • dataplex.glossaryCategories.update
  • dataplex.glossaryCategories.delete
  • dataplex.glossaryTerms.create
  • dataplex.glossaryTerms.list
  • dataplex.glossaryTerms.get
  • dataplex.glossaryTerms.update
  • dataplex.glossaryTerms.delete em desconhecido
    • Criar, pesquisar e excluir links de sinônimos entre termos no projeto

  Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

  Para mais informações, consulte Papéis do IAM do Knowledge Catalog.

  Criar e gerenciar glossários empresariais

  As seções a seguir descrevem como criar, visualizar, editar e excluir um glossário empresarial. Ao criar glossários empresariais, categorias ou termos, verifique se os IDs deles estão em conformidade com as diretrizes de nomenclatura de recursos do Knowledge Catalog.

  Observação: a solicitação de mudanças de metadados em glossários empresariais e entradas do Knowledge Catalog com fluxos de trabalho de governança está disponível em pré-lançamento particular. Para solicitar acesso ao recurso, preencha o formulário de acesso.

  Criar um glossário empresarial

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Clique em Criar glossário empresarial.

  3. Na página Criar glossário empresarial, especifique um nome e um local para o glossário empresarial. Depois de criar o glossário, não é possível mudar o local.

  4. Clique em Criar. O glossário é criado no projeto atual.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  C#

  C#

  Antes de testar este exemplo, siga as instruções de configuração do C# no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog C#.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  using Google.Api.Gax.ResourceNames;
  using Google.Cloud.Dataplex.V1;
  using Google.LongRunning;
  
  public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
  {
      /// <summary>Snippet for CreateGlossary</summary>
      /// <remarks>
      /// This snippet has been automatically generated and should be regarded as a code template only.
      /// It will require modifications to work:
      /// - It may require correct/in-range values for request initialization.
      /// - It may require specifying regional endpoints when creating the service client as shown in
      ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
      /// </remarks>
      public void CreateGlossaryRequestObject()
      {
          // Create client
          BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
          // Initialize request argument(s)
          CreateGlossaryRequest request = new CreateGlossaryRequest
          {
              ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
              GlossaryId = "",
              Glossary = new Glossary(),
              ValidateOnly = false,
          };
          // Make the request
          Operation<Glossary, OperationMetadata> response = businessGlossaryServiceClient.CreateGlossary(request);
  
          // Poll until the returned long-running operation is complete
          Operation<Glossary, OperationMetadata> completedResponse = response.PollUntilCompleted();
          // Retrieve the operation result
          Glossary result = completedResponse.Result;
  
          // Or get the name of the operation
          string operationName = response.Name;
          // This name can be stored, then the long-running operation retrieved later by name
          Operation<Glossary, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceCreateGlossary(operationName);
          // Check if the retrieved long-running operation has completed
          if (retrievedResponse.IsCompleted)
          {
              // If it has completed, then access the result
              Glossary retrievedResult = retrievedResponse.Result;
          }
      }
  }

  Go

  Go

  Antes de testar este exemplo, siga as instruções de configuração do Go no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Go.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  
  //go:build examples
  
  package main
  
  import (
  	"context"
  
  	dataplex "cloud.google.com/go/dataplex/apiv1"
  	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
  )
  
  func main() {
  	ctx := context.Background()
  	// This snippet has been automatically generated and should be regarded as a code template only.
  	// It will require modifications to work:
  	// - It may require correct/in-range values for request initialization.
  	// - It may require specifying regional endpoints when creating the service client as shown in:
  	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
  	c, err := dataplex.NewBusinessGlossaryClient(ctx)
  	if err != nil {
  		// TODO: Handle error.
  	}
  	defer c.Close()
  
  	req := &dataplexpb.CreateGlossaryRequest{
  		// TODO: Fill request struct fields.
  		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateGlossaryRequest.
  	}
  	op, err := c.CreateGlossary(ctx, req)
  	if err != nil {
  		// TODO: Handle error.
  	}
  
  	resp, err := op.Wait(ctx)
  	if err != nil {
  		// TODO: Handle error.
  	}
  	// TODO: Use resp.
  	_ = resp
  }
  

  Java

  Java

  Antes de testar este exemplo, siga as instruções de configuração do Java no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Java.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
  import com.google.cloud.dataplex.v1.CreateGlossaryRequest;
  import com.google.cloud.dataplex.v1.Glossary;
  import com.google.cloud.dataplex.v1.LocationName;
  
  public class SyncCreateGlossary {
  
    public static void main(String[] args) throws Exception {
      syncCreateGlossary();
    }
  
    public static void syncCreateGlossary() throws Exception {
      // This snippet has been automatically generated and should be regarded as a code template only.
      // It will require modifications to work:
      // - It may require correct/in-range values for request initialization.
      // - It may require specifying regional endpoints when creating the service client as shown in
      // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
      try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
          BusinessGlossaryServiceClient.create()) {
        CreateGlossaryRequest request =
            CreateGlossaryRequest.newBuilder()
                .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                .setGlossaryId("glossaryId1849967577")
                .setGlossary(Glossary.newBuilder().build())
                .setValidateOnly(true)
                .build();
        Glossary response = businessGlossaryServiceClient.createGlossaryAsync(request).get();
      }
    }
  }

  Node.js

  Node.js

  Antes de testar este exemplo, siga as instruções de configuração do Node.js no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Node.js.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource where this Glossary will be created.
   *  Format: projects/{project_id_or_number}/locations/{location_id}
   *  where `location_id` refers to a Google Cloud region.
   */
  // const parent = 'abc123'
  /**
   *  Required. Glossary ID: Glossary identifier.
   */
  // const glossaryId = 'abc123'
  /**
   *  Required. The Glossary to create.
   */
  // const glossary = {}
  /**
   *  Optional. Validates the request without actually creating the Glossary.
   *  Default: false.
   */
  // const validateOnly = true
  
  // Imports the Dataplex library
  const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;
  
  // Instantiates a client
  const dataplexClient = new BusinessGlossaryServiceClient();
  
  async function callCreateGlossary() {
    // Construct request
    const request = {
      parent,
      glossaryId,
      glossary,
    };
  
    // Run request
    const [operation] = await dataplexClient.createGlossary(request);
    const [response] = await operation.promise();
    console.log(response);
  }
  
  callCreateGlossary();

  Python

  Python

  Antes de testar este exemplo, siga as instruções de configuração do Python no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Python.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  # This snippet has been automatically generated and should be regarded as a
  # code template only.
  # It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  #   client as shown in:
  #   https://googleapis.dev/python/google-api-core/latest/client_options.html
  from google.cloud import dataplex_v1
  
  
  def sample_create_glossary():
      # Create a client
      client = dataplex_v1.BusinessGlossaryServiceClient()
  
      # Initialize request argument(s)
      request = dataplex_v1.CreateGlossaryRequest(
          parent="parent_value",
          glossary_id="glossary_id_value",
      )
  
      # Make the request
      operation = client.create_glossary(request=request)
  
      print("Waiting for operation to complete...")
  
      response = operation.result()
  
      # Handle the response
      print(response)
  
  

  Ruby

  Ruby

  Antes de testar este exemplo, siga as instruções de configuração do Ruby no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Ruby.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  require "google/cloud/dataplex/v1"
  
  ##
  # Snippet for the create_glossary call in the BusinessGlossaryService service
  #
  # This snippet has been automatically generated and should be regarded as a code
  # template only. It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  # client as shown in https://cloud.google.com/ruby/docs/reference.
  #
  # This is an auto-generated example demonstrating basic usage of
  # Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#create_glossary.
  #
  def create_glossary
    # Create a client object. The client can be reused for multiple calls.
    client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new
  
    # Create a request. To set request fields, pass in keyword arguments.
    request = Google::Cloud::Dataplex::V1::CreateGlossaryRequest.new
  
    # Call the create_glossary method.
    result = client.create_glossary request
  
    # The returned object is of type Gapic::Operation. You can use it to
    # check the status of an operation, cancel it, or wait for results.
    # Here is how to wait for a response.
    result.wait_until_done! timeout: 60
    if result.response?
      p result.response
    else
      puts "No response received."
    end
  end

  REST

  Quando você cria um glossário, o Knowledge Catalog cria uma entrada para representar o glossário.

  1. Crie o glossário.

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID --data @- << EOF
     {
     "displayName": "DISPLAY_NAME",
     "description": "DESCRIPTION"
     }
     EOF

     Substitua:

     • PROJECT_ID: o ID do projeto em que você quer criar o glossário.
     • LOCATION_ID: o ID do local em que você quer criar o glossário.
     • GLOSSARY_ID: o ID do glossário
     • DISPLAY_NAME: o nome de exibição do glossário.
     • DESCRIPTION: a descrição do glossário, com no máximo 1.024 caracteres.

  2. Opcional: adicione uma visão geral ao glossário.

     1. Procure a entrada do seu glossário:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID
        \
        \&view=ALL

        Substitua PROJECT_NUMBER pelo número do projeto em que o glossário foi criado.

     2. Adicione uma visão geral ao glossário:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID\
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.overview": {
              "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/overview",
              "data": {
              "content": "OVERVIEW",
              "links": []
              },
           }
        }
        }
        EOF

        Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  Ver os glossários disponíveis

  Console

  • No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

    Acessar Glossários

    O painel Meus glossários exibe todos os glossários da organização que você tem permissão para visualizar, além das descrições e dos carimbos de data/hora da última modificação.

  C#

  C#

  Antes de testar este exemplo, siga as instruções de configuração do C# no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog C#.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  using Google.Api.Gax;
  using Google.Api.Gax.ResourceNames;
  using Google.Cloud.Dataplex.V1;
  using System;
  
  public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
  {
      /// <summary>Snippet for ListGlossaries</summary>
      /// <remarks>
      /// This snippet has been automatically generated and should be regarded as a code template only.
      /// It will require modifications to work:
      /// - It may require correct/in-range values for request initialization.
      /// - It may require specifying regional endpoints when creating the service client as shown in
      ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
      /// </remarks>
      public void ListGlossariesRequestObject()
      {
          // Create client
          BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
          // Initialize request argument(s)
          ListGlossariesRequest request = new ListGlossariesRequest
          {
              ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
              Filter = "",
              OrderBy = "",
          };
          // Make the request
          PagedEnumerable<ListGlossariesResponse, Glossary> response = businessGlossaryServiceClient.ListGlossaries(request);
  
          // Iterate over all response items, lazily performing RPCs as required
          foreach (Glossary item in response)
          {
              // Do something with each item
              Console.WriteLine(item);
          }
  
          // Or iterate over pages (of server-defined size), performing one RPC per page
          foreach (ListGlossariesResponse page in response.AsRawResponses())
          {
              // Do something with each page of items
              Console.WriteLine("A page of results:");
              foreach (Glossary item in page)
              {
                  // Do something with each item
                  Console.WriteLine(item);
              }
          }
  
          // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
          int pageSize = 10;
          Page<Glossary> singlePage = response.ReadPage(pageSize);
          // Do something with the page of items
          Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
          foreach (Glossary item in singlePage)
          {
              // Do something with each item
              Console.WriteLine(item);
          }
          // Store the pageToken, for when the next page is required.
          string nextPageToken = singlePage.NextPageToken;
      }
  }

  Go

  Go

  Antes de testar este exemplo, siga as instruções de configuração do Go no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Go.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  
  //go:build examples
  
  package main
  
  import (
  	"context"
  
  	dataplex "cloud.google.com/go/dataplex/apiv1"
  	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
  	"google.golang.org/api/iterator"
  )
  
  func main() {
  	ctx := context.Background()
  	// This snippet has been automatically generated and should be regarded as a code template only.
  	// It will require modifications to work:
  	// - It may require correct/in-range values for request initialization.
  	// - It may require specifying regional endpoints when creating the service client as shown in:
  	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
  	c, err := dataplex.NewBusinessGlossaryClient(ctx)
  	if err != nil {
  		// TODO: Handle error.
  	}
  	defer c.Close()
  
  	req := &dataplexpb.ListGlossariesRequest{
  		// TODO: Fill request struct fields.
  		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListGlossariesRequest.
  	}
  	it := c.ListGlossaries(ctx, req)
  	for {
  		resp, err := it.Next()
  		if err == iterator.Done {
  			break
  		}
  		if err != nil {
  			// TODO: Handle error.
  		}
  		// TODO: Use resp.
  		_ = resp
  
  		// If you need to access the underlying RPC response,
  		// you can do so by casting the `Response` as below.
  		// Otherwise, remove this line. Only populated after
  		// first call to Next(). Not safe for concurrent access.
  		_ = it.Response.(*dataplexpb.ListGlossariesResponse)
  	}
  }
  

  Java

  Java

  Antes de testar este exemplo, siga as instruções de configuração do Java no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Java.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
  import com.google.cloud.dataplex.v1.Glossary;
  import com.google.cloud.dataplex.v1.ListGlossariesRequest;
  import com.google.cloud.dataplex.v1.LocationName;
  
  public class SyncListGlossaries {
  
    public static void main(String[] args) throws Exception {
      syncListGlossaries();
    }
  
    public static void syncListGlossaries() throws Exception {
      // This snippet has been automatically generated and should be regarded as a code template only.
      // It will require modifications to work:
      // - It may require correct/in-range values for request initialization.
      // - It may require specifying regional endpoints when creating the service client as shown in
      // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
      try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
          BusinessGlossaryServiceClient.create()) {
        ListGlossariesRequest request =
            ListGlossariesRequest.newBuilder()
                .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                .setPageSize(883849137)
                .setPageToken("pageToken873572522")
                .setFilter("filter-1274492040")
                .setOrderBy("orderBy-1207110587")
                .build();
        for (Glossary element : businessGlossaryServiceClient.listGlossaries(request).iterateAll()) {
          // doThingsWith(element);
        }
      }
    }
  }

  Node.js

  Node.js

  Antes de testar este exemplo, siga as instruções de configuração do Node.js no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Node.js.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which has this collection of Glossaries.
   *  Format: projects/{project_id_or_number}/locations/{location_id}
   *  where `location_id` refers to a Google Cloud region.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of Glossaries to return. The service may
   *  return fewer than this value. If unspecified, at most 50 Glossaries will be
   *  returned. The maximum value is 1000; values above 1000 will be coerced to
   *  1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListGlossaries` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListGlossaries` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter expression that filters Glossaries listed in the response.
   *  Filters on proto fields of Glossary are supported.
   *  Examples of using a filter are:
   *    - `display_name="my-glossary"`
   *    - `categoryCount=1`
   *    - `termCount=0`
   */
  // const filter = 'abc123'
  /**
   *  Optional. Order by expression that orders Glossaries listed in the
   *  response. Order by fields are: `name` or `create_time` for the result. If
   *  not specified, the ordering is undefined.
   */
  // const orderBy = 'abc123'
  
  // Imports the Dataplex library
  const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;
  
  // Instantiates a client
  const dataplexClient = new BusinessGlossaryServiceClient();
  
  async function callListGlossaries() {
    // Construct request
    const request = {
      parent,
    };
  
    // Run request
    const iterable = dataplexClient.listGlossariesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }
  
  callListGlossaries();

  Python

  Python

  Antes de testar este exemplo, siga as instruções de configuração do Python no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Python.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  # This snippet has been automatically generated and should be regarded as a
  # code template only.
  # It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  #   client as shown in:
  #   https://googleapis.dev/python/google-api-core/latest/client_options.html
  from google.cloud import dataplex_v1
  
  
  def sample_list_glossaries():
      # Create a client
      client = dataplex_v1.BusinessGlossaryServiceClient()
  
      # Initialize request argument(s)
      request = dataplex_v1.ListGlossariesRequest(
          parent="parent_value",
      )
  
      # Make the request
      page_result = client.list_glossaries(request=request)
  
      # Handle the response
      for response in page_result:
          print(response)
  
  

  Ruby

  Ruby

  Antes de testar este exemplo, siga as instruções de configuração do Ruby no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Ruby.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  require "google/cloud/dataplex/v1"
  
  ##
  # Snippet for the list_glossaries call in the BusinessGlossaryService service
  #
  # This snippet has been automatically generated and should be regarded as a code
  # template only. It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  # client as shown in https://cloud.google.com/ruby/docs/reference.
  #
  # This is an auto-generated example demonstrating basic usage of
  # Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#list_glossaries.
  #
  def list_glossaries
    # Create a client object. The client can be reused for multiple calls.
    client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new
  
    # Create a request. To set request fields, pass in keyword arguments.
    request = Google::Cloud::Dataplex::V1::ListGlossariesRequest.new
  
    # Call the list_glossaries method.
    result = client.list_glossaries request
  
    # The returned object is of type Gapic::PagedEnumerable. You can iterate
    # over elements, and API calls will be issued to fetch pages as needed.
    result.each do |item|
      # Each element is of type ::Google::Cloud::Dataplex::V1::Glossary.
      p item
    end
  end

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries

  Editar um glossário

  É possível editar o nome e a descrição de um glossário.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Clique no glossário que você quer editar.

  3. Clique em Editar ao lado do nome, da descrição ou da visão geral e faça as mudanças.

  4. Clique em Salvar.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID?update_mask=displayName,description --data @- << EOF
  {
  "displayName": "DISPLAY_NAME",
  "description": "DESCRIPTION"
  }
  EOF

  Excluir um glossário

  Antes de excluir um glossário, é preciso excluir todas as categorias e termos dele.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Clique no glossário que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

  C#

  C#

  Antes de testar este exemplo, siga as instruções de configuração do C# no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog C#.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  using Google.Cloud.Dataplex.V1;
  using Google.LongRunning;
  using Google.Protobuf.WellKnownTypes;
  
  public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
  {
      /// <summary>Snippet for DeleteGlossary</summary>
      /// <remarks>
      /// This snippet has been automatically generated and should be regarded as a code template only.
      /// It will require modifications to work:
      /// - It may require correct/in-range values for request initialization.
      /// - It may require specifying regional endpoints when creating the service client as shown in
      ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
      /// </remarks>
      public void DeleteGlossaryRequestObject()
      {
          // Create client
          BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
          // Initialize request argument(s)
          DeleteGlossaryRequest request = new DeleteGlossaryRequest
          {
              GlossaryName = GlossaryName.FromProjectLocationGlossary("[PROJECT]", "[LOCATION]", "[GLOSSARY]"),
              Etag = "",
          };
          // Make the request
          Operation<Empty, OperationMetadata> response = businessGlossaryServiceClient.DeleteGlossary(request);
  
          // Poll until the returned long-running operation is complete
          Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
          // Retrieve the operation result
          Empty result = completedResponse.Result;
  
          // Or get the name of the operation
          string operationName = response.Name;
          // This name can be stored, then the long-running operation retrieved later by name
          Operation<Empty, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceDeleteGlossary(operationName);
          // Check if the retrieved long-running operation has completed
          if (retrievedResponse.IsCompleted)
          {
              // If it has completed, then access the result
              Empty retrievedResult = retrievedResponse.Result;
          }
      }
  }

  Go

  Go

  Antes de testar este exemplo, siga as instruções de configuração do Go no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Go.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  
  //go:build examples
  
  package main
  
  import (
  	"context"
  
  	dataplex "cloud.google.com/go/dataplex/apiv1"
  	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
  )
  
  func main() {
  	ctx := context.Background()
  	// This snippet has been automatically generated and should be regarded as a code template only.
  	// It will require modifications to work:
  	// - It may require correct/in-range values for request initialization.
  	// - It may require specifying regional endpoints when creating the service client as shown in:
  	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
  	c, err := dataplex.NewBusinessGlossaryClient(ctx)
  	if err != nil {
  		// TODO: Handle error.
  	}
  	defer c.Close()
  
  	req := &dataplexpb.DeleteGlossaryRequest{
  		// TODO: Fill request struct fields.
  		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteGlossaryRequest.
  	}
  	op, err := c.DeleteGlossary(ctx, req)
  	if err != nil {
  		// TODO: Handle error.
  	}
  
  	err = op.Wait(ctx)
  	if err != nil {
  		// TODO: Handle error.
  	}
  }
  

  Java

  Java

  Antes de testar este exemplo, siga as instruções de configuração do Java no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Java.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
  import com.google.cloud.dataplex.v1.DeleteGlossaryRequest;
  import com.google.cloud.dataplex.v1.GlossaryName;
  import com.google.protobuf.Empty;
  
  public class SyncDeleteGlossary {
  
    public static void main(String[] args) throws Exception {
      syncDeleteGlossary();
    }
  
    public static void syncDeleteGlossary() throws Exception {
      // This snippet has been automatically generated and should be regarded as a code template only.
      // It will require modifications to work:
      // - It may require correct/in-range values for request initialization.
      // - It may require specifying regional endpoints when creating the service client as shown in
      // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
      try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
          BusinessGlossaryServiceClient.create()) {
        DeleteGlossaryRequest request =
            DeleteGlossaryRequest.newBuilder()
                .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString())
                .setEtag("etag3123477")
                .build();
        businessGlossaryServiceClient.deleteGlossaryAsync(request).get();
      }
    }
  }

  Node.js

  Node.js

  Antes de testar este exemplo, siga as instruções de configuração do Node.js no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Node.js.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Glossary to delete.
   *  Format:
   *  projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the Glossary.
   *  If this is provided, it must match the server's etag.
   *  If the etag is provided and does not match the server-computed etag,
   *  the request must fail with a ABORTED error code.
   */
  // const etag = 'abc123'
  
  // Imports the Dataplex library
  const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;
  
  // Instantiates a client
  const dataplexClient = new BusinessGlossaryServiceClient();
  
  async function callDeleteGlossary() {
    // Construct request
    const request = {
      name,
    };
  
    // Run request
    const [operation] = await dataplexClient.deleteGlossary(request);
    const [response] = await operation.promise();
    console.log(response);
  }
  
  callDeleteGlossary();

  Python

  Python

  Antes de testar este exemplo, siga as instruções de configuração do Python no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Python.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  # This snippet has been automatically generated and should be regarded as a
  # code template only.
  # It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  #   client as shown in:
  #   https://googleapis.dev/python/google-api-core/latest/client_options.html
  from google.cloud import dataplex_v1
  
  
  def sample_delete_glossary():
      # Create a client
      client = dataplex_v1.BusinessGlossaryServiceClient()
  
      # Initialize request argument(s)
      request = dataplex_v1.DeleteGlossaryRequest(
          name="name_value",
      )
  
      # Make the request
      operation = client.delete_glossary(request=request)
  
      print("Waiting for operation to complete...")
  
      response = operation.result()
  
      # Handle the response
      print(response)
  
  

  Ruby

  Ruby

  Antes de testar este exemplo, siga as instruções de configuração do Ruby no guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Ruby.

  Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

  require "google/cloud/dataplex/v1"
  
  ##
  # Snippet for the delete_glossary call in the BusinessGlossaryService service
  #
  # This snippet has been automatically generated and should be regarded as a code
  # template only. It will require modifications to work:
  # - It may require correct/in-range values for request initialization.
  # - It may require specifying regional endpoints when creating the service
  # client as shown in https://cloud.google.com/ruby/docs/reference.
  #
  # This is an auto-generated example demonstrating basic usage of
  # Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#delete_glossary.
  #
  def delete_glossary
    # Create a client object. The client can be reused for multiple calls.
    client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new
  
    # Create a request. To set request fields, pass in keyword arguments.
    request = Google::Cloud::Dataplex::V1::DeleteGlossaryRequest.new
  
    # Call the delete_glossary method.
    result = client.delete_glossary request
  
    # The returned object is of type Gapic::Operation. You can use it to
    # check the status of an operation, cancel it, or wait for results.
    # Here is how to wait for a response.
    result.wait_until_done! timeout: 60
    if result.response?
      p result.response
    else
      puts "No response received."
    end
  end

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID

  Criar e gerenciar categorias

  As seções a seguir descrevem como criar, visualizar, atualizar e excluir categorias.

  Criar uma categoria em um glossário

  Um glossário empresarial pode ter no máximo 200 categorias.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Selecione o glossário em que você quer criar uma categoria e clique em Criar categoria.

  3. Insira um nome para a categoria.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  REST

  Quando você cria uma categoria, o Knowledge Catalog cria uma entrada para representar a categoria.

  1. Crie a categoria.

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
     {
     "displayName": "CATEGORY_DISPLAY_NAME",
     "description": "CATEGORY_DESCRIPTION",
     "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
     }
     EOF

     Substitua:

     • CATEGORY_ID: o ID da categoria.
     • CATEGORY_DISPLAY_NAME: o nome de exibição da categoria
     • CATEGORY_DESCRIPTION: a descrição da categoria

  2. Opcional: adicione uma visão geral à categoria.

     1. Procure a entrada da sua categoria:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
        \
        \&view=ALL

     2. Adicione uma visão geral à categoria:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
        \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.overview": {
              "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
        ",
              "data": {
              "content": "OVERVIEW",
              "links": []
              },
           }
        }
        }
        EOF

        Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicionar contatos

     1. Procure a entrada da sua categoria:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
        \
        \&view=ALL

     2. Atualize a entrada da sua categoria com os contatos:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.contacts": {
              "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
              "data": {
              "identities": [
                 {
                    "role": "steward",
                    "name": "CONTACT_NAME",
                    "id": "CONTACT_EMAIL"
                 }
              ]
              },
           }
        }
        }
        EOF

  Criar uma categoria aninhada

  Um glossário empresarial pode ter no máximo três níveis de categoria aninhados, excluindo o nível do glossário raiz.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário em que você quer criar uma categoria.

  3. Selecione a categoria mãe em que você quer criar outra categoria e clique em Criar categoria.

  4. Insira um nome para a categoria.

  5. Clique em Criar.

  6. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
  {
     "displayName": "CATEGORY_DISPLAY_NAME",
     "description": "CATEGORY_DESCRIPTION",
     "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
  }
  EOF

  Substitua PARENT_CATEGORY_ID pelo ID da categoria mãe.

  Ver as categorias que pertencem a um glossário

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Para ver as categorias em um glossário, expanda-o.

  3. Para ver as categorias aninhadas em uma categoria, expanda-a.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories

  Editar uma categoria

  É possível editar o nome, a descrição e os contatos de uma categoria. Para categorias aninhadas, também é possível editar a categoria mãe.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique na categoria que você quer editar.

  3. Clique em Editar ao lado do nome, da descrição ou da visão geral e faça as mudanças.

  4. Clique em Salvar.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID?update_mask=displayName,description --data @- << EOF
  {
  "displayName": "CATEGORY_DISPLAY_NAME",
  "description": "DESCRIPTION"
  }
  EOF

  Excluir uma categoria

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique na categoria que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID

  Criar e gerenciar termos

  As seções a seguir descrevem como criar, visualizar, acessar, editar e excluir termos.

  Criar um termo em um glossário empresarial

  Um glossário empresarial pode ter no máximo 5.000 termos.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Para criar um termo no nível do glossário, selecione o glossário em que você quer criar um termo e clique em Criar termo.

  3. Insira um nome para o termo.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  6. Opcional: para adicionar contatos, clique em Editar e forneça uma lista de endereços de e-mail para os gestores de dados, proprietários de dados ou proprietários de domínios de dados. Clique em Salvar.

  REST

  Quando você cria um termo, o Knowledge Catalog cria uma entrada para representar o termo.

  1. Crie o termo.

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
     {
     "displayName": "TERM_DISPLAY_NAME",
     "description": "TERM_DESCRIPTION",
     "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
     }
     EOF

     Substitua:

     • TERM_ID: o ID do termo que você está criando.
     • TERM_DISPLAY_NAME: o nome de exibição do termo que você está criando.
     • TERM_DESCRIPTION: a descrição do termo que você está criando.

  2. Opcional: adicione uma visão geral ao termo.

     1. Procure a entrada do termo:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        \&view=ALL

     2. Adicione uma visão geral ao termo:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
        \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.overview": {
              "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
        ",
              "data": {
              "content": "OVERVIEW",
              "links": []
              },
           }
        }
        }
        EOF

        Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicione contatos.

     1. Procure a entrada do termo:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        \&view=ALL

     2. Atualize a entrada do termo com os contatos:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.contacts": {
              "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
              "data": {
              "identities": [
                 {
                    "role": "steward",
                    "name": "CONTACT_NAME",
                    "id": "CONTACT_EMAIL"
                 }
              ]
              },
           }
        }
        }
        EOF

  Criar um termo em uma categoria

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Para criar um termo em uma categoria, selecione a categoria em que você quer criar um termo e clique em Adicionar termo.

  3. Insira um nome para o termo.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  6. Opcional: para adicionar contatos, clique em Editar e forneça uma lista de endereços de e-mail para os gestores de dados, proprietários de dados ou proprietários de domínios de dados. Clique em Salvar.

  REST

  Quando você cria um termo, o Knowledge Catalog cria uma entrada para representar o termo.

  1. Criar um termo.

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
     {
     "displayName": "TERM_DISPLAY_NAME",
     "description": "TERM_DESCRIPTION",
     "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
     }
     EOF

     Substitua:

     • TERM_ID: o ID do termo que você está criando.
     • TERM_DISPLAY_NAME: o nome de exibição do termo que você está criando.
     • TERM_DESCRIPTION: a descrição do termo que você está criando.

  2. Opcional: adicione uma visão geral ao termo.

     1. Procure a entrada do termo:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        \&view=ALL

     2. Adicione uma visão geral ao termo:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
        \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.overview": {
              "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
        ",
              "data": {
              "content": "OVERVIEW",
              "links": []
              },
           }
        }
        }
        EOF

        Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicione contatos.

     1. Procure a entrada do termo:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
        :lookupEntry\
        ?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        \
        \&view=ALL

     2. Atualize a entrada do termo com os contatos:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
        ?update_mask=aspects\
        \&deleteMissingAspects=false\
        \&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
        --data @- << EOF
        {
        "aspects": {
           "dataplex-types.global.contacts": {
              "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
              "data": {
              "identities": [
                 {
                    "role": "steward",
                    "name": "CONTACT_NAME",
                    "id": "CONTACT_EMAIL"
                 }
              ]
              },
           }
        }
        }
        EOF

  Adicionar um aspecto a um termo

  É possível adicionar aspectos aos termos para fornecer mais contexto ou metadados.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo ao qual você quer adicionar um aspecto.

  3. Na seção Aspectos, clique em Adicionar.

  4. Pesquise o aspecto, forneça detalhes sobre ele e clique em Salvar.

  REST

  Os termos do glossário são entradas. Para anexar um aspecto, corrija o recurso de entrada. O grupo de entrada para glossários é @dataplex.

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
  {
    "aspects": {
      "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
        "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
        "data": {
          "sensitivity": "HIGH",
          "data_owner": "[e-mail]"
        }
      }
    }
  }
  EOF

  Substitua:

  • PROJECT_NUMBER: o número do projeto que contém o termo do glossário.
  • LOCATION_ID: o local do termo do glossário.
  • GLOSSARY_ID: o ID do glossário que contém o termo.
  • TERM_ID: o ID do termo ao qual o aspecto será anexado.
  • ASPECT_PROJECT_ID: o ID do projeto que contém o tipo de aspecto.
  • ASPECT_LOCATION_ID: o local do tipo de aspecto.
  • ASPECT_TYPE_ID: o ID do tipo de aspecto.

  Ver os termos em um glossário ou categoria

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Para ver os termos em um glossário, expanda-o. Para ver os termos de uma categoria neste glossário, expanda a categoria. Para ver os termos em uma categoria aninhada, expanda-a.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms

  Ver os detalhes de um termo

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Para ver a lista de termos em um glossário, expanda-o.

  3. Clique em um termo. A página Detalhes do termo mostra o nome, a descrição, os termos relacionados, os sinônimos e as entradas relacionadas.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

  Editar um termo

  É possível editar o nome, a descrição, a visão geral, os contatos e o termo pai.

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo que você quer editar.

  3. Clique em Editar.

  4. Edite os campos e clique em Salvar.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=displayName,description --data @- << EOF
  {
     "displayName": "TERM_DISPLAY_NAME",
     "description": "TERM_DESCRIPTION"
  }
  EOF

  Excluir um termo

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

  Gerenciar sinônimos e termos relacionados

  É possível adicionar relações entre termos vinculando-os como sinônimos ou termos relacionados.

  As relações entre termos são bidirecionais. Por exemplo, quando você vincula profit como um sinônimo de earnings, earnings também se torna um sinônimo de profit.

  Criar links de sinônimos entre termos

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo que você quer usar para criar links.

  3. Clique em Editar ao lado de Termos sinônimos.

  4. Pesquise e selecione os termos que você quer vincular.

     O termo é vinculado imediatamente quando você o seleciona.

  5. Clique em Fechar.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
  {
     "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
  "entry_references": [{
        "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
        "type": "UNSPECIFIED"
     }, {
        "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
        "type": "UNSPECIFIED"
     }
     ]
  
  }
  EOF
  )"

  Substitua:

  • TERM1_PROJECT_NUMBER: o número do projeto do primeiro termo que está sendo vinculado.
  • TERM1_LOCATION_ID: o ID do local do glossário que contém o primeiro termo.
  • TERM1_GLOSSARY_ID: o ID do glossário que contém o primeiro termo.
  • TERM1_ID: o ID do primeiro termo.
  • TERM2_PROJECT_NUMBER: o número do projeto do segundo termo que você quer vincular como sinônimo. Se os dois termos estiverem no mesmo projeto, esse valor será igual ao número do projeto do primeiro termo.
  • TERM2_LOCATION_ID: o ID do local do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo local, esse valor será igual ao ID do local do primeiro termo.
  • TERM2_GLOSSARY_ID: o ID do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo glossário, esse valor será o mesmo que o ID do glossário do primeiro termo.
  • TERM2_ID: o ID do segundo termo.
  • ENTRY_LINK_ID: um ID para o link entre os dois termos. Cada termo é representado como uma entrada do Knowledge Catalog. O link de entrada é a relação entre termos sinônimos.

  Criar links relacionados entre termos

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo que você quer usar para criar links.

  3. Clique em Editar ao lado de Termos relacionados.

  4. Pesquise e selecione os termos que você quer vincular.

     O termo é vinculado imediatamente quando você o seleciona.

  5. Clique em Fechar.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
  {
     "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/related",
  "entry_references": [{
        "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
        "type": "UNSPECIFIED"
     }, {
        "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
        "type": "UNSPECIFIED"
     }
     ]
  
  }
  EOF
  )"

  Substitua:

  • TERM1_PROJECT_NUMBER: o número do projeto do primeiro termo que está sendo vinculado.
  • TERM1_LOCATION_ID: o ID do local do glossário que contém o primeiro termo.
  • TERM1_GLOSSARY_ID: o ID do glossário que contém o primeiro termo.
  • TERM1_ID: o ID do primeiro termo.
  • TERM2_PROJECT_NUMBER: o número do projeto do segundo termo que você quer vincular como um termo relacionado. Se os dois termos estiverem no mesmo projeto, esse valor será igual ao número do projeto do primeiro termo.
  • TERM2_LOCATION_ID: o ID do local do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo local, esse valor será igual ao ID do local do primeiro termo.
  • TERM2_GLOSSARY_ID: o ID do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo glossário, esse valor será o mesmo que o ID do glossário do primeiro termo.
  • TERM2_ID: o ID do segundo termo.
  • ENTRY_LINK_ID: um ID para o link entre os dois termos. Cada termo é representado como uma entrada do Knowledge Catalog. O link de entrada é a relação entre termos relacionados.

  Procurar links de sinônimos para um termo

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/SYNONYM_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/synonym&page_size=10

  Substitua:

  • TERM_PROJECT_ID: o ID do projeto do termo com os links de sinônimos que você está procurando.
  • TERM_PROJECT_NUMBER: o número do projeto do termo com os links de sinônimos que você está procurando.
  • SYNONYM_LINKS_LOCATION_ID: o ID do local em que você está procurando os links de sinônimos.
  • TERM_LOCATION_ID: o ID do local do termo.
  • TERM_GLOSSARY_ID: o ID do glossário que contém o termo.
  • TERM_ID: o ID do termo.

  Observação: para buscar as páginas seguintes, anexe &page_token=PAGE_TOKEN à solicitação. Substitua PAGE_TOKEN pelo valor do token de página que você recebeu da resposta lookupEntryLinks anterior.

  Procurar links relacionados a um termo

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/RELATED_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/related&page_size=10

  Substitua:

  • TERM_PROJECT_ID: o ID do projeto do termo com os links relacionados que você está procurando.
  • TERM_PROJECT_NUMBER: o número do projeto do termo com os links relacionados que você está procurando.
  • RELATED_LINKS_LOCATION_ID: o ID do local em que você está procurando os links relacionados.
  • TERM_LOCATION_ID: o ID do local do termo.
  • TERM_GLOSSARY_ID: o ID do glossário que contém o termo.
  • TERM_ID: o ID do termo.

  Observação: para buscar as páginas seguintes, anexe &page_token=PAGE_TOKEN à solicitação. Substitua PAGE_TOKEN pelo valor do token de página que você recebeu da resposta lookupEntryLinks anterior.

  Remover links entre sinônimos e termos relacionados

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Abra o glossário e clique no termo que tem os sinônimos ou termos relacionados que você quer remover.

  3. Para excluir links entre termos relacionados, clique em Editar ao lado de Termos relacionados. Exclua os termos relacionados e clique em Fechar.

  4. Para excluir links entre sinônimos, clique em Editar ao lado de Termos sinônimos. Exclua os sinônimos e clique em Fechar.

  REST

  1. Procure os links de entrada para encontrar o ID do link de entrada que você quer excluir. Para mais informações, consulte Pesquisar links de sinônimos para um termo ou Pesquisar links relacionados para um termo.

  2. Exclua o link enviando a seguinte solicitação DELETE:

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

  Gerenciar links entre termos e recursos de dados

  É possível anexar termos a recursos de dados ou colunas de recursos de dados. Por exemplo, é possível anexar termos a conjuntos de dados do BigQuery e tabelas do catálogo REST do Iceberg.

  Anexar termos a um recurso de dados

  Console

  1. No console Google Cloud , acesse a página Pesquisa do Knowledge Catalog.

     Acesse Pesquisar

  2. Pesquise o recurso de dados (como um conjunto de dados, arquivo ou tabela) ao qual você quer vincular um termo e clique nele.

  3. Na página do recurso de dados, siga um destes procedimentos:

     • Para vincular termos a um recurso, na guia Detalhes, na seção Termos do glossário, clique em Adicionar. Pesquise e selecione os termos e clique em Fechar.
     • Se o recurso tiver um esquema, será possível vincular termos a uma coluna. Na guia Esquema, selecione uma coluna para vincular termos e clique em Adicionar termo comercial. Pesquise e selecione os termos e clique em Fechar.

  Python

  from google.cloud import dataplex_v1
  
  def attach_term_to_asset(
      project_id: str,
      location: str,
      entry_group_id: str,
      entry_link_id: str,
      source_entry_name: str,
      target_term_name: str,
  ) -> dataplex_v1.EntryLink:
      """Creates an entry link attaching a glossary term to a data asset."""
      client = dataplex_v1.CatalogServiceClient()
      parent_group = (
          f"projects/{project_id}/locations/{location}/"
          f"entryGroups/{entry_group_id}"
      )
  
      entry_link = dataplex_v1.EntryLink(
          entry_link_type=(
              "projects/dataplex-types/locations/global/"
              "entryLinkTypes/definition"
          ),
          entry_references=[
              dataplex_v1.EntryLink.EntryReference(
                  name=source_entry_name, type_="SOURCE"
              ),
              dataplex_v1.EntryLink.EntryReference(
                  name=target_term_name, type_="TARGET"
              ),
          ],
      )
  
      return client.create_entry_link(
          parent=parent_group,
          entry_link_id=entry_link_id,
          entry_link=entry_link,
      )
  

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
  {
     "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
     "entry_references": [{
        "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
        "type": "SOURCE"
     }, {
        "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
        "type": "TARGET"
     }
     ]
  }
  EOF
  )"

  Substitua:

  • PROJECT_NUMBER: o número do projeto do recurso de dados que está sendo vinculado.
  • ENTRY_LOCATION_ID: o ID do local do recurso de dados que está sendo vinculado.
  • ENTRY_GROUP_ID: o grupo de entrada do recurso de dados que está sendo vinculado.
  • ENTRY_LINK_ID: um ID para o link entre o termo e a entrada do Knowledge Catalog que representa o recurso de dados.
  • TERM_PROJECT_NUMBER: o número do projeto do termo que está sendo vinculado.

  Anexar termos a uma coluna em um esquema de entrada

  Console

  1. No console Google Cloud , acesse a página Pesquisa do Knowledge Catalog.

     Acesse Pesquisar

  2. Pesquise o recurso de dados (como um conjunto de dados, arquivo ou tabela) que tenha um esquema com uma coluna à qual você quer vincular um termo. Clique no recurso de dados.

  3. Na página do recurso de dados, siga um destes procedimentos:

     • Para vincular termos a uma coluna no recurso de dados, na guia Esquema, selecione as colunas a que você quer anexar o termo.
     • Clique em Adicionar termo de negócios. Pesquise o termo que você quer anexar e clique nele.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
  {
    "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
    "entry_references": [
      {
        "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
        "path": "Schema.COLUMN_NAME",
        "type": "SOURCE"
      },
      {
        "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
        "type": "TARGET"
      }
    ]
  }
  EOF
  )"

  Substitua:

  • PROJECT_NUMBER: o número do projeto do recurso de dados que está sendo vinculado.
  • ENTRY_LOCATION_ID: o ID do local do recurso de dados que está sendo vinculado.
  • ENTRY_GROUP_ID: o grupo de entrada do recurso de dados que está sendo vinculado.
  • ENTRY_LINK_ID: um ID para o link entre o termo e a entrada do Knowledge Catalog que representa o recurso de dados
  • TERM_PROJECT_NUMBER: o número do projeto do termo que está sendo vinculado
  • COLUMN_NAME: a coluna a que você quer anexar o termo.

  Anexar um termo a vários recursos ou colunas de dados

  É possível anexar um único termo do glossário a vários recursos ou colunas de dados simultaneamente. É possível selecionar até 20 recursos ou colunas em uma única operação.

  Console

  Para anexar um termo a vários recursos, siga estas etapas:

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Na lista Glossários, expanda o glossário que contém o termo que você quer vincular.

  3. Clique no termo.

  4. Na seção Entradas relacionadas, clique em Adicionar.

  5. Na caixa de diálogo Anexar entradas relacionadas, siga estas etapas:

     1. Encontre os recursos ou as colunas que você quer vincular. Para restringir os resultados da pesquisa, use Filtro para pesquisar por nome do recurso, tipo de recurso ou nome da coluna.

        Por exemplo, para encontrar uma coluna chamada sample-column em uma tabela do BigQuery chamada sample-table em um projeto com o ID sample-project, use a seguinte consulta:

        project id:sample-project
        Resource Name:sample-table
        Column Name:sample-column
        

        Você pode inserir strings parciais para encontrar recursos correspondentes.

     2. Selecione os recursos de dados e as colunas que você quer anexar.

     3. Para revisar suas seleções antes de adicionar, clique no botão de alternância Mostrar recursos selecionados.

     4. Clique em Adicionar.

  6. Para verificar os recursos e as colunas recém-anexados, acesse a seção Entradas relacionadas da página de detalhes do termo.

  Pesquisar recursos de dados vinculados a um termo

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=TARGET&page_size=10

  Substitua:

  • TERM_PROJECT_ID: o ID do projeto do termo com os links de definição que você está procurando.
  • TERM_PROJECT_NUMBER: o número do projeto do termo com os links de definição que você está procurando.
  • DEFINITION_LINKS_LOCATION_ID: o ID do local em que você está procurando os links de definição.
  • TERM_LOCATION_ID: o ID do local do termo.
  • TERM_GLOSSARY_ID: o ID do glossário que contém o termo.
  • TERM_ID: o ID do termo.

  Observação: as colunas vinculadas ao termo são retornadas no campo path.

  Para buscar as páginas seguintes, anexe &page_token=PAGE_TOKEN à solicitação. Substitua PAGE_TOKEN pelo valor do token de página que você recebeu da resposta lookupEntryLinks anterior.

  Pesquisar termos vinculados a um recurso de dados

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=SOURCE&page_size=10

  Substitua:

  • PROJECT_ID: o ID do projeto do recurso de dados com os links de definição que você está procurando.
  • PROJECT_NUMBER: o número do projeto do recurso de dados com os links de definição que você está procurando.
  • DEFINITION_LINKS_LOCATION_ID: o ID do local em que você está procurando os links de definição.
  • ENTRY_LOCATION_ID: o ID do local do recurso de dados.
  • ENTRY_GROUP_ID: o ID do grupo de entrada do recurso de dados.
  • ENTRY_ID: o ID do recurso de dados.

  Observação: as colunas vinculadas ao termo em um recurso de dados são retornadas no campo path.

  Para buscar as páginas seguintes, anexe &page_token=PAGE_TOKEN à solicitação. Substitua PAGE_TOKEN pelo valor do token de página que você recebeu da resposta lookupEntryLinks anterior.

  Remover termos de um recurso de dados

  Console

  1. No console Google Cloud , acesse a página Pesquisa do Knowledge Catalog.

     Acesse Pesquisar

  2. Pesquise o recurso de dados (como um conjunto de dados, arquivo ou tabela) do qual você quer remover os termos e clique nele.

  3. Na página do recurso de dados, siga um destes procedimentos:

     • Para remover um termo de um recurso, na guia Detalhes, na seção Termos do glossário, clique no termo. Em seguida, clique em .
     • Para remover um termo de uma coluna, na guia Esquema, clique em ao lado do termo.

  REST

  alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
  
  gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/ENTRY_PROJECT_ID/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

  Encontrar glossários, termos e recursos de dados vinculados

  Console

  Para navegar pelo conteúdo do glossário empresarial, use o glossário e a árvore de termos na página Glossários.

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Na página Glossários, use a barra de filtro para encontrar categorias. Os seguintes filtros estão disponíveis:

     • Nome: retorna os glossários, as categorias e os termos com nomes que contêm o texto fornecido.
     • Pai: retorna os termos em que o nome ou a descrição do glossário pai corresponde ao texto fornecido. Por exemplo, parent:Finance retorna os termos conectados ao glossário pai cujo nome ou descrição contém a frase Finance.
     • Sinônimo: retorna a lista de termos com um sinônimo cujo nome ou ID contém o texto fornecido. Por exemplo, synonym:Profit retorna os termos que têm um termo sinônimo com nome ou ID que contém a frase profit.
     • Contato: retorna os termos em que o administrador de dados está listado como um contato. Por exemplo, contact:[e-mail] retorna as entradas conectadas a termos com um gestor de dados que corresponde a [e-mail].

  REST

  Para encontrar glossários, termos e recursos de dados vinculados usando a API REST, consulte projects.locations.searchEntries.

  Pesquisar recursos de dados vinculados a termos

  Console

  1. No console do Google Cloud , acesse a página Glossários do Knowledge Catalog.

     Acessar Glossários

  2. Na página Glossários, use a barra de filtro para inserir uma consulta de pesquisa de texto de formato livre. Isso retorna uma lista de correspondências nos nomes de glossário, categoria e termo.

  3. Clique em um termo correspondente.

  4. Na página Detalhes do termo, confira os termos vinculados (sinônimos e termos relacionados) e as entradas vinculadas (recursos de dados) a esse termo.

  5. Para ver os detalhes de uma entrada no Knowledge Catalog, clique nela.

  REST

  Para encontrar glossários, termos e recursos de dados vinculados usando a API REST, consulte projects.locations.searchEntries.

  Importar glossários e links entre termos e termos ou recursos de dados

  Para importar glossários e links de outra ferramenta de catalogação ou atualizar seus glossários no Knowledge Catalog, é possível importar em massa glossários, categorias, termos, links entre termos, links entre termos e recursos de dados ou colunas usando a API REST.

  1. Crie o glossário de destino.

     REST

     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID -d "$(cat<<EOF
     
     {
        "displayName": "DISPLAY_NAME",
        "description": "DESCRIPTION"
     }
     EOF
     )"

     Substitua:

     • PROJECT_ID: o ID do projeto em que você está criando o glossário.
     • LOCATION_ID: o local em que queremos criar o glossário.
     • GLOSSARY_ID: o ID do glossário
     • DISPLAY_NAME: o nome de exibição do glossário.
     • DESCRIPTION: a descrição do glossário

  2. Para importar categorias, termos e links entre termos e recursos de dados no glossário de destino criado, faça upload de arquivos para cada um deles em um bucket do Cloud Storage. Esses arquivos têm o seguinte formato:

     • Exemplo de formato para termos e categorias de um glossário

       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-category","aspects":{"dataplex-types.global.glossary-category-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","displayName":"CATEGORY_NAME","description":"CATEGORY_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"}]}}}
       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","displayName":"TERM1_DISPLAY_NAME","description":"TERM1_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}
       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","displayName":"TERM2_DISPLAY_NAME","description":"TERM2_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}

     • Exemplo de formato para links entre termos

       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/synonym","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}
       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-2f7408e3-af3d-405d-81bb-861cf9ec5146","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/related","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}

     • Exemplo de formato para links entre termos e recursos de dados

       projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1 and term projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1
       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/definition","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1"}]}}

     # Set GCURL alias
     alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
     
     gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
     {
        "type":"IMPORT",
        "import_spec":{
           "log_level":"DEBUG",
           "source_storage_uri":"gs://STORAGE_BUCKET/",
           "entry_sync_mode":"FULL",
           "aspect_sync_mode":"INCREMENTAL",
           "scope":{
              "glossaries": "GLOSSARY_NAME"
           }
        }
     }
     EOF
     )"

     Substitua DATAPLEX_API pelo endpoint da API Dataplex no formato dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  3. Opcional: confira o status da operação.

     gcurl https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/operation-OPERATION_ID

     Substitua OPERATION_ID pelo ID da operação.

  4. Opcional: confira o status do job de metadados.

     gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataJobs/JOB_ID

  5. Importe links entre termos como sinônimos ou termos relacionados.

     gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
     {
        "type":"IMPORT",
        "import_spec":{
           "log_level":"DEBUG",
           "source_storage_uri":"gs://STORAGE_BUCKET/",
           "entry_sync_mode":"FULL",
           "aspect_sync_mode":"INCREMENTAL",
           "scope":{
              "entry_groups":[  "projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/@dataplex"
              ],
              "entry_link_types":[
                 "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
                 "projects/dataplex-types/locations/global/entryLinkTypes/related"
              ],
              "referenced_entry_scopes":[
                 "PROJECT_IDS"
              ]
           }
        }
     }
     EOF
     )"

     Substitua DATAPLEX_API por dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  6. Importe links entre termos e recursos de dados ou colunas.

     Para criar um link entre os termos do glossário e os recursos de dados, execute o job de importação para cada grupo de entradas ao qual a entrada do recurso de dados pertence. Todos os links de entrada de definição são criados nesse grupo de entrada.

     Observação :verifique se o arquivo de importação no bucket do Cloud Storage contém um arquivo para links em um grupo de entrada. Para criar um link entre um termo e uma entrada para o recurso de dados em outro grupo de entradas, forneça um novo arquivo no bucket do Cloud Storage.

     gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
     {
     "type":"IMPORT",
     "import_spec":{
        "log_level":"DEBUG",
        "source_storage_uri":"gs://STORAGE_BUCKET/",
        "entry_sync_mode":"FULL",
        "aspect_sync_mode":"INCREMENTAL",
        "scope":{
           "entry_groups":[  "projects/PROJECT_ID/locations/ENTRY_GROUP_LOCATION_ID/entryGroups/@dataplex"
           ],
           "entry_link_types":[
              "projects/dataplex-types/locations/global/entryLinkTypes/definition"
           ],
           "referenced_entry_scopes":[
              "PROJECT_IDS"
           ]
        }
     }
     }
     EOF
     )"

     Substitua DATAPLEX_API por dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  Preços

  A partir de julho de 2025, o glossário empresarial do Knowledge Catalog será faturado da mesma forma que o preço de armazenamento de metadados. Consulte os preços de armazenamento de metadados do Knowledge Catalog.

  A seguir

  • Saiba como estabelecer um contexto de dados fundamental.