Glossar für Unternehmen verwalten

Mit Unternehmensglossaren in Knowledge Catalog (früher Dataplex Universal Catalog) können Sie ein standardisiertes Vokabular für Ihre Daten-Assets in Ihrer Organisation erstellen. Sie können Kategorien und Begriffe erstellen und verwalten, um Unklarheiten zu reduzieren und die Datenerkennung und ‑governance zu verbessern. Wenn Sie zum ersten Mal ein Unternehmensglossar erstellen, lesen Sie die Kurzanleitung Unternehmensglossar erstellen und verwenden.

Anwendungsfälle für das Knowledge Catalog-Unternehmensglossar

Wenn Sie mit dem Unternehmensglossar von Knowledge Catalog eine gemeinsame Sprache für Daten erstellen, können Sie Folgendes erreichen:

• Definieren Sie eine klare Hierarchie von Unternehmenskategorien und ‑begriffen.
• Verknüpfen Sie Konzepte mithilfe von Synonymen und stellen Sie Beziehungen zwischen Begriffen her.
• Suchen Sie nach Datenressourcen basierend auf Geschäftskonzepten, nicht nur nach technischen Namen.

Das Unternehmensglossar von Knowledge Catalog hilft, die Datenerkennung zu optimieren und Unklarheiten zu reduzieren. Das führt zu einer besseren Governance, genaueren Analysen und schnelleren Erkenntnissen.

Elemente eines Unternehmensglossars

In diesem Abschnitt werden die wichtigsten Elemente beschrieben, mit denen Sie ein Unternehmensglossar strukturieren können.

Glossar

Ein Glossar hat die folgenden Eigenschaften:

• Überblick. Beschreibt den Zweck und den Inhalt des Unternehmensglossars. Sie können Bilder, Links und Tabellen hinzufügen. HTML-Formatierungen werden zwar nicht unterstützt, Sie können jedoch HTML-Code als Code formatiert einfügen oder einen Link zu einer HTML-Seite hinzufügen. Sie können auch Rich-Text-Formatierungsoptionen wie Fett, Kursiv, Unterstrichen, Aufzählungslisten, Absätze, Überschriften und Codeblöcke verwenden. Die maximal unterstützte Größe beträgt 120 KB.

• Beschreibung: Beschreibt das Glossar. Der Text in diesem Feld wird für die Suche indexiert. Die maximal unterstützte Größe beträgt 1 KB.

• Region Gibt die Region an, in der sich das Glossar befindet.

Kategorie

Mit einer Kategorie können Sie verschiedene Kategorien und Begriffe organisieren und strukturieren. Kategorien werden in einem Unternehmensglossar definiert. Sie können Kategorien bis zu drei Ebenen verschachteln.

Eine Kategorie hat die Eigenschaften eines Glossars sowie die folgenden Eigenschaften:

• Kontakte: Gibt die Person an, die für die Pflege der Kategorie verantwortlich ist. Diese Property ist beschreibend und hat keine Auswirkungen auf die Berechtigungen der Kategorie.
• Eltern. Gibt eine Beziehung an, die verwendet wird, um das übergeordnete Element der aktuellen Kategorie festzulegen. Sie können bis zu drei Kategorien verschachteln.

Die Region einer Kategorie ist dieselbe wie die Region des Glossars, in dem sie enthalten ist.

Begriff

Ein Begriff (Kurzform für „Glossarbegriff“) beschreibt ein Konzept, das in einem bestimmten Geschäftsbereich Ihres Unternehmens verwendet wird. Beispielsweise könnte die Marketingabteilung eines Unternehmens einen Begriff erstellen, der den Cost-per-Click beschreibt. Begriffe werden in einem Unternehmensglossar definiert, entweder direkt im Glossar oder in einer Kategorie im Glossar.

Ein Begriff hat die Eigenschaften einer Kategorie sowie die folgenden Eigenschaften:

• Synonyme Gibt Verknüpfungen zwischen Begriffen mit derselben Bedeutung an. Weitere Informationen finden Sie unter Synonymbegriffe.
• Ähnliche Begriffe. Gibt Verknüpfungen zwischen Begriffen an, die konzeptionell miteinander verwandt sind, aber unterschiedliche Bedeutungen haben. Siehe Verwandte Begriffe.
• Ähnliche Einträge. Gibt Links zwischen Begriffen und Daten-Assets oder zwischen Begriffen und Spalten in Daten-Assets an.
• Regeln für Datenqualität. Gibt Datenqualitätsanforderungen für den Begriff an. Weitere Informationen finden Sie unter Datenqualitätsregeln wiederverwenden.
• Kontakte: Gibt die Person an, die für die Pflege des Begriffs verantwortlich ist. Begriffe übernehmen nicht die Kontakte, die in Kategorien definiert sind.

Die Region eines Begriffs ist dieselbe wie die Region des Glossars, in dem er enthalten ist.

Synonyme Begriffe

Ein Synonym ist eine Beziehung, die die Äquivalenz zwischen zwei verschiedenen Begriffen angibt. Verwenden Sie Synonyme, wenn zwei Begriffe mit derselben Bedeutung von verschiedenen Teams in verschiedenen Glossaren definiert werden. Sie können beispielsweise ein Synonym erstellen, um die Begriffe „Gewinn“ und „Einnahmen“ zu verknüpfen.

Verwandte Begriffe

Ein verwandter Begriff ist eine Beziehung, die angibt, dass zwei Begriffe miteinander verknüpft sind, aber unterschiedliche Bedeutungen haben. Sie können beispielsweise einen verwandten Begriff erstellen, um die Begriffe „Umsatz“ und „Gewinn“ zu verknüpfen.

Beschränkungen

• Unternehmensglossare sind in Projekten und Standorten untergebracht. Für Glossare gelten die Einschränkungen für Projekte und Standorte.
• Wenn Sie ein Unternehmensglossar mit einem BigQuery-KI-Datenagenten verwenden, kann der KI-Datenagent maximal 10 Glossarbegriffe pro Tabelle importieren. Wenn Sie mehr als 10 Begriffe an eine Tabelle anhängen, ignoriert der KI-Datenagent die zusätzlichen Begriffe. Für eine optimale Leistung des KI-Datenagenten sollten Sie auch umfassende Beschreibungen auf Tabellen- und Spaltenebene für Ihre Tabellen bereitstellen.

Erforderliche Rollen

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

