Vertex AI Workbench client libraries

This page shows how to get started with the Cloud Client Libraries for theNotebooks API. Client libraries make it easier to accessGoogle Cloud APIs from a supported language. Although you can useGoogle Cloud APIs directly by making raw requests to the server, clientlibraries provide simplifications that significantly reduce the amount of codeyou need to write.

Read more about the Cloud Client Librariesand the older Google API Client Libraries inClient libraries explained.

Install the client library

C++

See theGitHubREADME for details about this client library's requirements and to install dependencies.

C#

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

For more information, seeSetting Up a C# Development Environment.

Go

gogetcloud.google.com/go/notebooks

For more information, seeSetting Up a Go Development Environment.

Java

If you are usingMaven, addthe following to yourpom.xml file. For more information aboutBOMs, seeThe Google Cloud Platform Libraries BOM.

<dependencyManagement><dependencies><dependency><groupId>com.google.cloud</groupId><artifactId>libraries-bom</artifactId><version>26.73.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>

If you are usingGradle,add the following to your dependencies:

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

If you are usingsbt, addthe following to your dependencies:

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

For more information, seeSetting Up a Java Development Environment.

Node.js

npminstall@google-cloud/notebooks

For more information, seeSetting Up a Node.js Development Environment.

PHP

composer require google/cloud

For more information, seeUsing PHP on Google Cloud.

Python

Mac/Linux

pipinstallvirtualenvvirtualenvENVIRONMENT_NAMEsourceENVIRONMENT_NAME/bin/activateENVIRONMENT_NAME/bin/pipinstallgoogle-cloud-notebooks

Windows

pipinstall--upgradegoogle-cloud-notebookspipinstallvirtualenvvirtualenvENVIRONMENT_NAMEENVIRONMENT_NAME\Scripts\activateENVIRONMENT_NAME\Scripts\pip.exeinstallgoogle-cloud-notebooks

For more information, seeSetting Up a Python Development Environment.

Ruby

geminstallgoogle-cloud-notebooks

For more information, seeSetting Up a Ruby Development Environment.

Set up authentication

To authenticate calls to Google Cloud APIs, client libraries supportApplication Default Credentials (ADC);the libraries look for credentials in a set of defined locations and use those credentialsto authenticate requests to the API. With ADC, you can makecredentials available to your application in a variety of environments, such as localdevelopment or production, without needing to modify your application code.

For production environments, the way you set up ADC depends on the serviceand context. For more information, seeSet up Application Default Credentials.

For a local development environment, you can set up ADC with the credentialsthat are associated with your Google Account:

  1. Install the Google Cloud CLI. After installation,initialize the Google Cloud CLI by running the following command:

    gcloudinit

    If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  2. If you're using a local shell, then create local authentication credentials for your user account:

    gcloudauthapplication-defaultlogin

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

    A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.

Use the client library

The following examples show how to use the client library insome of the available languages.

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>intmain(intargc,char*argv[])try{if(argc!=3){std::cerr <<"Usage: " <<argv[0] <<" project-id location-id\n";return1;}autoconstlocation=google::cloud::Location(argv[1],argv[2]);namespacenotebooks=::google::cloud::notebooks_v2;autoclient=notebooks::NotebookServiceClient(notebooks::MakeNotebookServiceConnection());for(autoi:client.ListInstances(location.FullName())){if(!i)throwstd::move(i).status();std::cout <<i->DebugString() <<"\n";}return0;}catch(google::cloud::Statusconst&status){std::cerr <<"google::cloud::Status thrown: " <<status <<"\n";return1;}//! [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';asyncfunctionmain(projectId,location){/**   * TODO(developer): Uncomment these variables before running the sample.   */// const projectId = 'my-project';// const location = 'global';// Imports the Google Cloud Some API libraryconst{NotebookServiceClient}=require('@google-cloud/notebooks');constclient=newNotebookServiceClient();asyncfunctionlistInstances(){const[instances]=awaitclient.listInstances({parent:`projects/${projectId}/locations/${location}`,});for(constinstanceofinstances){console.info(`instance:${instance.name}`);}}listInstances();}main(...process.argv.slice(2));process.on('unhandledRejection',err=>{console.error(err.message);process.exitCode=1;});

Additional resources

C++

The following list contains links to more resources related to theclient library for C++:

C#

The following list contains links to more resources related to theclient library for C#:

Go

The following list contains links to more resources related to theclient library for Go:

Java

The following list contains links to more resources related to theclient library for Java:

Node.js

The following list contains links to more resources related to theclient library for Node.js:

PHP

The following list contains links to more resources related to theclient library for PHP:

Python

The following list contains links to more resources related to theclient library for Python:

Ruby

The following list contains links to more resources related to theclient library for Ruby:

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.