Gerenciar aspectos e enriquecer metadados

Os metadados são cruciais para organizar e entender seus recursos de dados. Por exemplo, setores regulamentados precisam proteger informações de identificação pessoal (PII), como nomes, endereços e números de identificação emitidos pelo governo. Esses dados podem ocorrer em várias instâncias em sistemas de dados distribuídos. O Dataplex Universal Catalog ajuda você a descobrir e catalogar rapidamente seus recursos de dados distribuídos. Em seguida, você pode classificar os dados como PII.

Ao enriquecer as entradas de dados com um contexto significativo, você pode tornar seus dados mais fáceis de descobrir e mais úteis. O Dataplex Universal Catalog permite o contexto por meio de:

  • Tipo de aspecto: um modelo JSON que define dados relacionados. Por exemplo, para informações de compliance, você pode ter classificação de PII e compliance com o GDPR.
  • Aspecto: uma instância de um tipo de aspecto. Por exemplo, {"pii_classification": "confidential", "gdpr_compliant": true}. É possível aplicar um aspecto a uma tabela inteira ou a uma coluna específica.

Depois de classificar os dados, é possível aplicar políticas de qualidade ou acesso a eles.

Para mais informações, consulte Sobre o gerenciamento de metadados no Dataplex Universal Catalog.

Aspectos

Os aspectos permitem capturar metadados em entradas para fornecer um contexto significativo. É possível usar aspectos para armazenar:

  • Metadados comerciais: informações que fornecem contexto comercial, como classificação de dados.

  • Metadados técnicos: detalhes técnicos sobre o ativo de dados, por exemplo, o esquema dele.

  • Metadados derivados de dados: informações geradas com base nos dados em si, como estatísticas de uma tabela do BigQuery.

Os aspectos são considerados partes do recurso de entrada e não recursos separados. Ao modificar um aspecto, você modifica a entrada que o contém.

É possível especificar aspectos no nível da entrada para descrever uma entrada ou no nível da coluna para descrever uma coluna em uma entrada.

Todo aspecto é uma instância de um tipo de aspecto. Um tipo de aspecto define um modelo para os aspectos dele. Cada tipo de aspecto contém um conjunto de campos. Ao criar aspectos, é necessário fornecer valores para esses campos.

Para uma determinada entrada, pode haver no máximo um aspecto associado a ela por tipo de aspecto. É possível ter vários aspectos associados a colunas de entrada por tipo de aspecto.

Categorias de aspectos

Os aspectos são categorizados da seguinte forma:

  • Aspectos obrigatórios: são os aspectos obrigatórios na criação de uma entrada. Esses aspectos são definidos pelo tipo de entrada. Todas as entradas pertencentes a um tipo de entrada precisam sempre ter todos os aspectos obrigatórios definidos por esse tipo.

    O Dataplex Universal Catalog gerencia os aspectos necessários (por exemplo, esquema) para entradas do sistema.

    Observe o seguinte:

    • Você pode associar aspectos obrigatórios apenas a entradas, não às colunas de uma entrada.

    • Não é possível excluir os aspectos obrigatórios de uma entrada.

    • É possível ler os aspectos necessários das entradas do sistema, mas não modificá-los.

    • Aspectos de dados não podem ser obrigatórios.

  • Aspectos opcionais: é possível associar aspectos opcionais a entradas ou colunas de entrada. É possível preencher aspectos opcionais no momento da criação da entrada ou depois, atualizando-a.

    É possível excluir aspectos opcionais depois que eles forem preenchidos.

Aspectos de dados

Os aspectos podem conter informações derivadas de dados, como resultados de um perfil de dados ou consultas de exemplo. Eles são chamados de aspectos de dados.

Tipos de aspecto

Os tipos de aspecto são recursos reutilizáveis que fornecem modelos para aspectos.

Categorias de tipos de aspecto

Os tipos de aspecto são categorizados em tipos personalizados e do sistema.

Tipos de aspecto personalizados

Os tipos de aspecto criados no Dataplex Universal Catalog são chamados de tipos de aspecto personalizados.

