Criar produtos de dados

Este documento é destinado a proprietários de produtos de dados que querem criar e configurar produtos de dados no Dataplex Universal Catalog.

Para mais informações sobre a arquitetura e os conceitos principais dos produtos de dados, consulte Sobre produtos de dados.

Antes de começar

Ative as APIs Dataplex e BigQuery.
Funções necessárias para ativar APIs
Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder papéis.
Ativar as APIs
Verifique se os recursos de dados (por exemplo, conjuntos de dados, tabelas e visualizações do BigQuery) foram criados e preenchidos.

Para mais informações sobre como criar recursos de dados, consulte os documentos a seguir:
Identifique ou crie os Grupos do Google que você quer configurar no seu produto de dados. Cada produto de dados precisa ter um grupo do Google exclusivo.

Funções exigidas

Esta seção descreve os papéis mínimos do IAM necessários para dois grupos de usuários principais: proprietários de produtos de dados (que criam e gerenciam produtos de dados) e consumidores de produtos de dados (que pesquisam e usam produtos de dados).

Funções de um proprietário de produto de dados

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

Permissões completas para criar, atualizar, excluir e gerenciar permissões para produtos de dados: Administrador de produtos de dados do Dataplex (roles/dataplex.dataProductsAdmin)
Atualizar e gerenciar produtos de dados atuais: Editor de produtos de dados do Dataplex (roles/dataplex.dataProductsEditor)
Adicione aspectos como schema, overview e contacts: Proprietário de entradas e links de entradas do Dataplex (roles/dataplex.entryOwner)
Pesquisar e adicionar recursos: Leitor do Dataplex Catalog (roles/dataplex.catalogViewer)
Edite tipos de aspectos do sistema, como documentação e aspecto de contrato da cadência de atualização: Editor do Dataplex Catalog (roles/dataplex.catalogEditor)

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

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

Permissões necessárias

As seguintes permissões são necessárias para criar e gerenciar produtos de dados:

Edite o tipo de aspecto do sistema overview: dataplex.entryGroups.useOverviewAspect
Edite o tipo de aspecto do sistema refresh cadence: dataplex.entryGroups.useRefreshCadenceAspect

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

Funções para um consumidor de produtos de dados

Para que os consumidores de produtos de dados possam pesquisar, visualizar e solicitar acesso a produtos de dados, como proprietário de um produto de dados, você precisa garantir que ele seja detectável. Para fazer isso, conceda aos consumidores do produto de dados os seguintes papéis do IAM no produto de dados:

Pesquise e acesse produtos de dados na Pesquisa do Dataplex Universal Catalog: Consumidor de produtos de dados do Dataplex (dataplex.dataProductsConsumer)
Acesso somente leitura para visualizar definições e metadados de produtos de dados: Leitor de produtos de dados do Dataplex (dataplex.dataProductsViewer)
Solicitar acesso a produtos de dados: consumidor de produtos de dados do Dataplex (dataplex.dataProductsConsumer)

Criar e configurar um produto de dados

A criação de um produto de dados envolve as seguintes tarefas de alto nível:

Criar um produto de dados

Essa etapa inicial obrigatória exige a definição de detalhes principais, como um nome exclusivo, uma descrição, a região em que o produto de dados é criado e os detalhes do proprietário.
Opcional: adicione recursos

Nesta fase, você seleciona os recursos a serem incluídos no produto de dados. Uma restrição importante é que os recursos precisam estar na mesma região que o próprio produto de dados. É possível adicionar no máximo 10 recursos a um produto de dados.

Para conferir a lista de recursos compatíveis, consulte Recursos compatíveis.
Opcional: configurar grupos de acesso e permissões de recursos

Nesta fase opcional, você simplifica o controle de acesso criando grupos de acesso. Esses grupos de acesso funcionam como aliases fáceis de usar (por exemplo, Analyst ou Reader) para grupos do Google subjacentes. Em seguida, atribua permissões selecionando um papel específico do IAM e mapeando-o para um grupo de acesso de um recurso específico.
Opcional: adicione mais detalhes, como contratos, aspectos e documentação

