Gérer les aspects et enrichir les métadonnées

Les métadonnées sont essentielles pour organiser et comprendre vos composants de données, ainsi que les relations entre eux. Par exemple, les secteurs réglementés doivent protéger les informations permettant d'identifier personnellement l'utilisateur (PII) comme les noms, les adresses et les pièces d'identité officielles. Ces données peuvent se produire dans de nombreuses instances de systèmes de données distribués. Knowledge Catalog (anciennement Dataplex Universal Catalog) vous aide à découvrir et à cataloguer rapidement vos composants de données distribués. Vous pouvez ensuite classer les données comme étant des informations permettant d'identifier personnellement l'utilisateur.

En enrichissant les entrées de données et les liens d'entrée avec un contexte pertinent, vous pouvez rendre vos données plus faciles à découvrir et plus utiles. Knowledge Catalog fournit du contexte grâce aux types d'aspects et aux aspects :

• Type d'aspect : modèle JSON définissant les données associées. Par exemple, pour les informations de conformité, vous pouvez avoir une classification des informations permettant d'identifier personnellement l'utilisateur et la conformité au RGPD.
• Aspect : instance d'un type d'aspect. Par exemple, {"pii_classification": "confidential", "gdpr_compliant": true}. Vous pouvez appliquer un aspect à une table entière, à une colonne de table individuelle ou à un lien d'entrée.

Une fois les données classifiées, vous pouvez leur appliquer des règles de qualité des données ou d'accès.

Pour en savoir plus, consultez À propos des métadonnées dans Knowledge Catalog.

