Seit dem 10. April 2026 heißt Dataplex Universal Catalog jetzt Knowledge Catalog. Die Namen der API, der Clientbibliothek, der CLI und von IAM bleiben unverändert. Weitere Informationen finden Sie unter Google Cloud Knowledge Catalog.

Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Datenprodukte erstellen

Dieses Dokument richtet sich an Inhaber von Datenprodukten, die Datenprodukte in Knowledge Catalog (früher Dataplex Universal Catalog) erstellen und konfigurieren möchten.

Weitere Informationen zur Architektur und zu den wichtigsten Konzepten von Datenprodukten finden Sie unter Datenprodukte.

Hinweis

Bevor Sie Datenprodukte erstellen, müssen Sie die folgenden Voraussetzungen erfüllen.

Gemini aktivieren

Die Konfiguration von Gemini in Ihrem Daten-Asset ist ein optionaler, aber sehr empfehlenswerter Schritt, bevor Sie Ihr erstes Datenprodukt erstellen.

Standardmäßig müssen Sie beim Erstellen eines Datenprodukts Geschäfts- und technische Beschreibungen sowie Onboarding-Dokumentation für Ihre Assets manuell eingeben. Wenn Sie die Gemini-Integration aktivieren, nutzt Knowledge Catalog KI-Unterstützung, um Ihre Schemas und Daten-Scanergebnisse automatisch zu analysieren und Folgendes zu generieren:

Geschäftsdokumentation:Generiert Dokumentationsvorlagen und klare Beschreibungen für Ihr Datenprodukt und die einzelnen Daten-Assets.
Statistiken und Beispielanfragen:Erstellt gebrauchsfertige Beispielanfragen basierend auf dem Schemalayout des Assets, sodass Nutzer des Datenprodukts nach der Genehmigung sofort mit der Abfrage des Produkts beginnen können.

Wenn Sie Gemini nicht aktivieren möchten, können Sie diesen Abschnitt überspringen. Sie müssen jedoch alle Asset-Metadaten und Abfragevorlagen manuell angeben.

Weitere Informationen zum Aktivieren von Gemini in BigQuery finden Sie unter Gemini in BigQuery einrichten.

APIs aktivieren

Aktivieren Sie die Dataplex- und BigQuery-APIs.

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin), die die Berechtigung serviceusage.services.enable enthält. Weitere Informationen zum Zuweisen von Rollen

APIs aktivieren

Daten-Assets erstellen

Prüfen Sie, ob Ihre Daten-Assets (z. B. BigQuery-Datasets, ‑Tabellen und ‑Ansichten) erstellt und mit Daten gefüllt wurden.

Weitere Informationen zum Erstellen von Daten-Assets finden Sie in den folgenden Dokumenten:

Identitäten konfigurieren

Ermitteln oder erstellen Sie die Google-Gruppen oder Dienstkonten, die Sie in Ihrem Datenprodukt konfigurieren möchten.

Erforderliche Rollen

In diesem Abschnitt werden die erforderlichen Mindest-IAM-Rollen für die folgenden Hauptbereiche beschrieben:

Inhaber von Datenprodukten: Nutzer, die Datenprodukte und die zugehörigen Assets erstellen, konfigurieren und verwalten
Datennutzer: Nutzer, die nach veröffentlichten Datenprodukten suchen, sie ansehen und Zugriff darauf anfordern

Erforderliche Rollen für Data Product Owners

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für das Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Erstellen und Verwalten von Datenprodukten benötigen:

Vollständige Berechtigungen zum Erstellen, Aktualisieren, Löschen, Verwalten von Berechtigungen und Genehmigen oder Ablehnen von Zugriffsanfragen für Datenprodukte: Dataplex Data Products Admin (roles/dataplex.dataProductsAdmin)
Berechtigungen aktualisieren und verwalten sowie Zugriffsanfragen für Datenprodukte genehmigen oder ablehnen: Dataplex Data Products Editor (roles/dataplex.dataProductsEditor)
Fügen Sie Metadatenaspekte hinzu, z. B. schema, overview, contacts und queries: Dataplex Entry and EntryLink Owner (roles/dataplex.entryOwner)
Assets suchen und hinzufügen: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
Systemaspekttypen bearbeiten (z. B. overview, contact, contract und queries): Dataplex Catalog Editor (roles/dataplex.catalogEditor)
DataScans für Statistiken für die automatische Dokumentation und Statistikerstellung erstellen oder abrufen: Dataplex DataScan-Administrator (roles/dataplex.dataScanAdmin)

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Diese vordefinierten Rollen enthalten die Berechtigungen, die zum Erstellen und Verwalten von Datenprodukten erforderlich sind. Maximieren Sie den Abschnitt Erforderliche Berechtigungen, um die notwendigen Berechtigungen anzuzeigen:

Erforderliche Berechtigungen

Die folgenden Berechtigungen sind erforderlich, um Datenprodukte zu erstellen und zu verwalten:

Datenprodukt erstellen: dataplex.dataProducts.create
Datenprodukte in einem Projekt auflisten: dataplex.dataProducts.list
Datenprodukt abrufen oder ansehen: dataplex.dataProducts.get
So bearbeiten Sie ein vorhandenes Datenprodukt: dataplex.dataProducts.update
Datenprodukt löschen: dataplex.dataProducts.delete
Zugriffsanfrage für Datenprodukt genehmigen: dataplex.dataProducts.approve
So suchen Sie mit Knowledge Catalog nach einem Datenprodukt:
- dataplex.dataProducts.get
- dataplex.projects.search
Zugriffsanfrage für Datenprodukt erstellen: dataplex.dataProducts.get
Daten-Asset erstellen: dataplex.dataAssets.create
Daten-Assets in einem Datenprodukt auflisten: dataplex.dataAssets.list
Datenasset abrufen: dataplex.dataAssets.get
So bearbeiten Sie ein vorhandenes Daten-Asset: dataplex.dataAssets.update
Daten-Asset löschen: dataplex.dataAssets.delete
Datenscan erstellen: dataplex.datascans.create
Alle Daten-Scans auflisten: dataplex.datascans.list
Datenscan durchführen: dataplex.datascans.get
Datenscan ausführen: dataplex.datascans.run
Bearbeiten Sie den Systemaspekttyp overview: dataplex.entryGroups.useOverviewAspect
Bearbeiten Sie den Systemaspekttyp refresh cadence: dataplex.entryGroups.useRefreshCadenceAspect
Bearbeiten Sie den Systemaspekttyp queries: dataplex.entryGroups.useQueriesAspect

