Class NotebookServiceClient (2.24.0)

Version 2.24.0

• 2.34.0-rc (latest)
• 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.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

API v1 service for Cloud AI Platform Notebooks.

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

ListInstances(std::string const &, Options)

Lists instances in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Instance >	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.notebooks.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInstances(google::cloud::notebooks::v1::ListInstancesRequest, Options)

Lists instances in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ListInstancesRequest 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.notebooks.v1.ListInstancesRequest. 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::notebooks::v1::Instance >	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.notebooks.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInstance(std::string const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Instance >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstance(google::cloud::notebooks::v1::GetInstanceRequest const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::GetInstanceRequest 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.notebooks.v1.GetInstanceRequest. 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::notebooks::v1::Instance >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateInstance(std::string const &, google::cloud::notebooks::v1::Instance const &, std::string const &, Options)

Creates a new Instance in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
instance	google::cloud::notebooks::v1::Instance const & Required. The instance to be created.
instance_id	std::string const & Required. User-defined unique ID of this instance.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::CreateInstanceRequest 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.notebooks.v1.CreateInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Registers an existing legacy notebook instance to the Notebooks API server.

Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
Name	Description
request	google::cloud::notebooks::v1::RegisterInstanceRequest 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.notebooks.v1.RegisterInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Updates the guest accelerators of a single Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::SetInstanceAcceleratorRequest 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.notebooks.v1.SetInstanceAcceleratorRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Updates the machine type of a single Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::SetInstanceMachineTypeRequest 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.notebooks.v1.SetInstanceMachineTypeRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Update Notebook Instance configurations.

Parameters
Name	Description
request	google::cloud::notebooks::v1::UpdateInstanceConfigRequest 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.notebooks.v1.UpdateInstanceConfigRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Updates the Shielded instance configuration of a single Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest 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.notebooks.v1.UpdateShieldedInstanceConfigRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Replaces all the labels of an Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::SetInstanceLabelsRequest 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.notebooks.v1.SetInstanceLabelsRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInstanceMetadataItems(google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest const &, Options)

Add/update metadata items for an instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest 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.notebooks.v1.UpdateInstanceMetadataItemsRequest. 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::notebooks::v1::UpdateInstanceMetadataItemsResponse >	the result of the RPC. The response message type (google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteInstance(std::string const &, Options)

Deletes a single Instance.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::DeleteInstanceRequest 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.notebooks.v1.DeleteInstanceRequest. 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::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Starts a notebook instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::StartInstanceRequest 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.notebooks.v1.StartInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Stops a notebook instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::StopInstanceRequest 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.notebooks.v1.StopInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Resets a notebook instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ResetInstanceRequest 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.notebooks.v1.ResetInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Allows notebook instances to report their latest instance information to the Notebooks API server.

The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ReportInstanceInfoRequest 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.notebooks.v1.ReportInstanceInfoRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

IsInstanceUpgradeable(google::cloud::notebooks::v1::IsInstanceUpgradeableRequest const &, Options)

Check if a notebook instance is upgradable.

Parameters
Name	Description
request	google::cloud::notebooks::v1::IsInstanceUpgradeableRequest 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.notebooks.v1.IsInstanceUpgradeableRequest. 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::notebooks::v1::IsInstanceUpgradeableResponse >	the result of the RPC. The response message type (google.cloud.notebooks.v1.IsInstanceUpgradeableResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstanceHealth(std::string const &, Options)

Check if a notebook instance is healthy.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::GetInstanceHealthResponse >	the result of the RPC. The response message type (google.cloud.notebooks.v1.GetInstanceHealthResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstanceHealth(google::cloud::notebooks::v1::GetInstanceHealthRequest const &, Options)

Check if a notebook instance is healthy.

Parameters
Name	Description
request	google::cloud::notebooks::v1::GetInstanceHealthRequest 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.notebooks.v1.GetInstanceHealthRequest. 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::notebooks::v1::GetInstanceHealthResponse >	the result of the RPC. The response message type (google.cloud.notebooks.v1.GetInstanceHealthResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Upgrades a notebook instance to the latest version.

Parameters
Name	Description
request	google::cloud::notebooks::v1::UpgradeInstanceRequest 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.notebooks.v1.UpgradeInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Rollbacks a notebook instance to the previous version.

Parameters
Name	Description
request	google::cloud::notebooks::v1::RollbackInstanceRequest 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.notebooks.v1.RollbackInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DiagnoseInstance(std::string const &, google::cloud::notebooks::v1::DiagnosticConfig const &, Options)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
diagnostic_config	google::cloud::notebooks::v1::DiagnosticConfig const & Required. Defines flags that are used to run the diagnostic tool
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name	Description
request	google::cloud::notebooks::v1::DiagnoseInstanceRequest 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.notebooks.v1.DiagnoseInstanceRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Allows notebook instances to call this endpoint to upgrade themselves.

Do not use this method directly.

Parameters
Name	Description
request	google::cloud::notebooks::v1::UpgradeInstanceInternalRequest 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.notebooks.v1.UpgradeInstanceInternalRequest. 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::notebooks::v1::Instance > >	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.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListEnvironments(std::string const &, Options)

Lists environments in a project.

Parameters
Name	Description
parent	std::string const & Required. Format: projects/{project_id}/locations/{location}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Environment >	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.notebooks.v1.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEnvironments(google::cloud::notebooks::v1::ListEnvironmentsRequest, Options)

Lists environments in a project.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ListEnvironmentsRequest 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.notebooks.v1.ListEnvironmentsRequest. 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::notebooks::v1::Environment >	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.notebooks.v1.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEnvironment(std::string const &, Options)

Gets details of a single Environment.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Environment >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetEnvironment(google::cloud::notebooks::v1::GetEnvironmentRequest const &, Options)

Gets details of a single Environment.

Parameters
Name	Description
request	google::cloud::notebooks::v1::GetEnvironmentRequest 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.notebooks.v1.GetEnvironmentRequest. 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::notebooks::v1::Environment >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateEnvironment(std::string const &, google::cloud::notebooks::v1::Environment const &, std::string const &, Options)

Creates a new Environment.

Parameters
Name	Description
parent	std::string const & Required. Format: projects/{project_id}/locations/{location}
environment	google::cloud::notebooks::v1::Environment const & Required. The environment to be created.
environment_id	std::string const & Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Environment > >	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.notebooks.v1.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a new Environment.

Parameters
Name	Description
request	google::cloud::notebooks::v1::CreateEnvironmentRequest 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.notebooks.v1.CreateEnvironmentRequest. 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::notebooks::v1::Environment > >	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.notebooks.v1.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEnvironment(std::string const &, Options)

Deletes a single Environment.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Environment.

Parameters
Name	Description
request	google::cloud::notebooks::v1::DeleteEnvironmentRequest 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.notebooks.v1.DeleteEnvironmentRequest. 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::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListSchedules(std::string const &, Options)

Lists schedules in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Schedule >	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.notebooks.v1.Schedule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSchedules(google::cloud::notebooks::v1::ListSchedulesRequest, Options)

Lists schedules in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ListSchedulesRequest 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.notebooks.v1.ListSchedulesRequest. 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::notebooks::v1::Schedule >	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.notebooks.v1.Schedule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetSchedule(std::string const &, Options)

Gets details of schedule.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Schedule >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSchedule(google::cloud::notebooks::v1::GetScheduleRequest const &, Options)

Gets details of schedule.

Parameters
Name	Description
request	google::cloud::notebooks::v1::GetScheduleRequest 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.notebooks.v1.GetScheduleRequest. 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::notebooks::v1::Schedule >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteSchedule(std::string const &, Options)

Deletes schedule and all underlying jobs.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes schedule and all underlying jobs.

Parameters
Name	Description
request	google::cloud::notebooks::v1::DeleteScheduleRequest 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.notebooks.v1.DeleteScheduleRequest. 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::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSchedule(std::string const &, google::cloud::notebooks::v1::Schedule const &, std::string const &, Options)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
schedule	google::cloud::notebooks::v1::Schedule const & Required. The schedule to be created.
schedule_id	std::string const & Required. User-defined unique ID of this schedule.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Schedule > >	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.notebooks.v1.Schedule proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::CreateScheduleRequest 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.notebooks.v1.CreateScheduleRequest. 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::notebooks::v1::Schedule > >	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.notebooks.v1.Schedule proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Triggers execution of an existing schedule.

Parameters
Name	Description
request	google::cloud::notebooks::v1::TriggerScheduleRequest 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.notebooks.v1.TriggerScheduleRequest. 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::notebooks::v1::Schedule > >	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.notebooks.v1.Schedule proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListExecutions(std::string const &, Options)

Lists executions in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::notebooks::v1::Execution >	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.notebooks.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListExecutions(google::cloud::notebooks::v1::ListExecutionsRequest, Options)

Lists executions in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::ListExecutionsRequest 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.notebooks.v1.ListExecutionsRequest. 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::notebooks::v1::Execution >	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.notebooks.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetExecution(std::string const &, Options)

Gets details of executions.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::notebooks::v1::Execution >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetExecution(google::cloud::notebooks::v1::GetExecutionRequest const &, Options)

Gets details of executions.

Parameters
Name	Description
request	google::cloud::notebooks::v1::GetExecutionRequest 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.notebooks.v1.GetExecutionRequest. 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::notebooks::v1::Execution >	the result of the RPC. The response message type (google.cloud.notebooks.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteExecution(std::string const &, Options)

Deletes execution.

Parameters
Name	Description
name	std::string const & Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes execution.

Parameters
Name	Description
request	google::cloud::notebooks::v1::DeleteExecutionRequest 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.notebooks.v1.DeleteExecutionRequest. 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::notebooks::v1::OperationMetadata > >	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.notebooks.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateExecution(std::string const &, google::cloud::notebooks::v1::Execution const &, std::string const &, Options)

Creates a new Execution in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Format: parent=projects/{project_id}/locations/{location}
execution	google::cloud::notebooks::v1::Execution const & Required. The execution to be created.
execution_id	std::string const & Required. User-defined unique ID of this execution.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::notebooks::v1::Execution > >	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.notebooks.v1.Execution proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates a new Execution in a given project and location.

Parameters
Name	Description
request	google::cloud::notebooks::v1::CreateExecutionRequest 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.notebooks.v1.CreateExecutionRequest. 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::notebooks::v1::Execution > >	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.notebooks.v1.Execution proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.