Essa fase opcional melhora a governança e os metadados. É possível adicionar um contrato, que é um tipo de aspecto próprio, para comunicar formalmente a cadência de atualização de dados acordada, especificando parâmetros como frequência, horário e limite de atualização. Você também inclui Aspectos para fornecer mais metadados para seu produto de dados. Além disso, você adiciona documentação de rich text, como guias do usuário e exemplos de consultas.

Para criar e configurar um produto de dados, siga as etapas nas seções abaixo:

Criar um produto de dados

Console

No console Google Cloud , acesse a página Produtos de dados do Dataplex Universal Catalog.

Acessar Produtos de dados
Clique em Criar.
No painel Criar produtos de dados, insira os seguintes detalhes:
- Nome do produto de dados: insira um nome exclusivo para seu produto de dados.
- ID do produto de dados: um identificador exclusivo gerado automaticamente. É possível editar esse campo.
- ID do projeto: um identificador exclusivo do projeto em que o produto de dados é criado. Procure e selecione o projeto.
- Região: selecione a região ou multirregião em que o produto de dados foi criado.
- Ícone: navegue e selecione um ícone para identificar visualmente o produto de dados. Isso é opcional.
- Descrição: insira uma breve descrição do produto de dados.
- Contatos: insira o ID de e-mail do proprietário do produto de dados.
- Rótulos: adicione rótulos de chave-valor para organizar seus recursos. Isso é opcional.
Clique em Criar produto de dados.

REST

Para criar um produto de dados, use o método dataProducts.create.

Por exemplo, envie a seguinte solicitação POST:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"display_name": "DISPLAY_NAME", "owner_emails": ["EMAIL_IDs"]}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts?data_product_id=DATA_PRODUCT_ID

Substitua:

DISPLAY_NAME: um nome fácil de usar para seu produto de dados
EMAIL_IDs: IDs de e-mail separados por vírgulas dos proprietários de produtos de dados
PROJECT_ID: o ID do seu projeto Google Cloud
LOCATION: a região em que você quer criar o produto de dados
DATA_PRODUCT_ID: um ID exclusivo para seu produto de dados

Terraform

Para criar um produto de dados, use o recurso google_dataplex_data_product.

resource "google_dataplex_data_product" "example_product" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
display_name    = "DISPLAY_NAME"
description     = "DESCRIPTION"
owner_emails    = ["EMAIL_IDs"]

provider = google-beta
}

Substitua:

PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que você quer criar o produto de dados
DATA_PRODUCT_ID: um ID exclusivo para seu produto de dados
DISPLAY_NAME: um nome fácil de usar para seu produto de dados
DESCRIPTION: uma breve descrição do produto de dados
EMAIL_IDs: IDs de e-mail separados por vírgulas dos proprietários de produtos de dados, por exemplo, ["user1@example.com", "user2@example.com"]

Opcional: adicione recursos

Console

No painel Adicionar recursos, clique em +Adicionar.
Pesquise e selecione os recursos que você quer adicionar ao produto de dados. Os recursos selecionados precisam estar na mesma região do produto de dados.

Se você tiver as permissões necessárias, clique no recurso para ver os metadados dele.
Para refinar os resultados da pesquisa, use Filtros.
Depois de selecionar os recursos, clique em Adicionar.

Observação: na prévia, é possível adicionar no máximo 10 recursos a um produto de dados.
Clique em Continuar.

REST

Para adicionar um recurso de dados ao seu produto de dados, use o método dataAssets.create.

Por exemplo, envie a seguinte solicitação POST:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"resource": "RESOURCE_NAME"}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID/dataAssets?data_asset_id=DATA_ASSET_ID

Substitua:

