Class NotebookServiceConnection (3.4.0-rc)

3.4.0-rc 3.3.0 (latest) 3.2.0 2.48.0-rc 2.47.1-rc 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 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.1 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

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 aiplatform_v1_mocks::MockNotebookServiceConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual CreateNotebookRuntimeTemplate(google::cloud::aiplatform::v1::CreateNotebookRuntimeTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::CreateNotebookRuntimeTemplateRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookRuntimeTemplate > >

virtual CreateNotebookRuntimeTemplate(NoAwaitTag, google::cloud::aiplatform::v1::CreateNotebookRuntimeTemplateRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::CreateNotebookRuntimeTemplateRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookRuntimeTemplate > >

virtual GetNotebookRuntimeTemplate(google::cloud::aiplatform::v1::GetNotebookRuntimeTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::GetNotebookRuntimeTemplateRequest const &

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::NotebookRuntimeTemplate >

virtual ListNotebookRuntimeTemplates(google::cloud::aiplatform::v1::ListNotebookRuntimeTemplatesRequest)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::ListNotebookRuntimeTemplatesRequest

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::NotebookRuntimeTemplate >

virtual DeleteNotebookRuntimeTemplate(google::cloud::aiplatform::v1::DeleteNotebookRuntimeTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::DeleteNotebookRuntimeTemplateRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

virtual DeleteNotebookRuntimeTemplate(NoAwaitTag, google::cloud::aiplatform::v1::DeleteNotebookRuntimeTemplateRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteNotebookRuntimeTemplateRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

virtual UpdateNotebookRuntimeTemplate(google::cloud::aiplatform::v1::UpdateNotebookRuntimeTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::UpdateNotebookRuntimeTemplateRequest const &

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::NotebookRuntimeTemplate >

virtual AssignNotebookRuntime(google::cloud::aiplatform::v1::AssignNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::AssignNotebookRuntimeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookRuntime > >

virtual AssignNotebookRuntime(NoAwaitTag, google::cloud::aiplatform::v1::AssignNotebookRuntimeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::AssignNotebookRuntimeRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookRuntime > >

virtual GetNotebookRuntime(google::cloud::aiplatform::v1::GetNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::GetNotebookRuntimeRequest const &

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::NotebookRuntime >

virtual ListNotebookRuntimes(google::cloud::aiplatform::v1::ListNotebookRuntimesRequest)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::ListNotebookRuntimesRequest

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::NotebookRuntime >

virtual DeleteNotebookRuntime(google::cloud::aiplatform::v1::DeleteNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::DeleteNotebookRuntimeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

virtual DeleteNotebookRuntime(NoAwaitTag, google::cloud::aiplatform::v1::DeleteNotebookRuntimeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteNotebookRuntimeRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

virtual UpgradeNotebookRuntime(google::cloud::aiplatform::v1::UpgradeNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::UpgradeNotebookRuntimeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::UpgradeNotebookRuntimeResponse > >

virtual UpgradeNotebookRuntime(NoAwaitTag, google::cloud::aiplatform::v1::UpgradeNotebookRuntimeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::UpgradeNotebookRuntimeRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::UpgradeNotebookRuntimeResponse > >

virtual StartNotebookRuntime(google::cloud::aiplatform::v1::StartNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::StartNotebookRuntimeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::StartNotebookRuntimeResponse > >

virtual StartNotebookRuntime(NoAwaitTag, google::cloud::aiplatform::v1::StartNotebookRuntimeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::StartNotebookRuntimeRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::StartNotebookRuntimeResponse > >

virtual StopNotebookRuntime(google::cloud::aiplatform::v1::StopNotebookRuntimeRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::StopNotebookRuntimeRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::StopNotebookRuntimeResponse > >

virtual StopNotebookRuntime(NoAwaitTag, google::cloud::aiplatform::v1::StopNotebookRuntimeRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::StopNotebookRuntimeRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::StopNotebookRuntimeResponse > >

virtual CreateNotebookExecutionJob(google::cloud::aiplatform::v1::CreateNotebookExecutionJobRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::CreateNotebookExecutionJobRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookExecutionJob > >

virtual CreateNotebookExecutionJob(NoAwaitTag, google::cloud::aiplatform::v1::CreateNotebookExecutionJobRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::CreateNotebookExecutionJobRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::NotebookExecutionJob > >

virtual GetNotebookExecutionJob(google::cloud::aiplatform::v1::GetNotebookExecutionJobRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::GetNotebookExecutionJobRequest const &

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::NotebookExecutionJob >

virtual ListNotebookExecutionJobs(google::cloud::aiplatform::v1::ListNotebookExecutionJobsRequest)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::ListNotebookExecutionJobsRequest

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::NotebookExecutionJob >

virtual DeleteNotebookExecutionJob(google::cloud::aiplatform::v1::DeleteNotebookExecutionJobRequest const &)

Parameter
Name	Description
request	google::cloud::aiplatform::v1::DeleteNotebookExecutionJobRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

virtual DeleteNotebookExecutionJob(NoAwaitTag, google::cloud::aiplatform::v1::DeleteNotebookExecutionJobRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteNotebookExecutionJobRequest const &

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

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

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

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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

virtual WaitOperation(google::longrunning::WaitOperationRequest const &)

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

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