Class NotebookServiceConnection (2.17.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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 > >`