Os tipos de aspectos personalizados podem ser globais ou regionais. É possível criar tipos de aspectos personalizados em um local regional específico (por exemplo, us-central1) ou como um recurso global. A localização de um tipo de aspecto afeta o escopo da aplicabilidade dele e determina com quais entradas ele pode ser usado:

  • Tipos de aspecto globais: podem ser usados para criar aspectos de entradas em qualquer região. Escolha um tipo de aspecto global se precisar aplicar a mesma estrutura a entradas em várias regiões, já que só é necessário definir uma vez. Como a definição de um tipo de aspecto global é replicada em todas as regiões, essa opção pode não ser adequada se o próprio esquema do tipo de aspecto contiver informações sensíveis ou se for necessária uma residência de dados estrita para todos os componentes de metadados.
  • Tipos de aspecto regionais: só podem ser usados para criar aspectos de entradas que residem na mesma região do tipo de aspecto. Por exemplo, um tipo de aspecto criado em us-central1 só pode ser usado com entradas em us-central1. Escolha um local regional se um tipo de aspecto for relevante apenas para entradas em uma região específica ou para garantir que a definição do tipo de aspecto esteja na região selecionada, o que pode ajudar a atender aos requisitos de compliance e soberania de dados. Se você usa tipos de aspectos regionais, mas precisa da mesma estrutura em várias regiões, crie e gerencie definições separadas de tipo de aspecto em cada região.

Para mais informações, consulte Restrições de projeto e local.

Tipos de aspecto do sistema

Os tipos de aspecto que o Dataplex Universal Catalog fornece, usa e gerencia são chamados de tipos de aspecto do sistema. Os tipos de aspecto do sistema são sempre globais e podem ser usados em qualquer região. Os tipos de aspectos do sistema são armazenados em um projeto gerenciado pelo Google com o número 655216118709. Por exemplo, projects/655216118709/locations/global/aspectTypes/schema.

Os tipos de aspectos do sistema são categorizados em reutilizáveis e restritos. A tabela a seguir descreve as categorias de tipos de aspectos do sistema e a lista de tipos de aspectos que o Dataplex Universal Catalog oferece para cada uma das categorias:

Categoria do tipo de aspecto do sistema Descrição Tipos de aspectos fornecidos pelo Dataplex Universal Catalog
Tipo de aspecto do sistema reutilizável Você pode usar esses tipos de aspecto para criar ou modificar aspectos.
  • contacts
  • data-quality-scorecard
  • generic
  • overview
  • schema
  • usage
Tipo de aspecto do sistema restrito O Dataplex Universal Catalog gerencia esses tipos de aspecto.
Você pode ler aspectos nesses tipos, mas não pode criar ou editar aspectos nesses tipos.
incluindo, mas não se limitando a:
  • analytics-hub
  • aspecttype-aspect
  • bigquery-dataset
  • bigquery-table
  • cloudsql-database
  • cloudsql-instance
  • cloudsql-table
  • entrygroup-aspect
  • entrytype-aspect
  • sensitive-data-protection-profile
  • storage
  • storage-bucket
  • storage-folder

Antes de começar

Antes de criar e gerenciar tipos e aspectos, conclua as tarefas descritas nesta seção.

Funções exigidas

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

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

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

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

Ativar a API

Ative a API Dataplex no projeto do Dataplex Universal Catalog.

Ativar a API

Criar um tipo de aspecto personalizado

