Configurer les points de terminaison de la bibliothèque cliente

Chaque Google Cloud service d'API est accessible via un point de terminaison spécifique au service.

Par exemple, les bibliothèques clientes Java-Speech et Java-Translate ont respectivement des points de terminaison par défaut https://speech.googleapis.com:443 et https://translate.googleapis.com:443.

Les bibliothèques clientes Cloud pour Java déterminent automatiquement le point de terminaison de service approprié lors de l'initialisation du client. Si aucun point de terminaison personnalisé n'est configuré, les bibliothèques utilisent le point de terminaison par défaut du service.

Anatomie d'un point de terminaison

En utilisant le point de terminaison Java-Speech comme exemple, le tableau suivant détaille les sections qui composent le point de terminaison :

Scheme	Nom du service	Domaine de l'univers	Port
https://	speech	googleapis.com	443

Il s'agit des valeurs par défaut de tous les points de terminaison des bibliothèques clientes Cloud pour Java, à l'exception du nom du service. Le nom du service n'a pas de valeur par défaut car chaque Google Cloud service a une valeur différente.

Quand configurer un point de terminaison personnalisé ?

Dans certains cas d'utilisation, vous devez remplacer le point de terminaison par défaut, par exemple :

• Le service propose des points de terminaison régionaux. Le point de terminaison par défaut ne tient pas compte des variantes régionales.
• Vous ne travaillez pas en production. Par exemple, vous effectuez des tests en local avec un émulateur sans configurer TLS.

Ne modifiez la configuration du point de terminaison que si nécessaire. Lorsque vous utilisez un point de terminaison personnalisé, vous devez inclure le numéro de port (par exemple, example.com:443). Contrairement aux points de terminaison de service par défaut, les bibliothèques clientes n'ajoutent pas automatiquement de port par défaut tel que 443 aux points de terminaison personnalisés.

Configurer un point de terminaison personnalisé

Vous pouvez définir le point de terminaison à partir de ClientSettings spécifique au service dans les bibliothèques clientes Cloud pour Java.

L'exemple suivant utilise Java-KMS :

1. Définissez le point de terminaison dans le ClientSettings.Builder et créez le ClientSettings :

   // Replace with your desired endpoint
   String endpoint = "customEndpoint.com:443";
   KeyManagementServiceSettings keyManagementServiceSettings =
    KeyManagementServiceSettings.newBuilder()
       .setEndpoint(endpoint)
       .build();
   

2. Initialisez le client avec ClientSettings :

   try (KeyManagementServiceClient keyManagementServiceClient =
     KeyManagementServiceClient.create(keyManagementServiceSettings)) {
     ...
   }
   

   Le point de terminaison est résolu en customEndpoint.com:443.

   Le client utilise le point de terminaison de la première des sources suivantes qui en fournit un :

   1. Le point de terminaison défini de manière automatisée via ClientSettings.Builder.setEndpoint().
   2. Le point de terminaison par défaut du service, tel que https://{serviceName}.googleapis.com:443.

L'extrait de code suivant montre comment déterminer le point de terminaison résolu du client :

// The client's settings class contains a getter for the endpoint
keyManagementServiceClient.getSettings().getEndpoint();