RESOURCE_NAME: o nome completo do recurso do recurso de dados (por exemplo, //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID).
PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados existe
DATA_PRODUCT_ID: o ID do produto de dados
DATA_ASSET_ID: um ID exclusivo para esse recurso de dados no produto de dados.

Terraform

Para adicionar um recurso de dados ao produto de dados, use o recurso google_dataplex_data_product_data_asset.

resource "google_dataplex_data_product_data_asset" "example_asset" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
data_asset_id   = "DATA_ASSET_ID"
resource        = "RESOURCE_NAME"

provider = google-beta
}

Substitua:

PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados existe
DATA_PRODUCT_ID: o ID do produto de dados
DATA_ASSET_ID: um ID exclusivo para esse recurso de dados no produto de dados.
RESOURCE_NAME: o nome completo do recurso do recurso de dados (por exemplo, //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID).

Opcional: configurar grupos de acesso e permissões de recursos

No painel Configurar grupos de acesso e permissões de recursos, é possível criar grupos de acesso e atribuir permissões aos recursos.

Configurar grupos de acesso

Console

Clique em Adicionar grupo de acesso.
No campo Nome do grupo de acesso, digite um nome para o grupo. Por exemplo, Analyst.
No campo Descrição do grupo de acesso, insira uma descrição para o grupo de acesso.
No campo Identificador do grupo de acesso, insira o endereço de e-mail de um grupo do Google que você quer atribuir a esse grupo de acesso. Os consumidores de produtos de dados que solicitarem acesso a esse grupo podem ser adicionados como membros ao grupo do Google mapeado.

Se você não tiver um grupo do Google, crie um. Para mais informações, consulte Criar e gerenciar Grupos do Google no console do Google Cloud .

Observação: é possível adicionar no máximo três grupos de acesso por produto de dados.
Clique em Adicionar.

REST

Para configurar um grupo de acesso ao produto de dados, use o método dataProducts.patch.

Por exemplo, envie a seguinte solicitação PATCH:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"access_groups": ACCESS_GROUPS_MAP}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID?update_mask="access_groups"

Substitua:

ACCESS_GROUPS_MAP: um objeto JSON que representa um mapa em que cada chave é um ID de grupo de acesso e o valor é um objeto AccessGroup. Exemplo:

{
"analyst": {
  "id": "analyst","display_name": "Analyst access group","description": "Access group for analysts","principal":
{"google_group": "analyst-team@example.com"}
  }
}

PROJECT_ID: o ID do seu projeto Google Cloud
LOCATION: a região em que o produto de dados existe
DATA_PRODUCT_ID: o ID do seu produto de dados

Terraform

Para definir grupos de acesso ao produto de dados, use o bloco aninhado access_groups no recurso google_dataplex_data_product.

Por exemplo, use a seguinte configuração:

resource "google_dataplex_data_product" "example_data_product" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
display_name    = "DISPLAY_NAME"
owner_emails    = ["EMAIL_IDs"]

access_groups {
  id           = "analyst" # Internal identifier for configuration
  group_id     = "analyst" # Unique identifier of the access group, should be same as the 'id'
  display_name = "Business Analyst"
  description  = "Access group for regional analysts"
  principal {
    google_group = "analyst-team@example.com"
  }

provider = google-beta
}

Substitua:

PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados está localizado
DATA_PRODUCT_ID: um ID exclusivo para o produto de dados.
DISPLAY_NAME: um nome fácil de usar para seu produto de dados
EMAIL_IDs: IDs de e-mail separados por vírgulas dos proprietários de produtos de dados, por exemplo, ["user1@example.com", "user2@example.com"]

Configurar permissões de recursos

Depois de configurar os grupos de acesso, você pode configurar as permissões para os recursos no produto de dados.

Console

Na seção Permissões de recursos, selecione o recurso para o qual você quer configurar permissões.
Clique em Configurar permissões.
No campo Selecionar grupo de acesso, escolha um grupo.
No campo Atribuir papel do IAM, selecione um papel do IAM que você quer atribuir ao grupo de acesso.

