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.

Aspekte verwalten und Metadaten anreichern

Metadaten sind entscheidend, um Ihre Datenbestände und die Beziehungen zwischen ihnen zu organisieren und zu verstehen. In regulierten Branchen müssen beispielsweise personenidentifizierbare Informationen wie Namen, Adressen und behördliche Identifikationsnummern geschützt werden. Diese Daten können in zahlreichen Instanzen in verteilten Datensystemen vorkommen. Mit Knowledge Catalog (ehemals Dataplex Universal Catalog) können Sie Ihre verteilten Daten-Assets schnell ermitteln und katalogisieren. Sie können Daten dann als personenidentifizierbare Informationen klassifizieren.

Wenn Sie Dateneinträge und Eintragslinks mit aussagekräftigem Kontext anreichern, können Sie Ihre Daten leichter auffindbar und nützlicher machen. Knowledge Catalog bietet Kontext durch:

Aspekttyp: Eine JSON-Vorlage, die zugehörige Daten definiert. Für Compliance-Informationen haben Sie möglicherweise die Klassifizierung personenidentifizierbarer Informationen und die DSGVO-Compliance.
Aspekt: Eine Instanz eines Aspekttyps. Beispiel: {"pii_classification": "confidential", "gdpr_compliant": true}. Sie können ein Attribut auf eine gesamte Tabelle, eine einzelne Tabellenspalte oder einen Eintragslink anwenden (mit Einschränkungen).

Nachdem Sie Daten klassifiziert haben, können Sie Richtlinien für Datenqualität oder Zugriff auf die Daten anwenden.

Weitere Informationen finden Sie unter Metadatenverwaltung in Knowledge Catalog.

Aspekte

Mit Aspekten können Sie Metadaten in Einträgen oder Eintragslinks erfassen, um aussagekräftigen Kontext bereitzustellen. Sie können Aspekte für Folgendes verwenden:

Geschäftsmetadaten: Informationen, die Geschäftskontext liefern, z. B. Datenklassifizierung.
Technische Metadaten: Technische Details von Einträgen oder Eintragslinks, einschließlich der folgenden:
- Für Einträge: Details zum Daten-Asset selbst, z. B. das Schema.
- Für Eingabelinks: Details zur Beziehung zwischen Daten-Assets, z. B. Join-Details.
Abgeleitete Metadaten: Informationen, die aus den Daten selbst generiert werden, z. B. Statistiken aus einer BigQuery-Tabelle.

Aspekte gelten als Teile der Eintragsressource und nicht als separate Ressourcen. Wenn Sie einen Aspekt ändern, müssen Sie auch den Eintrag ändern, der den Aspekt enthält. Mit Feeds für Metadatenänderungen können Sie Benachrichtigungen erhalten, wenn Aspekte geändert werden.

Für Einträge können Sie Aspekte auf Eintragsebene zur Beschreibung eines Eintrags oder auf Spaltenebene zur Beschreibung einer Spalte in einem Eintrag angeben. Bei Einstiegslinks fügen Sie dem Link selbst Aspekte hinzu.

Jeder Aspekt ist eine Instanz eines Aspekttyps. Ein Aspekttyp definiert eine Vorlage für seine Aspekte. Jeder Aspekttyp enthält eine Reihe von Feldern. Wenn Sie Aspekte erstellen, müssen Sie Werte für diese Felder angeben.

Für einen bestimmten Eintrag oder einen bestimmten Eintragslink kann pro Aspekttyp höchstens ein Aspekt zugeordnet sein. Für Einträge können mehrere Aspekte mit den entsprechenden Spalten verknüpft sein.

gehören.

Aspektkategorien

Aspekte werden in die folgenden Kategorien eingeteilt:

Erforderliche Aspekte: Aspekte, die beim Erstellen eines Eintrags oder Eintragslinks obligatorisch sind. Diese Aspekte werden durch den Eintragstyp oder den Eintragstyp des Links definiert. Alle Ressourcen eines bestimmten Typs müssen immer alle erforderlichen Aspekte haben, die durch diesen Typ definiert sind.

Knowledge Catalog verwaltet die erforderlichen Aspekte (z. B. das Schema) für Systemeinträge.

Wichtige Hinweise:
- Sie können erforderliche Aspekte nur Einträgen und nicht den zugehörigen Spalten zuordnen.
- Sie können die erforderlichen Aspekte nicht aus einem Eintrag oder Eintragslink löschen.
- Sie können die erforderlichen Aspekte von Systemeinträgen lesen, aber nicht ändern.
- Datenaspekte können keine erforderlichen Aspekte sein.
Optionale Aspekte: Sie können Einträgen oder Spalten von Einträgen optionale Aspekte zuordnen. Sie können optionale Aspekte entweder beim Erstellen des Eintrags oder später durch Aktualisieren des Eintrags hinzufügen.

Wichtige Hinweise:
- Sie können optionale Aspekte löschen, nachdem sie ausgefüllt wurden.
- Eintraglinks unterstützen nur erforderliche Aspekte.

Datenaspekte

Einige Aspekte enthalten Informationen, die aus den zugrunde liegenden Daten eines Eintrags abgeleitet wurden, und nicht Metadaten zum Eintrag. Diese werden als Datenaspekte bezeichnet. Die Ergebnisse eines Datenprofil- oder Datenqualitätsscans enthalten beispielsweise Statistiken, die aus den Daten selbst abgeleitet werden, und werden daher als Datenaspekte klassifiziert.

Zu den Systemaspekttypen, die Datenaspekte sind, gehören die folgenden:

data-profile: Enthält Ergebnisse eines Datenprofilscans. Weitere Informationen finden Sie unter Datenprofilerstellung.
data-quality-scorecard: Enthält eine Zusammenfassung der Datenqualitätswerte.
data-rules: Datenqualitätsregeln an einen Eintrag anhängen.
data-quality-rule-template: Definieren Sie eine wiederverwendbare Vorlage für Datenqualitätsregeln.

Aspekttypen

Aspekttypen sind wiederverwendbare Ressourcen, die Vorlagen für Aspekte enthalten.

Kategorien von Aspekttypen

Aspekttypen werden in benutzerdefinierte und Systemaspekttypen unterteilt.

Benutzerdefinierte Aspekttypen

Aspekttypen, die Sie in Knowledge Catalog erstellen, werden als benutzerdefinierte Aspekttypen bezeichnet.

Benutzerdefinierte Aspekttypen können global oder regional sein. Sie können benutzerdefinierte Aspekttypen entweder an einem bestimmten regionalen Standort (z. B. us-central1) oder als global-Ressource erstellen. Der Speicherort eines Aspekttyps wirkt sich auf den Anwendungsbereich aus und bestimmt, für welche Einträge er verwendet werden kann:

