Class NotebookServiceConnection (2.28.0)

Version 2.28.0

• 2.31.0-rc (latest)
• 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_v1_mocks::MockNotebookServiceConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual ListInstances(google::cloud::notebooks::v1::ListInstancesRequest)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ListInstancesRequest

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Instance >

virtual GetInstance(google::cloud::notebooks::v1::GetInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::GetInstanceRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Instance >

virtual CreateInstance(google::cloud::notebooks::v1::CreateInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::CreateInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual CreateInstance(NoAwaitTag, google::cloud::notebooks::v1::CreateInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual RegisterInstance(google::cloud::notebooks::v1::RegisterInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::RegisterInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual RegisterInstance(NoAwaitTag, google::cloud::notebooks::v1::RegisterInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::RegisterInstanceRequest const &

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

virtual RegisterInstance(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceAccelerator(google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceAccelerator(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &

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

virtual SetInstanceAccelerator(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceMachineType(google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceMachineType(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &

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

virtual SetInstanceMachineType(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpdateInstanceConfig(google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpdateInstanceConfig(NoAwaitTag, google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &

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

virtual UpdateInstanceConfig(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpdateShieldedInstanceConfig(google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpdateShieldedInstanceConfig(NoAwaitTag, google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &

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

virtual UpdateShieldedInstanceConfig(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceLabels(google::cloud::notebooks::v1::SetInstanceLabelsRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::SetInstanceLabelsRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual SetInstanceLabels(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceLabelsRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::SetInstanceLabelsRequest const &

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

virtual SetInstanceLabels(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpdateInstanceMetadataItems(google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::UpdateInstanceMetadataItemsResponse >

virtual DeleteInstance(google::cloud::notebooks::v1::DeleteInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::DeleteInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual DeleteInstance(NoAwaitTag, google::cloud::notebooks::v1::DeleteInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::OperationMetadata > >

virtual StartInstance(google::cloud::notebooks::v1::StartInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::StartInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual StartInstance(NoAwaitTag, google::cloud::notebooks::v1::StartInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual StopInstance(google::cloud::notebooks::v1::StopInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::StopInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual StopInstance(NoAwaitTag, google::cloud::notebooks::v1::StopInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual ResetInstance(google::cloud::notebooks::v1::ResetInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ResetInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual ResetInstance(NoAwaitTag, google::cloud::notebooks::v1::ResetInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual ReportInstanceInfo(google::cloud::notebooks::v1::ReportInstanceInfoRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ReportInstanceInfoRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual ReportInstanceInfo(NoAwaitTag, google::cloud::notebooks::v1::ReportInstanceInfoRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::ReportInstanceInfoRequest const &

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

virtual ReportInstanceInfo(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual IsInstanceUpgradeable(google::cloud::notebooks::v1::IsInstanceUpgradeableRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::IsInstanceUpgradeableRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::IsInstanceUpgradeableResponse >

virtual GetInstanceHealth(google::cloud::notebooks::v1::GetInstanceHealthRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::GetInstanceHealthRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::GetInstanceHealthResponse >

virtual UpgradeInstance(google::cloud::notebooks::v1::UpgradeInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::UpgradeInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpgradeInstance(NoAwaitTag, google::cloud::notebooks::v1::UpgradeInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual RollbackInstance(google::cloud::notebooks::v1::RollbackInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::RollbackInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual RollbackInstance(NoAwaitTag, google::cloud::notebooks::v1::RollbackInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual DiagnoseInstance(google::cloud::notebooks::v1::DiagnoseInstanceRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::DiagnoseInstanceRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual DiagnoseInstance(NoAwaitTag, google::cloud::notebooks::v1::DiagnoseInstanceRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::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::v1::Instance > >

virtual UpgradeInstanceInternal(google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual UpgradeInstanceInternal(NoAwaitTag, google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &

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

virtual UpgradeInstanceInternal(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >

virtual ListEnvironments(google::cloud::notebooks::v1::ListEnvironmentsRequest)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ListEnvironmentsRequest

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Environment >

virtual GetEnvironment(google::cloud::notebooks::v1::GetEnvironmentRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::GetEnvironmentRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Environment >

virtual CreateEnvironment(google::cloud::notebooks::v1::CreateEnvironmentRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::CreateEnvironmentRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Environment > >

virtual CreateEnvironment(NoAwaitTag, google::cloud::notebooks::v1::CreateEnvironmentRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::CreateEnvironmentRequest const &

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

virtual CreateEnvironment(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Environment > >

virtual DeleteEnvironment(google::cloud::notebooks::v1::DeleteEnvironmentRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::DeleteEnvironmentRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual DeleteEnvironment(NoAwaitTag, google::cloud::notebooks::v1::DeleteEnvironmentRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::DeleteEnvironmentRequest const &

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

virtual DeleteEnvironment(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual ListSchedules(google::cloud::notebooks::v1::ListSchedulesRequest)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ListSchedulesRequest

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Schedule >

virtual GetSchedule(google::cloud::notebooks::v1::GetScheduleRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::GetScheduleRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Schedule >

virtual DeleteSchedule(google::cloud::notebooks::v1::DeleteScheduleRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::DeleteScheduleRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual DeleteSchedule(NoAwaitTag, google::cloud::notebooks::v1::DeleteScheduleRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::DeleteScheduleRequest const &

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

virtual DeleteSchedule(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual CreateSchedule(google::cloud::notebooks::v1::CreateScheduleRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::CreateScheduleRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Schedule > >

virtual CreateSchedule(NoAwaitTag, google::cloud::notebooks::v1::CreateScheduleRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::CreateScheduleRequest const &

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

virtual CreateSchedule(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Schedule > >

virtual TriggerSchedule(google::cloud::notebooks::v1::TriggerScheduleRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::TriggerScheduleRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Schedule > >

virtual TriggerSchedule(NoAwaitTag, google::cloud::notebooks::v1::TriggerScheduleRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::TriggerScheduleRequest const &

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

virtual TriggerSchedule(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Schedule > >

virtual ListExecutions(google::cloud::notebooks::v1::ListExecutionsRequest)

Parameter
Name	Description
request	google::cloud::notebooks::v1::ListExecutionsRequest

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Execution >

virtual GetExecution(google::cloud::notebooks::v1::GetExecutionRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::GetExecutionRequest const &

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Execution >

virtual DeleteExecution(google::cloud::notebooks::v1::DeleteExecutionRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::DeleteExecutionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual DeleteExecution(NoAwaitTag, google::cloud::notebooks::v1::DeleteExecutionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::DeleteExecutionRequest const &

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

virtual DeleteExecution(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >

virtual CreateExecution(google::cloud::notebooks::v1::CreateExecutionRequest const &)

Parameter
Name	Description
request	google::cloud::notebooks::v1::CreateExecutionRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Execution > >

virtual CreateExecution(NoAwaitTag, google::cloud::notebooks::v1::CreateExecutionRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::notebooks::v1::CreateExecutionRequest const &

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

virtual CreateExecution(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Execution > >