• Datenadministratoren erhalten vollständigen Zugriff auf Glossare, Kategorien, Begriffe, Synonyme und verwandte Begriffe und können IAM-Richtlinien festlegen: Dataplex Catalog Admin (roles/dataplex.catalogAdmin)
• Für Data Stewards oder Dateneigentümer, die Zugriff auf das Erstellen, Bearbeiten oder Löschen von Glossaren, Kategorien, Begriffen, Verknüpfungen zwischen Begriffen, Verknüpfungen zwischen Begriffen und Daten-Assets sowie die Suche benötigen: Dataplex Catalog Editor (roles/dataplex.catalogEditor)
• Für Datenanalysten oder Datennutzer, die Lesezugriff auf Glossare, Kategorien, Begriffe, Verknüpfungen zwischen Begriffen und zwischen Begriffen und Daten-Assets sowie die Suche benötigen: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)

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

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

Erforderliche Berechtigungen

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

• Unternehmensglossar, Kategorie und Begriffe in Ihrem Projekt erstellen, lesen, aktualisieren und löschen:
  • dataplex.glossaries.list
  • dataplex.glossaries.create
  • dataplex.glossaries.get
  • dataplex.glossaries.update
  • dataplex.glossaries.delete
  • dataplex.glossaryCategories.create
  • dataplex.glossaryCategories.list
  • dataplex.glossaryCategories.get
  • dataplex.glossaryCategories.update
  • dataplex.glossaryCategories.delete
  • dataplex.glossaryTerms.create
  • dataplex.glossaryTerms.list
  • dataplex.glossaryTerms.get
  • dataplex.glossaryTerms.update
  • dataplex.glossaryTerms.delete
• Synonym-Begriff-zu-Begriff-Verknüpfungen in Ihrem Projekt erstellen, suchen und löschen:
  • dataplex.entryLinks.create für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem einer der Glossarbegriffe vorhanden ist. Der Link wird in der Eintragsgruppe erstellt, für die die Berechtigung erteilt wurde.
  • dataplex.entryGroups.useSynonymEntryLink für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem einer der Glossarbegriffe vorhanden ist. Der Link wird in der Eintragsgruppe erstellt, für die die Berechtigung erteilt wurde.
  • dataplex.glossaryTerms.use für die Glossare, deren Begriffe verknüpft werden müssen.
  • dataplex.glossaryTerms.get für den Begriff, dessen Synonymlinks Sie suchen. Knowledge Catalog entfernt Synonyme in der Antwort, wenn Sie nicht die Berechtigung „dataplex.glossaryTerms.get“ für diese Begriffe haben.
  • dataplex.entryLinks.delete für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem der Link vorhanden ist.
• Erstellen, suchen und löschen Sie zugehörige Begriff-zu-Begriff-Verknüpfungen in Ihrem Projekt:
  • dataplex.entryLinks.create für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem einer der Glossarbegriffe vorhanden ist. Der Link wird in der Eintragsgruppe erstellt, für die die Berechtigung erteilt wurde.
  • dataplex.entryGroups.useRelatedEntryLink für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem einer der Glossarbegriffe vorhanden ist. Der Link wird in der Eintragsgruppe erstellt, für die die Berechtigung erteilt wurde.
  • dataplex.entries.link für die Knowledge Catalog-Eintragsgruppe in Projekten, in denen Einträge vorhanden sind, die Glossarbegriffen entsprechen.
  • dataplex.glossaryTerms.get für den Begriff, dessen weitere Informationen Sie abrufen möchten. Knowledge Catalog entfernt verwandte Begriffe in der Antwort, wenn Sie nicht die Berechtigung „dataplex.glossaryTerms.get“ für diese Begriffe haben.
  • dataplex.entryLinks.delete für die Knowledge Catalog-Eintragsgruppe in dem Projekt, in dem der Link vorhanden ist.
• Verknüpfungen zwischen Begriffen und Daten-Assets oder Spalten in Ihrem Projekt erstellen, suchen und löschen:
  • dataplex.entryLinks.create für die Systemeintragsgruppe, die den Daten-Assets oder Spalten im Projekt entspricht. Der Link wird in dem Projekt erstellt, für das die Berechtigung erteilt wurde.
  • dataplex.entryGroups.useDefinitionEntryLink für die System-Eintragsgruppe, die den Daten-Assets oder Spalten im Projekt entspricht. Die Verknüpfung wird in dem Projekt erstellt, für das die Berechtigung erteilt wurde.
  • dataplex.entries.link für die Systemeintragsgruppe, die den Daten-Assets oder Spalten im Projekt entspricht. Der Link wird in dem Projekt erstellt, für das die Berechtigung erteilt wurde.
  • dataplex.glossaryTerms.use für das Glossar, dessen Begriff verknüpft werden muss.
  • Leseberechtigung für das Quellsystem (z. B. bigquery.tables.get oder dataplex.glossaryTerms.get) für den Eintrag, dessen Links Sie suchen. Knowledge Catalog entfernt Daten-Assets in der Antwort, wenn Sie nicht die Leseberechtigung für das Quellsystem für diese Assets haben.
  • dataplex.entryLinks.delete für die Systemeintragsgruppe, in der der Link vorhanden ist.

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

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

Unternehmensglossare erstellen und verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie ein Unternehmensglossar erstellen, aufrufen, bearbeiten und löschen. Wenn Sie Unternehmensglossare, Kategorien oder Begriffe erstellen, müssen deren IDs den Richtlinien für die Benennung von Knowledge Catalog-Ressourcen entsprechen.

Hinweis: Das Anfordern von Metadatenänderungen an Unternehmensglossaren und Knowledge Catalog-Einträgen mit Governance-Workflows ist in der privaten Vorschau verfügbar. Wenn Sie Zugriff auf die Funktion anfordern möchten, füllen Sie das folgende Zugriffsformular aus.

Unternehmensglossar erstellen

Console

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

   Zu Glossaren

2. Klicken Sie auf Unternehmensglossar erstellen.

3. Geben Sie auf der Seite Unternehmensglossar erstellen einen Namen und einen Standort für das Unternehmensglossar an. Nachdem Sie das Glossar erstellt haben, können Sie den Speicherort nicht mehr ändern.

4. Klicken Sie auf Erstellen. Das Glossar wird im aktuellen Projekt erstellt.

5. Optional: Fügen Sie unter Beschreibung eine kurze Beschreibung (bis zu 1.024 Zeichen) oder unter Übersicht eine lange Beschreibung (bis zu 120 KB) hinzu.

C#

C#

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