Globale Aspekttypen: Mit ihnen können Aspekte für Einträge in jeder Region erstellt werden. Wählen Sie einen global-Aspekttyp aus, wenn Sie dieselbe Struktur auf Einträge in mehreren Regionen anwenden möchten, da Sie sie nur einmal definieren müssen. Da die Definition eines globalen Aspekttyps in allen Regionen repliziert wird, ist diese Option möglicherweise nicht geeignet, wenn das Schema des Aspekttyps selbst vertrauliche Informationen enthält oder wenn ein strenger Datenstandort für alle Metadatenkomponenten erforderlich ist.
Regionale Aspekttypen: Können nur verwendet werden, um Aspekte für Einträge zu erstellen, die sich in derselben Region wie der Aspekttyp befinden. Ein in us-central1 erstellter Aspekttyp kann beispielsweise nur mit Einträgen in us-central1 verwendet werden. Wählen Sie einen regionalen Standort aus, wenn ein Aspekttyp nur für Einträge in einer bestimmten Region relevant ist oder um sicherzustellen, dass sich die Aspekttypdefinition in der ausgewählten Region befindet. Dies kann dazu beitragen, Anforderungen an Datensouveränität und Compliance zu erfüllen. Wenn Sie regionale Aspekttypen verwenden, aber dieselbe Struktur in mehreren Regionen benötigen, müssen Sie in jeder Region separate Aspekttypdefinitionen erstellen und verwalten.

Weitere Informationen finden Sie unter Projekt- und Standortbeschränkungen.

Systemaspekttypen

Aspekttypen, die von Knowledge Catalog bereitgestellt, verwendet und verwaltet werden, werden als Systemaspekttypen bezeichnet. Systemaspekttypen sind immer global und können daher in jeder Region verwendet werden. Systemaspekttypen werden in einem von Google verwalteten Projekt mit der Projektnummer 655216118709 gespeichert. Beispiel: projects/655216118709/locations/global/aspectTypes/schema

Jeder systemdefinierte Aspekttyp, Eintragstyp und Eintragstyp für Links hat eigene IAM-Berechtigungen. Weitere Informationen finden Sie unter IAM-Berechtigungen für Systemaspekttypen, Eintragstypen und Eintragsverknüpfungstypen.

Systemaspekttypen werden weiter in wiederverwendbare und eingeschränkte Typen unterteilt. In der folgenden Tabelle werden die Kategorien von Systemaspekttypen und die Liste der Aspekttypen beschrieben, die Knowledge Catalog für jede Kategorie bereitstellt:

Kategorie des Systemaspekttyps	Beschreibung	Von Knowledge Catalog bereitgestellte Aspekttypen
Wiederverwendbarer Systemaspekttyp	Mit diesen Aspekttypen können Sie Aspekte erstellen oder ändern.	`contacts` `data-profile` `data-quality-scorecard` `generic` `guidelines` `overview` `schema-join` `schema` `storage` `usage`
Eingeschränkt zulässiger Systemaspekttyp	Diese Aspekttypen werden von Knowledge Catalog verwaltet. Sie können Aspekte unter diesen Aspekttypen lesen, aber nicht erstellen oder bearbeiten.	Hierzu gehören unter anderem: `analytics-hub` `aspecttype-aspect` `bigquery-dataset` `bigquery-table` `cloudsql-database` `cloudsql-instance` `cloudsql-table` `entrygroup-aspect` `entrytype-aspect` `sensitive-data-protection-profile` `storage-bucket` `storage-folder`

Hinweis

Bevor Sie Aspekttypen und Aspekte erstellen und verwalten, müssen Sie die Aufgaben in diesem Abschnitt ausführen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für die Ressource zuzuweisen, damit Sie die nötigen Berechtigungen zum Erstellen und Verwalten von Aspekttypen und Aspekten haben:

Vollständiger Satz von Berechtigungen für Metadatenressourcen in Knowledge Catalog, einschließlich Aspekttypen und Datenaspekten: Dataplex Catalog Admin (roles/dataplex.catalogAdmin)
Metadatenressourcen in Knowledge Catalog erstellen und verwalten, einschließlich Aspekttypen und Datenaspekten: Dataplex Catalog Editor (roles/dataplex.catalogEditor)
Vollständiger Satz von Berechtigungen für benutzerdefinierte Aspekttypen (mit Ausnahme von Berechtigungen zum Erstellen oder Bearbeiten von Einträgen mit Aspekttypen): Dataplex Aspect Type Owner (roles/dataplex.aspectTypeOwner)
Aspekttypen und zugehörige IAM-Richtlinien ansehen: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
Mit Aspekttypen können Sie Einträge mit den entsprechenden Aspekten erstellen und ändern: Dataplex Aspect Type User (roles/dataplex.aspectTypeUser)
Fügen Sie Aspekte einiger der Systemaspekttypen hinzu, z. B. schema, schema-join, overview, contacts: Dataplex Entry and EntryLink Owner (roles/dataplex.entryOwner)

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

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Weitere Informationen finden Sie unter IAM-Rollen für Knowledge Catalog.

API aktivieren

Aktivieren Sie die Dataplex API in Ihrem Knowledge Catalog-Projekt. Wenn Sie ein neues Google Cloud -Projekt oder ein Projekt verwenden, in dem die BigQuery API aktiviert ist, ist die Dataplex API standardmäßig aktiviert.

API aktivieren

Benutzerdefinierten Aspekttyp erstellen

Console

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

Zu Metadatentypen
Klicken Sie auf den Tab Aspekttypen und Tag-Vorlagen >Benutzerdefiniert.
Klicken Sie auf Aspekttyp erstellen.
Geben Sie im Fenster Aspekttyp erstellen Folgendes ein:
1. Optional: Geben Sie im Feld Anzeigename einen Namen für den Aspekttyp ein.
2. Geben Sie im Feld Aspect type ID (ID des Aspekttyps) eine eindeutige ID für den Aspekttyp ein.
3. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für den Aspekttyp ein.
4. Wählen Sie im Feld Location (Standort) einen Standort für den Aspekttyp aus. Sie können den Standort eines Aspekttyps nach der Erstellung nicht mehr ändern. Informationen zu den Auswirkungen der Auswahl eines globalen im Vergleich zu einem regionalen Standort finden Sie im Abschnitt Benutzerdefinierte Aspekttypen.
Optional: Definieren Sie eine Vorlage für den Aspekttyp.