Conseil : Si vous utilisez les métadonnées Knowledge Catalog pour la première fois, envisagez de suivre les guides de démarrage rapide suivants : [Ajouter des métadonnées à une table BigQuery](/knowledge-catalog/docs/add-metadata-quickstart) ou [Créer et utiliser un glossaire d'entreprise](/knowledge-catalog/docs/quickstart-business-glossary).

Que sont les types d'aspects ?

Les types d'aspect sont des ressources réutilisables qui fournissent des modèles pour les aspects. Lorsque vous créez un type d'aspect personnalisé, vous devez spécifier un ID conforme aux Consignes de dénomination des ressources Knowledge Catalog.

Catégories de types d'aspects

Les types d'aspects sont classés en types d'aspects personnalisés et système :

Types d'aspects personnalisés

Les types d'aspects que vous créez dans Knowledge Catalog sont appelés types d'aspects personnalisés.

Remarque : Les types d'aspects personnalisés s'appliquent aux entrées, mais pas aux liens vers les entrées.

Remarque : Limite de récupération du contexte Gemini : Gemini dans BigQuery fonde la génération de code SQL et le raisonnement sur les données sur les définitions de schéma standards, les contraintes de table et les champs de description de table/colonne. Les types d'aspects personnalisés définis par l'utilisateur dans Knowledge Catalog sont stockés dans le plan du catalogue pour la gouvernance, la recherche et la récupération d'API, mais ne sont pas injectés de manière dynamique dans le pipeline de récupération des invites contextuelles de Gemini. Bonne pratique recommandée : Pour vous assurer que la logique métier, le contexte sémantique ou les notes du développeur sont visibles par Gemini dans BigQuery, documentez-les directement dans les champs [description de la table](/bigquery/docs/managing-tables#updating_a_tables_description) et [description de la colonne](/bigquery/docs/managing-table-schemas#change-column-description), dans l'[aspect overview standard](#other-reusable-aspect-types) ou en utilisant les [termes du glossaire d'entreprise](/knowledge-catalog/docs/manage-glossaries). Pour en savoir plus, consultez [Utiliser Knowledge Catalog avec BigQuery](/bigquery/docs/use-knowledge-catalog).

Les types d'aspects personnalisés peuvent être globaux ou régionaux :

• Types d'aspects globaux : peuvent être utilisés pour créer des aspects pour les entrées de n'importe quelle région. Choisissez un type d'aspect global si vous devez appliquer la même structure aux entrées de plusieurs régions, car vous n'avez besoin de la définir qu'une seule fois. Étant donné que la définition d'un type d'aspect global est répliquée dans toutes les régions, cette option peut ne pas convenir si le schéma de type d'aspect lui-même contient des informations sensibles ou si une résidence stricte des données est requise pour tous les composants de métadonnées.
• Types d'aspect régionaux : ne peuvent être utilisés que pour créer des aspects pour les entrées qui se trouvent dans la même région que le type d'aspect. Par exemple, un type d'aspect créé dans us-central1 ne peut être utilisé qu'avec des entrées dans us-central1. Choisissez un emplacement régional si un type d'aspect n'est pertinent que pour les entrées d'une région spécifique ou pour vous assurer que la définition du type d'aspect réside dans la région sélectionnée, ce qui peut vous aider à répondre aux exigences de souveraineté et de conformité des données. Si vous utilisez des types d'aspects régionaux, mais que vous avez besoin de la même structure dans plusieurs régions, vous devez créer et gérer des définitions de types d'aspects distinctes dans chaque région.

Vous pouvez créer des types d'aspect personnalisés dans une zone géographique spécifique (par exemple, us-central1) ou en tant que ressource global. L'emplacement d'un type d'aspect a une incidence sur le champ d'application et détermine les entrées avec lesquelles il peut être utilisé.

Pour en savoir plus, consultez Contraintes liées au projet et à la zone géographique.

Types d'aspects système

Les types d'aspects fournis, utilisés et gérés par Knowledge Catalog sont appelés types d'aspects système. Les types d'aspect système sont toujours globaux et peuvent donc être utilisés dans n'importe quelle région. Les types d'aspects système sont stockés dans un projet géré par Google portant le numéro de projet 655216118709. Exemple : projects/655216118709/locations/global/aspectTypes/schema.

Chaque type d'aspect, type d'entrée et type de lien d'entrée définis par le système possède ses propres autorisations IAM. Pour en savoir plus, consultez Autorisations IAM pour les types d'aspects, d'entrées et de liens d'entrées système.

Les types d'aspects système sont classés en deux catégories : réutilisables et limités. Le tableau suivant décrit les catégories de types d'aspect système et la liste des types d'aspect que Knowledge Catalog fournit pour chacune des catégories :

Catégorie du type d'aspect système	Description	Types d'aspects fournis par Knowledge Catalog
Type d'aspect système réutilisable	Vous pouvez utiliser ces types d'aspect pour créer ou modifier des aspects.	contacts data-profile data-quality-scorecard generic graph-profile guidelines overview schema-join schema storage usage
Type d'aspect système restreint	Knowledge Catalog gère ces types d'aspects. Vous pouvez lire les aspects de ces types d'aspects, mais vous ne pouvez pas les créer ni les modifier.	y compris, mais sans s'y limiter : analytics-hub aspecttype-aspect bigquery-dataset bigquery-table cloudsql-database cloudsql-instance cloudsql-table entrygroup-aspect entrytype-aspect sensitive-data-protection-profile storage-bucket storage-folder

Que sont les aspects ?

Les aspects vous permettent de capturer les métadonnées dans les entrées ou les liens d'entrée pour fournir un contexte pertinent. Vous pouvez utiliser des aspects pour stocker les types de métadonnées suivants :

• Métadonnées métier : informations qui fournissent un contexte métier, comme la classification des données.

• Métadonnées techniques : détails techniques des entrées ou des liens d'entrée, y compris les éléments suivants :

  • Pour les entrées : détails sur l'élément de données lui-même, par exemple son schéma.
  • Pour les liens d'entrée : détails sur la relation entre les composants de données, par exemple les détails de la jointure.

• Métadonnées dérivées des données : informations générées à partir des données elles-mêmes, comme les statistiques d'une table BigQuery.

Les aspects sont des composants de la ressource d'entrée parente plutôt que des ressources autonomes distinctes. La modification d'un aspect met à jour l'entrée qui le contient. Pour suivre ces modifications, vous pouvez vous abonner aux flux de modifications des métadonnées.

Emplacement des aspects et niveaux cibles

Chaque aspect est une instance d'un modèle de type d'aspect, qui définit les champs que vous devez renseigner. L'emplacement où vous pouvez appliquer un aspect et le nombre de fois qu'il peut apparaître dépendent du type de ressource cible :

Ressource cible	Niveaux acceptés	Limites de cardinalité
Entrées	Au niveau de l'entrée ou de la colonne	Un aspect maximum par type d'aspect au niveau de l'entrée. Plusieurs aspects par type d'aspect sont autorisés dans différentes colonnes.
Liens d'entrée	Au niveau de l'association uniquement	Un seul aspect par type d'aspect et par lien.

Remarque : Vous ne pouvez pas créer ni utiliser d'aspects si le type d'aspect parent et l'entrée cible (ou le lien d'entrée) appartiennent à des organisations Google Cloud différentes.

Catégories d'aspects

Les aspects sont classés en aspects obligatoires et aspects facultatifs :

Aspects requis

Les aspects requis sont ceux qui sont obligatoires lors de la création d'une entrée ou d'un lien d'entrée. Ces aspects sont définis par le type d'entrée ou le type de lien d'entrée. Toutes les ressources appartenant à un type spécifique doivent toujours comporter tous les aspects requis définis par ce type.

Knowledge Catalog gère les aspects requis (par exemple, le schéma) pour les entrées système.

Veuillez noter les points suivants :

• Vous ne pouvez associer les aspects requis qu'aux entrées, et non à leurs colonnes.

• Vous ne pouvez pas supprimer les aspects requis d'une entrée ou d'un lien vers une entrée.

• Vous pouvez lire les aspects requis des entrées système, mais vous ne pouvez pas les modifier.

• Les aspects de données ne peuvent pas être des aspects requis.

Aspects facultatifs

Vous pouvez associer des aspects facultatifs à des entrées ou à des colonnes d'entrée. Vous pouvez renseigner les aspects facultatifs au moment de la création de l'entrée ou ultérieurement en la modifiant.

Veuillez noter les points suivants :

• Vous pouvez supprimer les aspects facultatifs une fois qu'ils ont été renseignés.

• Les liens d'entrée ne sont compatibles qu'avec les aspects requis.

Aspects des données

Certains aspects contiennent des informations dérivées des données sous-jacentes d'une entrée, plutôt que des métadonnées sur l'entrée. C'est ce qu'on appelle les aspects des données. Par exemple, les résultats d'une analyse de profilage des données ou d'une analyse de la qualité des données contiennent des statistiques dérivées des données elles-mêmes et sont donc classés comme des aspects de données.

Voici les types d'aspect système qui sont des aspects de données :

• data-profile : contient les résultats d'une analyse de profilage des données. Pour en savoir plus, consultez À propos du profilage de données.
• data-quality-scorecard : contient un récapitulatif des scores de qualité des données.
• data-rules : associez des règles de qualité des données à une entrée.
• data-quality-rule-template : définit un modèle de règle de qualité des données réutilisable.

Avant de commencer

Avant de créer et de gérer des types d'aspects et des aspects, effectuez les tâches décrites dans cette section.

Rôles requis

Pour obtenir les autorisations nécessaires pour créer et gérer des types d'aspects et des aspects, demandez à votre administrateur de vous accorder les rôles IAM suivants sur la ressource :

• Ensemble complet d'autorisations sur les ressources de métadonnées dans Knowledge Catalog, y compris les types d'aspects et les aspects de données : Administrateur Dataplex Catalog (roles/dataplex.catalogAdmin)
• Créer et gérer des ressources de métadonnées dans Knowledge Catalog, y compris les types d'aspects et les aspects de données : Éditeur de catalogue Dataplex (roles/dataplex.catalogEditor)
• Ensemble complet d'autorisations sur les types d'aspects personnalisés (à l'exception des autorisations permettant d'utiliser les types d'aspects pour créer ou modifier des entrées) : Propriétaire du type d'aspect Dataplex (roles/dataplex.aspectTypeOwner)
• Afficher les types d'aspects et les règles IAM associées : Lecteur de catalogue Dataplex (roles/dataplex.catalogViewer)
• Utiliser des types d'aspect pour créer et modifier des entrées avec les aspects correspondants : Utilisateur du type d'aspect Dataplex (roles/dataplex.aspectTypeUser)
• Ajouter des aspects de certains types d'aspects système, tels que schema, schema-join, overview, contacts : Propriétaire des entrées et des liens d'entrée Dataplex (roles/dataplex.entryOwner)

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Pour en savoir plus, consultez Rôles IAM Knowledge Catalog.

Activer l'API

Activez l'API Dataplex dans votre projet Knowledge Catalog. Si vous utilisez un nouveau projet Google Cloud ou un projet dans lequel l'API BigQuery est activée, l'API Dataplex est activée par défaut.

Activer l'API

Créer un type d'aspect personnalisé

Console

1. Dans la console Google Cloud , accédez à la page Types de métadonnées de Knowledge Catalog.

   Accéder à "Types de métadonnées"

2. Cliquez sur l'onglet Types d'aspects > Personnalisé.

3. Cliquez sur Créer un type d'aspect.

4. Dans la fenêtre Créer un type d'aspect, saisissez les informations suivantes :

   1. Facultatif : Dans le champ Nom à afficher, saisissez un nom pour le type d'aspect.
   2. Dans le champ ID du type d'aspect, saisissez un identifiant unique pour le type d'aspect.
   3. Facultatif : Dans le champ Description, saisissez une description du type d'aspect.
   4. Dans le champ Emplacement, sélectionnez un emplacement pour le type d'aspect. Vous ne pouvez pas modifier l'emplacement d'un type d'aspect après l'avoir créé. Pour comprendre l'impact du choix d'un emplacement global par rapport à un emplacement régional, consultez la section Types d'aspects personnalisés.

5. Facultatif : définissez un modèle pour votre type d'aspect.

   Dans la section Modèle, cliquez sur Ajouter un champ. Dans la section Nouveau champ, saisissez les informations suivantes :

   1. Dans le champ Nom, saisissez un nom.
   2. Facultatif : Dans le champ Nom à afficher, saisissez un nom à afficher.
   3. Facultatif : Dans le champ Description, saisissez une description.

   4. Dans le champ Type, sélectionnez un type de données pour le champ. En fonction de votre sélection, l'ensemble suivant de champs et d'options s'affiche :

      • Si vous avez sélectionné Texte comme type de données, procédez comme suit :

        1. Dans le champ Type de texte, sélectionnez le type de texte.
        2. Dans le champ Valeurs de texte, fournissez un indice pour le champ de texte. Pour ce faire, cliquez sur Ajouter une valeur et saisissez l'indice. Vous pouvez ajouter plusieurs suggestions pour un champ de texte.
        3. Cliquez sur OK.

      • Si vous avez sélectionné Enum comme type de données, ajoutez une valeur enum :

        1. Cliquez sur Ajouter une valeur enum.
        2. Dans le champ Valeur, saisissez une valeur d'énumération. Vous pouvez ajouter plusieurs valeurs enum.
        3. Cliquez sur OK.

      • Si vous avez sélectionné Tableau comme type de données, dans la section Élément de tableau, définissez les types d'éléments à inclure dans le tableau :

        1. Cliquez sur Ajouter un élément de tableau.
        2. Dans le champ Nom, saisissez un nom pour les éléments du tableau.
        3. Facultatif : Dans le champ Nom à afficher, saisissez un nom à afficher pour les éléments du tableau.
        4. Facultatif : Dans le champ Description, saisissez une description des éléments du tableau.

        5. Dans le champ Type, sélectionnez un type de données pour les éléments du tableau.

           En fonction de votre sélection, l'ensemble suivant de champs et d'options s'affiche. Elles sont semblables aux options décrites pour les types de données Text, Enum, Map, Array et Record ailleurs dans cette section.

        6. Cliquez sur OK.

      • Si vous avez sélectionné Map (Carte) comme type de données, dans la section Map value (Valeur de la carte), définissez les types de valeurs à inclure dans la carte :

        1. Cliquez sur Ajouter une valeur de carte.
        2. Dans le champ Nom, saisissez un nom pour la carte.
        3. Facultatif : Dans le champ Nom à afficher, saisissez un nom à afficher pour la carte.
        4. Facultatif : Dans le champ Description, saisissez une description de la carte.

        5. Dans le champ Type, sélectionnez un type de données pour la carte.

           En fonction de votre sélection, l'ensemble suivant de champs et d'options s'affiche. Elles sont semblables aux options décrites pour les types de données Text, Enum, Map, Array et Record ailleurs dans cette section.

        6. Cliquez sur OK.

      • Si vous avez sélectionné Enregistrement comme type de données, saisissez les informations suivantes :

        1. Dans le champ ID de l'enregistrement, saisissez un identifiant unique que les autres champs d'enregistrement pourront utiliser pour faire référence à cet enregistrement. Consultez la section Exemple d'utilisation des champs "ID d'enregistrement" et "Référence d'enregistrement" de ce document.
        2. Facultatif : Si vous souhaitez ajouter une référence à un autre enregistrement à partir de ce modèle, utilisez le champ Référence d'enregistrement. Vous ne pouvez pas modifier ce paramètre après avoir créé le type d'aspect. Consultez la section Exemple d'utilisation des champs "ID de l'enregistrement" et "Référence de l'enregistrement" de ce document.

        3. Dans la section Champs d'enregistrement, vous pouvez définir un objet complexe avec plusieurs champs imbriqués. Pour ce faire, cliquez sur Ajouter un élément de champ d'enregistrement, puis spécifiez les éléments suivants :

        4. Dans le champ Nom, saisissez un nom pour le champ d'enregistrement.

        5. Facultatif : Dans le champ Nom à afficher, saisissez un nom à afficher pour le champ d'enregistrement.

        6. Facultatif : Dans le champ Description, saisissez une description pour le champ d'enregistrement.

        7. Dans le champ Type, sélectionnez un type de données.

           En fonction de votre sélection, l'ensemble de champs et d'options suivant s'affiche. Elles sont semblables aux options décrites précédemment dans cette section pour les types de données Text, Enum, Map, Array et Record.

        8. Cliquez sur OK.

   5. Pour rendre le champ obligatoire pour un aspect de ce type, sélectionnez Obligatoire. Pour en savoir plus sur les aspects obligatoires et facultatifs, consultez la section Catégories d'aspects de ce document.

   6. Cliquez sur OK.

   7. Pour ajouter plusieurs champs, cliquez sur Ajouter un champ et répétez les étapes précédentes.

6. Facultatif : Dans la section Libellés, ajoutez des libellés arbitraires sous forme de paires clé/valeur à vos ressources :

   1. Cliquez sur Ajouter une étiquette.
   2. Dans le champ Clé, saisissez une clé.
   3. Dans le champ Valeur, saisissez une valeur pour la clé.
   4. Pour ajouter d'autres libellés, cliquez sur Ajouter un libellé et répétez la procédure.

7. Cliquez sur Enregistrer.

gcloud

Pour créer un type d'aspect personnalisé, utilisez la commande gcloud dataplex aspect-types create.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncCreateAspectType {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType, of the form:
 *  projects/{project_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Required. AspectType identifier.
 */
// const aspectTypeId = 'abc123'
/**
 *  Required. AspectType Resource.
 */
// const aspectType = {}
/**
 *  Optional. The service validates the request without performing any
 *  mutations. The default is false.
 */
// const validateOnly = true

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

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

async function callCreateAspectType() {
  // Construct request
  const request = {
    parent,
    aspectTypeId,
    aspectType,
  };

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

callCreateAspectType();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour créer un type d'aspect personnalisé, utilisez la méthode aspectType.create.

Une fois que vous avez créé un type d'aspect personnalisé, vous pouvez ajouter des aspects aux entrées.

Exemple d'utilisation des champs "ID d'enregistrement" et "Référence d'enregistrement"

Vous pouvez utiliser les champs ID de l'enregistrement et Référence de l'enregistrement pour les références récursives. L'exemple suivant montre comment utiliser ces champs :

Prenons l'exemple d'un type d'aspect appelé Employee, avec les champs suivants :

• Nom (type : Text)
• Date de début (type : Date & time)
• Désignation (type : Text)
• Adresse actuelle (type : Record)
• Adresse permanente (type : Record)

Les deux champs d'adresse Adresse actuelle et Adresse permanente sont du même type de données Record. Pour éviter les doublons, vous pouvez définir les valeurs ID de l'enregistrement et Référence de l'enregistrement lorsque vous définissez ces champs.

Lorsque vous définissez le champ Adresse actuelle, vous pouvez spécifier ID de l'enregistrement comme address-field. Pour Adresse permanente, vous pouvez spécifier la même valeur (address-field) pour Référence de l'enregistrement. Exemple :

• Nom (type : Text)
• Date de début (type : Date & time)
• Désignation (type : Text)
• Adresse actuelle (type : Record, ID d'enregistrement : address-field)
• Adresse permanente (type : Record, référence de l'enregistrement : address-field)

Ainsi, vous n'avez pas besoin de dupliquer les champs d'une autre adresse.

Ajouter des aspects à une entrée

Une fois que vous avez créé un type d'aspect personnalisé, vous pouvez créer des aspects de ce type. Pour ajouter des aspects à une entrée, vous devez mettre à jour l'entrée, car les aspects sont stockés dans les entrées.

Veuillez noter les points suivants :

• Vous pouvez ajouter des aspects à une entrée ou aux colonnes d'une entrée.
• Vous ne pouvez modifier les aspects requis que pour les entrées personnalisées. Vous ne pouvez pas supprimer les aspects requis.
• Vous pouvez modifier et supprimer les aspects facultatifs pour les entrées personnalisées et système.

Remarque : Lorsque vous utilisez une instruction CREATE OR REPLACE TABLE pour remplacer une table BigQuery, les métadonnées (y compris les aspects) associées à la table d'origine ne sont pas appliquées à la nouvelle table. Si vous souhaitez que les métadonnées soient conservées, vous pouvez créer une vue BigQuery pour la table et y ajouter les métadonnées.

Console

1. Dans la console Google Cloud , accédez à la page Rechercher de Knowledge Catalog.

   Accéder à la recherche

2. Recherchez l'entrée à laquelle vous souhaitez ajouter des aspects, puis cliquez dessus. La page des détails de l'entrée s'ouvre.

3. Pour ajouter des aspects à l'entrée, procédez comme suit :

   1. Cliquez sur l'onglet Détails.
   2. Pour ajouter des aspects obligatoires ou facultatifs à l'entrée, dans la section Aspects, cliquez sur Ajouter pour la catégorie correspondante.
      Vous ne pouvez pas ajouter d'aspects requis si le type d'entrée de l'entrée sélectionnée n'en a aucun.
      
   3. Recherchez et sélectionnez l'aspect que vous souhaitez ajouter.
   4. Dans la fenêtre Ajouter un aspect, saisissez les valeurs des champs.

   5. Cliquez sur Enregistrer.

   6. Pour ajouter des aspects à une colonne de l'entrée, procédez comme suit :

   7. Sur la page d'informations sur l'entrée, cliquez sur l'onglet Schéma.

   8. Sélectionnez les colonnes auxquelles vous souhaitez ajouter des aspects.

   9. Cliquez sur Ajouter un aspect.

   10. Recherchez et sélectionnez l'aspect que vous souhaitez ajouter.

   11. Dans la fenêtre Ajouter un aspect, saisissez les valeurs des champs.

   12. Cliquez sur Enregistrer.

gcloud

Pour ajouter des aspects à une entrée ou à une colonne d'une entrée, utilisez la commande gcloud dataplex entries update.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Pour ajouter des aspects à l'objet d'entrée, consultez Aspects.

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Pour ajouter des aspects à l'objet d'entrée, consultez Entrée.

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class UpdateEntry {

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

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

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

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

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

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

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


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

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

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

Pour ajouter des aspects à l'objet d'entrée, consultez #required_aspects=.

REST

Pour ajouter des aspects à une entrée ou à une colonne d'une entrée, utilisez la méthode entry.patch.

La création et l'utilisation d'aspects dans une entrée où le type d'aspect respectif et l'entrée se trouvent dans des organisations Google Cloud différentes ne sont pas acceptées.

Associer des aspects de types d'aspect système réutilisables

Vous pouvez associer des aspects de types d'aspect système réutilisables à des entrées.

Vous pouvez modifier un aspect d'un type d'aspect réutilisable dans la console Google Cloud en fonction de sa structure. Les types d'aspects contenant des champs imbriqués ne peuvent pas être modifiés dans la console Google Cloud . Vous devez utiliser l'outil de ligne de commande gcloud ou l'API REST pour associer ou mettre à jour les aspects de ce type.

Fiche d'évaluation sur la qualité des données

Une fiche d'évaluation de la qualité des données est un élément qui fournit un récapitulatif de la qualité des données, souvent basé sur des analyses de la qualité des données ou d'autres processus. Vous pouvez associer un tableau de données sur la qualité des données à une entrée pour fournir des informations personnalisées sur la qualité des données. Pour ce faire, associez un aspect du type data-quality-scorecard défini par le système.

Le champ data de l'aspect data-quality-scorecard peut inclure les champs suivants :

• job : facultatif. Enregistrement contenant des informations sur le job qui a généré le tableau de données.

  • name : nom de ressource du job de qualité des données.

  • runTime : durée d'exécution du job de qualité des données.

• score : facultatif. Niveau de qualité global des données. Le score est compris entre 0 et 100.

• status : valeur obligatoire. État de la fiche d'évaluation de la qualité des données, indiquant si elle a réussi ou échoué au seuil de qualité (PASS ou FAIL).

• dimensions : facultatif. Tableau de résultats de dimension. Chaque résultat inclut les éléments suivants :

  • name : nom de la dimension. Il peut s'agir de ACCURACY, COMPLETENESS, CONSISTENCY, FRESHNESS, UNIQUENESS, VALIDITY ou VOLUME, ou du nom d'une dimension personnalisée. Les noms de dimensions personnalisées doivent être en majuscules et ne pas dépasser 30 caractères.

  • score : score global au niveau de la dimension, compris entre 0 et 100.

  • status : état de la dimension, indiquant si elle a dépassé ou non le seuil de qualité (PASS ou FAIL).

• columns : facultatif. Tableau de résultats de colonnes. Chaque résultat inclut les éléments suivants :

  • name : nom de la colonne.

  • score : score global au niveau de la colonne, compris entre [0, 100].

  • status : état de la colonne, indiquant si elle a atteint ou non le seuil de qualité (PASS ou FAIL).

  • dimensions : tableau des scores de dimension pour la colonne. Chaque score de dimension inclut les éléments suivants :

    • name : nom de la dimension.

    • score : score de la dimension, compris entre 0 et 100.

    • status : état de la dimension pour la colonne, indiquant si elle a atteint ou non le seuil de qualité (PASS ou FAIL).

Lorsque vous exécutez la commande pour associer un aspect, elle remplace toutes les données existantes pour cet aspect spécifique. Par exemple, si vous mettez à jour une fiche d'évaluation dont le score est de 80 avec un nouveau fichier indiquant un score de 90, le score 80 est écrasé. Il ne fusionne pas les données.

Pour associer un tableau de données sur la qualité des données, procédez comme suit :

gcloud

Pour mettre à jour les aspects d'une entrée, utilisez la commande gcloud dataplex entries update-aspects.

1. Créez un fichier JSON (dq-aspect.json) avec le contenu suivant.

   Remarque : La clé de la carte d'aspect suit le format dataplex-types.global.<ASPECT-TYPE>.

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

2. Exécutez la commande suivante :

     gcloud dataplex entries update-aspects ENTRY_ID
     --location=LOCATION
     --entry-group=ENTRY_GROUP_ID
     --project=PROJECT_ID
     --aspects=dq-aspect.json
   

   Remplacez les variables suivantes :

   • ENTRY_ID : ID de l'entrée, par exemple example-entry
   • LOCATION : emplacement de l'entrée (par exemple, us-central1)
   • ENTRY_GROUP_ID : ID du groupe d'entrées, par exemple example-entry-group
   • PROJECT_ID : ID du projet, par exemple example-project

REST

Pour mettre à jour les aspects d'une entrée, utilisez la méthode entry.patch.

1. Créez un fichier nommé payload.json et collez-y le contenu JSON de votre requête.

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

2. Exécutez la commande suivante dans votre terminal :

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

   Remplacez les éléments suivants :

   • PROJECT_ID : ID du projet, par exemple example-project
   • LOCATION : emplacement de l'entrée (par exemple, us-central1)
   • ENTRY_GROUP_ID : ID du groupe d'entrées, par exemple example-entry-group
   • ENTRY_ID : ID de l'entrée, par exemple example-entry

Autres types d'aspect réutilisables

Les types d'aspect système suivants sont également disponibles. Vous pouvez les joindre à l'aide des mêmes méthodes gcloud ou d'API REST que celles indiquées pour le tableau de données sur la qualité des données. Pour les types d'aspects sans champs imbriqués, par exemple generic, vous pouvez utiliser la console.

• Contacts. Utilisez le type d'aspect contacts pour attribuer la propriété ou la gestion. Les champs incluent les suivants :

  • identities (tableau) : liste de contacts. Chaque contact inclut les informations suivantes :
    • role (chaîne) : rôle du contact (par exemple, owner, steward, producer ou admin).
    • name (chaîne) : nom du contact.
    • id (chaîne) : adresse e-mail ou ID du contact.

  Créez le fichier payload.json comme suit :

   {
     "aspects": {
       "dataplex-types.global.contacts": {
         "data": {
           "identities": [
             {
               "role": "steward",
               "name": "Jane Doe",
               "id": "[e-mail]"
             }
           ]
         }
       }
     }
   }
  

• Profil de données. Utilisez le type d'aspect data-profile pour capturer les résultats du profilage des données. Pour en savoir plus, consultez À propos du profilage de données.

  Les champs incluent les suivants :

  • sourceDataInfo (enregistrement) : informations sur les données sources analysées pour générer le profil.
    • scope (énumération) : champ d'application du profil (PREVIEW, SAMPLED ou ALL). La valeur PREVIEW correspond aux résultats d'une analyse de profilage léger.
    • scannedRows (int) : nombre de lignes analysées.
    • samplingPercentage (double) : pourcentage d'échantillonnage utilisé.
  • fields (map) : carte des noms de colonnes et de leurs profils de données, y compris des métriques telles que les valeurs uniqueness, nullness et topN, ainsi que des statistiques spécifiques au type pour les colonnes numeric, string, datetime et array.

  Créez le fichier payload.json comme suit :

   {
     "aspects": {
       "dataplex-types.global.data-profile": {
         "data": {
           "sourceDataInfo": {
           "scope": "ALL",
           "scannedRows": 100
         },
         "fields": {
           "col1": {
             "nullness": 0.0,
             "uniqueness": 0.1,
        "string": {
          "length": {
            "min": 1,
            "max": 20,
            "avg": 12.54
          }
        }
           }
         }
       }
     }
   }}
  

• Générique Utilisez le type d'aspect generic pour les informations d'entrée génériques. Les champs incluent les suivants :

  • type (chaîne) : champ de texte libre permettant de stocker un type spécifié par l'utilisateur.
  • system (chaîne) : système de l'entrée personnalisée.

  Créez le fichier payload.json comme suit :

  {
    "aspects": {
      "dataplex-types.global.generic": {
        "data": {
          "type": "custom-type",
          "system": "custom-system"
        }
      }
    }
  }
  

• Présentation. Utilisez le type d'aspect overview pour fournir une description en texte enrichi. Les champs incluent les suivants :

  • content (chaîne) : aperçu de l'entrée, compatible avec le format HTML.
  • links (tableau) : liste des liens vers le système source. Chaque lien inclut les éléments suivants :
    • url (chaîne) : URL du lien.
    • title (chaîne) : titre du lien.

  Créez le fichier payload.json comme suit :

  {
    "aspects": {
      "dataplex-types.global.overview": {
        "data": {
          "content": "This is a <b>rich text</b> description.",
        "links": [
          {
            "url": "https://example.com",
            "title": "Example Link"
          }
        ]
      }
    }
  }}
  

• Schema. Utilisez le type d'aspect schema pour décrire la structure des données.

  • fields (tableau) : liste des champs de schéma. Les champs incluent les suivants :
    • name (chaîne) : nom du champ.
    • dataType (chaîne) : type de données du champ.
    • metadataType (enum) : type de métadonnées (par exemple, STRING, BOOLEAN).
    • mode (énumération) : mode du champ (NULLABLE, REQUIRED, REPEATED).
    • description (chaîne) : description du champ.

  Créez le fichier payload.json comme suit :

  {
    "aspects": {
      "dataplex-types.global.schema": {
        "data": {
          "fields": [
          {
            "name": "id",
            "dataType": "string",
            "metadataType": "STRING",
            "mode": "REQUIRED"
          }
        ]
      }
    }
  }}
  

• Utilisation Utilisez le type d'aspect usage pour suivre les métriques d'utilisation. Les champs incluent les suivants :

  • metrics (tableau) : liste des métriques d'utilisation. Chaque métrique inclut les éléments suivants :
    • name (chaîne) : nom de la métrique (par exemple, views, reads).
    • timeSeries (tableau) : liste de données de séries temporelles. Chaque élément inclut les données suivantes :
      • interval (chaîne) : intervalle d'agrégation (par exemple, 30d).
      • value (entier) : valeur agrégée.
  • refreshTime (datetime) : heure de la dernière actualisation des métriques.

  Créez le fichier payload.json comme suit :

  {
    "aspects": {
      "dataplex-types.global.usage": {
        "data": {
          "metrics": [
          {
            "name": "views",
            "timeSeries": [
              {
                "interval": "30d",
                "value": 100
              }
            ]
          }
        ],
        "refreshTime": "2025-01-01T12:00:00Z"
      }
    }
  }}
  

Créer un lien d'entrée

Vous pouvez établir une relation entre deux entrées en créant un lien d'entrée.

Une liaison d'entrée peut être symétrique, comme un synonym, ou asymétrique, comme un definition.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CreateEntryLink</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 CreateEntryLinkRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CreateEntryLinkRequest request = new CreateEntryLinkRequest
        {
            ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
            EntryLinkId = "",
            EntryLink = new EntryLink(),
        };
        // Make the request
        EntryLink response = catalogServiceClient.CreateEntryLink(request);
    }
}

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.CreateEntryLinkRequest;
import com.google.cloud.dataplex.v1.EntryGroupName;
import com.google.cloud.dataplex.v1.EntryLink;

public class SyncCreateEntryLink {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the parent Entry Group:
 *  `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
 */
// const parent = 'abc123'
/**
 *  Required. Entry Link identifier
 *  * Must contain only lowercase letters, numbers and hyphens.
 *  * Must start with a letter.
 *  * Must be between 1-63 characters.
 *  * Must end with a number or a letter.
 *  * Must be unique within the EntryGroup.
 */
// const entryLinkId = 'abc123'
/**
 *  Required. Entry Link resource.
 */
// const entryLink = {}

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

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

async function callCreateEntryLink() {
  // Construct request
  const request = {
    parent,
    entryLinkId,
    entryLink,
  };

  // Run request
  const response = await dataplexClient.createEntryLink(request);
  console.log(response);
}

callCreateEntryLink();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

    # Initialize request argument(s)
    entry_link = dataplex_v1.EntryLink()
    entry_link.entry_link_type = "entry_link_type_value"
    entry_link.entry_references.name = "name_value"
    entry_link.entry_references.type_ = "TARGET"

    request = dataplex_v1.CreateEntryLinkRequest(
        parent="parent_value",
        entry_link_id="entry_link_id_value",
        entry_link=entry_link,
    )

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

    # Handle the response
    print(response)

REST

Pour créer un lien d'entrée avec l'aspect requis, utilisez la méthode entryLinks.create, en incluant les données d'aspect dans le corps de la requête.

Ajouter des aspects à un lien d'entrée

Aperçu

Ce produit ou cette fonctionnalité sont soumis aux "Conditions des offres de pré-DG" de la section "Conditions générales du service" des Conditions spécifiques du service. Les produits et fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une compatibilité limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Pour enrichir les métadonnées avec des informations sur les relations entre les entrées, ajoutez des aspects aux liens d'entrée.

Vous pouvez configurer les types de liens d'entrée pour exiger un aspect spécifique. Lorsque vous créez un lien d'entrée de ce type, vous devez fournir l'aspect requis.

Vous pouvez ajouter ces aspects lorsque vous créez un lien vers une entrée ou en modifiant un lien existant, comme suit :

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntryLink</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 UpdateEntryLinkRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryLinkRequest request = new UpdateEntryLinkRequest
        {
            EntryLink = new EntryLink(),
            AllowMissing = false,
            AspectKeys = { "", },
        };
        // Make the request
        EntryLink response = catalogServiceClient.UpdateEntryLink(request);
    }
}

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.EntryLink;
import com.google.cloud.dataplex.v1.UpdateEntryLinkRequest;
import java.util.ArrayList;

public class SyncUpdateEntryLink {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry Link resource.
 */
// const entryLink = {}
/**
 *  Optional. If set to true and the entry link doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. The map keys of the Aspects which the service should modify.
 *  It should be the aspect type reference in the format
 *  `{project_id_or_number}.{location_id}.{aspect_type_id}`.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

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

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

async function callUpdateEntryLink() {
  // Construct request
  const request = {
    entryLink,
  };

  // Run request
  const response = await dataplexClient.updateEntryLink(request);
  console.log(response);
}

callUpdateEntryLink();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

    # Initialize request argument(s)
    entry_link = dataplex_v1.EntryLink()
    entry_link.entry_link_type = "entry_link_type_value"
    entry_link.entry_references.name = "name_value"
    entry_link.entry_references.type_ = "TARGET"

    request = dataplex_v1.UpdateEntryLinkRequest(
        entry_link=entry_link,
    )

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

    # Handle the response
    print(response)

REST

Pour mettre à jour un lien d'entrée, utilisez la méthode entryLinks.patch, en incluant les données d'aspect dans le corps entryLink.

Notez les limites suivantes concernant l'utilisation d'aspects avec des liens d'entrée :

• Les aspects facultatifs ne sont pas acceptés.
• Les aspects de données ne sont pas acceptés.
• Certains aspects des types personnalisés ne sont pas acceptés.
• Vous ne pouvez gérer que les aspects requis définis par les types d'aspects système, par exemple schema-join.
• La recherche de liens d'entrée en fonction du contenu de leurs aspects n'est pas possible.
• L'importation ou l'exportation d'aspects de lien d'entrée n'est pas possible.

Gérer les aspects existants d'une entrée

Cette section explique comment modifier et supprimer les aspects existants d'une entrée.

Modifier un aspect

Vous pouvez modifier les aspects facultatifs pour les entrées personnalisées et système. Vous ne pouvez modifier les aspects requis que pour les entrées personnalisées.

Pour les entrées système propriétaires (1P), telles que les tables BigQuery, vous pouvez mettre à jour les aspects à l'aide de l'API modifyEntry. Cela vous permet d'utiliser les autorisations de mise à jour des métadonnées du système source (par exemple, Éditeur de données BigQuery).

Console

1. Dans la console Google Cloud , accédez à la page Rechercher de Knowledge Catalog.

   Accéder à la recherche

2. Recherchez l'entrée dont vous souhaitez modifier les aspects, puis cliquez dessus.

La page des détails de l'entrée s'ouvre.

1. Cliquez sur l'onglet Détails.
2. Dans la section Aspects, développez l'aspect que vous souhaitez mettre à jour, puis cliquez sur Modifier.
3. Dans la fenêtre Modifier l'aspect, mettez à jour les champs obligatoires.
4. Cliquez sur Enregistrer.

gcloud

Pour mettre à jour les aspects d'une entrée ou d'une colonne d'une entrée, utilisez la commande gcloud dataplex entries update.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncUpdateEntry {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

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

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

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

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

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour mettre à jour les aspects d'une entrée ou d'une colonne d'une entrée, utilisez la méthode entry.patch.

Supprimer un aspect

Remarque : Vous pouvez supprimer les aspects facultatifs d'une entrée, mais pas les aspects obligatoires.

Console

1. Dans la console Google Cloud , accédez à la page Rechercher de Knowledge Catalog.

   Accéder à la recherche

2. Si votre plate-forme de recherche est définie sur Data Catalog, dans le menu Choisir une plate-forme de recherche, sélectionnez Dataplex Universal Catalog.

3. Recherchez l'entrée dont vous souhaitez supprimer les aspects, puis cliquez dessus.

La page des détails de l'entrée s'ouvre.

1. Cliquez sur l'onglet Détails.
2. Dans la section Aspects, développez l'aspect que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Cliquez sur Confirmer.

gcloud

Pour supprimer un aspect d'une entrée, utilisez la commande gcloud dataplex entries update.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncUpdateEntry {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

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

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

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

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

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour supprimer un aspect d'une entrée, utilisez la méthode entry.patch.

Gérer les aspects existants pour un lien d'entrée

Cette section explique comment mettre à jour les aspects existants d'un lien d'entrée.

Modifier un aspect

Pour les liens d'entrée, vous ne pouvez modifier que les aspects requis qui utilisent des types d'aspect système réutilisables.

Pour en savoir plus, consultez Autorisations IAM pour les opérations sur les liens d'entrée.

Remarque : Les liens vers des entrées sont compatibles avec les types d'aspect système, mais pas avec les types d'aspect personnalisés.

REST

Pour mettre à jour un lien d'entrée avec l'aspect requis, utilisez la méthode entryLinks.patch, en incluant les données de l'aspect dans le corps de la requête.

Supprimer un aspect

Vous ne pouvez pas supprimer l'aspect requis pour un lien d'entrée.

Gérer les types d'aspects

Cette section explique comment afficher les types d'aspect, et comment mettre à jour et supprimer les types d'aspect personnalisés.

Remarque : Vous ne pouvez pas modifier ni supprimer les types d'aspect système, ni modifier leurs autorisations.

Afficher la liste des types d'aspects disponibles

Console

1. Dans la console Google Cloud , accédez à la page Types de métadonnées de Knowledge Catalog.

   Accéder à "Types de métadonnées"

2. Cliquez sur l'onglet Types d'aspect.

Cette page répertorie tous les types d'aspects Knowledge Catalog disponibles.

1. Pour afficher les types d'aspect personnalisés, cliquez sur l'onglet Personnalisé. Dans l'onglet Personnalisé, la colonne Source du catalogue indique où se trouve la ressource dans Knowledge Catalog.

Pour afficher les types d'aspect système, cliquez sur l'onglet Système.

Pour en savoir plus sur les types d'aspects personnalisés et système, consultez la section Catégories de types d'aspects de ce document.

1. Facultatif : Pour afficher la liste des types d'aspects dans le projet sélectionné, cliquez sur l'onglet Personnalisé, puis désactivez l'option Afficher tous les projets.

L'option Afficher tous les projets est activée par défaut. La liste inclut les ressources Knowledge Catalog de l'organisation sélectionnée.

Remarque : Si l'option Afficher les données de tous les projets est activée, vous ne pouvez pas modifier ni supprimer directement un type d'aspect. Cliquez plutôt sur le type d'aspect pour ouvrir la page Détails du type d'aspect, puis modifiez-le ou supprimez-le.

gcloud

Pour lister tous les types d'aspects disponibles, utilisez la commande gcloud dataplex aspect-types list.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncListAspectTypes {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType location, of the form:
 *  `projects/{project_number}/locations/{location_id}`
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Optional. Maximum number of AspectTypes to return. The service may return
 *  fewer than this value. If unspecified, the service returns at most 10
 *  AspectTypes. The maximum value is 1000; values above 1000 will be coerced
 *  to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. Page token received from a previous `ListAspectTypes` call.
 *  Provide this to retrieve the subsequent page. When paginating, all other
 *  parameters you provide to `ListAspectTypes` must match the call that
 *  provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter request. Filters are case-sensitive.
 *  The service supports the following formats:
 *  * labels.key1 = "value1"
 *  * labels:key1
 *  * name = "value"
 *  These restrictions can be conjoined with AND, OR, and NOT conjunctions.
 */
// const filter = 'abc123'
/**
 *  Optional. Orders the result by `name` or `create_time` fields.
 *  If not specified, the ordering is undefined.
 */
// const orderBy = 'abc123'

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

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

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

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

callListAspectTypes();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

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

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

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour lister tous les types d'aspects disponibles, utilisez la méthode aspectTypes.list.

Afficher les détails d'un type d'aspect

Console

1. Dans la console Google Cloud , accédez à la page Types de métadonnées de Knowledge Catalog.

   Accéder à "Types de métadonnées"

2. Cliquez sur l'onglet Types d'aspect.

3. Pour afficher les détails d'un type d'aspect Knowledge Catalog, cliquez dessus. La page d'informations du type d'aspect s'ouvre. Vous pouvez y accéder à des informations telles que le nom à afficher, l'ID du type d'aspect, la description, l'ID du projet, l'emplacement, les libellés, la date de création et la date de la dernière modification.

   • Pour afficher la structure du type d'aspect sélectionné, cliquez sur l'onglet Modèle.
   • Pour afficher la liste des 10 entrées associées créées récemment, cliquez sur l'onglet Exemples d'entrées.
   • Pour rechercher toutes les entrées associées, cliquez sur Afficher toutes les entrées associées dans la recherche. Ce bouton n'apparaît que s'il existe au moins une entrée associée.

gcloud

Pour obtenir les détails d'un type d'aspect, utilisez la commande gcloud dataplex aspect-types describe.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Cloud.Dataplex.V1;

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncGetAspectType {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType:
 *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
 */
// const name = 'abc123'

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

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

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

  // Run request
  const response = await dataplexClient.getAspectType(request);
  console.log(response);
}

callGetAspectType();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

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

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour obtenir les détails d'un type d'aspect, utilisez la méthode aspectTypes.get.

Mettre à jour un type d'aspect personnalisé

Vous pouvez modifier le nom à afficher, la description, les champs de modèle et les libellés d'un type d'aspect personnalisé. Vous ne pouvez pas supprimer un champ existant dans un modèle.

Une fois le type d'aspect créé, vous ne pouvez plus modifier son ID ni son emplacement.

Console

1. Dans la console Google Cloud , accédez à la page Types de métadonnées de Knowledge Catalog.

   Accéder à "Types de métadonnées"

2. Cliquez sur l'onglet Type d'aspect.

3. Cliquez sur le type d'aspect que vous souhaitez modifier.

4. Sur la page Détails du type d'aspect, cliquez sur Modifier.

5. Modifiez le nom à afficher, la description, les champs du modèle et les libellés, si nécessaire.

6. Facultatif : Pour marquer un champ du type d'aspect comme obsolète, procédez comme suit :

   1. Dans la section Modèle, développez le champ.
   2. Sélectionnez Is Deprecated (Est obsolète).
   3. Dans le champ Motif de l'abandon, saisissez un motif pour l'abandon du champ sélectionné.

   4. Cliquez sur OK.

   5. Cliquez sur Enregistrer.

gcloud

Pour mettre à jour un type d'aspect personnalisé, utilisez la commande gcloud dataplex aspect-types update.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncUpdateAspectType {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. AspectType Resource
 */
// const aspectType = {}
/**
 *  Required. Mask of fields to update.
 */
// const updateMask = {}
/**
 *  Optional. Only validate the request, but do not perform mutations.
 *  The default is false.
 */
// const validateOnly = true

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

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

async function callUpdateAspectType() {
  // Construct request
  const request = {
    aspectType,
    updateMask,
  };

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

callUpdateAspectType();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

    request = dataplex_v1.UpdateAspectTypeRequest(
        aspect_type=aspect_type,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour mettre à jour un type d'aspect personnalisé, utilisez la méthode aspectTypes.patch.

Supprimer un type d'aspect personnalisé

Attention : La suppression d'un type d'aspect personnalisé supprime tous les aspects associés à ce type d'aspect dans toutes les entrées.

Console

1. Dans la console Google Cloud , accédez à la page Types de métadonnées de Knowledge Catalog.

   Accéder à "Types de métadonnées"

2. Cliquez sur l'onglet Types d'aspect.

3. Cliquez sur le type d'aspect que vous souhaitez supprimer.

4. Sur la page Détails du type d'aspect, cliquez sur Supprimer. Confirmez l'opération lorsque vous y êtes invité.

gcloud

Pour supprimer un type d'aspect personnalisé, utilisez la commande gcloud dataplex aspect-types delete.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

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

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

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

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

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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

public class SyncDeleteAspectType {

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

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

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType:
 *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
 */
// const name = 'abc123'
/**
 *  Optional. If the client provided etag value does not match the current etag
 *  value, the DeleteAspectTypeRequest method returns an ABORTED error
 *  response.
 */
// const etag = 'abc123'

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

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

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

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

callDeleteAspectType();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

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


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

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

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

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

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

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

REST

Pour supprimer un type d'aspect personnalisé existant, utilisez la méthode aspectTypes.delete.

Étapes suivantes

• Découvrez comment rechercher des ressources dans Knowledge Catalog.
• Apprenez à gérer les entrées et ingérer des sources personnalisées.
• Découvrez comment importer des métadonnées dans Knowledge Catalog.
• En savoir plus sur les métadonnées dans Knowledge Catalog
• Découvrez comment établir un contexte de données de base.
• Découvrez les cas d'utilisation de Knowledge Catalog.