Agent Platform Workbench 用戶端程式庫

本頁說明如何開始使用 Notebooks API 適用的 Cloud 用戶端程式庫。有了用戶端程式庫，您可以透過支援的語言，更輕鬆地存取Google Cloud API。雖然您可以直接向伺服器發出原始要求來使用Google Cloud API，但用戶端程式庫提供簡化功能，可大幅減少需要編寫的程式碼數量。

如要進一步瞭解 Cloud 用戶端程式庫和舊版 Google API 用戶端程式庫，請參閱「用戶端程式庫說明」。

安裝用戶端程式庫

C++

請參閱 GitHub，進一步瞭解這個用戶端程式庫的需求，以及如何安裝依附元件。README

C#

Install-Package Google.Cloud.Notebooks.V1 -Pre

詳情請參閱「設定 C# 開發環境」。

Go

go get cloud.google.com/go/notebooks

詳情請參閱「設定 Go 開發環境」。

Java

如果您使用 Maven，請將下列指令新增到 pom.xml 檔案中。如要進一步瞭解 BOM，請參閱 Google Cloud Platform 程式庫 BOM。

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.79.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-notebooks</artifactId>
  </dependency>
</dependencies>

如果您使用 Gradle，請將下列指令新增到依附元件中：

implementation 'com.google.cloud:google-cloud-notebooks:1.89.0'

如果您使用 sbt，請在依附元件中加入以下指令：

libraryDependencies += "com.google.cloud" % "google-cloud-notebooks" % "1.89.0"

詳情請參閱「設定 Java 開發環境」。

Node.js

npm install @google-cloud/notebooks

詳情請參閱「設定 Node.js 開發環境」。

PHP

composer require google/cloud

詳情請參閱「在 Google Cloud 上使用 PHP」。

Python

Mac/Linux

pip install virtualenv
virtualenv ENVIRONMENT_NAME
source ENVIRONMENT_NAME/bin/activate
ENVIRONMENT_NAME/bin/pip install google-cloud-notebooks

Windows

pip install --upgrade google-cloud-notebooks
pip install virtualenv
virtualenv ENVIRONMENT_NAME
ENVIRONMENT_NAME\Scripts\activate
ENVIRONMENT_NAME\Scripts\pip.exe install google-cloud-notebooks

詳情請參閱「設定 Python 開發環境」。

Ruby

gem install google-cloud-notebooks

詳情請參閱「設定 Ruby 開發環境」。

設定驗證方法

為驗證向 Google Cloud API 發出的呼叫，用戶端程式庫支援應用程式預設憑證 (ADC)；程式庫會在定義的一組位置中尋找憑證，並使用這些憑證驗證向 API 發出的要求。有了 ADC，無需修改應用程式程式碼，就能在各種環境 (例如本機開發環境或正式環境)，為應用程式提供憑證。

在正式環境中，設定 ADC 的方式取決於服務和背景。詳情請參閱「設定應用程式預設憑證」。

在本機開發環境中，您可以使用與 Google 帳戶相關聯的憑證設定 ADC：

1. 安裝 Google Cloud CLI。 完成後，執行下列指令來初始化 Google Cloud CLI：

   gcloud init

   若您採用的是外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

2. 如果您使用本機殼層，請為使用者帳戶建立本機驗證憑證：

   gcloud auth application-default login

   如果您使用 Cloud Shell，則不需要執行這項操作。

   如果系統傳回驗證錯誤，且您使用外部識別資訊提供者 (IdP)，請確認您已 使用聯合身分登入 gcloud CLI。

   登入畫面會隨即顯示。登入後，您的憑證會儲存在 ADC 使用的本機憑證檔案中。

使用用戶端程式庫

下列範例說明如何以部分可用語言使用用戶端程式庫。

C++

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/notebooks/v2/notebook_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 notebooks = ::google::cloud::notebooks_v2;
  auto client = notebooks::NotebookServiceClient(
      notebooks::MakeNotebookServiceConnection());

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

  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}
//! [all]

Node.js

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

async function main(projectId, location) {
  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  // const projectId = 'my-project';
  // const location = 'global';

  // Imports the Google Cloud Some API library
  const {NotebookServiceClient} = require('@google-cloud/notebooks');
  const client = new NotebookServiceClient();
  async function listInstances() {
    const [instances] = await client.listInstances({
      parent: `projects/${projectId}/locations/${location}`,
    });
    for (const instance of instances) {
      console.info(`instance: ${instance.name}`);
    }
  }
  listInstances();
}

main(...process.argv.slice(2));
process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});

其他資源

C++

下方列出與 C++ 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

C#

下方列出與 C++ 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

Go

下方列出與 Go 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

Java

下方列出與 Java 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

Node.js

下方列出與 Node.js 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

PHP

下方列出與 PHP 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

Python

下方列出與 Python 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼

Ruby

下方列出與 Ruby 用戶端程式庫相關的其他資源連結：

• API 參考資料
• 用戶端程式庫最佳做法
• Issue Tracker
• Stack Overflow 的
• 原始碼