Sie können diese Berechtigungen auch mit benutzerdefinierten Rollen oder anderen vordefinierten Rollen erhalten.

Erforderliche Rollen für Nutzer von Datenprodukten

Damit Nutzer von Datenprodukten nach Datenprodukten suchen, sie aufrufen und Zugriff darauf anfordern können, müssen Sie als Inhaber eines Datenprodukts dafür sorgen, dass das Datenprodukt auffindbar ist. Weisen Sie den Nutzern des Datenprodukts dazu die folgenden IAM-Rollen für das Datenprodukt zu:

Nach Datenprodukten suchen und Zugriff darauf anfordern: Dataplex Data Product Consumer (dataplex.dataProductsConsumer) und Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
Schreibgeschützter Zugriff zum Aufrufen von Datenproduktdefinitionen und ‑metadaten: Dataplex Data Product Viewer (dataplex.dataProductsViewer)

Datenprodukt erstellen und konfigurieren

Das Erstellen eines Datenprodukts umfasst die folgenden allgemeinen Aufgaben:

Datenprodukt erstellen

In diesem obligatorischen ersten Schritt müssen grundlegende Details wie ein eindeutiger Name des Datenprodukts, eine Beschreibung, die Region, in der das Datenprodukt erstellt wird, und Kontaktdaten angegeben werden.
Optional: Assets hinzufügen

In dieser Phase wählen Sie Assets aus, die in das Datenprodukt aufgenommen werden sollen. Eine wichtige Einschränkung ist, dass sich Assets in derselben Region wie das Datenprodukt selbst befinden müssen. Sie können bis zu 10 Assets gleichzeitig hinzufügen, wobei maximal 50 Assets pro Datenprodukt zulässig sind.

Eine Liste der unterstützten Assets finden Sie unter Unterstützte Assets.
Optional: Zugriffsgruppen und Asset-Berechtigungen konfigurieren

In dieser optionalen Phase vereinfachen Sie die Zugriffssteuerung, indem Sie Zugriffsgruppen erstellen. Diese Zugriffsgruppen fungieren als benutzerfreundliche Aliase (z. B. Analyst oder Reader) für zugrunde liegende Google-Gruppen und Dienstkonten. Anschließend weisen Sie Berechtigungen zu, indem Sie eine bestimmte IAM-Rolle auswählen und sie einer Zugriffsgruppe für ein bestimmtes Asset zuordnen.
Optional: Details zu Vertrag und Aspekt hinzufügen

In dieser Phase verbessern Sie die Governance und die Auffindbarkeit von Daten, indem Sie Metadaten-Frameworks anhängen. Sie können einen Vertrag hinzufügen, um die Häufigkeit der Datenaktualisierung formal zu kommunizieren. Dabei können Sie Parameter wie Aktualisierungshäufigkeit, Timing und Varianzschwellenwerte angeben. Sie können auch benutzerdefinierte Aspekte anhängen, um zusätzliche Geschäfts- oder technische Metadaten für Ihr Datenprodukt bereitzustellen.
Optional: Zusätzliche Details hinzufügen

In dieser letzten Phase fügen Sie Rich-Text-Dokumentation hinzu, z. B. Anleitungen für das Onboarding von Nutzern, Geschäftsdefinitionen und Beispielabfragen, damit Nutzer nach der Genehmigung sofort mit dem Datenprodukt interagieren können.

Führen Sie die Schritte in den folgenden Abschnitten aus, um ein Datenprodukt zu erstellen und zu konfigurieren:

Datenprodukt erstellen

Console

Rufen Sie in der Google Cloud Console die Seite Datenprodukte des Knowledge Catalog auf.

Zu Datenprodukten
Klicken Sie auf Erstellen.
Geben Sie im Bereich Datenprodukte erstellen die folgenden Details ein:
- Name des Datenprodukts: Geben Sie einen eindeutigen Namen für Ihr Datenprodukt ein.
- Datenprodukt-ID: Dies ist eine automatisch generierte eindeutige Kennung. Dieses Feld kann bearbeitet werden.
- Projekt-ID: Eine eindeutige Kennung des Projekts, in dem das Datenprodukt erstellt wird. Suchen Sie nach dem Projekt und wählen Sie es aus.
- Region: Wählen Sie die Region oder multiregionale Umgebung aus, in der das Datenprodukt erstellt wird.
- Datenproduktsymbol: Suchen Sie nach einem Symbol und wählen Sie es aus, um das Datenprodukt visuell zu kennzeichnen. Dies ist optional.
- Beschreibung: Geben Sie eine kurze Beschreibung des Datenprodukts ein.
- Kontakte: Geben Sie die Kontaktdaten für Governance- und Genehmigungsworkflows an:
  - E‑Mail-Adresse des/der Datenproduktinhaber(s): Geben Sie die E‑Mail-Adresse des/der Datenproduktinhaber(s) ein.
  - E‑Mail-Adresse des bzw. der Datenproduktgenehmiger(s):Geben Sie die E‑Mail-Adresse der zuständigen Genehmiger ein, die für die Genehmigung von Zugriffsanfragen oder ‑änderungen verantwortlich sind.
- Labels: Fügen Sie Schlüssel/Wert-Labels hinzu, um Ihre Ressourcen zu organisieren. Dies ist optional.
Klicken Sie auf Datenprodukt erstellen.

