This page shows how to get started with the Cloud Client Libraries for the Data Catalog API. Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Installing the client library
C#
For more information, see Setting Up a C# Development Environment.
Go
For more information, see Setting Up a Go Development Environment.
Java
For more information, see Setting Up a Java Development Environment.
If you are using Maven, add this to your pom.xml file:
Maven: <dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-datacatalog</artifactId> <version>insert datacatalog-library-version here</version> </dependency>If you are using Gradle, add this to your dependencies:
compile group: 'com.google.cloud', name: 'google-cloud-datacatalog', version: 'insert datacatalog-library-version here'
Node.js
For more information, see Setting Up a Node.js Development Environment.
npm install --save @google-cloud/datacatalog
PHP
For more information, see Using PHP on Google Cloud.
Python
For more information, see Setting Up a Python Development Environment.
pip install --upgrade google-cloud-datacatalog
Ruby
For more information, see Setting Up a Ruby Development Environment.
Setting up authentication
To run the client library, you must first set up authentication by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.
Cloud Console
Créez un compte de service :
-
Dans Cloud Console, accédez à la page Créer un compte de service.
Accéder à la page "Créer un compte de service" - Sélectionnez un projet.
-
Dans le champ Nom du compte de service, saisissez un nom. Cloud Console remplit le champ ID du compte de service en fonction de ce nom.
Dans le champ Description du compte de service, saisissez une description. Exemple :
Service account for quickstart
. - Cliquez sur Create (Créer).
-
Cliquez sur le champ Sélectionner un rôle.
Dans la section Accès rapide, cliquez sur Basique, puis sur Propriétaire.
- Cliquez sur Continuer.
-
Cliquez sur OK pour terminer la création du compte de service.
Ne fermez pas la fenêtre de votre navigateur. Vous en aurez besoin lors de la tâche suivante.
Créez une clé de compte de service :
- Dans Cloud Console, cliquez sur l'adresse e-mail du compte de service que vous avez créé.
- Cliquez sur Clés.
- Cliquez sur Ajouter une clé, puis sur Créer une clé.
- Cliquez sur Create (Créer). Un fichier de clé JSON est téléchargé sur votre ordinateur.
- Cliquez sur Close (Fermer).
Ligne de commande
Vous pouvez exécuter les commandes suivantes à l'aide du SDK Cloud sur votre ordinateur local, ou dans Cloud Shell.
-
Créez le compte de service. Remplacez NAME par le nom que vous souhaitez donner au compte de service.
gcloud iam service-accounts create NAME
-
Accordez des autorisations au compte de service. Remplacez PROJECT_ID par votre ID de projet.
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"
-
Générez le fichier de clé. Remplacez FILE_NAME par le nom du fichier de clé.
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
Fournissez des identifiants d'authentification au code de votre application en définissant la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS
.
Remplacez [PATH] par le chemin du fichier JSON contenant la clé de votre compte de service. Cette variable ne s'applique qu'à la session d'interface système actuelle. Par conséquent, si vous ouvrez une nouvelle session, vous devez la définir à nouveau.
Linux ou macOS
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
Exemple :
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"
Windows
Avec PowerShell :
$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
Exemple :
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"
Avec l'invite de commande :
set GOOGLE_APPLICATION_CREDENTIALS=[PATH]
Using the client library
The following example shows how to use the client library.
Java
For more information, see the Data Catalog Java API reference documentation.
Node.js
For more information, see the Data Catalog Node.js API reference documentation.
Python
For more information, see the Data Catalog Python API reference documentation.