Console

  1. No console Google Cloud , acesse a página Catálogo do Dataplex Universal Catalog.

    Acessar o catálogo

  2. Clique na guia Tipos de aspecto e modelos de tag > Personalizado.

  3. Clique em Criar tipo de aspecto.

  4. Na janela Criar tipo de aspecto, insira o seguinte:

    1. Opcional: no campo Nome de exibição, insira um nome para o tipo de aspecto.
    2. No campo ID do tipo de aspecto, insira um ID exclusivo para o tipo de aspecto.
    3. Opcional: no campo Descrição, insira uma descrição para o tipo de aspecto.
    4. No campo Local, selecione um local para o tipo de aspecto. Não é possível mudar o local de um tipo de aspecto depois de criá-lo. Para entender o impacto de escolher um local global em vez de um regional, consulte a seção Tipos de aspectos personalizados.
  5. Opcional: defina um modelo para seu tipo de aspecto.

    Na seção Modelo, clique em Adicionar campo. Na seção Novo campo, insira o seguinte:

    1. No campo Nome, digite um nome.
    2. Opcional: no campo Nome de exibição, insira um nome de exibição.
    3. Opcional: no campo Descrição, insira uma descrição.
    4. No campo Tipo, selecione um tipo de dados para o campo. Com base na sua seleção, o próximo conjunto de campos e opções será mostrado:

      • Se você selecionou Texto como o tipo de dados, siga estas etapas:

        1. No campo Tipo de texto, selecione o tipo de texto.
        2. No campo Valores de texto, forneça uma dica para o campo de texto. Para fazer isso, clique em Adicionar valor e insira a dica. É possível adicionar várias dicas para um campo de texto.
        3. Clique em Concluído.
      • Se você selecionou Enumeração como o tipo de dados, adicione um valor de enumeração:

        1. Clique em Adicionar um valor de tipo enumerado.
        2. No campo Valor, insira um valor de enumeração. É possível adicionar vários valores de enumeração.
        3. Clique em Concluído.
      • Se você selecionou Matriz como o tipo de dados, na seção Item da matriz, defina os tipos de itens que estarão presentes na matriz:

        1. Clique em Adicionar item de matriz.
        2. No campo Nome, insira um nome para os itens da matriz.
        3. Opcional: no campo Nome de exibição, insira um nome de exibição para os itens da matriz.
        4. Opcional: no campo Descrição, insira uma descrição para os itens da matriz.
        5. No campo Tipo, selecione um tipo de dados para os itens da matriz.

          Com base na sua seleção, o próximo conjunto de campos e opções será exibido. Elas são semelhantes às opções descritas para os tipos de dados Texto, Enumeração, Mapa, Matriz e Registro em outras partes desta seção.

        6. Clique em Concluído.

      • Se você selecionou Mapa como o tipo de dados, na seção Valor do mapa, defina os tipos de valores que vão aparecer no mapa:

        1. Clique em Adicionar valor de mapa.
        2. No campo Nome, insira um nome para o mapa.
        3. Opcional: no campo Nome de exibição, insira um nome para o mapa.
        4. Opcional: no campo Descrição, insira uma descrição para o mapa.
        5. No campo Tipo, selecione um tipo de dados para o mapa.

          Com base na sua seleção, o próximo conjunto de campos e opções será exibido. Elas são semelhantes às opções descritas para os tipos de dados Texto, Enumeração, Mapa, Matriz e Registro em outras partes desta seção.

        6. Clique em Concluído.

      • Se você selecionou Registro como o tipo de dados, insira o seguinte:

        1. No campo ID do registro, insira um ID exclusivo que outros campos de registro possam usar para se referir a este registro. Consulte a seção Exemplo de uso dos campos "ID do registro" e "Referência do registro" deste documento.
        2. Opcional: se você quiser adicionar uma referência a outro registro deste modelo, use o campo Referência de registro. Não é possível modificar isso depois de criar o tipo de aspecto. Consulte a seção Exemplo de uso dos campos "ID do registro" e "Referência do registro" deste documento.
        3. Na seção Campos de registro, é possível definir um objeto complexo com vários campos aninhados. Para fazer isso, clique em Adicionar item de campo de registro e especifique o seguinte:

        4. No campo Nome, insira um nome para o campo de registro.

        5. Opcional: no campo Nome de exibição, insira um nome para o campo de registro.

        6. Opcional: no campo Descrição, insira uma descrição para o campo de registro.

        7. No campo Tipo, selecione um tipo de dados.

          Com base na sua seleção, o próximo conjunto de campos e opções será exibido. Elas são semelhantes às opções descritas para os tipos de dados Texto, Enumeração, Mapa, Matriz e Registro nesta seção.

        8. Clique em Concluído.

    5. Para tornar o campo obrigatório para um aspecto desse tipo, selecione É obrigatório. Para mais informações sobre aspectos obrigatórios e opcionais, consulte a seção Categorias de aspectos deste documento.

    6. Clique em Concluído.

    7. Para adicionar vários campos, clique em Adicionar campo e repita as etapas anteriores.

  6. Opcional: na seção Rótulos, adicione rótulos arbitrários como pares de chave-valor aos recursos:

    1. Clique em Adicionar rótulo.
    2. No campo Chave, insira uma chave.
    3. No campo Valor, insira um valor para a chave.
    4. Para adicionar mais rótulos, clique em Adicionar rótulo e repita as etapas.
  7. Clique em Salvar.

gcloud

Para criar um tipo de aspecto personalizado, use o comando gcloud dataplex aspect-types create.

C#

C#

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