Klicken Sie im Bereich Vorlage auf Feld hinzufügen. Geben Sie im Bereich Neues Feld Folgendes ein:
1. Geben Sie im Feld Name einen Namen ein.
2. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen ein.
3. Optional: Geben Sie im Feld Beschreibung eine Beschreibung ein.
4. Wählen Sie im Feld Typ einen Datentyp für das Feld aus. Je nach Auswahl werden die nächsten Felder und Optionen angezeigt:
  - Wenn Sie Text als Datentyp ausgewählt haben, gehen Sie so vor:
    1. Wählen Sie im Feld Texttyp den Texttyp aus.
    2. Geben Sie im Feld Textwerte einen Hinweis für das Textfeld ein. Klicken Sie dazu auf Wert hinzufügen und geben Sie den Hinweis ein. Sie können einem Textfeld mehrere Hinweise hinzufügen.
    3. Klicken Sie auf Fertig.
  - Wenn Sie Enum als Datentyp ausgewählt haben, fügen Sie einen Enum-Wert hinzu:
    1. Klicken Sie auf Enum-Wert hinzufügen.
    2. Geben Sie im Feld Wert einen Enumerationswert ein. Sie können mehrere Enum-Werte hinzufügen.
    3. Klicken Sie auf Fertig.
  - Wenn Sie Array als Datentyp ausgewählt haben, definieren Sie im Abschnitt Array-Element die Typen der Elemente, die im Array enthalten sein sollen:
    1. Klicken Sie auf Array-Element hinzufügen.
    2. Geben Sie im Feld Name einen Namen für die Array-Elemente ein.
    3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für die Arrayelemente ein.
    4. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für die Arrayelemente ein.
    5. Wählen Sie im Feld Typ einen Datentyp für die Arrayelemente aus.
      
      Je nach Auswahl wird die nächste Gruppe von Feldern und Optionen angezeigt. Sie ähneln den Optionen, die an anderer Stelle in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben werden.
    6. Klicken Sie auf Fertig.
  - Wenn Sie Karte als Datentyp ausgewählt haben, definieren Sie im Bereich Kartenwert die Arten von Werten, die in der Karte enthalten sein sollen:
    1. Klicken Sie auf Kartenwert hinzufügen.
    2. Geben Sie im Feld Name einen Namen für die Karte ein.
    3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für die Karte ein.
    4. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für die Karte ein.
    5. Wählen Sie im Feld Typ einen Datentyp für die Karte aus.
      
      Je nach Auswahl wird die nächste Gruppe von Feldern und Optionen angezeigt. Sie ähneln den Optionen, die an anderer Stelle in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben werden.
    6. Klicken Sie auf Fertig.
  - Wenn Sie Eintrag als Datentyp ausgewählt haben, geben Sie Folgendes ein:
    1. Geben Sie im Feld Eintrags-ID eine eindeutige ID ein, mit der andere Eintragsfelder auf diesen Eintrag verweisen können. Weitere Informationen finden Sie im Abschnitt Beispiel für die Verwendung der Felder „Datensatz-ID“ und „Datensatzreferenz“ in diesem Dokument.
    2. Optional: Wenn Sie einen Verweis auf einen anderen Eintrag aus dieser Vorlage hinzufügen möchten, verwenden Sie das Feld Eintragverweis. Sie können diese Einstellung nach dem Erstellen des Aspekttyps nicht mehr ändern. Weitere Informationen finden Sie im Abschnitt Beispiel für die Verwendung der Felder „Datensatz-ID“ und „Datensatzreferenz“ in diesem Dokument.
    3. Im Bereich Felder aufzeichnen können Sie ein komplexes Objekt mit mehreren verschachtelten Feldern definieren. Klicken Sie dazu auf Datensatzfeld-Element hinzufügen und geben Sie Folgendes an:
    4. Geben Sie im Feld Name einen Namen für das Datensatzfeld ein.
    5. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für das Datensatzfeld ein.
    6. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für das Datensatzfeld ein.
    7. Wählen Sie im Feld Typ einen Datentyp aus.
      
      Je nach Auswahl werden die nächsten Felder und Optionen angezeigt. Sie ähneln den Optionen, die weiter oben in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben werden.
    8. Klicken Sie auf Fertig.
5. Wenn Sie das Feld für einen Aspekt dieses Typs als obligatorisch festlegen möchten, wählen Sie Is required (Erforderlich) aus. Weitere Informationen zu erforderlichen und optionalen Attributen finden Sie im Abschnitt Attributkategorien in diesem Dokument.
6. Klicken Sie auf Fertig.
7. Wenn Sie mehrere Felder hinzufügen möchten, klicken Sie auf Feld hinzufügen und wiederholen Sie die vorherigen Schritte.
Optional: Fügen Sie im Abschnitt Labels den Ressourcen beliebige Labels als Schlüssel/Wert-Paare hinzu:
1. Klicken Sie auf Label hinzufügen.
2. Geben Sie im Feld Schlüssel einen Schlüssel ein.
3. Geben Sie im Feld Wert einen Wert für den Schlüssel ein.
4. Wenn Sie weitere Labels hinzufügen möchten, klicken Sie auf Label hinzufügen und wiederholen Sie die Schritte.
Klicken Sie auf Speichern.

gcloud

Verwenden Sie zum Erstellen eines benutzerdefinierten Aspekttyps den Befehl gcloud dataplex aspect-types create.

C#