Richten Sie zur Authentifizierung bei Knowledge Catalog 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 GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for CreateGlossary</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CreateGlossaryRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        CreateGlossaryRequest request = new CreateGlossaryRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            GlossaryId = "",
            Glossary = new Glossary(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<Glossary, OperationMetadata> response = businessGlossaryServiceClient.CreateGlossary(request);

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

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

Go

Go

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

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

//go:build examples

package main

import (
	"context"

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

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

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

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

Java

Java

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

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

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.CreateGlossaryRequest;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateGlossary {

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

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

Node.js

Node.js

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

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

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent resource where this Glossary will be created.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Required. Glossary ID: Glossary identifier.
 */
// const glossaryId = 'abc123'
/**
 *  Required. The Glossary to create.
 */
// const glossary = {}
/**
 *  Optional. Validates the request without actually creating the Glossary.
 *  Default: false.
 */
// const validateOnly = true

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

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

async function callCreateGlossary() {
  // Construct request
  const request = {
    parent,
    glossaryId,
    glossary,
  };

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

callCreateGlossary();

Python

Python

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

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

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


def sample_create_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.CreateGlossaryRequest(
        parent="parent_value",
        glossary_id="glossary_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

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

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

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Wenn Sie ein Glossar erstellen, erstellt Knowledge Catalog einen Eintrag, der das Glossar darstellt.

1. Erstellen Sie das Glossar.

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

   Ersetzen Sie Folgendes:

   • PROJECT_ID: die ID des Projekts, in dem Sie das Glossar erstellen möchten
   • LOCATION_ID: die ID des Standorts, an dem Sie das Glossar erstellen möchten
   • GLOSSARY_ID: die ID des Glossars
   • DISPLAY_NAME: der Anzeigename des Glossars
   • DESCRIPTION: die Beschreibung des Glossars, maximal 1.024 Zeichen

2. Optional: Fügen Sie dem Glossar eine Übersicht hinzu.

   1. Suchen Sie den Eintrag für Ihr Glossar:

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

      Ersetzen Sie PROJECT_NUMBER durch die Nummer des Projekts, in dem Ihr Glossar erstellt wird.

   2. So fügen Sie Ihrem Glossar eine Übersicht hinzu:

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

      Ersetzen Sie OVERVIEW durch Nur-Text oder HTML, um die Glossarkategorie oder den Begriff zu beschreiben.

Verfügbare Glossare ansehen

Console

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

  Zu Glossaren

  Im Bereich Meine Glossare werden alle Glossare der Organisation angezeigt, für die Sie die Berechtigung zum Ansehen haben, zusammen mit ihren Beschreibungen und Zeitstempeln der letzten Änderung.

C#

C#

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

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

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

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

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

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

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

Go

Go

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

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

//go:build examples

package main

import (
	"context"

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

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

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

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

Java

Java

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

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

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.ListGlossariesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListGlossaries {

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

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

Node.js

Node.js

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

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

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

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

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

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

  // Run request
  const iterable = dataplexClient.listGlossariesAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListGlossaries();

Python

Python

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

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

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


def sample_list_glossaries():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

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

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

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

Ruby

Ruby

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

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

require "google/cloud/dataplex/v1"

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

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

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

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

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

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

Glossar bearbeiten

Sie können den Namen und die Beschreibung eines Glossars bearbeiten.

Console

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

   Zu Glossaren

2. Klicken Sie auf das Glossar, das Sie bearbeiten möchten.

3. Klicken Sie neben dem Namen, der Beschreibung oder der Übersicht auf Bearbeiten und nehmen Sie die gewünschten Änderungen vor.

4. Klicken Sie auf Speichern.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Glossar löschen

Bevor Sie ein Glossar löschen können, müssen Sie zuerst alle Kategorien und Begriffe im Glossar löschen.

Console

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

   Zu Glossaren

2. Klicken Sie auf das Glossar, das Sie löschen möchten.

3. Klicken Sie auf Löschen und bestätigen Sie den Löschvorgang, wenn Sie dazu aufgefordert werden.

C#

C#

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

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

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

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

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

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

Go

Go

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

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

//go:build examples

package main

import (
	"context"

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

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

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

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

Java

Java

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

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

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.DeleteGlossaryRequest;
import com.google.cloud.dataplex.v1.GlossaryName;
import com.google.protobuf.Empty;

public class SyncDeleteGlossary {

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

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

Node.js

Node.js

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

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

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The name of the Glossary to delete.
 *  Format:
 *  projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 */
// const name = 'abc123'
/**
 *  Optional. The etag of the Glossary.
 *  If this is provided, it must match the server's etag.
 *  If the etag is provided and does not match the server-computed etag,
 *  the request must fail with a ABORTED error code.
 */
// const etag = 'abc123'

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

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

async function callDeleteGlossary() {
  // Construct request
  const request = {
    name,
  };

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

callDeleteGlossary();

Python

Python

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

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

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


def sample_delete_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

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

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

require "google/cloud/dataplex/v1"

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

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

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

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

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID

Kategorien erstellen und verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Kategorien erstellen, ansehen, aktualisieren und löschen.

Kategorie in einem Glossar erstellen

Ein Unternehmensglossar kann maximal 200 Kategorien enthalten.

Console

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

   Zu Glossaren

2. Wählen Sie das Glossar aus, in dem Sie eine Kategorie erstellen möchten, und klicken Sie dann auf Kategorie erstellen.

3. Geben Sie einen Namen für die Kategorie ein.

4. Klicken Sie auf Erstellen.

5. Optional: Fügen Sie unter Beschreibung eine kurze Beschreibung (bis zu 1.024 Zeichen) oder unter Übersicht eine lange Beschreibung (bis zu 120 KB) hinzu.

REST

Wenn Sie eine Kategorie erstellen, erstellt Knowledge Catalog einen Eintrag, der die Kategorie darstellt.

1. Erstellen Sie die Kategorie.

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

   Ersetzen Sie Folgendes:

   • CATEGORY_ID: die Kategorie-ID
   • CATEGORY_DISPLAY_NAME: der Anzeigename der Kategorie
   • CATEGORY_DESCRIPTION: die Kategoriebeschreibung

2. Optional: Fügen Sie der Kategorie eine Übersicht hinzu.

   1. Suchen Sie nach dem Eintrag für Ihre Kategorie:

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

   2. Fügen Sie Ihrer Kategorie eine Übersicht hinzu:

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

      Ersetzen Sie OVERVIEW durch Nur-Text oder HTML, um die Glossarkategorie oder den Begriff zu beschreiben.

3. Optional: Kontakte hinzufügen

   1. Suchen Sie nach dem Eintrag für Ihre Kategorie:

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

   2. Aktualisieren Sie den Eintrag für Ihre Kategorie mit Kontakten:

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

Verschachtelte Kategorie erstellen

Ein Unternehmensglossar kann maximal drei verschachtelte Kategorieebenen haben, ausgenommen die Stammglossarebene.

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar, in dem Sie eine Kategorie erstellen möchten.

3. Wählen Sie die übergeordnete Kategorie aus, in der Sie eine weitere Kategorie erstellen möchten, und klicken Sie auf Kategorie erstellen.

4. Geben Sie einen Namen für die Kategorie ein.

5. Klicken Sie auf Erstellen.

6. Optional: Fügen Sie unter Beschreibung eine kurze Beschreibung (bis zu 1.024 Zeichen) oder unter Übersicht eine lange Beschreibung (bis zu 120 KB) hinzu.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
  "displayName": "CATEGORY_DISPLAY_NAME",
  "description": "CATEGORY_DESCRIPTION",
  "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

Ersetzen Sie PARENT_CATEGORY_ID durch die ID der übergeordneten Kategorie.

Kategorien ansehen, die zu einem Glossar gehören

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar, um die Kategorien darin aufzurufen.

3. Wenn Sie die verschachtelten Kategorien in einer Kategorie aufrufen möchten, maximieren Sie die Kategorie.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories

Kategorie bearbeiten

Sie können den Namen, die Beschreibung und die Kontakte für eine Kategorie bearbeiten. Bei verschachtelten Kategorien können Sie auch die übergeordnete Kategorie bearbeiten.

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf die Kategorie, die Sie bearbeiten möchten.

3. Klicken Sie neben dem Namen, der Beschreibung oder der Übersicht auf Bearbeiten und nehmen Sie die gewünschten Änderungen vor.

4. Klicken Sie auf Speichern.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Kategorie löschen

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf die Kategorie, die Sie löschen möchten.

3. Klicken Sie auf Löschen und bestätigen Sie den Löschvorgang, wenn Sie dazu aufgefordert werden.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID

Begriffe erstellen und verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Begriffe erstellen, ansehen, aufrufen, bearbeiten und löschen.

Begriff in einem Unternehmensglossar erstellen

Ein Unternehmensglossar kann maximal 5.000 Begriffe enthalten.

Console

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

   Zu Glossaren

2. Wenn Sie einen Begriff auf Glossarebene erstellen möchten, wählen Sie das Glossar aus, in dem Sie einen Begriff erstellen möchten, und klicken Sie dann auf Begriff erstellen.

3. Geben Sie einen Namen für den Begriff ein.

4. Klicken Sie auf Erstellen.

5. Optional: Fügen Sie unter Beschreibung eine kurze Beschreibung (bis zu 1.024 Zeichen) oder unter Übersicht eine lange Beschreibung (bis zu 120 KB) hinzu.

6. Optional: Wenn Sie Kontakte hinzufügen möchten, klicken Sie auf Bearbeiten und geben Sie eine Liste mit E-Mail-Adressen für die Data Stewards, Dateninhaber oder Datendomaininhaber an. Klicken Sie dann auf Speichern.

REST

Wenn Sie einen Begriff erstellen, erstellt Knowledge Catalog einen Eintrag, der den Begriff darstellt.

1. Erstellen Sie den Begriff.

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

   Ersetzen Sie Folgendes:

   • TERM_ID: die ID des Begriffs, den Sie erstellen
   • TERM_DISPLAY_NAME: der Anzeigename für den Begriff, den Sie erstellen
   • TERM_DESCRIPTION: die Beschreibung des Begriffs, den Sie erstellen

2. Optional: Fügen Sie dem Begriff eine Übersicht hinzu.

   1. Suchen Sie den Eintrag für Ihren Begriff:

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

   2. Fügen Sie Ihrem Begriff eine Übersicht hinzu:

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

      Ersetzen Sie OVERVIEW durch Nur-Text oder HTML, um die Glossarkategorie oder den Begriff zu beschreiben.

3. Optional: Fügen Sie Kontakte hinzu.

   1. Suchen Sie den Eintrag für Ihren Begriff:

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

   2. Aktualisieren Sie den Eintrag für Ihren Begriff mit Kontakten:

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

Begriff unter einer Kategorie erstellen

Console

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

   Zu Glossaren

2. Wenn Sie einen Begriff in einer Kategorie erstellen möchten, wählen Sie die Kategorie aus, in der Sie einen Begriff erstellen möchten, und klicken Sie dann auf Begriff hinzufügen.

3. Geben Sie einen Namen für den Begriff ein.

4. Klicken Sie auf Erstellen.

5. Optional: Fügen Sie unter Beschreibung eine kurze Beschreibung (bis zu 1.024 Zeichen) oder unter Übersicht eine lange Beschreibung (bis zu 120 KB) hinzu.

6. Optional: Wenn Sie Kontakte hinzufügen möchten, klicken Sie auf Bearbeiten und geben Sie eine Liste mit E-Mail-Adressen für die Data Stewards, Dateninhaber oder Datendomaininhaber an. Klicken Sie dann auf Speichern.

REST

Wenn Sie einen Begriff erstellen, erstellt Knowledge Catalog einen Eintrag, der den Begriff darstellt.

1. Erstellen Sie einen Begriff.

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

   Ersetzen Sie Folgendes:

   • TERM_ID: die ID des Begriffs, den Sie erstellen
   • TERM_DISPLAY_NAME: der Anzeigename für den Begriff, den Sie erstellen
   • TERM_DESCRIPTION: die Beschreibung des Begriffs, den Sie erstellen

2. Optional: Fügen Sie dem Begriff eine Übersicht hinzu.

   1. Suchen Sie den Eintrag für Ihren Begriff:

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

   2. Fügen Sie Ihrem Begriff eine Übersicht hinzu:

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

      Ersetzen Sie OVERVIEW durch Nur-Text oder HTML, um die Glossarkategorie oder den Begriff zu beschreiben.

3. Optional: Fügen Sie Kontakte hinzu.

   1. Suchen Sie den Eintrag für Ihren Begriff:

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

   2. Aktualisieren Sie den Eintrag für Ihren Begriff mit Kontakten:

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

Aspekt einem Begriff hinzufügen

Sie können Begriffen Aspekte hinzufügen, um zusätzlichen Kontext oder Metadaten bereitzustellen.

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, dem Sie einen Aspekt hinzufügen möchten.

3. Klicken Sie im Abschnitt Aspekte auf Hinzufügen.

4. Suchen Sie nach dem Aspekt, geben Sie Details für den Aspekt an und klicken Sie dann auf Speichern.

REST

Glossarbegriffe sind Einträge. Wenn Sie einen Aspekt anhängen möchten, patchen Sie die Eintragsressource. Die Eintragsgruppe für Glossare ist @dataplex.

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
{
 "aspects": {
   "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
     "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
     "data": {
       "sensitivity": "HIGH",
       "data_owner": "[e-mail]"
     }
   }
 }
}
EOF

Ersetzen Sie Folgendes:

• PROJECT_NUMBER: die Nummer des Projekts, das den Glossarbegriff enthält.
• LOCATION_ID: Der Speicherort des Glossarbegriffs.
• GLOSSARY_ID: die ID des Glossars, das den Begriff enthält.
• TERM_ID: die ID des Begriffs, dem der Aspekt zugewiesen werden soll.
• ASPECT_PROJECT_ID: die ID des Projekts, das den Aspekttyp enthält.
• ASPECT_LOCATION_ID: der Standort des Aspekttyps.
• ASPECT_TYPE_ID: die ID des Aspekttyps.

Begriffe in einem Glossar oder einer Kategorie ansehen

Console

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

   Zu Glossaren

2. Wenn Sie die Begriffe in einem Glossar aufrufen möchten, maximieren Sie das Glossar. Wenn Sie die Begriffe einer Kategorie in diesem Glossar aufrufen möchten, maximieren Sie die Kategorie. Wenn Sie Begriffe in einer verschachtelten Kategorie aufrufen möchten, maximieren Sie die verschachtelte Kategorie.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms

Details eines Begriffs ansehen

Console

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

   Zu Glossaren

2. Wenn Sie die Liste der Begriffe in einem Glossar aufrufen möchten, maximieren Sie das Glossar.

3. Klicken Sie auf einen Begriff. Auf der Seite Begriffsdetails werden der Name des Begriffs, die Beschreibung, verwandte Begriffe, Synonyme und verwandte Einträge angezeigt.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

Begriff bearbeiten

Sie können den Namen, die Beschreibung, die Übersicht, die Kontakte und das übergeordnete Element für einen Begriff bearbeiten.

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, den Sie bearbeiten möchten.

3. Klicken Sie auf Bearbeiten.

4. Bearbeiten Sie die gewünschten Felder und klicken Sie auf Speichern.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=displayName,description --data @- << EOF
{
  "displayName": "TERM_DISPLAY_NAME",
  "description": "TERM_DESCRIPTION"
}
EOF

Begriff löschen

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, den Sie löschen möchten.

3. Klicken Sie auf Löschen und bestätigen Sie den Löschvorgang, wenn Sie dazu aufgefordert werden.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

Synonyme und verwandte Begriffe verwalten

Sie können Beziehungen zwischen Begriffen hinzufügen, indem Sie sie als Synonyme oder verwandte Begriffe verknüpfen.

Begriffsbeziehungen sind bidirektional. Wenn Sie beispielsweise profit als Synonym für earnings verknüpfen, wird earnings auch zu einem Synonym für profit.

Synonymverknüpfungen zwischen Begriffen erstellen

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, für den Sie Links erstellen möchten.

3. Klicken Sie neben Synonymbegriffe auf Bearbeiten.

4. Suchen Sie nach den Begriffen, die Sie verknüpfen möchten, und wählen Sie sie aus.

   Der Begriff wird sofort verknüpft, wenn Sie ihn auswählen.

5. Klicken Sie auf Schließen.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

Ersetzen Sie Folgendes:

• TERM1_PROJECT_NUMBER: die Projektnummer für den ersten Begriff, der verknüpft wird.
• TERM1_LOCATION_ID: die Standort-ID des Glossars, das den ersten Begriff enthält.
• TERM1_GLOSSARY_ID: die ID des Glossars, das den ersten Begriff enthält.
• TERM1_ID: die ID des ersten Begriffs.
• TERM2_PROJECT_NUMBER: die Projektnummer für den zweiten Begriff, den Sie als Synonym verknüpfen möchten. Wenn sich beide Begriffe im selben Projekt befinden, entspricht dieser Wert der Projektnummer für den ersten Begriff.
• TERM2_LOCATION_ID: die Standort-ID des Glossars, das den zweiten Begriff enthält. Wenn sich beide Begriffe am selben Ort befinden, entspricht dieser Wert der Standort-ID für den ersten Begriff.
• TERM2_GLOSSARY_ID: die ID des Glossars, das den zweiten Begriff enthält. Wenn sich beide Begriffe im selben Glossar befinden, ist dieser Wert mit der Glossar-ID für den ersten Begriff identisch.
• TERM2_ID: die ID des zweiten Begriffs.
• ENTRY_LINK_ID: eine ID für die Verknüpfung zwischen den beiden Begriffen. Jeder Begriff wird als Knowledge Catalog-Eintrag dargestellt. Der Eintragslink ist die Beziehung zwischen Synonymbegriffen.

Verwandte Links zwischen Begriffen erstellen

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, für den Sie Links erstellen möchten.

3. Klicken Sie neben Verwandte Begriffe auf Bearbeiten.

4. Suchen Sie nach den Begriffen, die Sie verknüpfen möchten, und wählen Sie sie aus.

   Der Begriff wird sofort verknüpft, wenn Sie ihn auswählen.

5. Klicken Sie auf Schließen.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/related",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

Ersetzen Sie Folgendes:

• TERM1_PROJECT_NUMBER: die Projektnummer für den ersten Begriff, der verknüpft wird.
• TERM1_LOCATION_ID: die Standort-ID des Glossars, das den ersten Begriff enthält.
• TERM1_GLOSSARY_ID: die ID des Glossars, das den ersten Begriff enthält.
• TERM1_ID: die ID des ersten Begriffs.
• TERM2_PROJECT_NUMBER: die Projektnummer für den zweiten Begriff, den Sie als verwandten Begriff verknüpfen möchten. Wenn sich beide Begriffe im selben Projekt befinden, entspricht dieser Wert der Projektnummer für den ersten Begriff.
• TERM2_LOCATION_ID: die Standort-ID des Glossars, das den zweiten Begriff enthält. Wenn sich beide Begriffe am selben Ort befinden, entspricht dieser Wert der Standort-ID für den ersten Begriff.
• TERM2_GLOSSARY_ID: die ID des Glossars, das den zweiten Begriff enthält. Wenn sich beide Begriffe im selben Glossar befinden, ist dieser Wert mit der Glossar-ID für den ersten Begriff identisch.
• TERM2_ID: die ID des zweiten Begriffs.
• ENTRY_LINK_ID: eine ID für die Verknüpfung zwischen den beiden Begriffen. Jeder Begriff wird als Knowledge Catalog-Eintrag dargestellt. Der Eintragslink ist die Beziehung zwischen verwandten Begriffen.

Synonymlinks für einen Begriff suchen

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/SYNONYM_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/synonym&page_size=10

Ersetzen Sie Folgendes:

• TERM_PROJECT_ID: die Projekt-ID des Begriffs, dessen Synonymlinks Sie suchen.
• TERM_PROJECT_NUMBER: die Projektnummer des Begriffs, dessen Synonymlinks Sie abrufen möchten.
• SYNONYM_LINKS_LOCATION_ID: die Standort-ID, unter der Sie die Synonymverknüpfungen suchen.
• TERM_LOCATION_ID: die Standort-ID des Begriffs.
• TERM_GLOSSARY_ID: Die ID des Glossars, das den Begriff enthält.
• TERM_ID: die ID des Begriffs.

Hinweis: Wenn Sie nachfolgende Seiten abrufen möchten, hängen Sie &page_token=PAGE_TOKEN an die Anfrage an. Ersetzen Sie PAGE_TOKEN durch den Wert des Seitentokens, das Sie in der vorherigen lookupEntryLinks-Antwort erhalten haben.

Verwandte Links für einen Begriff suchen

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/RELATED_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/related&page_size=10

Ersetzen Sie Folgendes:

• TERM_PROJECT_ID: die Projekt-ID des Begriffs, dessen zugehörige Links Sie suchen.
• TERM_PROJECT_NUMBER: die Projektnummer des Begriffs, dessen zugehörige Links Sie suchen.
• RELATED_LINKS_LOCATION_ID: die Standort-ID, unter der Sie die zugehörigen Links suchen.
• TERM_LOCATION_ID: die Standort-ID des Begriffs.
• TERM_GLOSSARY_ID: Die ID des Glossars, das den Begriff enthält.
• TERM_ID: die ID des Begriffs.

Hinweis: Wenn Sie nachfolgende Seiten abrufen möchten, hängen Sie &page_token=PAGE_TOKEN an die Anfrage an. Ersetzen Sie PAGE_TOKEN durch den Wert des Seitentokens, das Sie in der vorherigen lookupEntryLinks-Antwort erhalten haben.

Verknüpfungen zwischen Synonymen und verwandten Begriffen entfernen

Console

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

   Zu Glossaren

2. Maximieren Sie das Glossar und klicken Sie auf den Begriff, dessen Synonyme oder verwandte Begriffe Sie entfernen möchten.

3. Wenn Sie Verknüpfungen zwischen verwandten Begriffen löschen möchten, klicken Sie neben Verwandte Begriffe auf Bearbeiten. Löschen Sie die zugehörigen Begriffe und klicken Sie dann auf Schließen.

4. Wenn Sie Verknüpfungen zwischen Synonymen löschen möchten, klicken Sie neben Synonymbegriffe auf Bearbeiten. Löschen Sie die Synonyme und klicken Sie dann auf Schließen.

REST

1. Suchen Sie nach Eintragslinks, um die Verknüpfungs-ID des Links zu finden, den Sie löschen möchten. Weitere Informationen finden Sie unter Synonymlinks für einen Begriff suchen oder Verwandte Links für einen Begriff suchen.

2. Löschen Sie die Verknüpfung, indem Sie die folgende DELETE-Anfrage senden:

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

Verknüpfungen zwischen Begriffen und Daten-Assets verwalten

Sie können Begriffe an Daten-Assets oder Daten-Asset-Spalten anhängen. Sie können beispielsweise Begriffe an BigQuery-Datasets und Iceberg REST Catalog-Tabellen anhängen.

Begriffe an ein Daten-Asset anhängen

Console

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

   Zur Suche

2. Suchen Sie nach dem Daten-Asset (z. B. einem Dataset, einer Datei oder einer Tabelle), mit dem Sie einen Begriff verknüpfen möchten, und klicken Sie darauf.

3. Führen Sie auf der Seite des Daten-Assets einen der folgenden Schritte aus:

   • Wenn Sie Begriffe mit einem Asset verknüpfen möchten, klicken Sie auf dem Tab Details im Abschnitt Glossarbegriffe auf Hinzufügen. Suchen Sie nach den Begriffen, wählen Sie sie aus und klicken Sie dann auf Schließen.
   • Wenn das Asset ein Schema hat, können Sie Begriffe mit einer Spalte verknüpfen. Wählen Sie auf dem Tab Schema eine Spalte aus, mit der Sie Begriffe verknüpfen möchten, und klicken Sie dann auf Geschäftlichen Begriff hinzufügen. Suchen Sie nach den Begriffen, wählen Sie sie aus und klicken Sie dann auf Schließen.

Python

from google.cloud import dataplex_v1

def attach_term_to_asset(
    project_id: str,
    location: str,
    entry_group_id: str,
    entry_link_id: str,
    source_entry_name: str,
    target_term_name: str,
) -> dataplex_v1.EntryLink:
    """Creates an entry link attaching a glossary term to a data asset."""
    client = dataplex_v1.CatalogServiceClient()
    parent_group = (
        f"projects/{project_id}/locations/{location}/"
        f"entryGroups/{entry_group_id}"
    )

    entry_link = dataplex_v1.EntryLink(
        entry_link_type=(
            "projects/dataplex-types/locations/global/"
            "entryLinkTypes/definition"
        ),
        entry_references=[
            dataplex_v1.EntryLink.EntryReference(
                name=source_entry_name, type_="SOURCE"
            ),
            dataplex_v1.EntryLink.EntryReference(
                name=target_term_name, type_="TARGET"
            ),
        ],
    )

    return client.create_entry_link(
        parent=parent_group,
        entry_link_id=entry_link_id,
        entry_link=entry_link,
    )

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
  "entry_references": [{
     "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
     "type": "SOURCE"
  }, {
     "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
     "type": "TARGET"
  }
  ]
}
EOF
)"

Ersetzen Sie Folgendes:

• PROJECT_NUMBER: die Projektnummer des Daten-Assets, mit dem verknüpft wird
• ENTRY_LOCATION_ID: die Standort-ID des Daten-Assets, mit dem verknüpft wird
• ENTRY_GROUP_ID: die Eintraggruppe des Daten-Assets, mit dem verknüpft wird
• ENTRY_LINK_ID: eine ID für die Verknüpfung zwischen dem Begriff und dem Knowledge Catalog-Eintrag, der das Daten-Asset darstellt.
• TERM_PROJECT_NUMBER: die Projektnummer für den verknüpften Begriff.

Begriffe an eine Spalte in einem Eintragsschema anhängen

Console

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

   Zur Suche

2. Suchen Sie nach dem Daten-Asset (z. B. einem Dataset, einer Datei oder einer Tabelle), das ein Schema mit einer Spalte enthält, mit der Sie einen Begriff verknüpfen möchten. Klicken Sie auf das Daten-Asset.

3. Führen Sie auf der Seite des Daten-Assets einen der folgenden Schritte aus:

   • Wenn Sie Begriffe mit einer Spalte im Daten-Asset verknüpfen möchten, wählen Sie auf dem Tab Schema die Spalten aus, an die Sie den Begriff anhängen möchten.
   • Klicken Sie auf Unternehmensbegriff hinzufügen. Suchen Sie nach dem Begriff, den Sie anhängen möchten, und klicken Sie darauf.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
 "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
 "entry_references": [
   {
     "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
     "path": "Schema.COLUMN_NAME",
     "type": "SOURCE"
   },
   {
     "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
     "type": "TARGET"
   }
 ]
}
EOF
)"

Ersetzen Sie Folgendes:

• PROJECT_NUMBER: die Projektnummer des Daten-Assets, mit dem verknüpft wird
• ENTRY_LOCATION_ID: die Standort-ID des Daten-Assets, mit dem verknüpft wird
• ENTRY_GROUP_ID: die Eintraggruppe des Daten-Assets, mit dem verknüpft wird
• ENTRY_LINK_ID: eine ID für die Verknüpfung zwischen dem Begriff und dem Knowledge Catalog-Eintrag, der das Daten-Asset darstellt
• TERM_PROJECT_NUMBER: die Projektnummer für den verknüpften Begriff
• COLUMN_NAME: die Spalte, an die Sie den Begriff anhängen möchten

Begriff an mehrere Daten-Assets oder Spalten anhängen

Sie können einen einzelnen Glossarbegriff gleichzeitig an mehrere Daten-Assets oder Spalten anhängen. Sie können in einem einzelnen Vorgang bis zu 20 Ressourcen oder Spalten auswählen.

Console

So hängen Sie einen Begriff an mehrere Ressourcen an:

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

   Zu Glossaren

2. Maximieren Sie in der Liste Glossare das Glossar, das den Begriff enthält, den Sie verknüpfen möchten.

3. Klicken Sie auf den Begriff.

4. Klicken Sie im Abschnitt Zugehörige Einträge auf Hinzufügen.

5. Führen Sie im Dialogfeld Zugehörige Einträge anhängen die folgenden Schritte aus:

   1. Suchen Sie die Ressourcen oder Spalten, die Sie verknüpfen möchten. Wenn Sie die Suchergebnisse eingrenzen möchten, verwenden Sie Filter, um nach Ressourcenname, Ressourcentyp oder Spaltenname zu suchen.

      Wenn Sie beispielsweise eine Spalte mit dem Namen sample-column in einer BigQuery-Tabelle mit dem Namen sample-table in einem Projekt mit der ID sample-project suchen möchten, verwenden Sie die folgende Abfrage:

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

      Sie können Teilstrings eingeben, um übereinstimmende Assets zu finden.

   2. Wählen Sie die Daten-Assets und Spalten aus, die Sie anhängen möchten.

   3. Wenn Sie Ihre Auswahl vor dem Hinzufügen prüfen möchten, klicken Sie auf die Ein-/Aus-Schaltfläche Ausgewählte Ressourcen anzeigen.

   4. Klicken Sie auf Hinzufügen.

6. Wenn Sie die neu angehängten Ressourcen und Spalten prüfen möchten, rufen Sie den Abschnitt Zugehörige Einträge auf der Detailseite des Begriffs auf.

Mit einem Begriff verknüpfte Daten-Assets suchen

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM_PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=TARGET&page_size=10

Ersetzen Sie Folgendes:

• TERM_PROJECT_ID: die Projekt-ID des Begriffs, dessen Definitionslinks Sie suchen.
• TERM_PROJECT_NUMBER: die Projektnummer des Begriffs, dessen Definitionslinks Sie suchen.
• DEFINITION_LINKS_LOCATION_ID: die Standort-ID, unter der Sie die Definitionslinks suchen.
• TERM_LOCATION_ID: die Standort-ID des Begriffs.
• TERM_GLOSSARY_ID: Die ID des Glossars, das den Begriff enthält.
• TERM_ID: die ID des Begriffs.

Hinweis: Mit dem Begriff verknüpfte Spalten werden im Feld path zurückgegeben.

Wenn Sie nachfolgende Seiten abrufen möchten, hängen Sie &page_token=PAGE_TOKEN an die Anfrage an. Ersetzen Sie PAGE_TOKEN durch den Wert des Seitentokens, das Sie aus der vorherigen lookupEntryLinks-Antwort erhalten haben.

Mit einem Daten-Asset verknüpfte Begriffe suchen

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=SOURCE&page_size=10

Ersetzen Sie Folgendes:

• PROJECT_ID: die Projekt-ID des Daten-Assets, dessen Definitionslinks Sie abrufen möchten.
• PROJECT_NUMBER: die Projektnummer des Daten-Assets, dessen Definitionslinks Sie abrufen möchten.
• DEFINITION_LINKS_LOCATION_ID: die Standort-ID, unter der Sie die Definitionslinks suchen.
• ENTRY_LOCATION_ID: die Standort-ID des Daten-Assets.
• ENTRY_GROUP_ID: die ID der Eintraggruppe für das Daten-Asset.
• ENTRY_ID: die ID des Daten-Assets.

Hinweis: Spalten, die mit dem Begriff innerhalb eines Daten-Assets verknüpft sind, werden im Feld path zurückgegeben.

Wenn Sie nachfolgende Seiten abrufen möchten, hängen Sie &page_token=PAGE_TOKEN an die Anfrage an. Ersetzen Sie PAGE_TOKEN durch den Wert des Seitentokens, das Sie aus der vorherigen lookupEntryLinks-Antwort erhalten haben.

Begriffe aus einem Daten-Asset entfernen

Console

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

   Zur Suche

2. Suchen Sie nach dem Daten-Asset (z. B. einem Dataset, einer Datei oder einer Tabelle), aus dem Sie die Begriffe entfernen möchten, und klicken Sie darauf.

3. Führen Sie auf der Seite des Daten-Assets einen der folgenden Schritte aus:

   • Wenn Sie einen Begriff aus einem Asset entfernen möchten, klicken Sie auf dem Tab Details im Abschnitt Glossarbegriffe auf den Begriff. Klicken Sie dann auf .
   • Wenn Sie einen Begriff aus einer Spalte entfernen möchten, klicken Sie auf dem Tab Schema neben dem Begriff auf .

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/ENTRY_PROJECT_ID/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

Glossare, Begriffe und verknüpfte Daten-Assets finden

Console

Wenn Sie durch die Inhalte Ihres Unternehmensglossars navigieren möchten, verwenden Sie die Baumstruktur für Glossare und Begriffe auf der Seite Glossare.

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

   Zu Glossaren

2. Verwenden Sie auf der Seite Glossare die Filterleiste, um Kategorien zu finden. Folgende Filter sind verfügbar:

   • Name: Gibt die Glossare, Kategorien und Begriffe zurück, deren Name den von Ihnen angegebenen Text enthält.
   • Übergeordnetes Element: Gibt die Begriffe zurück, deren übergeordneter Glossarname oder deren Beschreibung mit dem von Ihnen angegebenen Text übereinstimmt. Beispiel: parent:Finance gibt die Begriffe zurück, die mit dem übergeordneten Glossar verknüpft sind, dessen Name oder Beschreibung die Wortgruppe Finance enthält.
   • Synonym: Gibt die Liste der Begriffe mit einem Synonym zurück, dessen Name oder ID den von Ihnen angegebenen Text enthält. Beispiel: synonym:Profit gibt die Begriffe zurück, die einen Synonymbegriff haben, dessen Name oder ID die Wortgruppe profit enthält.
   • Kontakt: Gibt die Begriffe zurück, bei denen der Data Steward als Kontakt aufgeführt ist. Beispiel: contact:[e-mail] gibt die Einträge zurück, die mit Begriffen mit einem Data Steward verbunden sind, der mit [e-mail] übereinstimmt.

REST

Wenn Sie Glossare, Begriffe und verknüpfte Daten-Assets mithilfe der REST API finden möchten, müssen Sie sich für die Vorschau registrieren.

Nach Daten-Assets suchen, die mit Begriffen verknüpft sind

Console

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

   Zu Glossaren

2. Geben Sie auf der Seite Glossare in der Filterleiste eine Freitext-Suchanfrage ein. Dadurch wird eine Liste der entsprechenden Übereinstimmungen in den Glossar-, Kategorie- und Begriffsnamen zurückgegeben.

3. Klicken Sie auf einen übereinstimmenden Begriff.

4. Auf der Seite Begriffsdetails finden Sie die verknüpften Begriffe (Synonyme und verwandte Begriffe) und die verknüpften Einträge (Daten-Assets) für diesen Begriff.

5. Wenn Sie die Details für einen Eintrag in Knowledge Catalog aufrufen möchten, klicken Sie auf den Eintrag.

REST

Wenn Sie Glossare, Begriffe und verknüpfte Daten-Assets mithilfe der REST API finden möchten, müssen Sie sich für die Vorschau registrieren.

Glossare und Verknüpfungen zwischen Begriffen und Begriffen oder Daten-Assets importieren

Wenn Sie Glossare und Links aus einem anderen Katalogisierungstool importieren oder Ihre Glossare in Knowledge Catalog aktualisieren möchten, können Sie Glossare, Kategorien, Begriffe, Links zwischen Begriffen, Links zwischen Begriffen und Daten-Assets oder Spalten mithilfe der REST API im Bulk importieren.

1. Erstellen Sie das Zielglossar.

   REST

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

   Ersetzen Sie Folgendes:

   • PROJECT_ID: die Projekt-ID, in der Sie das Glossar erstellen
   • LOCATION_ID: der Standort, an dem das Glossar erstellt werden soll
   • GLOSSARY_ID: die Glossar-ID
   • DISPLAY_NAME: der Anzeigename des Glossars
   • DESCRIPTION: die Beschreibung des Glossars

2. Wenn Sie Kategorien, Begriffe und Verknüpfungen zwischen Begriffen und Daten-Assets in das erstellte Zielglossar importieren möchten, laden Sie für jeden dieser Bereiche Dateien in einen Cloud Storage-Bucket hoch. Diese Dateien haben das folgende Format:

   • Beispielformat für Begriffe und Kategorien eines Glossars

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

   • Beispielformat für Links zwischen Begriffen

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

   • Beispielformat für Links zwischen Begriffen und Daten-Assets

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

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

   Ersetzen Sie DATAPLEX_API durch den Dataplex API-Endpunkt im Format dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

3. Optional: Status des Vorgangs abrufen.

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

   Ersetzen Sie OPERATION_ID durch die ID des Vorgangs.

4. Optional: Rufen Sie den Status des Metadatenjobs ab.

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

5. Importieren Sie Verknüpfungen zwischen Begriffen als Synonyme oder verwandte Begriffe.

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

   Ersetzen Sie DATAPLEX_API durch dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

6. Links zwischen Begriffen und Daten-Assets oder Spalten importieren.

   Wenn Sie eine Verknüpfung zwischen Glossarbegriffen und Daten-Assets erstellen möchten, führen Sie den Importjob für jede Eintragsgruppe aus, zu der der Eintrag für das Daten-Asset gehört. Alle Links zu Definitionseinträgen werden in dieser Eintragsgruppe erstellt.

   Hinweis: Die Importdatei im Cloud Storage-Bucket muss eine Datei für Links in einer Eintraggruppe enthalten. Wenn Sie eine Verknüpfung zwischen einem Begriff und einem Eintrag für das Daten-Asset in einer anderen Eintragsgruppe erstellen möchten, stellen Sie eine neue Datei im Cloud Storage-Bucket bereit.

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

   Ersetzen Sie DATAPLEX_API durch dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

Preise

Ab Juli 2025 wird das Knowledge Catalog-Unternehmensglossar zu den gleichen Preisen wie der Metadatenspeicher abgerechnet. Weitere Informationen finden Sie unter Preise für den Metadatenspeicher von Knowledge Catalog.

Nächste Schritte

• Grundlegenden Datenkontext einrichten