Por exemplo, se o recurso for uma tabela do BigQuery chamada Sales, e se você tiver selecionado o grupo de acesso Analyst e atribuído a função BigQuery Metadata Viewer a esse grupo, os consumidores de produtos de dados que fazem parte do grupo de acesso Analyst terão permissão BigQuery Metadata Viewer na tabela Sales.

É possível adicionar várias funções a um recurso.
Clique em Configurar. O recurso agora mostra as permissões atribuídas.
Para configurar permissões para outros recursos, repita as etapas.
Clique em Continuar.

REST

Para configurar permissões para os recursos no produto de dados, use o método dataAssets.patch.

Por exemplo, envie a seguinte solicitação PATCH:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"access_group_configs": ACCESS_GROUP_CONFIGS_MAP}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID/dataAssets/DATA_ASSET_ID?update_mask="access_group_configs"

Substitua:

ACCESS_GROUP_CONFIGS_MAP: um objeto JSON que representa um mapa em que cada chave é um ID de grupo de acesso e o valor é um objeto AccessGroupConfig. Exemplo:
```
{
"analyst": {
  iam_roles: ["roles/bigquery.dataViewer"]
  }
}
```
PROJECT_ID: o ID do seu projeto Google Cloud
LOCATION: a região em que o produto de dados existe
DATA_PRODUCT_ID: o ID do seu produto de dados
DATA_ASSET_ID: o ID do recurso para o qual você quer configurar permissões

Terraform

Atribua papéis do IAM aos seus grupos de acesso para recursos específicos usando o bloco access_group_configs no recurso google_dataplex_data_product_data_asset.

Por exemplo, use a seguinte configuração:

resource "google_dataplex_data_product_data_asset" "example_data_asset" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
data_asset_id   = "DATA_ASSET_ID"
resource        = "RESOURCE_NAME"

access_group_configs {
  access_group = "analyst" # Must match the 'id' defined in google_dataplex_data_product
  iam_roles    = ["roles/bigquery.dataViewer"]
}

provider = google-beta
}

Substitua:

PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados existe
DATA_PRODUCT_ID: o ID do produto de dados
DATA_ASSET_ID: um ID exclusivo para esse recurso de dados no produto de dados.
RESOURCE_NAME: o nome completo do recurso do recurso de dados (por exemplo, //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID).

Opcional: adicione mais detalhes

Também é possível adicionar contratos, aspectos e documentação extra para o produto de dados.

Adicionar um contrato

Para estabelecer uma base de confiança entre produtores e consumidores de dados, você pode anexar um contrato ao seu produto de dados. Ao especificar parâmetros como tempo de atualização e limites, você fornece aos consumidores o contexto necessário para entender quando os dados são atualizados e se atendem aos requisitos comerciais específicos.

Console

No painel Adicionar mais detalhes, clique em Adicionar contrato.
No campo Selecionar contrato, escolha Refresh cadence.
No campo Frequência, selecione uma programação acordada para a frequência com que os dados são atualizados ou entregues, garantindo um fluxo previsível do produtor ao consumidor de dados. Por exemplo, Weekly.
No campo Tempo de atualização, insira um tempo máximo aceitável entre a atualização dos dados na origem e a disponibilização para o consumidor. Por exemplo, 23:00 PST.
No campo Limite (em minutos), insira um limite mensurável em minutos para o atraso aceitável na entrega de dados. Por exemplo, insira 30 para definir o limite como 30 minutos.
Opcional: no campo Programação do cron, insira uma expressão cron que defina a programação para geração e entrega de dados no formato: MINUTE HOUR DAY_OF_MONTH MONTH DAY_OF_WEEK

Confira a seguir os valores aceitos:
- MINUTE: 0-59
- HOUR: 0-23
- DAY_OF_MONTH: 1-31
- MONTH: 1-31 ou JAN-DEC.
- DAY_OF_WEEK: 0-6 ou SUN-SAT.
Por exemplo, 0 8 * * 1-5 é executado às 8h nos dias úteis (de segunda a sexta-feira).
Clique em Salvar.

REST

Os contratos são modelados como aspectos no produto de dados. Para adicionar um contrato de Refresh Cadence a um produto de dados, use o método entries.patch.

Por exemplo, envie a seguinte solicitação PATCH:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "dataplex-types.global.refresh-cadence": {
      "aspectType": "projects/dataplex-types/locations/global/aspectTypes/refresh-cadence",
      "data": {
        "frequency": "REFRESH_FREQUENCY"
      }
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

Substitua:

REFRESH_FREQUENCY: o cronograma acordado de atualização ou entrega de dados, garantindo um fluxo previsível do produtor para o consumidor de dados. Por exemplo: Weekly
PROJECT_ID: o ID do seu Google Cloud projeto em que a chamada de API está sendo feita
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
DATA_PRODUCT_LOCATION: o local do recurso de produto de dados
DATA_PRODUCT_ID: o ID do seu produto de dados

Terraform

Os contratos são modelados como aspectos no produto de dados. Para gerenciar um contrato, é preciso gerenciar a entrada do Dataplex Universal Catalog associada. Como o Terraform não descobre automaticamente os aspectos atuais, primeiro você precisa importar o google_dataplex_entry.

Para importar a entrada, use o seguinte comando:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Configuração do Terraform:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "655216118709.global.refresh-cadence"
  aspect {
    data = jsonencode({
      frequency = "REFRESH_FREQUENCY"
    })
  }
}

provider = google-beta
}