Folgen Sie der Einrichtungsanleitung für C# in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken, bevor Sie dieses Beispiel anwenden. 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 GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CreateAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CreateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CreateAspectTypeRequest request = new CreateAspectTypeRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            AspectTypeId = "",
            AspectType = new AspectType(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.CreateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceCreateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

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


package main

import (
	"context"

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

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

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

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

Java

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

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.CreateAspectTypeRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateAspectType {

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

  public static void syncCreateAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      CreateAspectTypeRequest request =
          CreateAspectTypeRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setAspectTypeId("aspectTypeId-423030675")
              .setAspectType(AspectType.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.createAspectTypeAsync(request).get();
    }
  }
}

Python

Folgen Sie der Einrichtungsanleitung für Python in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken, bevor Sie dieses Beispiel anwenden. 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_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Folgen Sie der Einrichtungsanleitung für Ruby in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken, bevor Sie dieses Beispiel anwenden. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Ruby API.

require "google/cloud/dataplex/v1"

##
# Snippet for the create_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#create_aspect_type.
#
def create_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

Verwenden Sie zum Erstellen eines benutzerdefinierten Aspekttyps die Methode aspectType.create.

Nachdem Sie einen benutzerdefinierten Aspekttyp erstellt haben, können Sie Einträgen Aspekte hinzufügen.

Beispiel für die Verwendung der Felder „Datensatz-ID“ und „Datensatzverweis“

Sie können die Felder Datensatz-ID und Datensatzreferenz für rekursive Referenzen verwenden. Das folgende Beispiel zeigt, wie diese Felder verwendet werden:

Angenommen, es gibt einen Aspekttyp namens Employee mit den folgenden Feldern:

Name (Typ: Text)
Startdatum (Typ: Date & time)
Bezeichnung (Typ: Text)
Aktuelle Adresse (Typ: Record)
Ständige Anschrift (Typ: Record)

Die beiden Adressfelder Aktuelle Adresse und Adresse des ständigen Wohnsitzes haben denselben Datentyp Record. Um Duplikate zu vermeiden, können Sie die Werte Datensatz-ID und Datensatzreferenz festlegen, wenn Sie diese Felder definieren.

Wenn Sie das Feld Aktuelle Adresse definieren, können Sie Datensatz-ID als address-field angeben. Für Anschrift des Hauptwohnsitzes können Sie für Datensatzreferenz denselben Wert (address-field) angeben. Beispiel:

Name (Typ: Text)
Startdatum (Typ: Date & time)
Bezeichnung (Typ: Text)
Aktuelle Adresse (Typ: Record, Datensatz-ID: address-field)
Ständige Anschrift (Typ: Record, Datensatzreferenz: address-field)

So müssen Sie die Felder einer anderen Adresse nicht duplizieren.

Eintrag Aspekte hinzufügen

Nachdem Sie einen benutzerdefinierten Aspekttyp erstellt haben, können Sie Aspekte dieses Typs erstellen. Wenn Sie einem Eintrag Aspekte hinzufügen möchten, müssen Sie den Eintrag aktualisieren, da Aspekte in Einträgen gespeichert werden.

Wichtige Hinweise:

Sie können einem Eintrag oder den Spalten eines Eintrags Aspekte hinzufügen.
Sie können die erforderlichen Aspekte nur für benutzerdefinierte Einträge bearbeiten. Sie können die erforderlichen Aspekte nicht löschen.
Sie können die optionalen Aspekte sowohl für benutzerdefinierte als auch für Systemeinträge bearbeiten und löschen.

Console

Rufen Sie in der Google Cloud Console die Seite Suchen im Knowledge Catalog auf.

Zur Suche
Wenn Ihre Suchplattform auf Data Catalog festgelegt ist, wählen Sie im Menü Suchplattform auswählen die Option Dataplex Universal Catalog aus.
Suchen Sie nach dem Eintrag, dem Sie Aspekte hinzufügen möchten, und klicken Sie darauf. Die Seite mit den Eintragsdetails wird geöffnet.
So fügen Sie dem Eintrag Aspekte hinzu:
1. Klicken Sie auf den Tab Details.
2. Wenn Sie dem Eintrag erforderliche oder optionale Aspekte hinzufügen möchten, klicken Sie im Bereich Tags und Aspekte für die entsprechende Kategorie auf Hinzufügen.
  Sie können keine erforderlichen Aspekte hinzufügen, wenn für den Eintragstyp des ausgewählten Eintrags keine erforderlichen Aspekte definiert sind.
3. Suchen Sie nach dem Aspekt, den Sie hinzufügen möchten, und wählen Sie ihn aus.
4. Geben Sie im Fenster Aspekt hinzufügen die Werte für die Felder ein.
5. Klicken Sie auf Speichern.
6. So fügen Sie einer Spalte des Eintrags Aspekte hinzu:
7. Klicken Sie auf der Detailseite des Eintrags auf den Tab Schema.
8. Wählen Sie die Spalten aus, denen Sie Aspekte hinzufügen möchten.
9. Klicken Sie auf Aspekt hinzufügen.
10. Suchen Sie nach dem Aspekt, den Sie hinzufügen möchten, und wählen Sie ihn aus.
11. Geben Sie im Fenster Aspekt hinzufügen die Werte für die Felder ein.
12. Klicken Sie auf Speichern.

gcloud

Verwenden Sie den gcloud dataplex entries update-Befehl, um einem Eintrag oder einer Spalte eines Eintrags Aspekte hinzuzufügen.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Informationen zum Hinzufügen von Aspekten zum Eintragsobjekt finden Sie unter Aspekte.

Go


package main

import (
	"context"

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

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

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

Informationen zum Hinzufügen von Aspekten zum Eintragsobjekt finden Sie unter Entry.

Java

import com.google.cloud.dataplex.v1.Aspect;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryName;
import com.google.cloud.dataplex.v1.EntrySource;
import com.google.protobuf.FieldMask;
import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import java.util.Map;

public class UpdateEntry {

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

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

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

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

Python

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


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

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

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


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

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

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

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

Informationen zum Hinzufügen von Aspekten zum Eintragsobjekt finden Sie unter #required_aspects=.

REST

Mit der Methode entry.patch können Sie einem Eintrag oder einer Spalte eines Eintrags Aspekte hinzufügen.

Das Erstellen und Verwenden von Aspekten in einem Eintrag, bei dem sich der entsprechende Aspekttyp und der Eintrag in verschiedenen Google Cloud Organisationen befinden, wird nicht unterstützt.

Aspekte wiederverwendbarer Systemaspekttypen anhängen

Sie können Aspekte wiederverwendbarer Systemaspekttypen an Einträge anhängen.

Je nach Struktur können Sie einen Aspekt eines wiederverwendbaren Aspekttyps in der Google Cloud Konsole bearbeiten. Aspekttypen mit verschachtelten Feldern können in der Google Cloud -Konsole nicht bearbeitet werden. Sie müssen das gcloud-Befehlszeilentool oder die REST API verwenden, um Aspekte dieses Typs anzuhängen oder zu aktualisieren.

Kurzübersicht zur Datenqualität

Eine Datenqualitäts-Scorecard ist ein Aspekt, der eine Zusammenfassung der Datenqualität bietet, oft basierend auf Datenqualitätsscans oder anderen Prozessen. Sie können einem Eintrag eine Kurzübersicht zur Datenqualität anhängen, um benutzerdefinierte Informationen zur Datenqualität bereitzustellen. Hängen Sie dazu einen Aspekt des systemdefinierten Typs data-quality-scorecard an.

Das Feld data im Aspekt data-quality-scorecard kann die folgenden Felder enthalten:

job: Optional. Ein Datensatz mit Details zum Job, mit dem die Scorecard generiert wurde.
- name: Der Ressourcenname des Jobs zur Datenqualität.
- runTime: Die Laufzeit des Jobs zur Datenqualität.
score: Optional. Der Gesamtqualitätsfaktor für Daten. Der Wert liegt zwischen [0, 100].
status: erforderlich. Der Status der Datenqualitätsübersicht. Er gibt an, ob der Qualitätsgrenzwert erreicht wurde (PASS) oder nicht (FAIL).
dimensions: Optional. Ein Array mit Dimensionsergebnissen. Jedes Ergebnis enthält:
- name: Der Name der Dimension. Das kann ACCURACY, COMPLETENESS, CONSISTENCY, FRESHNESS, UNIQUENESS, VALIDITY oder VOLUME oder ein benutzerdefinierter Dimensionsname sein. Benutzerdefinierte Dimensionsnamen müssen in Großbuchstaben geschrieben sein und dürfen maximal 30 Zeichen lang sein.
- score: Der Gesamtwert auf Dimensionsebene im Bereich [0, 100].
- status: Der Status der Dimension, der angibt, ob sie den Qualitätsschwellenwert (PASS oder FAIL) erreicht oder überschritten hat.
columns: Optional. Ein Array mit Spaltenergebnissen. Jedes Ergebnis enthält:
- name: Der Name der Spalte.
- score: Die Gesamtbewertung auf Spaltenebene im Bereich [0, 100].
- status: Der Status der Spalte, der angibt, ob sie den Qualitätsschwellenwert (PASS oder FAIL) erreicht oder nicht erreicht hat.
- dimensions: Ein Array mit Dimensionswerten für die Spalte. Jeder Dimensionswert umfasst:
  - name: Der Name der Dimension.
  - score: Der Wert für die Dimension, der zwischen 0 und 100 liegt.
  - status: Der Status der Dimension für die Spalte. Er gibt an, ob der Qualitätsgrenzwert (PASS oder FAIL) erreicht wurde.

Wenn Sie den Befehl zum Anhängen eines Aspekts ausführen, werden alle vorhandenen Daten für diesen Aspekt ersetzt. Wenn Sie beispielsweise eine Kurzübersicht mit einem Wert von 80 mit einer neuen Datei aktualisieren, die einen Wert von 90 enthält, wird 80 überschrieben. Die Daten werden nicht zusammengeführt.

So hängen Sie eine Übersicht zur Datenqualität an:

gcloud

Verwenden Sie den Befehl gcloud dataplex entries update-aspects, um Aspekte für einen Eintrag zu aktualisieren.

Erstellen Sie eine JSON-Datei (dq-aspect.json) mit folgendem Inhalt.

  {
    "dataplex-types.global.data-quality-scorecard": {
      "data": {
        "score": 0.8,
        "status": "PASS",
        "dimensions": [
          {
            "name": "completeness",
            "score": 0.9,
            "status": "PASS"
          },
          {
            "name": "uniqueness",
            "score": 0.7,
            "status": "FAIL"
          }
        ],
        "columns": [
          {
            "name": "col1",
            "score": 0.85,
            "status": "PASS"
          }
        ]
      }
    }
  }
}

Führen Sie dazu diesen Befehl aus:
```
  gcloud dataplex entries update-aspects ENTRY_ID
  --location=LOCATION
  --entry-group=ENTRY_GROUP_ID
  --project=PROJECT_ID
  --aspects=dq-aspect.json
```
Ersetzen Sie die folgenden Variablen:
- ENTRY_ID: die ID des Eintrags, z. B. example-entry
- LOCATION: der Standort des Eintrags, z. B. us-central1
- ENTRY_GROUP_ID: die ID der Eintragsgruppe, z. B. example-entry-group
- PROJECT_ID: die ID des Projekts, z. B. example-project

REST

Verwenden Sie die Methode entry.patch, um Aspekte für einen Eintrag zu aktualisieren.

Erstellen Sie eine Datei namens payload.json und fügen Sie den JSON-Inhalt aus Ihrer Anfrage ein.


  {
    "aspects": {
      "dataplex-types.global.data-quality-scorecard": {
        "data": {
          "score": 80,
          "status": "PASS",
          "dimensions": [
            {
              "name": "completeness",
              "score": 90,
              "status": "PASS"
            },
            {
              "name": "uniqueness",
              "score": 70,
              "status": "FAIL"
            }
          ],
          "columns": [
            {
              "name": "col1",
              "score": 85,
              "status": "PASS"
            }
          ]
        }
      }
    }
  }

Führen Sie im Terminal den folgenden Befehl aus:

 curl -X PATCH \
 -H "Authorization: Bearer $(gcloud auth print-access-token)" \
 -H "Content-Type: application/json" \
 -d @payload.json \
 "https://dataplex.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/<var>LOCATION</var>/entryGroups/<var>ENTRY_GROUP_ID</var>/entries/<var>ENTRY_ID</var>?updateMask=aspects"

Ersetzen Sie Folgendes:

PROJECT_ID: die ID des Projekts, z. B. example-project
LOCATION: der Standort des Eintrags, z. B. us-central1
ENTRY_GROUP_ID: die ID der Eintragsgruppe, z. B. example-entry-group
ENTRY_ID: die ID des Eintrags, z. B. example-entry

Andere wiederverwendbare Aspekttypen

Die folgenden Systemaspekttypen sind ebenfalls verfügbar. Sie können sie mit denselben gcloud- oder REST API-Methoden anhängen, die für die Scorecard zur Datenqualität beschrieben werden. Für Aspekttypen ohne verschachtelte Felder, z. B. generic, können Sie die Console verwenden.

Kontakte Verwenden Sie den Aspekttyp contacts, um die Inhaberschaft oder Verwaltung zuzuweisen. Die Felder umfassen Folgendes:

identities (Array): Eine Liste mit Kontakten. Jeder Kontakt enthält:
- role (String): Die Rolle des Kontakts, z. B. owner, steward, producer oder admin.
- name (String): Der Name des Kontakts.
- id (String): Die E-Mail-Adresse oder ID des Kontakts.

Erstellen Sie die Datei payload.json so:

 {
   "aspects": {
     "dataplex-types.global.contacts": {
       "data": {
         "identities": [
           {
             "role": "steward",
             "name": "Jane Doe",
             "id": "jane.doe@example.com"
           }
         ]
       }
     }
   }
 }

Datenprofil: Verwenden Sie den Aspekttyp data-profile, um Datenprofilergebnisse zu erfassen. Weitere Informationen finden Sie unter Datenprofilerstellung.

Die Felder umfassen Folgendes:
- sourceDataInfo (Datensatz): Informationen zu den Quelldaten, die gescannt wurden, um das Profil zu erstellen.
  - scope (enum): Der Umfang des Profils (PREVIEW, SAMPLED oder ALL). Der Wert PREVIEW entspricht den Ergebnissen eines Lightweight-Profilerstellungsscans.
  - scannedRows (int): Die Anzahl der gescannten Zeilen.
  - samplingPercentage (double): Der verwendete Prozentsatz für die Stichprobenerhebung.
- fields (Map): Eine Zuordnung von Spaltennamen zu ihren Datenprofilen, einschließlich Messwerten wie uniqueness-, nullness- und topN-Werten sowie typspezifischen Statistiken für numeric-, string-, datetime- und array-Spalten.
Erstellen Sie die Datei payload.json so:
```
 {
   "aspects": {
     "dataplex-types.global.data-profile": {
       "data": {
         "sourceDataInfo": {
         "scope": "ALL",
         "scannedRows": 100
       },
       "fields": {
         "col1": {
           "nullness": 0.0,
           "uniqueness": 0.1,
      "string": {
        "length": {
          "min": 1,
          "max": 20,
          "avg": 12.54
        }
      }
         }
       }
     }
   }
 }}
```
Allgemein Verwenden Sie den Aspekttyp generic für allgemeine Informationen zum Eintrag. Die Felder umfassen Folgendes:
- type (String): Ein Freiformfeld zum Speichern eines vom Nutzer angegebenen Typs.
- system (String): Das System des benutzerdefinierten Eintrags.
Erstellen Sie die Datei payload.json so:
```
{
  "aspects": {
    "dataplex-types.global.generic": {
      "data": {
        "type": "custom-type",
        "system": "custom-system"
      }
    }
  }
}
```
Übersicht Verwenden Sie den Aspekttyp overview, um eine RTF-Beschreibung anzugeben. Die Felder umfassen Folgendes:
- content (String): Die Übersicht des Eintrags, die das HTML-Format unterstützt.
- links (Array): Eine Liste mit Links zum Quellsystem. Jeder Link enthält:
  - url (String): Die URL des Links.
  - title (String): Der Titel des Links.
Erstellen Sie die Datei payload.json so:
```
{
  "aspects": {
    "dataplex-types.global.overview": {
      "data": {
        "content": "This is a <b>rich text</b> description.",
      "links": [
        {
          "url": "https://example.com",
          "title": "Example Link"
        }
      ]
    }
  }
}}
```
Schema: Verwenden Sie den Aspekttyp schema, um die Struktur von Daten zu beschreiben.
- fields (Array): Eine Liste von Schemafeldern. Die Felder umfassen Folgendes:
  - name (String): Der Name des Felds.
  - dataType (String): Der Datentyp des Felds.
  - metadataType (enum): Der Metadatentyp (z. B. STRING, BOOLEAN).
  - mode (enum): Der Modus des Felds (NULLABLE, REQUIRED, REPEATED).
  - description (String): Eine Beschreibung des Felds.
Erstellen Sie die Datei payload.json so:
```
{
  "aspects": {
    "dataplex-types.global.schema": {
      "data": {
        "fields": [
        {
          "name": "id",
          "dataType": "string",
          "metadataType": "STRING",
          "mode": "REQUIRED"
        }
      ]
    }
  }
}}
```
Nutzung Verwenden Sie den Aspekttyp usage, um Nutzungsmesswerte zu erfassen. Die Felder umfassen Folgendes:
- metrics (Array): Eine Liste von Nutzungsmesswerten. Jeder Messwert umfasst:
  - name (String): Der Name des Messwerts, z. B. views, reads.
  - timeSeries (Array): Eine Liste mit Zeitreihendaten. Jeder Artikel enthält:
    - interval (String): Das Aggregationsintervall, z. B. 30d.
    - value (Ganzzahl): Der aggregierte Wert.
- refreshTime (datetime): Der Zeitpunkt, zu dem die Messwerte zuletzt aktualisiert wurden.
Erstellen Sie die Datei payload.json so:
```
{
  "aspects": {
    "dataplex-types.global.usage": {
      "data": {
        "metrics": [
        {
          "name": "views",
          "timeSeries": [
            {
              "interval": "30d",
              "value": 100
            }
          ]
        }
      ],
      "refreshTime": "2025-01-01T12:00:00Z"
    }
  }
}}
```

Eintrag-Link Aspekte hinzufügen

Wenn Sie Metadaten mit Informationen zu Beziehungen zwischen den Einträgen anreichern möchten, fügen Sie den Eintragslinks Aspekte hinzu.

Sie können die Typen von Eintragslinks so konfigurieren, dass ein bestimmter Aspekt erforderlich ist. Wenn Sie einen solchen Eintrag erstellen, müssen Sie den erforderlichen Aspekt angeben.

Aspekte für Eintragslinks erstellen

Aspekte von Einstiegslinks werden als Teil der EntryLink-Ressource verwaltet.

Beachten Sie die folgenden Einschränkungen für die Verwendung von Aspekten mit Einstiegslinks:

Optionale Aspekte werden nicht unterstützt.
Datenaspekte werden nicht unterstützt.
Aspekte benutzerdefinierter Typen werden nicht unterstützt.
Sie können nur erforderliche Aspekte verwalten, die durch Systemaspekttypen definiert sind, z. B. schema-join.
Die Suche nach Links zu Einträgen anhand des Inhalts ihrer Attribute wird nicht unterstützt.
Der Import oder Export von Aspekten für Eintragslinks wird nicht unterstützt.

REST

Wenn Sie einen Eintragslink mit dem erforderlichen Aspekt erstellen möchten, verwenden Sie die Methode entryLinks.create und fügen Sie die Aspektdaten in den Anfragetext ein.

Vorhandene Aspekte für einen Eintrag verwalten

In diesem Abschnitt wird beschrieben, wie Sie die vorhandenen Aspekte für einen Eintrag aktualisieren und löschen.

Aspekt aktualisieren

Sie können die optionalen Aspekte sowohl für benutzerdefinierte als auch für Systemeinträge bearbeiten. Sie können die erforderlichen Aspekte nur für benutzerdefinierte Einträge bearbeiten.

Bei Systemen von Erstanbietern (1P), z. B. BigQuery-Tabellen, können Sie Aspekte mit der modifyEntry API aktualisieren. So können Sie die Berechtigungen zum Aktualisieren von Metadaten des Quellsystems verwenden (z. B. „BigQuery-Datenbearbeiter“).

Console

Rufen Sie in der Google Cloud Console die Seite Suchen im Knowledge Catalog auf.

Zur Suche
Wenn Ihre Suchplattform auf Data Catalog festgelegt ist, wählen Sie im Menü Suchplattform auswählen die Option Dataplex Universal Catalog aus.
Suchen Sie nach dem Eintrag, dessen Aspekte Sie aktualisieren möchten, und klicken Sie darauf.

Die Seite mit den Eintragsdetails wird geöffnet.

Klicken Sie auf den Tab Details.
Maximieren Sie im Bereich Tags und Aspekte den Aspekt oder das Tag, das Sie aktualisieren möchten, und klicken Sie auf Bearbeiten.
Aktualisieren Sie im Fenster Aspekt bearbeiten die erforderlichen Felder.
Klicken Sie auf Speichern.

gcloud

Verwenden Sie den Befehl gcloud dataplex entries update, um Aspekte für einen Eintrag oder eine Spalte eines Eintrags zu aktualisieren.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go


package main

import (
	"context"

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

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

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

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

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

  public static void syncUpdateEntry() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

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

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

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

REST

Mit der Methode entry.patch können Sie Aspekte für einen Eintrag oder eine Spalte eines Eintrags aktualisieren.

Aspekt löschen

Console

Rufen Sie in der Google Cloud Console die Seite Suchen im Knowledge Catalog auf.

Zur Suche
Wenn Ihre Suchplattform auf Data Catalog festgelegt ist, wählen Sie im Menü Suchplattform auswählen die Option Dataplex Universal Catalog aus.
Suchen Sie nach dem Eintrag, dessen Aspekte Sie löschen möchten, und klicken Sie darauf.

Die Seite mit den Eintragsdetails wird geöffnet.

Klicken Sie auf den Tab Details.
Erweitern Sie im Bereich Tags und Aspekte den Aspekt oder das Tag, das Sie löschen möchten, und klicken Sie auf Löschen.
Klicken Sie auf Bestätigen.

gcloud

Verwenden Sie den Befehl gcloud dataplex entries update, um einen Aspekt für einen Eintrag zu löschen.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go


package main

import (
	"context"

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

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

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

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

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

  public static void syncUpdateEntry() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

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

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

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

REST

Wenn Sie einen Aspekt für einen Eintrag löschen möchten, verwenden Sie die Methode entry.patch.

Vorhandene Aspekte für einen Einstiegslink verwalten

In diesem Abschnitt wird beschrieben, wie Sie die vorhandenen Aspekte für einen Einstiegslink aktualisieren.

Aspekt aktualisieren

Bei Eintragslinks können Sie nur erforderliche Aspekte aktualisieren, für die wiederverwendbare Systemaspekttypen verwendet werden.

Weitere Informationen finden Sie unter IAM-Berechtigungen für Vorgänge mit Einstiegslinks.

REST

Wenn Sie einen Eintragslink mit dem erforderlichen Aspekt aktualisieren möchten, verwenden Sie die Methode entryLinks.patch und fügen Sie die Aspektdaten in den Anfragetext ein.

Aspekt löschen

Sie können keinen erforderlichen Aspekt für einen Eintragslink löschen.

Aspekttypen verwalten

In diesem Abschnitt wird beschrieben, wie Sie Aspekttypen aufrufen und benutzerdefinierte Aspekttypen aktualisieren und löschen.

Liste der verfügbaren Aspekttypen und Tag-Vorlagen ansehen

Console

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

Zu Metadatentypen
Klicken Sie auf den Tab Aspekttypen und Tag-Vorlagen.

Auf dieser Seite werden alle verfügbaren Knowledge Catalog-Aspekttypen und Data Catalog-Tag-Vorlagen aufgeführt.

Wenn Sie benutzerdefinierte Aspekttypen und Tag-Vorlagen aufrufen möchten, klicken Sie auf den Tab Benutzerdefiniert. Auf dem Tab Benutzerdefiniert wird in der Spalte Katalogquelle angezeigt, wo sich die Ressource befindet: im Knowledge Catalog oder im Data Catalog.

Klicken Sie auf den Tab System, um Systemaspekttypen aufzurufen.

Weitere Informationen zu benutzerdefinierten und System-Aspekttypen finden Sie im Abschnitt Kategorien von Aspekttypen in diesem Dokument.

Optional: Wenn Sie die Liste der Aspekttypen und Tag-Vorlagen in Ihrem ausgewählten Projekt aufrufen möchten, klicken Sie auf den Tab Benutzerdefiniert und stellen Sie dann den Schalter Aus allen Projekten anzeigen auf „Aus“.

Die Ein/Aus-Schaltfläche Aus allen Projekten anzeigen ist standardmäßig aktiviert. Die Liste enthält Knowledge Catalog-Ressourcen aus der ausgewählten Organisation und Data Catalog-Ressourcen aus allen Organisationen, auf die Sie zugreifen können.

gcloud

Verwenden Sie den gcloud dataplex aspect-types list-Befehl, um alle verfügbaren Aspekttypen aufzulisten.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for ListAspectTypes</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void ListAspectTypesRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        ListAspectTypesRequest request = new ListAspectTypesRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListAspectTypesResponse, AspectType> response = catalogServiceClient.ListAspectTypes(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (AspectType item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListAspectTypesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (AspectType item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<AspectType> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (AspectType item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go


package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

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

	req := &dataplexpb.ListAspectTypesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAspectTypesRequest.
	}
	it := c.ListAspectTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListAspectTypesResponse)
	}
}

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.ListAspectTypesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListAspectTypes {

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

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

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_aspect_types():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

    # Make the request
    page_result = client.list_aspect_types(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the list_aspect_types call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#list_aspect_types.
#
def list_aspect_types
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::AspectType.
    p item
  end
end

REST

Verwenden Sie die Methode aspectTypes.list, um alle verfügbaren Aspekttypen aufzulisten.

Details zu einem Aspekttyp oder einer Tag-Vorlage ansehen

Console

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

Zu Metadatentypen
Klicken Sie auf den Tab Aspekttypen und Tag-Vorlagen.
Wenn Sie die Details eines Knowledge Catalog-Aspekttyps aufrufen möchten, klicken Sie auf den Aspekttyp. Die Detailseite für den Aspekttyp wird geöffnet. Dort können Sie auf Details wie Anzeigename, Aspekttyp-ID, Beschreibung, Projekt-ID, Standort, Labels, Erstellungsdatum und Datum der letzten Änderung zugreifen.
- Wenn Sie die Struktur des ausgewählten Aspekttyps aufrufen möchten, klicken Sie auf den Tab Vorlage.
- Klicken Sie auf den Tab Beispieleinträge, um die Liste der 10 zuletzt erstellten ähnlichen Einträge aufzurufen.
- Wenn Sie nach allen zugehörigen Einträgen suchen möchten, klicken Sie auf Alle verwandten Einträge in der Suche anzeigen. Diese Schaltfläche wird nur angezeigt, wenn es mindestens einen zugehörigen Eintrag gibt.
Wenn Sie die Details einer Data Catalog-Tag-Vorlage aufrufen möchten, klicken Sie auf die Tag-Vorlage. Die Detailseite der Tag-Vorlage wird im Data Catalog geöffnet. Dort können Sie auf Details wie Anzeigename, Vorlagen-ID, Projekt-ID, Standort, Sichtbarkeit und Labels zugreifen.

gcloud

Mit dem Befehl gcloud dataplex aspect-types describe können Sie die Details eines Aspekttyps abrufen.

C#

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for GetAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void GetAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        GetAspectTypeRequest request = new GetAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
        };
        // Make the request
        AspectType response = catalogServiceClient.GetAspectType(request);
    }
}

Go


package main

import (
	"context"

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

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

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

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.GetAspectTypeRequest;

public class SyncGetAspectType {

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

  public static void syncGetAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      GetAspectTypeRequest request =
          GetAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .build();
      AspectType response = catalogServiceClient.getAspectType(request);
    }
  }
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_get_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

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

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the get_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#get_aspect_type.
#
def get_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

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

REST

Verwenden Sie die Methode aspectTypes.get, um die Details eines Aspekttyps abzurufen.

Benutzerdefinierten Aspekttyp aktualisieren

Sie können den Anzeigenamen, die Beschreibung, die Vorlagenfelder und die Labels eines benutzerdefinierten Aspekttyps aktualisieren. Sie können kein vorhandenes Feld in einer Vorlage löschen.

Sie können die ID und den Standort des Aspekttyps nach dem Erstellen des Aspekttyps nicht mehr aktualisieren.

Console

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

Zu Metadatentypen
Klicken Sie auf den Tab Aspekttypen und Tag-Vorlagen.
Klicken Sie auf den Aspekttyp, den Sie aktualisieren möchten.
Klicken Sie auf der Seite Details zum Aspekttyp auf Bearbeiten.
Bearbeiten Sie nach Bedarf den Anzeigenamen, die Beschreibung, die Vorlagenfelder und die Labels.
Optional: So markieren Sie ein Feld im Aspekttyp als veraltet:
1. Maximieren Sie im Bereich Vorlage das Feld.
2. Wählen Sie Is Deprecated (Wird nicht mehr unterstützt) aus.
3. Geben Sie im Feld Grund für die Einstellung einen Grund für die Einstellung des ausgewählten Felds ein.
4. Klicken Sie auf Fertig.
5. Klicken Sie auf Speichern.

gcloud

Verwenden Sie den Befehl gcloud dataplex aspect-types update, um einen benutzerdefinierten Aspekttyp zu aktualisieren.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateAspectTypeRequest request = new UpdateAspectTypeRequest
        {
            AspectType = new AspectType(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.UpdateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceUpdateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


package main

import (
	"context"

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

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

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

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

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.UpdateAspectTypeRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateAspectType {

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

  public static void syncUpdateAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateAspectTypeRequest request =
          UpdateAspectTypeRequest.newBuilder()
              .setAspectType(AspectType.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.updateAspectTypeAsync(request).get();
    }
  }
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

    request = dataplex_v1.UpdateAspectTypeRequest(
        aspect_type=aspect_type,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_aspect_type.
#
def update_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

Verwenden Sie zum Aktualisieren eines benutzerdefinierten Aspekttyps die Methode aspectTypes.patch.

Benutzerdefinierten Aspekttyp löschen

Console

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

Zu Metadatentypen
Klicken Sie auf den Tab Aspekttypen und Tag-Vorlagen.
Klicken Sie auf den Aspekttyp, den Sie löschen möchten.
Klicken Sie auf der Seite Details zum Aspekttyp auf Löschen. Bestätigen Sie den Vorgang, wenn Sie dazu aufgefordert werden.

gcloud

Verwenden Sie den Befehl gcloud dataplex aspect-types delete, um einen benutzerdefinierten Aspekttyp zu löschen.

C#

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

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for DeleteAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void DeleteAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        DeleteAspectTypeRequest request = new DeleteAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
            Etag = "",
        };
        // Make the request
        Operation<Empty, OperationMetadata> response = catalogServiceClient.DeleteAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Empty result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Empty, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceDeleteAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Empty retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


package main

import (
	"context"

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

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

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

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

Java

import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.DeleteAspectTypeRequest;
import com.google.protobuf.Empty;

public class SyncDeleteAspectType {

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

  public static void syncDeleteAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      DeleteAspectTypeRequest request =
          DeleteAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .setEtag("etag3123477")
              .build();
      catalogServiceClient.deleteAspectTypeAsync(request).get();
    }
  }
}

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_delete_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the delete_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#delete_aspect_type.
#
def delete_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

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

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

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

Verwenden Sie die Methode aspectTypes.delete, um einen vorhandenen benutzerdefinierten Aspekttyp zu löschen.

Aspekte verwalten und Metadaten anreichern Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Aspekte

Aspektkategorien

Datenaspekte

Aspekttypen

Kategorien von Aspekttypen

Benutzerdefinierte Aspekttypen

Systemaspekttypen

Hinweis

Erforderliche Rollen

API aktivieren

Benutzerdefinierten Aspekttyp erstellen

Console

gcloud

C#

C#

Go

Go

Java

Java

Python

Python

Ruby

Ruby

REST

Beispiel für die Verwendung der Felder „Datensatz-ID“ und „Datensatzverweis“

Eintrag Aspekte hinzufügen

Console

gcloud

C#

C#

Go

Go

Java

Java

Python

Python

Ruby

Ruby

REST

Aspekte wiederverwendbarer Systemaspekttypen anhängen

Kurzübersicht zur Datenqualität

gcloud

REST

Andere wiederverwendbare Aspekttypen

Eintrag-Link Aspekte hinzufügen

Aspekte für Eintragslinks erstellen

REST

Vorhandene Aspekte für einen Eintrag verwalten

Aspekt aktualisieren

Console

gcloud

C#

C#

Go

Go

Java

Java

Python

Python

Ruby

Ruby

REST

Aspekt löschen

Console

gcloud

C#

C#

Go

Go

Java

Java

Python

Python

Ruby

Ruby

REST

Vorhandene Aspekte für einen Einstiegslink verwalten

Aspekt aktualisieren

REST

Aspekte verwalten und Metadaten anreichern