Endpunkte der Clientbibliothek konfigurieren

Auf jeden Google Cloud API-Dienst wird über einen dienstspezifischen Endpunkt zugegriffen.

Die Java-Clientbibliotheken für Speech und Translate haben beispielsweise die Standardendpunkte https://speech.googleapis.com:443 bzw. https://translate.googleapis.com:443.

Die Cloud-Clientbibliotheken für Java ermitteln den richtigen Dienstendpunkt automatisch bei der Clientinitialisierung. Wenn kein benutzerdefinierter Endpunkt konfiguriert ist, verwenden die Bibliotheken den Standardendpunkt des Dienstes.

Aufbau eines Endpunkts

In der folgenden Tabelle sind die Abschnitte aufgeführt, aus denen der Java-Speech-Endpunkt besteht:

Schema Dienstname Universe-Domain Port
https:// speech googleapis.com 443

Dies sind die Standardwerte aller Cloud-Clientbibliotheken für Java-Endpunkte, mit Ausnahme des Dienstnamens. Der Dienstname hat keinen Standardwert, da jeder Google Cloud Dienst einen anderen Wert hat.

Wann ein benutzerdefinierter Endpunkt konfiguriert werden sollte

Es gibt bestimmte Anwendungsfälle, in denen der Standardendpunkt ersetzt werden sollte, z. B.:

  • Der Dienst bietet regionale Endpunkte. Beim Standardendpunkt werden keine regionalen Varianten berücksichtigt.
  • Sie arbeiten nicht in der Produktion. Beispiel: Sie testen lokal mit einem Emulator, ohne TLS zu konfigurieren.

Ändern Sie die Endpunktkonfiguration nur bei Bedarf. Wenn Sie einen benutzerdefinierten Endpunkt verwenden, müssen Sie die Portnummer angeben (z. B. example.com:443). Die Clientbibliotheken hängen nicht automatisch einen Standardport wie 443 an benutzerdefinierte Endpunkte an, wie sie es bei Standarddienstendpunkten tun.

Benutzerdefinierten Endpunkt konfigurieren

Sie können den Endpunkt über die dienstspezifische ClientSettings in den Cloud-Clientbibliotheken für Java festlegen.

Im folgenden Beispiel wird Java-KMS verwendet:

  1. Legen Sie den Endpunkt in ClientSettings.Builder fest und erstellen Sie ClientSettings:

    // Replace with your desired endpoint
    String endpoint = "customEndpoint.com:443";
    KeyManagementServiceSettings keyManagementServiceSettings =
     KeyManagementServiceSettings.newBuilder()
        .setEndpoint(endpoint)
        .build();
    
  2. Initialisieren Sie den Client mit ClientSettings:

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

    Der Endpunkt wird in customEndpoint.com:443 aufgelöst.

    Der Client verwendet den Endpunkt aus der ersten der folgenden Quellen, die einen Endpunkt bereitstellt:

    1. Der Endpunkt wird programmatisch über ClientSettings.Builder.setEndpoint() festgelegt.
    2. Der Standardendpunkt des Dienstes, z. B. https://{serviceName}.googleapis.com:443.

Das folgende Snippet zeigt, wie der aufgelöste Endpunkt des Clients ermittelt wird:

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