Substitua:

DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_ID: o ID do seu produto de dados
REFRESH_FREQUENCY: o cronograma acordado para a frequência de atualização ou entrega dos dados, garantindo um fluxo previsível do produtor para o consumidor de dados. Por exemplo: Weekly

Para informações gerais sobre o processo de importação, consulte a documentação de importação do Terraform.

Adicionar aspectos

Use aspectos para enriquecer seu produto de dados com metadados estruturados e reutilizáveis. Esses modelos oferecem uma maneira padronizada para os produtores de dados comunicarem a qualidade e a adequação de um produto de dados, melhorando a governança e ajudando os consumidores a determinar se o produto atende às necessidades comerciais deles.

Para adicionar aspectos ao produto de dados, siga estas etapas:

Console

No painel Adicionar mais detalhes, clique em + Adicionar aspecto.
No campo Selecionar tipo de aspecto, pesquise e selecione um tipo de aspecto na lista. Por exemplo, Geo context.
No campo País, selecione o país do recurso.
No campo Região, selecione a região comercial a que o recurso pertence.
Clique em Salvar.

REST

Para adicionar aspectos a um produto de dados, use o método entries.patch.

Por exemplo, envie a seguinte solicitação PATCH:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "ASPECT_PROJECT_ID.ASPECT_LOCATION.ASPECT_NAME": {
      "aspectType": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION/aspectTypes/ASPECT_NAME",
      "data": {}
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

Substitua:

ASPECT_PROJECT_ID: o ID do seu projeto Google Cloud em que o aspecto é criado
ASPECT_LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog em que o aspecto é criado (por exemplo, us-central1)
ASPECT_NAME: o nome do aspecto que você quer anexar ao produto de dados
PROJECT_ID: o ID do seu Google Cloud projeto em que a chamada de API está sendo feita
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
DATA_PRODUCT_LOCATION: o local do recurso de produto de dados
DATA_PRODUCT_ID: o ID do seu produto de dados

Terraform

Para gerenciar aspectos, é preciso gerenciar a entrada do Dataplex Universal Catalog. Como o Terraform não descobre automaticamente os aspectos atuais, primeiro importe o google_dataplex_entry.

Para importar a entrada, use o seguinte comando:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Configuração do Terraform:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "ASPECT_PROJECT_NUMBER.ASPECT_LOCATION.ASPECT_NAME"
  aspect {
    data = {}
  }
}