Para autenticar no Dataplex Universal 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 GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CreateAspectType</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 CreateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CreateAspectTypeRequest request = new CreateAspectTypeRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            AspectTypeId = "",
            AspectType = new AspectType(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.CreateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType 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<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceCreateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Go.

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.CreateAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateAspectTypeRequest.
	}
	op, err := c.CreateAspectType(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.CreateAspectTypeRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateAspectType {

  public static void main(String[] args) throws Exception {
    syncCreateAspectType();
  }

  public static void syncCreateAspectType() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      CreateAspectTypeRequest request =
          CreateAspectTypeRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setAspectTypeId("aspectTypeId-423030675")
              .setAspectType(AspectType.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.createAspectTypeAsync(request).get();
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    aspect_type = dataplex_v1.AspectType()
    aspect_type.metadata_template.name = "name_value"
    aspect_type.metadata_template.type_ = "type__value"

    request = dataplex_v1.CreateAspectTypeRequest(
        parent="parent_value",
        aspect_type_id="aspect_type_id_value",
        aspect_type=aspect_type,
    )

    # Make the request
    operation = client.create_aspect_type(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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_aspect_type call in the CatalogService 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::CatalogService::Client#create_aspect_type.
#
def create_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::CreateAspectTypeRequest.new

  # Call the create_aspect_type method.
  result = client.create_aspect_type 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

Para criar um tipo de aspecto personalizado, use o método aspectType.create.

Depois de criar um tipo de aspecto personalizado, é possível adicionar aspectos às entradas.

Exemplo de uso dos campos "ID do registro" e "Referência do registro"

Você pode usar os campos ID do registro e Referência do registro para referências recursivas. O exemplo a seguir mostra como usar esses campos:

Considere um tipo de aspecto chamado Employee, com os seguintes campos:

  • Nome (tipo:Text)
  • Data de início (tipo:Date & time)
  • Designação (tipo:Text)
  • Endereço atual (tipo:Record)
  • Endereço permanente (tipo:Record)

Os dois campos de endereço Endereço atual e Endereço permanente são do mesmo tipo de dados Record. Para evitar a duplicação, defina os valores ID do registro e Referência do registro ao definir esses campos.

Ao definir o campo Endereço atual, é possível especificar ID do registro como address-field. Para Endereço permanente, você pode especificar o mesmo valor (address-field) para Referência do registro. Exemplo:

  • Nome (tipo:Text)
  • Data de início (tipo:Date & time)
  • Designação (tipo:Text)
  • Endereço atual (tipo:Record, ID do registro:address-field)
  • Endereço permanente (tipo:Record, referência do registro:address-field)

Assim, não é necessário duplicar os campos de outro endereço.

Adicionar aspectos a uma entrada

Depois de criar um tipo de aspecto, é possível criar aspectos desse tipo. Para adicionar aspectos a uma entrada, é necessário atualizar a entrada, já que os aspectos são armazenados dentro das entradas.

Observe o seguinte:

  • É possível adicionar aspectos a uma entrada ou às colunas dela.
  • É possível editar os aspectos obrigatórios apenas para entradas personalizadas. Não é possível excluir os aspectos obrigatórios.
  • É possível editar e excluir os aspectos opcionais das entradas personalizadas e do sistema.

Console

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

    Acesse Pesquisar

  2. Em Escolher plataforma de pesquisa, selecione Catálogo Universal do Dataplex como o modo de pesquisa.

  3. Pesquise a entrada a que você quer adicionar aspectos e clique nela. A página de detalhes da entrada é aberta.

  4. Para adicionar aspectos à entrada, siga estas etapas:

    1. Clique na guia Detalhes.
    2. Para adicionar aspectos obrigatórios ou opcionais à entrada, na seção Tags e aspectos, clique em Adicionar na categoria correspondente.
      Não é possível adicionar aspectos obrigatórios se o tipo de entrada selecionada não tiver aspectos obrigatórios definidos.
    3. Pesquise e selecione o aspecto que você quer adicionar.
    4. Na janela Adicionar aspecto, insira os valores nos campos.
    5. Clique em Salvar.
  5. Para adicionar aspectos a uma coluna da entrada, siga estas etapas:

    1. Na página de detalhes da entrada, clique na guia Esquema.
    2. Selecione as colunas a que você quer adicionar aspectos.
    3. Clique em Adicionar aspecto.
    4. Pesquise e selecione o aspecto que você quer adicionar.
    5. Na janela Adicionar aspecto, insira os valores nos campos.
    6. Clique em Salvar.

gcloud

Para adicionar aspectos a uma entrada ou a uma coluna dela, use o comando gcloud dataplex entries update.

C#

C#

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

Para autenticar no Dataplex Universal 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.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</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 UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Para adicionar aspectos ao objeto de entrada, consulte Aspectos.

Go

Go

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

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Para adicionar aspectos ao objeto de entrada, consulte Entry.

Java

Java

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

Para autenticar no Dataplex Universal 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.Aspect;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryName;
import com.google.cloud.dataplex.v1.EntrySource;
import com.google.protobuf.FieldMask;
import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import java.util.Map;

public class UpdateEntry {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    // Available locations: https://cloud.google.com/dataplex/docs/locations
    String location = "MY_LOCATION";
    String entryGroupId = "MY_ENTRY_GROUP_ID";
    String entryId = "MY_ENTRY_ID";

    Entry createdEntry = updateEntry(projectId, location, entryGroupId, entryId);
    System.out.println("Successfully updated entry: " + createdEntry.getName());
  }

  // Method to update Entry located in projectId, location, entryGroupId and with entryId
  public static Entry updateEntry(
      String projectId, String location, String entryGroupId, String entryId) throws Exception {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests.
    try (CatalogServiceClient client = CatalogServiceClient.create()) {
      Entry entry =
          Entry.newBuilder()
              .setName(EntryName.of(projectId, location, entryGroupId, entryId).toString())
              .setEntrySource(
                  EntrySource.newBuilder()
                      .setDescription("updated description of the entry")
                      .build())
              .putAllAspects(
                  Map.of(
                      "dataplex-types.global.generic",
                      Aspect.newBuilder()
                          .setAspectType(
                              "projects/dataplex-types/locations/global/aspectTypes/generic")
                          .setData(
                              Struct.newBuilder()
                                  // "Generic" Aspect Type have fields called "type" and "system.
                                  // The values below are a sample of possible options.
                                  .putFields(
                                      "type",
                                      Value.newBuilder()
                                          .setStringValue("updated example value")
                                          .build())
                                  .putFields(
                                      "system",
                                      Value.newBuilder()
                                          .setStringValue("updated example system")
                                          .build())
                                  .build())
                          .build()))
              .build();

      // Update mask specifies which fields will be updated.
      // For more information on update masks, see: https://google.aip.dev/161
      FieldMask updateMask =
          FieldMask.newBuilder().addPaths("aspects").addPaths("entry_source.description").build();
      return client.updateEntry(entry, updateMask);
    }
  }
}

Python

Python

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

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

from google.cloud import dataplex_v1
from google.protobuf import struct_pb2


def update_entry(
    project_id: str, location: str, entry_group_id: str, entry_id: str
) -> dataplex_v1.Entry:
    """Method to update Entry located in project_id, location, entry_group_id and with entry_id"""

    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    # After completing all of your requests, call the "__exit__()" method to safely
    # clean up any remaining background resources. Alternatively, use the client as
    # a context manager.
    with dataplex_v1.CatalogServiceClient() as client:
        # The resource name of the Entry
        name = f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}"
        entry = dataplex_v1.Entry(
            name=name,
            entry_source=dataplex_v1.EntrySource(
                description="updated description of the entry"
            ),
            aspects={
                "dataplex-types.global.generic": dataplex_v1.Aspect(
                    aspect_type="projects/dataplex-types/locations/global/aspectTypes/generic",
                    data=struct_pb2.Struct(
                        fields={
                            # "Generic" Aspect Type have fields called "type" and "system.
                            # The values below are a sample of possible options.
                            "type": struct_pb2.Value(
                                string_value="updated example value"
                            ),
                            "system": struct_pb2.Value(
                                string_value="updated example system"
                            ),
                        }
                    ),
                )
            },
        )

        # Update mask specifies which fields will be updated.
        # For more information on update masks, see: https://google.aip.dev/161
        update_mask = {"paths": ["aspects", "entry_source.description"]}
        return client.update_entry(entry=entry, update_mask=update_mask)


if __name__ == "__main__":
    # TODO(developer): Replace these variables before running the sample.
    project_id = "MY_PROJECT_ID"
    # Available locations: https://cloud.google.com/dataplex/docs/locations
    location = "MY_LOCATION"
    entry_group_id = "MY_ENTRY_GROUP_ID"
    entry_id = "MY_ENTRY_ID"

    updated_entry = update_entry(project_id, location, entry_group_id, entry_id)
    print(f"Successfully updated entry: {updated_entry.name}")

Ruby

Ruby

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

Para autenticar no Dataplex Universal 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 update_entry call in the CatalogService 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::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

Para adicionar aspectos ao objeto de entrada, consulte #required_aspects=.

REST

Para adicionar aspectos a uma entrada ou a uma coluna de uma entrada, use o método entry.patch.

Não é possível criar e usar aspectos em uma entrada em que o tipo de aspecto e a entrada estão em diferentes organizações Google Cloud .

Gerenciar aspectos de uma entrada

Nesta seção, descrevemos como atualizar e excluir os aspectos de uma entrada.

Atualizar um aspecto

É possível editar os aspectos opcionais das entradas personalizadas e do sistema. É possível editar os aspectos obrigatórios apenas para entradas personalizadas.

Console

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

    Acesse Pesquisar

  2. Em Escolher plataforma de pesquisa, selecione Catálogo Universal do Dataplex como o modo de pesquisa.

  3. Pesquise e clique na entrada que você quer atualizar.

    A página de detalhes da entrada é aberta.

  4. Clique na guia Detalhes.

  5. Na seção Tags e aspectos, expanda o aspecto ou a tag que você quer atualizar e clique em Editar.

  6. Na janela Editar aspecto, atualize os campos obrigatórios.

  7. Clique em Salvar.

gcloud

Para atualizar aspectos de uma entrada ou coluna de uma entrada, use o comando gcloud dataplex entries update.

C#

C#

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

Para autenticar no Dataplex Universal 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.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</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 UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go

Go

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

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

  public static void main(String[] args) throws Exception {
    syncUpdateEntry();
  }

  public static void syncUpdateEntry() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry = dataplex_v1.Entry()
    entry.entry_type = "entry_type_value"

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

    # Make the request
    response = client.update_entry(request=request)

    # 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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 update_entry call in the CatalogService 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::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

REST

Para atualizar aspectos de uma entrada ou coluna de uma entrada, use o método entry.patch.

Excluir um aspecto

Console

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

    Acesse Pesquisar

  2. Em Escolher plataforma de pesquisa, selecione Catálogo Universal do Dataplex como o modo de pesquisa.

  3. Pesquise e clique na entrada cujos aspectos você quer excluir.

    A página de detalhes da entrada é aberta.

  4. Clique na guia Detalhes.

  5. Na seção Tags e aspectos, expanda o aspecto ou a tag que você quer excluir e clique em Excluir.

  6. Clique em Confirmar.

gcloud

Para excluir um aspecto de uma entrada, use o comando gcloud dataplex entries update.

C#

C#

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

Para autenticar no Dataplex Universal 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.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</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 UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go

Go

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

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

  public static void main(String[] args) throws Exception {
    syncUpdateEntry();
  }

  public static void syncUpdateEntry() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry = dataplex_v1.Entry()
    entry.entry_type = "entry_type_value"

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

    # Make the request
    response = client.update_entry(request=request)

    # 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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 update_entry call in the CatalogService 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::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

REST

Para excluir um aspecto de uma entrada, use o método entry.patch.

Gerenciar tipos de aspecto

Nesta seção, descrevemos como ver, atualizar e excluir tipos de aspectos.

Confira a lista de tipos de aspecto e modelos de tag disponíveis

Console

  1. No console Google Cloud , acesse a página Catálogo do Dataplex Universal Catalog.

    Acessar o catálogo

  2. Clique na guia Tipos de aspecto e modelos de tag.

    Esta página lista todos os tipos de aspecto do Dataplex Universal Catalog e os modelos de tag do Data Catalog disponíveis.

  3. Para ver os tipos de aspectos personalizados e modelos de tag, clique na guia Personalizado. Na guia Personalizado, a coluna Origem do catálogo mostra onde o recurso está localizado: no Dataplex Universal Catalog ou no Data Catalog.

    Para ver os tipos de aspectos do sistema, clique na guia Sistema.

    Para mais informações sobre tipos de aspectos personalizados e do sistema, consulte a seção Categorias de tipos de aspectos deste documento.

  4. Opcional: para conferir a lista de tipos de aspectos e modelos de tag no projeto selecionado, clique na guia Personalizado e depois no botão Mostrar de todos os projetos para desativar.

    A opção Mostrar de todos os projetos fica ativada por padrão, e a lista inclui recursos do Dataplex Universal Catalog da organização selecionada e recursos do Data Catalog de todas as organizações a que você tem acesso.

gcloud

Para listar todos os tipos de aspectos disponíveis, use o comando gcloud dataplex aspect-types list.

C#

C#

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

Para autenticar no Dataplex Universal 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 GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for ListAspectTypes</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 ListAspectTypesRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        ListAspectTypesRequest request = new ListAspectTypesRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListAspectTypesResponse, AspectType> response = catalogServiceClient.ListAspectTypes(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (AspectType 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 (ListAspectTypesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (AspectType 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<AspectType> 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 (AspectType 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Go.

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.ListAspectTypesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAspectTypesRequest.
	}
	it := c.ListAspectTypes(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.ListAspectTypesResponse)
	}
}

Java

Java

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

Para autenticar no Dataplex Universal 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.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.ListAspectTypesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListAspectTypes {

  public static void main(String[] args) throws Exception {
    syncListAspectTypes();
  }

  public static void syncListAspectTypes() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      ListAspectTypesRequest request =
          ListAspectTypesRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .setOrderBy("orderBy-1207110587")
              .build();
      for (AspectType element : catalogServiceClient.listAspectTypes(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_aspect_types():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListAspectTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_aspect_types(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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_aspect_types call in the CatalogService 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::CatalogService::Client#list_aspect_types.
#
def list_aspect_types
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListAspectTypesRequest.new

  # Call the list_aspect_types method.
  result = client.list_aspect_types 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::AspectType.
    p item
  end
end

REST

Para listar todos os tipos de aspectos disponíveis, use o método aspectTypes.list.

Ver detalhes de um tipo de aspecto ou modelo de tag

Console

  1. No console Google Cloud , acesse a página Catálogo do Dataplex Universal Catalog.

    Acessar o catálogo

  2. Clique na guia Tipos de aspecto e modelos de tag.

  3. Para ver os detalhes de um tipo de aspecto do Dataplex Universal Catalog, clique nele. A página de detalhes do tipo de aspecto é aberta, onde você pode acessar detalhes como nome de exibição, ID do tipo de aspecto, descrição, ID do projeto, local, rótulos, data de criação e data da última modificação.

    • Para conferir a estrutura do tipo de aspecto selecionado, clique na guia Modelo.
    • Para conferir a lista de 10 entradas relacionadas criadas recentemente, clique na guia Entradas de exemplo.
    • Para pesquisar todas as entradas relacionadas, clique em Mostrar todas as entradas relacionadas na pesquisa. Esse botão só aparece se houver pelo menos uma entrada relacionada.
  4. Para conferir os detalhes de um modelo de tag do Data Catalog, clique nele. A página de detalhes do modelo de tag é aberta no Data Catalog, onde é possível acessar detalhes como nome de exibição, ID do modelo, ID do projeto, local, visibilidade e rótulos.

gcloud

Para conferir os detalhes de um tipo de aspecto, use o comando gcloud dataplex aspect-types describe.

C#

C#

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

Para autenticar no Dataplex Universal 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;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for GetAspectType</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 GetAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        GetAspectTypeRequest request = new GetAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
        };
        // Make the request
        AspectType response = catalogServiceClient.GetAspectType(request);
    }
}

Go

Go

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

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.GetAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetAspectTypeRequest.
	}
	resp, err := c.GetAspectType(ctx, req)
	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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.AspectType;
import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.GetAspectTypeRequest;

public class SyncGetAspectType {

  public static void main(String[] args) throws Exception {
    syncGetAspectType();
  }

  public static void syncGetAspectType() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      GetAspectTypeRequest request =
          GetAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .build();
      AspectType response = catalogServiceClient.getAspectType(request);
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_get_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.GetAspectTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_aspect_type(request=request)

    # 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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 get_aspect_type call in the CatalogService 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::CatalogService::Client#get_aspect_type.
#
def get_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::GetAspectTypeRequest.new

  # Call the get_aspect_type method.
  result = client.get_aspect_type request

  # The returned object is of type Google::Cloud::Dataplex::V1::AspectType.
  p result
end

REST

Para receber os detalhes de um tipo de aspecto, use o método aspectTypes.get.

Atualizar um tipo de aspecto personalizado

É possível atualizar o nome de exibição, a descrição, os campos de modelo e os rótulos de um tipo de aspecto personalizado. Não é possível excluir um campo em um modelo.

Não é possível atualizar o ID e o local do tipo de aspecto depois de criar o tipo de aspecto.

Console

  1. No console Google Cloud , acesse a página Catálogo do Dataplex Universal Catalog.

    Acessar o catálogo

  2. Clique na guia Tipos de aspecto e modelos de tag.

  3. Clique no tipo de aspecto que você quer atualizar.

  4. Na página Detalhes do tipo de aspecto, clique em Editar.

  5. Edite o nome de exibição, a descrição, os campos de modelo e os rótulos, conforme necessário.

  6. Opcional: para marcar um campo no tipo de aspecto como descontinuado, siga estas etapas:

    1. Na seção Modelo, expanda o campo.
    2. Selecione Está descontinuado.
    3. No campo Motivo da descontinuação, insira um motivo para descontinuar o campo selecionado.
    4. Clique em Concluído.
  7. Clique em Salvar.

gcloud

Para atualizar um tipo de aspecto personalizado, use o comando gcloud dataplex aspect-types update.

C#

C#

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

Para autenticar no Dataplex Universal 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 GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateAspectType</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 UpdateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateAspectTypeRequest request = new UpdateAspectTypeRequest
        {
            AspectType = new AspectType(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.UpdateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType 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<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceUpdateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType 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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Go.

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateAspectTypeRequest.
	}
	op, err := c.UpdateAspectType(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.UpdateAspectTypeRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateAspectType {

  public static void main(String[] args) throws Exception {
    syncUpdateAspectType();
  }

  public static void syncUpdateAspectType() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateAspectTypeRequest request =
          UpdateAspectTypeRequest.newBuilder()
              .setAspectType(AspectType.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.updateAspectTypeAsync(request).get();
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_update_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    aspect_type = dataplex_v1.AspectType()
    aspect_type.metadata_template.name = "name_value"
    aspect_type.metadata_template.type_ = "type__value"

    request = dataplex_v1.UpdateAspectTypeRequest(
        aspect_type=aspect_type,
    )

    # Make the request
    operation = client.update_aspect_type(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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 update_aspect_type call in the CatalogService 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::CatalogService::Client#update_aspect_type.
#
def update_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest.new

  # Call the update_aspect_type method.
  result = client.update_aspect_type 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

Para atualizar um tipo de aspecto personalizado, use o método aspectTypes.patch.

Excluir um tipo de aspecto personalizado

Console

  1. No console Google Cloud , acesse a página Catálogo do Dataplex Universal Catalog.

    Acessar o catálogo

  2. Clique na guia Tipos de aspecto e modelos de tag.

  3. Clique no tipo de aspecto que você quer excluir.

  4. Na página Detalhes do tipo de aspecto, clique em Excluir. Confirme quando solicitado.

gcloud

Para excluir um tipo de aspecto personalizado, use o comando gcloud dataplex aspect-types delete.

C#

C#

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

Para autenticar no Dataplex Universal 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 GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for DeleteAspectType</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 DeleteAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        DeleteAspectTypeRequest request = new DeleteAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
            Etag = "",
        };
        // Make the request
        Operation<Empty, OperationMetadata> response = catalogServiceClient.DeleteAspectType(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 = catalogServiceClient.PollOnceDeleteAspectType(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Go.

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


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.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.DeleteAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteAspectTypeRequest.
	}
	op, err := c.DeleteAspectType(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Java.

Para autenticar no Dataplex Universal 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.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.DeleteAspectTypeRequest;
import com.google.protobuf.Empty;

public class SyncDeleteAspectType {

  public static void main(String[] args) throws Exception {
    syncDeleteAspectType();
  }

  public static void syncDeleteAspectType() 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      DeleteAspectTypeRequest request =
          DeleteAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .setEtag("etag3123477")
              .build();
      catalogServiceClient.deleteAspectTypeAsync(request).get();
    }
  }
}

Python

Python

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

Para autenticar no Dataplex Universal 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_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.DeleteAspectTypeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_aspect_type(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 catálogo universal do Dataplex: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Dataplex Universal Catalog Ruby.

Para autenticar no Dataplex Universal 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_aspect_type call in the CatalogService 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::CatalogService::Client#delete_aspect_type.
#
def delete_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest.new

  # Call the delete_aspect_type method.
  result = client.delete_aspect_type 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

Para excluir um tipo de aspecto personalizado, use o método aspectTypes.delete.

A seguir