Terraform

Verwenden Sie zum Erstellen eines Datenprodukts die Ressource 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
}

Ersetzen Sie Folgendes:

PROJECT_ID: die ID Ihres Google Cloud -Projekts
LOCATION: die Region, in der Sie das Datenprodukt erstellen möchten
DATA_PRODUCT_ID: Eine eindeutige ID für Ihr Datenprodukt
DISPLAY_NAME: Ein nutzerfreundlicher Name für Ihr Datenprodukt
DESCRIPTION: eine kurze Beschreibung des Datenprodukts
EMAIL_IDs: kommagetrennte E-Mail-Adressen der Inhaber des Datenprodukts, z. B. ["user1@example.com", "user2@example.com"]

C#

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für C# in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog C# API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using Google.LongRunning;

public sealed partial class GeneratedDataProductServiceClientSnippets
{
    /// <summary>Snippet for CreateDataProduct</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 CreateDataProductRequestObject()
    {
        // Create client
        DataProductServiceClient dataProductServiceClient = DataProductServiceClient.Create();
        // Initialize request argument(s)
        CreateDataProductRequest request = new CreateDataProductRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            DataProductId = "",
            DataProduct = new DataProduct(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<DataProduct, OperationMetadata> response = dataProductServiceClient.CreateDataProduct(request);

        // Poll until the returned long-running operation is complete
        Operation<DataProduct, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        DataProduct 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<DataProduct, OperationMetadata> retrievedResponse = dataProductServiceClient.PollOnceCreateDataProduct(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            DataProduct retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Go in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Go API.


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewDataProductClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Java in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Java API.

import com.google.cloud.dataplex.v1.CreateDataProductRequest;
import com.google.cloud.dataplex.v1.DataProduct;
import com.google.cloud.dataplex.v1.DataProductServiceClient;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateDataProduct {

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

  public static void syncCreateDataProduct() 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 (DataProductServiceClient dataProductServiceClient = DataProductServiceClient.create()) {
      CreateDataProductRequest request =
          CreateDataProductRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setDataProductId("dataProductId1437828576")
              .setDataProduct(DataProduct.newBuilder().build())
              .setValidateOnly(true)
              .build();
      DataProduct response = dataProductServiceClient.createDataProductAsync(request).get();
    }
  }
}

Node.js

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Node.js in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Node.js API.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent resource where this data product will be created.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 */
// const parent = 'abc123'
/**
 *  Optional. The ID of the data product to create.
 *  The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
 *  numbers (0-9), or hyphens, with the first character a letter, the last a
 *  letter or a number, and a 63 character maximum. Characters outside of
 *  ASCII are not permitted.
 *  Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
 *  If not provided, a system generated ID will be used.
 */
// const dataProductId = 'abc123'
/**
 *  Required. The data product to create.
 */
// const dataProduct = {}
/**
 *  Optional. Validates the request without actually creating the data product.
 *  Default: false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {DataProductServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new DataProductServiceClient();

async function callCreateDataProduct() {
  // Construct request
  const request = {
    parent,
    dataProduct,
  };

  // Run request
  const [operation] = await dataplexClient.createDataProduct(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateDataProduct();

Python

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Python in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Python API.

# 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_data_product():
    # Create a client
    client = dataplex_v1.DataProductServiceClient()

    # Initialize request argument(s)
    data_product = dataplex_v1.DataProduct()
    data_product.display_name = "display_name_value"
    data_product.owner_emails = ["owner_emails_value1", "owner_emails_value2"]

    request = dataplex_v1.CreateDataProductRequest(
        parent="parent_value",
        data_product=data_product,
    )

    # Make the request
    operation = client.create_data_product(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

REST

Verwenden Sie zum Erstellen eines Datenprodukts die Methode dataProducts.create.

Senden Sie beispielsweise die folgende POST-Anfrage:

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"], "access_approval_config": { "approver_emails": ["APPROVER_EMAIL_IDs"]} }' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts?data_product_id=DATA_PRODUCT_ID

Ersetzen Sie Folgendes:

DISPLAY_NAME: ein benutzerfreundlicher Name für Ihr Datenprodukt
EMAIL_IDs: kommagetrennte E-Mail-Adressen der Datenproduktinhaber
APPROVER_EMAIL_IDs: kommagetrennte E-Mail-Adressen der zuständigen Genehmiger, die für die Genehmigung von Zugriffsanfragen oder ‑änderungen verantwortlich sind.
PROJECT_ID: die ID Ihres Google Cloud-Projekts
LOCATION: die Region, in der Sie das Datenprodukt erstellen möchten
DATA_PRODUCT_ID: Eine eindeutige ID für Ihr Datenprodukt.

Optional: Assets hinzufügen

Sie können Ihrem Datenprodukt verschiedene Daten-Assets wie BigQuery-Tabellen, ‑Ansichten, ‑Datasets und ‑Modelle hinzufügen. Eine Liste der unterstützten Assets finden Sie unter Unterstützte Assets.

Console

Klicken Sie im Bereich Assets hinzufügen auf + Hinzufügen.
Suchen Sie nach den Assets, die Sie Ihrem Datenprodukt hinzufügen möchten, und wählen Sie sie aus. Die ausgewählten Assets müssen sich in derselben Region wie das Datenprodukt befinden.

Wenn Sie die erforderlichen Berechtigungen haben, können Sie die Metadaten von Assets aufrufen, indem Sie auf das Asset klicken.
Mit Filtern können Sie die Suchergebnisse eingrenzen.
Klicken Sie nach der Auswahl der Assets auf Hinzufügen.

Hinweis :Sie können bis zu 10 Assets gleichzeitig hinzufügen. Insgesamt sind maximal 50 Assets pro Datenprodukt zulässig.
Klicken Sie auf Weiter.

Terraform

Verwenden Sie die Ressource google_dataplex_data_product_data_asset, um Ihrem Datenprodukt ein Daten-Asset hinzuzufügen.

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
}

Ersetzen Sie Folgendes:

PROJECT_ID: die ID Ihres Google Cloud -Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: die ID des Datenprodukts
DATA_ASSET_ID: eine eindeutige ID für dieses Daten-Asset im Datenprodukt
RESOURCE_NAME: Der vollständige Ressourcenname des Daten-Assets, z. B. //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;

public sealed partial class GeneratedDataProductServiceClientSnippets
{
    /// <summary>Snippet for CreateDataAsset</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 CreateDataAssetRequestObject()
    {
        // Create client
        DataProductServiceClient dataProductServiceClient = DataProductServiceClient.Create();
        // Initialize request argument(s)
        CreateDataAssetRequest request = new CreateDataAssetRequest
        {
            ParentAsDataProductName = DataProductName.FromProjectLocationDataProduct("[PROJECT]", "[LOCATION]", "[DATA_PRODUCT]"),
            DataAssetId = "",
            DataAsset = new DataAsset(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<DataAsset, OperationMetadata> response = dataProductServiceClient.CreateDataAsset(request);

        // Poll until the returned long-running operation is complete
        Operation<DataAsset, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        DataAsset 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<DataAsset, OperationMetadata> retrievedResponse = dataProductServiceClient.PollOnceCreateDataAsset(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            DataAsset retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewDataProductClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.CreateDataAssetRequest;
import com.google.cloud.dataplex.v1.DataAsset;
import com.google.cloud.dataplex.v1.DataProductName;
import com.google.cloud.dataplex.v1.DataProductServiceClient;

public class SyncCreateDataAsset {

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

  public static void syncCreateDataAsset() 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 (DataProductServiceClient dataProductServiceClient = DataProductServiceClient.create()) {
      CreateDataAssetRequest request =
          CreateDataAssetRequest.newBuilder()
              .setParent(DataProductName.of("[PROJECT]", "[LOCATION]", "[DATA_PRODUCT]").toString())
              .setDataAssetId("dataAssetId2108984609")
              .setDataAsset(DataAsset.newBuilder().build())
              .setValidateOnly(true)
              .build();
      DataAsset response = dataProductServiceClient.createDataAssetAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent resource where this data asset will be created.
 *  Format:
 *  projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}
 */
// const parent = 'abc123'
/**
 *  Optional. The ID of the data asset to create.
 *  The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
 *  numbers (0-9), or hyphens, with the first character a letter, the last a
 *  letter or a number, and a 63 character maximum. Characters outside of
 *  ASCII are not permitted.
 *  Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
 *  If not provided, a system generated ID will be used.
 */
// const dataAssetId = 'abc123'
/**
 *  Required. The data asset to create.
 */
// const dataAsset = {}
/**
 *  Optional. Validates the request without actually creating the data asset.
 *  Defaults to false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {DataProductServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new DataProductServiceClient();

async function callCreateDataAsset() {
  // Construct request
  const request = {
    parent,
    dataAsset,
  };

  // Run request
  const [operation] = await dataplexClient.createDataAsset(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateDataAsset();

Python

# 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_data_asset():
    # Create a client
    client = dataplex_v1.DataProductServiceClient()

    # Initialize request argument(s)
    data_asset = dataplex_v1.DataAsset()
    data_asset.resource = "resource_value"

    request = dataplex_v1.CreateDataAssetRequest(
        parent="parent_value",
        data_asset=data_asset,
    )

    # Make the request
    operation = client.create_data_asset(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

REST

Verwenden Sie die Methode dataAssets.create, um Ihrem Datenprodukt ein Daten-Asset hinzuzufügen.

Senden Sie beispielsweise die folgende POST-Anfrage:

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

Ersetzen Sie Folgendes:

RESOURCE_NAME: Der vollständige Ressourcenname des Daten-Assets, z. B. //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
PROJECT_ID: die ID Ihres Google Cloud -Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: die ID des Datenprodukts
DATA_ASSET_ID: eine eindeutige ID für dieses Daten-Asset im Datenprodukt

Optional: Zugriffsgruppen und Asset-Berechtigungen konfigurieren

Im Bereich Zugriffsgruppen und Asset-Berechtigungen konfigurieren können Sie Zugriffsgruppen erstellen und Assets Berechtigungen zuweisen.

Zugriffsgruppen konfigurieren

Console

Klicken Sie auf Zugriffsgruppe hinzufügen.
Geben Sie im Feld Name der Zugriffsgruppe einen Namen für die Zugriffsgruppe ein. Beispiel: Analyst.
Geben Sie im Feld Beschreibung der Zugriffsgruppe eine Beschreibung für die Zugriffsgruppe ein.
Geben Sie im Feld Kennung der Zugriffsgruppe die E‑Mail-Adresse einer Google-Gruppe ein, die Sie dieser Zugriffsgruppe zuweisen möchten.

Datenproduktnutzer, die Zugriff für sich selbst anfordern, werden der zugeordneten Google-Gruppe als Mitglieder hinzugefügt.

Weitere Informationen zum Erstellen von Google-Gruppen finden Sie unter Google-Gruppen in der Google Cloud Konsole erstellen und verwalten.
Geben Sie im Feld Dienstkonto der Zugriffsgruppe die E-Mail-Adresse eines Dienstkontos ein, das Sie dieser Zugriffsgruppe zuweisen möchten.

Datenproduktnutzern, die Zugriff für ihre Dienstkonten anfordern, wird die IAM-Rolle „Dienstkonto-Token-Ersteller“ (roles/iam.serviceAccountTokenCreator) gewährt, um die Identität des Dienstkontos des Datenproduzenten zu übernehmen, das der Zugriffsgruppe zugeordnet ist.

Weitere Informationen zum Erstellen von Dienstkonten finden Sie unter Dienstkonten erstellen.
Klicken Sie auf Fertig.
Wenn Sie eine weitere Zugriffsgruppe hinzufügen möchten, klicken Sie auf Zugriffsgruppe hinzufügen und wiederholen Sie die Schritte.

Sie können maximal drei Zugriffsgruppen pro Datenprodukt hinzufügen.
Klicken Sie auf Speichern.

Terraform

Verwenden Sie den verschachtelten Block access_groups in der Ressource google_dataplex_data_product, um Zugriffsgruppen für Ihr Datenprodukt zu definieren.

Verwenden Sie zum Beispiel die folgende Konfiguration:

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
}

Ersetzen Sie Folgendes:

PROJECT_ID: die ID Ihres Google Cloud -Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: eine eindeutige ID für das Datenprodukt
DISPLAY_NAME: Ein nutzerfreundlicher Name für Ihr Datenprodukt
EMAIL_IDs: kommagetrennte E-Mail-Adressen der Inhaber des Datenprodukts, z. B. ["user1@example.com", "user2@example.com"]

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedDataProductServiceClientSnippets
{
    /// <summary>Snippet for UpdateDataProduct</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 UpdateDataProductRequestObject()
    {
        // Create client
        DataProductServiceClient dataProductServiceClient = DataProductServiceClient.Create();
        // Initialize request argument(s)
        UpdateDataProductRequest request = new UpdateDataProductRequest
        {
            DataProduct = new DataProduct(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<DataProduct, OperationMetadata> response = dataProductServiceClient.UpdateDataProduct(request);

        // Poll until the returned long-running operation is complete
        Operation<DataProduct, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        DataProduct 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<DataProduct, OperationMetadata> retrievedResponse = dataProductServiceClient.PollOnceUpdateDataProduct(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            DataProduct retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewDataProductClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.DataProduct;
import com.google.cloud.dataplex.v1.DataProductServiceClient;
import com.google.cloud.dataplex.v1.UpdateDataProductRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateDataProduct {

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

  public static void syncUpdateDataProduct() 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 (DataProductServiceClient dataProductServiceClient = DataProductServiceClient.create()) {
      UpdateDataProductRequest request =
          UpdateDataProductRequest.newBuilder()
              .setDataProduct(DataProduct.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      DataProduct response = dataProductServiceClient.updateDataProductAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The data product to update.
 *  The data product's `name` field is used to identify the data product to
 *  update.
 */
// const dataProduct = {}
/**
 *  Optional. The list of fields to update.
 *  If this is empty or not set, then all the fields will be updated.
 */
// const updateMask = {}
/**
 *  Optional. Validates the request without actually updating the data product.
 *  Default: false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {DataProductServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new DataProductServiceClient();

async function callUpdateDataProduct() {
  // Construct request
  const request = {
    dataProduct,
  };

  // Run request
  const [operation] = await dataplexClient.updateDataProduct(request);
  const [response] = await operation.promise();
  console.log(response);
}

callUpdateDataProduct();

Python

# 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_data_product():
    # Create a client
    client = dataplex_v1.DataProductServiceClient()

    # Initialize request argument(s)
    data_product = dataplex_v1.DataProduct()
    data_product.display_name = "display_name_value"
    data_product.owner_emails = ["owner_emails_value1", "owner_emails_value2"]

    request = dataplex_v1.UpdateDataProductRequest(
        data_product=data_product,
    )

    # Make the request
    operation = client.update_data_product(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

REST

Verwenden Sie die Methode dataProducts.patch, um eine Zugriffsgruppe für das Datenprodukt zu konfigurieren.

Senden Sie beispielsweise die folgende PATCH-Anfrage:

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"

Ersetzen Sie Folgendes:

ACCESS_GROUPS_MAP: Ein JSON-Objekt, das eine Zuordnung darstellt, in der jeder Schlüssel eine Zugriffsgruppen-ID und der Wert ein AccessGroup-Objekt ist. Beispiel:

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

PROJECT_ID: die ID Ihres Google Cloud-Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: die ID Ihres Datenprodukts

Asset-Berechtigungen konfigurieren

Nachdem Sie Zugriffsgruppen konfiguriert haben, können Sie Berechtigungen für die Assets im Datenprodukt konfigurieren.

Console

Wählen Sie im Bereich Asset permissions (Asset-Berechtigungen) das Asset aus, für das Sie Berechtigungen konfigurieren möchten. Sie können Berechtigungen für bis zu 10 Assets gleichzeitig auswählen und konfigurieren.
Klicken Sie auf Berechtigungen konfigurieren.
Wählen Sie im Feld Zugriffsgruppe auswählen eine Zugriffsgruppe aus.
Wählen Sie im Feld IAM-Rolle zuweisen eine IAM-Rolle aus, die Sie der Zugriffsgruppe zuweisen möchten.

Wenn Ihr Asset beispielsweise eine BigQuery-Tabelle mit dem Namen Sales ist, Sie die Zugriffsgruppe Analyst ausgewählt und dieser Zugriffsgruppe die Rolle BigQuery Metadata Viewer zugewiesen haben, haben die Nutzer des Datenprodukts, die Teil der Zugriffsgruppe Analyst sind, die Berechtigung BigQuery Metadata Viewer für die Tabelle Sales.

Sie können einem Asset mehrere Rollen hinzufügen.
Klicken Sie auf Konfigurieren. Für das Asset werden jetzt die zugewiesenen Berechtigungen angezeigt.
Wenn Sie Berechtigungen für andere Assets konfigurieren möchten, wiederholen Sie die Schritte.
Klicken Sie auf Weiter.

Terraform

Weisen Sie Ihren Zugriffsgruppen IAM-Rollen für bestimmte Assets mit dem access_group_configs-Block in der Ressource google_dataplex_data_product_data_asset zu.

Verwenden Sie zum Beispiel die folgende Konfiguration:

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
}

Ersetzen Sie Folgendes:

PROJECT_ID: die ID Ihres Google Cloud -Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: die ID des Datenprodukts
DATA_ASSET_ID: eine eindeutige ID für dieses Daten-Asset im Datenprodukt
RESOURCE_NAME: Der vollständige Ressourcenname des Daten-Assets, z. B. //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedDataProductServiceClientSnippets
{
    /// <summary>Snippet for UpdateDataAsset</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 UpdateDataAssetRequestObject()
    {
        // Create client
        DataProductServiceClient dataProductServiceClient = DataProductServiceClient.Create();
        // Initialize request argument(s)
        UpdateDataAssetRequest request = new UpdateDataAssetRequest
        {
            DataAsset = new DataAsset(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<DataAsset, OperationMetadata> response = dataProductServiceClient.UpdateDataAsset(request);

        // Poll until the returned long-running operation is complete
        Operation<DataAsset, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        DataAsset 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<DataAsset, OperationMetadata> retrievedResponse = dataProductServiceClient.PollOnceUpdateDataAsset(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            DataAsset retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewDataProductClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.DataAsset;
import com.google.cloud.dataplex.v1.DataProductServiceClient;
import com.google.cloud.dataplex.v1.UpdateDataAssetRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateDataAsset {

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

  public static void syncUpdateDataAsset() 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 (DataProductServiceClient dataProductServiceClient = DataProductServiceClient.create()) {
      UpdateDataAssetRequest request =
          UpdateDataAssetRequest.newBuilder()
              .setDataAsset(DataAsset.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      DataAsset response = dataProductServiceClient.updateDataAssetAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The data asset to update.
 *  The data asset's `name` field is used to identify the data asset to update.
 */
// const dataAsset = {}
/**
 *  Optional. The list of fields to update.
 *  If this is empty or not set, then all the fields will be updated.
 */
// const updateMask = {}
/**
 *  Optional. Validates the request without actually updating the data asset.
 *  Defaults to false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {DataProductServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new DataProductServiceClient();

async function callUpdateDataAsset() {
  // Construct request
  const request = {
    dataAsset,
  };

  // Run request
  const [operation] = await dataplexClient.updateDataAsset(request);
  const [response] = await operation.promise();
  console.log(response);
}

callUpdateDataAsset();

Python

# 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_data_asset():
    # Create a client
    client = dataplex_v1.DataProductServiceClient()

    # Initialize request argument(s)
    data_asset = dataplex_v1.DataAsset()
    data_asset.resource = "resource_value"

    request = dataplex_v1.UpdateDataAssetRequest(
        data_asset=data_asset,
    )

    # Make the request
    operation = client.update_data_asset(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

REST

Verwenden Sie die Methode dataAssets.patch, um Berechtigungen für die Assets im Datenprodukt zu konfigurieren.

Senden Sie beispielsweise die folgende PATCH-Anfrage:

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"

Ersetzen Sie Folgendes:

ACCESS_GROUP_CONFIGS_MAP: Ein JSON-Objekt, das eine Zuordnung darstellt, in der jeder Schlüssel eine Zugriffs-Gruppen-ID und der Wert ein AccessGroupConfig-Objekt ist. Beispiel:
```
{
"analyst": {
  iam_roles: ["roles/bigquery.dataViewer"]
  }
}
```
PROJECT_ID: die ID Ihres Google Cloud-Projekts
LOCATION: die Region, in der das Datenprodukt vorhanden ist
DATA_PRODUCT_ID: die ID Ihres Datenprodukts
DATA_ASSET_ID: die ID des Assets, für das Sie Berechtigungen konfigurieren möchten

Optional: Details zu Vertrag und Aspekt hinzufügen

Sie können einem Datenprodukt Verträge und Aspekte hinzufügen.

Vertrag hinzufügen

Um eine Vertrauensbasis zwischen Datenerstellern und ‑nutzern zu schaffen, können Sie Ihrem Datenprodukt einen Vertrag beifügen. Durch die Angabe von Parametern wie Aktualisierungszeit und Grenzwerten stellen Sie den Nutzern den erforderlichen Kontext zur Verfügung, um zu verstehen, wann die Daten aktualisiert werden und ob sie ihren spezifischen Geschäftsanforderungen entsprechen.

Console

Klicken Sie im Bereich Details zu Vertrag und Aspekt hinzufügen auf Vertrag hinzufügen.
Wählen Sie im Feld Vertrag auswählen die Option Refresh cadence aus.
Wählen Sie im Feld Häufigkeit einen vereinbarten Zeitplan dafür aus, wie oft Daten aktualisiert oder bereitgestellt werden. So sorgen Sie für einen vorhersehbaren Fluss vom Datenproduzenten zum Datenverbraucher. Beispiel: Weekly.
Geben Sie im Feld Aktualisierungszeit die maximal zulässige Zeit ein, die zwischen der Aktualisierung der Daten an der Quelle und der Verfügbarkeit für den Nutzer vergehen darf. Beispiel: 23:00 PST.
Geben Sie im Feld Schwellenwert (in Minuten) ein messbares Limit in Minuten für die akzeptable Verzögerung bei der Datenübermittlung ein. Geben Sie beispielsweise 30 ein, um einen Schwellenwert von 30 Minuten festzulegen.
Optional: Geben Sie im Feld Cron-Zeitplan einen Cron-Ausdruck ein, der den Zeitplan für die Datengenerierung und ‑bereitstellung im Format MINUTE HOUR DAY_OF_MONTH MONTH DAY_OF_WEEK definiert.

Folgende Werte sind zulässig:
- MINUTE: 0–59
- HOUR: 0–23
- DAY_OF_MONTH: 1–31
- MONTH: 1-31 oder JAN-DEC
- DAY_OF_WEEK: 0-6 oder SUN-SAT
Beispiel: 0 8 * * 1-5 wird an Wochentagen (Montag bis Freitag) um 8:00 Uhr ausgeführt.
Klicken Sie auf Speichern.

REST

Verträge werden als Aspekte für das Datenprodukt modelliert. Wenn Sie einen Refresh Cadence-Vertrag für ein Datenprodukt hinzufügen möchten, verwenden Sie die Methode entries.patch.

Senden Sie beispielsweise die folgende PATCH-Anfrage:

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"

Ersetzen Sie Folgendes:

REFRESH_FREQUENCY: Der vereinbarte Zeitplan für die Häufigkeit, mit der Daten aktualisiert oder bereitgestellt werden, um einen vorhersehbaren Fluss vom Datenproduzenten zum Datenverbraucher zu gewährleisten. Beispiel: Weekly
PROJECT_ID: die ID Ihres Google Cloud Projekts, in dem der API-Aufruf erfolgt
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer des Projekts, in dem sich die Datenproduktressource befindet
DATA_PRODUCT_LOCATION: der Speicherort der Datenproduktressource
DATA_PRODUCT_ID: die ID Ihres Datenprodukts

Terraform

Verträge werden als Aspekte für das Datenprodukt modelliert. Wenn Sie einen Vertrag verwalten möchten, müssen Sie den zugrunde liegenden Knowledge Catalog-Eintrag verwalten. Da Terraform vorhandene Aspekte nicht automatisch erkennt, müssen Sie zuerst die google_dataplex_entry importieren.

Verwenden Sie den folgenden Befehl, um den Eintrag zu importieren:

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"

Terraform-Konfiguration:

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
}

Ersetzen Sie Folgendes:

DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer, in der sich die Datenproduktressource befindet
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_ID: die ID Ihres Datenprodukts
REFRESH_FREQUENCY: der vereinbarte Zeitplan für die Häufigkeit, mit der Daten aktualisiert oder bereitgestellt werden, um einen vorhersehbaren Fluss vom Datenproduzenten zum Datenkonsumenten zu gewährleisten. Beispiel: Weekly

Allgemeine Informationen zum Importvorgang finden Sie in der Terraform-Dokumentation zum Importieren.

Aspekte hinzufügen

Verwenden Sie Aspekte, um Ihr Datenprodukt mit strukturierten, wiederverwendbaren Metadaten anzureichern. Diese Vorlagen bieten Datenproduzenten eine standardisierte Möglichkeit, die Qualität und Eignung eines Datenprodukts zu kommunizieren. So wird die Governance verbessert und Nutzer können leichter feststellen, ob das Produkt ihren geschäftlichen Anforderungen entspricht.

So fügen Sie Aspekte für das Datenprodukt hinzu:

Console

Klicken Sie im Bereich Details zu Vertrag und Aspekt hinzufügen auf + Aspekt hinzufügen.
Suchen Sie im Feld Aspekttyp auswählen nach einem Aspekttyp und wählen Sie ihn aus der Liste aus. Beispiel: Geo context.
Klicken Sie auf Speichern.

REST

Verwenden Sie die Methode entries.patch, um Aspekte für ein Datenprodukt hinzuzufügen.

Senden Sie beispielsweise die folgende PATCH-Anfrage:

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"

Ersetzen Sie Folgendes:

ASPECT_PROJECT_ID: die ID Ihres Google Cloud-Projekts, in dem der Aspekt erstellt wird
ASPECT_LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, in dem der Aspekt erstellt wird (z. B. us-central1)
ASPECT_NAME: Der Name des Aspekts, den Sie dem Datenprodukt zuweisen möchten.
PROJECT_ID: die ID Ihres Google Cloud Projekts, in dem der API-Aufruf erfolgt
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer, in der sich die Datenproduktressource befindet
DATA_PRODUCT_LOCATION: der Speicherort der Datenproduktressource
DATA_PRODUCT_ID: die ID Ihres Datenprodukts

Terraform

Um Aspekte zu verwalten, müssen Sie den zugrunde liegenden Knowledge Catalog-Eintrag verwalten. Da Terraform vorhandene Aspekte nicht automatisch erkennt, müssen Sie zuerst google_dataplex_entry importieren.

Verwenden Sie den folgenden Befehl, um den Eintrag zu importieren:

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"

Terraform-Konfiguration:

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
}

Ersetzen Sie Folgendes:

DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer, in der sich die Datenproduktressource befindet
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_ID: die ID Ihres Datenprodukts
ASPECT_PROJECT_NUMBER: die Google Cloud Projektnummer, in der der Aspekt erstellt wird
ASPECT_LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, in dem der Aspekt erstellt wird (z. B. us-central1)
ASPECT_NAME: Der Name des Aspekts, den Sie dem Datenprodukt zuweisen möchten.

Allgemeine Informationen zum Importvorgang finden Sie in der Terraform-Dokumentation zum Importieren.

Optional: Zusätzliche Details hinzufügen

Sie können Ihrem Datenprodukt Dokumentation und Beispielanfragen hinzufügen, um wichtigen Kontext, Beschreibungen der Geschäftslogik und Nutzeranleitungen bereitzustellen. In Knowledge Catalog wird die Dokumentation über den Systemaspekt overview verwaltet.

Sie können diese Dokumentation manuell erstellen oder Knowledge Catalog-Datenstatistiken verwenden, um sie automatisch generieren zu lassen.

Dokumentation und Beispielabfragen manuell hinzufügen

Console

So fügen Sie Dokumentation für Ihr Datenprodukt hinzu:

Klicken Sie im Bereich Zusätzliche Details hinzufügen neben Dokumentation auf Bearbeiten.
Geben Sie den Inhalt in den Rich-Text-Editor ein.
Klicken Sie auf Speichern.

So fügen Sie Beispielabfragen für Ihr Datenprodukt hinzu:

Klicken Sie im Bereich Zusätzliche Details hinzufügen im Abschnitt Abfrageempfehlung auf Abfragen hinzufügen.
Geben Sie die Beispielabfragen ein.
Klicken Sie auf Speichern.

Das neu erstellte Datenprodukt wird auf der Knowledge Catalog-Seite Datenprodukte angezeigt.

REST

Die Dokumentation wird als Aspekte des Datenprodukts modelliert. Verwenden Sie zum Hinzufügen von Dokumentation die Methode entries.patch.

Senden Sie beispielsweise die folgende PATCH-Anfrage:

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"

Ersetzen Sie Folgendes:

PROJECT_ID: die ID Ihres Google Cloud Projekts, in dem der API-Aufruf erfolgt
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer, in der sich die Datenproduktressource befindet
DATA_PRODUCT_LOCATION: der Speicherort der Datenproduktressource
DATA_PRODUCT_ID: die ID Ihres Datenprodukts
DOCUMENTATION: Der Inhalt, den Sie an das Datenprodukt anhängen möchten

Terraform

Die Dokumentation wird als Aspekte des Datenprodukts modelliert. Wenn Sie die Dokumentation verwalten möchten, müssen Sie den zugrunde liegenden Knowledge Catalog-Eintrag verwalten. Da Terraform vorhandene Aspekte nicht automatisch erkennt, müssen Sie zuerst die google_dataplex_entry importieren.

Verwenden Sie den folgenden Befehl, um den Eintrag zu importieren:

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"

Terraform-Konfiguration:

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
}

Ersetzen Sie Folgendes:

DATA_PRODUCT_PROJECT_NUMBER: die Projektnummer, in der sich die Datenproduktressource befindet
LOCATION: die Region des Knowledge Catalog-Dienstendpunkts, den Sie aufrufen (z. B. us-central1)
DATA_PRODUCT_ID: die ID Ihres Datenprodukts
DOCUMENTATION: Der Inhalt, den Sie an das Datenprodukt anhängen möchten

Allgemeine Informationen zum Importvorgang finden Sie in der Terraform-Dokumentation zum Importieren.

Automatisierte Dokumentation und Beispielabfragen mit Datenstatistiken erstellen

Bevor Sie mit Gemini Dokumentation und Beispielabfragen erstellen können, müssen Sie die folgenden Voraussetzungen erfüllen:

Aktivieren Sie die Gemini for Google Cloud API in dem Projekt, in dem Sie das Datenprodukt erstellen.
Weisen Sie nutzerspezifische Rollen für Statistiken zu: Bitten Sie Ihren Administrator, Ihrer Identität die folgenden Rollen und Berechtigungen für das Datenproduktprojekt zuzuweisen:
- Datenstatistiken generieren und verwalten: Dataplex DataScan-Bearbeiter (roles/dataplex.dataScanEditor) oder Dataplex DataScan-Administrator (roles/dataplex.dataScanAdmin) für das Projekt, in dem sich das Datenprodukt befindet
- Generierte Statistiken ansehen: Dataplex DataScan DataViewer (roles/dataplex.dataScanDataViewer) für das Projekt, in dem sich das Datenprodukt befindet
Berechtigungen für projektübergreifende Dienst-Agents konfigurieren Wenn sich Ihre zugrunde liegenden Daten-Assets in einem Google Cloud Projekt befinden, das sich von Ihrem Datenproduktprojekt unterscheidet, müssen Sie dem Knowledge Catalog-Dienst-Agent (P4SA) Zugriff auf diese Assets gewähren:
1. Führen Sie den folgenden Google Cloud CLI-Befehl aus, um die Dienst-Agent-ID für Ihr Datenproduktprojekt zu generieren oder abzurufen:
```
gcloud beta services identity create --service=dataplex.googleapis.com --project=DATA_PRODUCT_PROJECT_ID
```
  Ersetzen Sie DATA_PRODUCT_PROJECT_ID durch dieGoogle Cloud Projekt-ID, in der sich Ihr Datenprodukt befindet.
2. Weisen Sie dem Dienst-Agent des Datenproduktprojekts in jedem externen Projekt, in dem sich Ihre Assets befinden, die folgenden Rollen zu:
  - BigQuery-Dateneditor (roles/bigquery.dataEditor) für die zugrunde liegenden Tabellen und Datasets
  - BigQuery Studio-Administrator (roles/bigquery.studioAdmin) für das Asset-Projekt

So generieren Sie Dokumentation und Beispielabfragen für Ihr Datenprodukt mithilfe von Datenstatistiken:

Klicken Sie im Bereich Weitere Details hinzufügen in der Leiste Mit Gemini Statistiken generieren auf Generieren.

Warten Sie einige Minuten, bis die Statistiken generiert wurden.
Wenn Sie sich die generierten Inhalte ansehen möchten, klicken Sie auf Anzeigen.
Generierte Inhalte bewerten:
- Wenn die Inhalte korrekt sind, klicken Sie auf Speichern. Der Rich-Text-Editor wird mit einer vordefinierten Dokumentationsvorlage gefüllt und dem Bereich Insights werden Beispielabfragen hinzugefügt.
- Wenn der Inhalt nicht den Erwartungen entspricht, klicken Sie auf Verwerfen.
Klicken Sie auf Speichern, um die Änderungen zu übernehmen.

Datenprodukte erstellen Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Hinweis

Gemini aktivieren

APIs aktivieren

Daten-Assets erstellen

Identitäten konfigurieren

Erforderliche Rollen

Erforderliche Rollen für Data Product Owners

Erforderliche Berechtigungen

Erforderliche Rollen für Nutzer von Datenprodukten

Datenprodukt erstellen und konfigurieren

Datenprodukt erstellen

Console

Terraform

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

Optional: Assets hinzufügen

Console

Terraform

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

Optional: Zugriffsgruppen und Asset-Berechtigungen konfigurieren

Zugriffsgruppen konfigurieren

Console

Terraform

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

Asset-Berechtigungen konfigurieren

Console

Terraform

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

Optional: Details zu Vertrag und Aspekt hinzufügen

Vertrag hinzufügen

Console

REST

Terraform

Aspekte hinzufügen

Console

REST

Terraform

Optional: Zusätzliche Details hinzufügen

Dokumentation und Beispielabfragen manuell hinzufügen

Console

Datenprodukte erstellen