Class NotebookServiceConnection (2.30.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.30.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(NoAwaitTag, google::cloud::notebooks::v2::CreateInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::CreateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::UpdateInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::UpdateInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::DeleteInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::DeleteInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::StartInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::StartInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual StartInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::StopInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::StopInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual StopInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::ResetInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::ResetInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual ResetInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::UpgradeInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::UpgradeInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpgradeInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::RollbackInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::RollbackInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual RollbackInstance(google::longrunning::Operation const &)
Parameter
Name Description
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(NoAwaitTag, google::cloud::notebooks::v2::DiagnoseInstanceRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::notebooks::v2::DiagnoseInstanceRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DiagnoseInstance(google::longrunning::Operation const &)
Parameter
Name Description
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-08-14 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-08-14 UTC."],[[["\u003cp\u003eThis webpage details the \u003ccode\u003eNotebookServiceConnection\u003c/code\u003e interface for \u003ccode\u003eNotebookServiceClient\u003c/code\u003e, which is available in versions ranging from 2.11.0 to the latest release candidate 2.37.0-rc, as of the provided data.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eNotebookServiceConnection\u003c/code\u003e interface defines virtual methods that correspond to user-facing overload sets found in \u003ccode\u003eNotebookServiceClient\u003c/code\u003e, enabling the injection of custom behaviors during testing.\u003c/p\u003e\n"],["\u003cp\u003eThe content shows a diverse list of virtual functions, such as \u003ccode\u003eListInstances\u003c/code\u003e, \u003ccode\u003eGetInstance\u003c/code\u003e, \u003ccode\u003eCreateInstance\u003c/code\u003e, \u003ccode\u003eUpdateInstance\u003c/code\u003e, \u003ccode\u003eDeleteInstance\u003c/code\u003e, and various instance management operations like \u003ccode\u003eStartInstance\u003c/code\u003e, \u003ccode\u003eStopInstance\u003c/code\u003e, \u003ccode\u003eResetInstance\u003c/code\u003e, \u003ccode\u003eUpgradeInstance\u003c/code\u003e, and \u003ccode\u003eDiagnoseInstance\u003c/code\u003e, each taking a respective request parameter.\u003c/p\u003e\n"],["\u003cp\u003eThere are distinct versions of the virtual functions, one with the \u003ccode\u003eNoAwaitTag\u003c/code\u003e parameter and \u003ccode\u003egoogle::longrunning::Operation\u003c/code\u003e parameter, with each of these versions designed to handle operation management.\u003c/p\u003e\n"],["\u003cp\u003eUsers can implement custom logic, and this interface is mockable using \u003ccode\u003enotebooks_v2_mocks::MockNotebookServiceConnection\u003c/code\u003e for testing purposes, and concrete instances are created using \u003ccode\u003eMakeNotebookServiceConnection()\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