provider = google-beta
}

Substitua:

DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_ID: o ID do seu produto de dados
ASPECT_PROJECT_NUMBER: o número do projeto Google Cloud em que o aspecto é criado
ASPECT_LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog em que o aspecto é criado (por exemplo, us-central1)
ASPECT_NAME: o nome do aspecto que você quer anexar ao produto de dados

Para informações gerais sobre o processo de importação, consulte a documentação de importação do Terraform.

Adicionar documentação

A documentação fornece o contexto essencial para que os consumidores entendam e usem um produto de dados de maneira eficaz. Você pode incluir detalhes de rich text, como guias do usuário, exemplos de consultas SQL e descrições de lógica de negócios, para ajudar os usuários a gerar insights com base nos recursos subjacentes. No Dataplex Universal Catalog, a documentação é gerenciada pelo aspecto do sistema overview.

Para adicionar documentação ao produto de dados, siga estas etapas:

Console

No painel Adicionar mais detalhes, clique em Editar ao lado de Documentação.
Digite o conteúdo no editor de rich text.
Clique em Salvar.

O produto de dados recém-criado aparece na página Produtos de dados do Dataplex Universal Catalog.

REST

A documentação é modelada como aspectos no produto de dados. Para adicionar documentação, use o método entries.patch.

Por exemplo, envie a seguinte solicitação PATCH:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "dataplex-types.global.overview": {
      "aspectType": "projects/dataplex-types/locations/global/aspectTypes/overview",
      "data": {
        "content": "DOCUMENTATION"
      }
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

Substitua:

PROJECT_ID: o ID do seu Google Cloud projeto em que a chamada de API está sendo feita
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
DATA_PRODUCT_LOCATION: o local do recurso de produto de dados
DATA_PRODUCT_ID: o ID do seu produto de dados
DOCUMENTATION: o conteúdo que você quer anexar ao produto de dados.

Terraform

A documentação é modelada como aspectos no produto de dados. Para gerenciar a documentação, é preciso gerenciar a entrada do Dataplex Universal Catalog. Como o Terraform não descobre automaticamente os aspectos atuais, primeiro você precisa importar o google_dataplex_entry.

Para importar a entrada, use o seguinte comando:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Configuração do Terraform:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "655216118709.global.overview"
  aspect {
    data = jsonencode({
      content = "DOCUMENTATION"
    })
  }
}

provider = google-beta
}

Substitua:

DATA_PRODUCT_PROJECT_NUMBER: o número do projeto em que o recurso do produto de dados está localizado
LOCATION: a região do endpoint de serviço do Dataplex Universal Catalog que você está chamando (por exemplo, us-central1)
DATA_PRODUCT_ID: o ID do seu produto de dados
DOCUMENTATION: o conteúdo que você quer anexar ao produto de dados.

Para informações gerais sobre o processo de importação, consulte a documentação de importação do Terraform.

A seguir

Saiba mais sobre gerenciar produtos de dados.
Saiba como pesquisar produtos de dados.
Como consumidor de dados, saiba como solicitar acesso a produtos de dados.

Criar produtos de dados Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Antes de começar

Funções exigidas

Funções de um proprietário de produto de dados

Permissões necessárias

Funções para um consumidor de produtos de dados

Criar e configurar um produto de dados

Criar um produto de dados

Console

REST

Terraform

Opcional: adicione recursos

Console

REST

Terraform

Opcional: configurar grupos de acesso e permissões de recursos

Configurar grupos de acesso

Console

REST

Terraform

Configurar permissões de recursos

Console

REST

Terraform

Opcional: adicione mais detalhes

Adicionar um contrato

Console

REST

Terraform

Adicionar aspectos

Console

REST

Terraform

Adicionar documentação

Console

REST

Terraform

A seguir

Criar produtos de dados