Class NotebookServiceConnection (2.31.0)

Version 2.31.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The NotebookServiceConnection object for NotebookServiceClient.

This interface defines virtual methods for each of the user-facing overload sets in NotebookServiceClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type NotebookServiceClient.

To create a concrete instance, see MakeNotebookServiceConnection().

For mocking, see notebooks_v2_mocks::MockNotebookServiceConnection.

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 > >

virtual ListLocations(google::cloud::location::ListLocationsRequest)

Parameter
Name	Description
request	google::cloud::location::ListLocationsRequest

Returns
Type	Description
StreamRange< google::cloud::location::Location >

virtual GetLocation(google::cloud::location::GetLocationRequest const &)

Parameter
Name	Description
request	google::cloud::location::GetLocationRequest const &

Returns
Type	Description
StatusOr< google::cloud::location::Location >

virtual SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &)

Parameter
Name	Description
request	google::iam::v1::SetIamPolicyRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::Policy >

virtual GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &)

Parameter
Name	Description
request	google::iam::v1::GetIamPolicyRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::Policy >

virtual TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &)

Parameter
Name	Description
request	google::iam::v1::TestIamPermissionsRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

virtual ListOperations(google::longrunning::ListOperationsRequest)

Parameter
Name	Description
request	google::longrunning::ListOperationsRequest

Returns
Type	Description
StreamRange< google::longrunning::Operation >

virtual GetOperation(google::longrunning::GetOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::GetOperationRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteOperation(google::longrunning::DeleteOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::DeleteOperationRequest const &

Returns
Type	Description
Status

virtual CancelOperation(google::longrunning::CancelOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::CancelOperationRequest const &

Returns
Type	Description
Status