Mengonfigurasi endpoint library klien

Setiap layanan Google Cloud API diakses melalui endpoint khusus layanan.

Misalnya, library klien Java-Speech dan Java-Translate memiliki endpoint default https://speech.googleapis.com:443 dan https://translate.googleapis.com:443.

Library Klien Cloud untuk Java secara otomatis menentukan endpoint layanan yang benar selama inisialisasi klien. Jika tidak ada endpoint kustom yang dikonfigurasi, library akan menggunakan endpoint default layanan.

Anatomi endpoint

Dengan menggunakan endpoint Java-Speech sebagai contoh, tabel berikut menjelaskan bagian-bagian yang membentuk endpoint:

Skema Nama Layanan Domain Semesta Port
https:// ucapan googleapis.com 443

Ini adalah nilai default semua endpoint Library Klien Cloud untuk Java, selain nama layanan. Nama layanan tidak memiliki nilai default karena setiap Google Cloud layanan memiliki nilai yang berbeda.

Kapan harus mengonfigurasi endpoint kustom

Ada kasus penggunaan tertentu untuk mengganti endpoint default, seperti:

  • Layanan ini menawarkan endpoint regional. Endpoint default tidak mempertimbangkan varian regional.
  • Anda tidak bekerja di produksi. Misalnya, Anda melakukan pengujian secara lokal dengan emulator tanpa mengonfigurasi TLS.

Hanya ubah konfigurasi endpoint jika perlu. Saat menggunakan endpoint kustom, Anda harus menyertakan nomor port (misalnya, example.com:443). Library klien tidak otomatis menambahkan port default seperti 443 ke endpoint kustom, tidak seperti yang dilakukan untuk endpoint layanan default.

Mengonfigurasi endpoint kustom

Anda dapat menetapkan endpoint dari ClientSettings khusus layanan di Library Klien Cloud untuk Java.

Contoh berikut menggunakan Java-KMS:

  1. Tetapkan endpoint di ClientSettings.Builder dan buat ClientSettings:

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

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

    Endpoint diselesaikan menjadi customEndpoint.com:443.

    Klien menggunakan endpoint dari sumber pertama berikut yang menyediakan endpoint:

    1. Endpoint ditetapkan secara terprogram melalui ClientSettings.Builder.setEndpoint().
    2. Endpoint default layanan, seperti https://{serviceName}.googleapis.com:443.

Cuplikan berikut menunjukkan cara menentukan endpoint yang di-resolve klien:

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