Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Class NotebookServiceConnection (2.26.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.26.0keyboard_arrow_down
Functions
virtual options()
Returns
Type Description
Options
virtual ListInstances(google::cloud::notebooks::v2::ListInstancesRequest)
Parameter
Name Description
request
google::cloud::notebooks::v2::ListInstancesRequest
Returns
Type Description
StreamRange< google::cloud::notebooks::v2::Instance >
virtual GetInstance(google::cloud::notebooks::v2::GetInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::GetInstanceRequest const &
Returns
Type Description
StatusOr< google::cloud::notebooks::v2::Instance >
virtual CreateInstance(google::cloud::notebooks::v2::CreateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::CreateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual CreateInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::CreateInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::CreateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual UpdateInstance(google::cloud::notebooks::v2::UpdateInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::UpdateInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual UpdateInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::UpdateInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::UpdateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual DeleteInstance(google::cloud::notebooks::v2::DeleteInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::DeleteInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::OperationMetadata > >
virtual DeleteInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::DeleteInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::DeleteInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::OperationMetadata > >
virtual StartInstance(google::cloud::notebooks::v2::StartInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::StartInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual StartInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::StartInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::StartInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual StartInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual StopInstance(google::cloud::notebooks::v2::StopInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::StopInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual StopInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::StopInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::StopInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual StopInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual ResetInstance(google::cloud::notebooks::v2::ResetInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::ResetInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual ResetInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::ResetInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::ResetInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ResetInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual CheckInstanceUpgradability(google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &
Returns
Type Description
StatusOr< google::cloud::notebooks::v2::CheckInstanceUpgradabilityResponse >
virtual UpgradeInstance(google::cloud::notebooks::v2::UpgradeInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::UpgradeInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual UpgradeInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::UpgradeInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::UpgradeInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpgradeInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual RollbackInstance(google::cloud::notebooks::v2::RollbackInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::RollbackInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual RollbackInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::RollbackInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::RollbackInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual RollbackInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual DiagnoseInstance(google::cloud::notebooks::v2::DiagnoseInstanceRequest const &)
Parameter
Name Description
request
google::cloud::notebooks::v2::DiagnoseInstanceRequest const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
virtual DiagnoseInstance(ExperimentalTag, NoAwaitTag, google::cloud::notebooks::v2::DiagnoseInstanceRequest const &)
Parameters
Name Description
ExperimentalTag
NoAwaitTag
request
google::cloud::notebooks::v2::DiagnoseInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DiagnoseInstance(ExperimentalTag, google::longrunning::Operation const &)
Parameters
Name Description
ExperimentalTag
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::notebooks::v2::Instance > >
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-08 UTC."],[[["This document outlines the `NotebookServiceConnection` object for `NotebookServiceClient`, which provides a set of virtual methods for interacting with notebook instances, enabling custom behavior injection for testing."],["The latest release candidate version available is 2.37.0-rc, while the latest stable release is 2.36.0, and the current version of this documentation corresponds to 2.26.0."],["The document offers links to previous versions, ranging from 2.36.0 to 2.11.0, offering a comprehensive view of the API's evolution."],["The `NotebookServiceConnection` interface includes methods to manage instances, such as listing, getting, creating, updating, deleting, starting, stopping, resetting, upgrading, rolling back and diagnosing instances, all of which are detailed with their respective parameters and return types."],["For creating a concrete instance, the document refers to `MakeNotebookServiceConnection()`, and for mocking purposes, it mentions `notebooks_v2_mocks::MockNotebookServiceConnection`."]]],[]]
