Bibliothèques clientes Cloud Deploy

Cette page explique comment utiliser les bibliothèques clientes Cloud pour l'API Cloud Deploy. Les bibliothèques clientes facilitent l'accès aux API Google Cloud à l'aide d'un langage compatible. Bien que vous puissiez utiliser directement les API Google Cloud en envoyant des requêtes brutes au serveur, les bibliothèques clientes fournissent des simplifications qui réduisent considérablement la quantité de code à écrire.

Toutefois, nous vous recommandons d'utiliser les anciennes bibliothèques clientes pour les API Google si vous utilisez l' environnement standard App Engine. Pour en savoir plus sur les bibliothèques clientes Cloud et les anciennes bibliothèques clientes pour les API Google, consultez la section Présentation des bibliothèques clientes.

Installer la bibliothèque cliente

C++C#GoJavaNode.jsPHPPythonRuby

Pour en savoir plus sur les exigences de cette bibliothèque cliente et installer des dépendances, consultez la page Configurer un environnement de développement C++.

Install-Package Google.Cloud.Deploy.V1 -Pre
  
    
    
For more information, see Setting Up a C# Development Environment.

    
  

go get cloud.google.com/go/storage

Pour plus d'informations, consultez la page Configurer un environnement de développement Go.

Si vous utilisez Maven, ajoutez ce code à votre fichier pom.xml :

<dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-deploy</artifactId>
    <version></version>
</dependency>

Si vous utilisez Gradle, ajoutez ceci à vos dépendances :

compile group: 'com.google.cloud', name: 'google-cloud-deploy', version: ''

Pour en savoir plus, consultez la page Configurer un environnement de développement Java.

npm install --save @google-cloud/deploy

Pour en savoir plus, consultez la section Configurer un environnement de développement Node.js.

composer require google/cloud-deploy

Pour en savoir plus, consultez la page Utiliser PHP sur Google Cloud.

pip install --upgrade google-cloud-deploy

Pour en savoir plus, consultez la page Configurer un environnement de développement Python.

gem install google-cloud-deploy

Pour en savoir plus, consultez la section Configurer un environnement de développement Ruby.

Configurer l'authentification

Pour authentifier les appels aux API Google Cloud, les bibliothèques clientes sont compatibles avec le service d'Identifiants par défaut de l'application (ADC). Les bibliothèques recherchent des identifiants dans un ensemble d'emplacements définis et les utilisent pour authentifier les requêtes adressées à l'API. Le service ADC vous permet de mettre des identifiants à disposition de votre application dans divers environnements, tels que l'environnement de développement local ou l'environnement de production, sans avoir à modifier le code de votre application.

Pour les environnements de production, la façon de configurer le service ADC dépend du service et du contexte. Pour en savoir plus, consultez la page Configurer les identifiants par défaut de l'application.

Pour un environnement de développement local, vous pouvez configurer ADC avec les identifiants associés à votre compte Google :

  1. Installez et initialisez la gcloud CLI.

    Lorsque vous initialisez la gcloud CLI, veillez à spécifier un projet Google Cloud dans lequel vous êtes autorisé à accéder aux ressources dont votre application a besoin.

  2. Configurez le service ADC :

    gcloud auth application-default login

    Un écran de connexion s'affiche. Une fois que vous êtes connecté, vos identifiants sont stockés dans le fichier d'identifiants local utilisé par ADC.

Utiliser la bibliothèque cliente

L'exemple suivant montre comment utiliser la bibliothèque cliente.

C++Node.js

#include "google/cloud/deploy/v1/cloud_deploy_client.h"
#include "google/cloud/location.h"
#include <iostream>

int main(int argc, char* argv[]) try {
  if (argc != 3) {
    std::cerr << "Usage: " << argv[0] << " project-id location-id\n";
    return 1;
  }

  auto const location = google::cloud::Location(argv[1], argv[2]);

  namespace deploy = ::google::cloud::deploy_v1;
  auto client = deploy::CloudDeployClient(deploy::MakeCloudDeployConnection());

  for (auto dp : client.ListDeliveryPipelines(location.FullName())) {
    if (!dp) throw std::move(dp).status();
    std::cout << dp->DebugString() << "\n";
  }

  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}
 
/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent, which owns this collection of pipelines. Format must be
 *  projects/{project_id}/locations/{location_name}.
 */
// const parent = 'abc123'
/**
 *  The maximum number of pipelines to return. The service may return
 *  fewer than this value. If unspecified, at most 50 pipelines will
 *  be returned. The maximum value is 1000; values above 1000 will be set
 *  to 1000.
 */
// const pageSize = 1234
/**
 *  A page token, received from a previous `ListDeliveryPipelines` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other provided parameters match
 *  the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Filter builds to be returned. See https://google.aip.dev/160 for more
 *  details.
 */
// const filter = 'abc123'
/**
 *  Field to sort by. See https://google.aip.dev/132#ordering for more details.
 */
// const orderBy = 'abc123'

// Imports the Deploy library
const {CloudDeployClient} = require('@google-cloud/deploy').v1;

// Instantiates a client
const deployClient = new CloudDeployClient();

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

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

listDeliveryPipelines();

Autres ressources

C++C#GoJavaNode.jsPHPPythonRuby

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour C++ :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour C# :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Go :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Java :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Node.js :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour PHP :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Python :

La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Ruby :