Class NotebookServiceClient (2.24.0)

The interface for Vertex Notebook service (a.k.a.

Colab on Workbench).

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

NotebookServiceClient(NotebookServiceClient const &)

Copy and move support

Parameter
Name Description
NotebookServiceClient const &

NotebookServiceClient(NotebookServiceClient &&)

Copy and move support

Parameter
Name Description
NotebookServiceClient &&

NotebookServiceClient(std::shared_ptr< NotebookServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< NotebookServiceConnection >
opts Options

Operators

operator=(NotebookServiceClient const &)

Copy and move support

Parameter
Name Description
NotebookServiceClient const &
Returns
Type Description
NotebookServiceClient &

operator=(NotebookServiceClient &&)

Copy and move support

Parameter
Name Description
NotebookServiceClient &&
Returns
Type Description
NotebookServiceClient &

Functions

CreateNotebookRuntimeTemplate(std::string const &, google::cloud::aiplatform::v1::NotebookRuntimeTemplate const &, std::string const &, Options)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: projects/{project}/locations/{location}
notebook_runtime_template google::cloud::aiplatform::v1::NotebookRuntimeTemplate const &

Required. The NotebookRuntimeTemplate to create.

notebook_runtime_template_id std::string const &

Optional. User specified ID for the notebook runtime template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.NotebookRuntimeTemplate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a NotebookRuntimeTemplate.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateNotebookRuntimeTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.NotebookRuntimeTemplate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetNotebookRuntimeTemplate(std::string const &, Options)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntimeTemplate resource. Format: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

the result of the RPC. The response message type (google.cloud.aiplatform.v1.NotebookRuntimeTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNotebookRuntimeTemplate(google::cloud::aiplatform::v1::GetNotebookRuntimeTemplateRequest const &, Options)

Gets a NotebookRuntimeTemplate.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetNotebookRuntimeTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

the result of the RPC. The response message type (google.cloud.aiplatform.v1.NotebookRuntimeTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNotebookRuntimeTemplates(std::string const &, Options)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: projects/{project}/locations/{location}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NotebookRuntimeTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNotebookRuntimeTemplates(google::cloud::aiplatform::v1::ListNotebookRuntimeTemplatesRequest, Options)

Lists NotebookRuntimeTemplates in a Location.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NotebookRuntimeTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteNotebookRuntimeTemplate(std::string const &, Options)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a NotebookRuntimeTemplate.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteNotebookRuntimeTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AssignNotebookRuntime(std::string const &, std::string const &, google::cloud::aiplatform::v1::NotebookRuntime const &, std::string const &, Options)

Assigns a NotebookRuntime to a user for a particular Notebook file.

This method will either returns an existing assignment or generates a new one.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}
notebook_runtime_template std::string const &

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).

notebook_runtime google::cloud::aiplatform::v1::NotebookRuntime const &

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.

notebook_runtime_id std::string const &

Optional. User specified ID for the notebook runtime.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.NotebookRuntime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Assigns a NotebookRuntime to a user for a particular Notebook file.

This method will either returns an existing assignment or generates a new one.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.AssignNotebookRuntimeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.NotebookRuntime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetNotebookRuntime(std::string const &, Options)

Gets a NotebookRuntime.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

the result of the RPC. The response message type (google.cloud.aiplatform.v1.NotebookRuntime) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNotebookRuntime(google::cloud::aiplatform::v1::GetNotebookRuntimeRequest const &, Options)

Gets a NotebookRuntime.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetNotebookRuntimeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

the result of the RPC. The response message type (google.cloud.aiplatform.v1.NotebookRuntime) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNotebookRuntimes(std::string const &, Options)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NotebookRuntime, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNotebookRuntimes(google::cloud::aiplatform::v1::ListNotebookRuntimesRequest, Options)

Lists NotebookRuntimes in a Location.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListNotebookRuntimesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NotebookRuntime, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteNotebookRuntime(std::string const &, Options)

Deletes a NotebookRuntime.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a NotebookRuntime.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteNotebookRuntimeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeNotebookRuntime(std::string const &, Options)

Upgrades a NotebookRuntime.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.UpgradeNotebookRuntimeResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Upgrades a NotebookRuntime.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpgradeNotebookRuntimeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.UpgradeNotebookRuntimeResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartNotebookRuntime(std::string const &, Options)

Starts a NotebookRuntime.

Parameters
Name Description
name std::string const &

Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.StartNotebookRuntimeResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Starts a NotebookRuntime.

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.StartNotebookRuntimeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.StartNotebookRuntimeResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.