Class ManagedNotebookServiceClient (2.11.0)

API v1 service for Managed 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

ManagedNotebookServiceClient(ManagedNotebookServiceClient const &)

Copy and move support

Parameter
Name Description
ManagedNotebookServiceClient const &

ManagedNotebookServiceClient(ManagedNotebookServiceClient &&)

Copy and move support

Parameter
Name Description
ManagedNotebookServiceClient &&

ManagedNotebookServiceClient(std::shared_ptr< ManagedNotebookServiceConnection >, Options)

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

Operators

operator=(ManagedNotebookServiceClient const &)

Copy and move support

Parameter
Name Description
ManagedNotebookServiceClient const &
Returns
Type Description
ManagedNotebookServiceClient &

operator=(ManagedNotebookServiceClient &&)

Copy and move support

Parameter
Name Description
ManagedNotebookServiceClient &&
Returns
Type Description
ManagedNotebookServiceClient &

Functions

ListRuntimes(std::string const &, Options)

Lists Runtimes 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::Runtime >

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.Runtime, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRuntimes(google::cloud::notebooks::v1::ListRuntimesRequest, Options)

Lists Runtimes in a given project and location.

Parameters
Name Description
request google::cloud::notebooks::v1::ListRuntimesRequest

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.ListRuntimesRequest. 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::Runtime >

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.Runtime, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetRuntime(std::string const &, Options)

Gets details of a single Runtime.

The location must be a regional endpoint rather than zonal.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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

GetRuntime(google::cloud::notebooks::v1::GetRuntimeRequest const &, Options)

Gets details of a single Runtime.

The location must be a regional endpoint rather than zonal.

Parameters
Name Description
request google::cloud::notebooks::v1::GetRuntimeRequest 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.GetRuntimeRequest. 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::Runtime >

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

CreateRuntime(std::string const &, std::string const &, google::cloud::notebooks::v1::Runtime const &, Options)

Creates a new Runtime in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Format: parent=projects/{project_id}/locations/{location}
runtime_id std::string const &

Required. User-defined unique ID of this Runtime.

runtime google::cloud::notebooks::v1::Runtime const &

Required. The Runtime to be created.

opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRuntime(google::cloud::notebooks::v1::CreateRuntimeRequest const &, Options)

Creates a new Runtime in a given project and location.

Parameters
Name Description
request google::cloud::notebooks::v1::CreateRuntimeRequest 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.CreateRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRuntime(google::cloud::notebooks::v1::Runtime const &, google::protobuf::FieldMask const &, Options)

Update Notebook Runtime configuration.

Parameters
Name Description
runtime google::cloud::notebooks::v1::Runtime const &

Required. The Runtime to be updated.

update_mask google::protobuf::FieldMask const &

Required. Specifies the path, relative to Runtime, of the field to update. For example, to change the software configuration kernels, the update_mask parameter would be specified as software_config.kernels, and the PATCH request body would specify the new value, as follows:
{ "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } }
Currently, only the following fields can be updated:

  • software_config.kernels
  • software_config.post_startup_script
  • software_config.custom_gpu_driver_path
  • software_config.idle_shutdown
  • software_config.idle_shutdown_timeout
  • software_config.disable_terminal
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRuntime(google::cloud::notebooks::v1::UpdateRuntimeRequest const &, Options)

Update Notebook Runtime configuration.

Parameters
Name Description
request google::cloud::notebooks::v1::UpdateRuntimeRequest 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.UpdateRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRuntime(std::string const &, Options)

Deletes a single Runtime.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_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.

DeleteRuntime(google::cloud::notebooks::v1::DeleteRuntimeRequest const &, Options)

Deletes a single Runtime.

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

StartRuntime(std::string const &, Options)

Starts a Managed Notebook Runtime.

Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instancehttps://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartRuntime(google::cloud::notebooks::v1::StartRuntimeRequest const &, Options)

Starts a Managed Notebook Runtime.

Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instancehttps://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request google::cloud::notebooks::v1::StartRuntimeRequest 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.StartRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopRuntime(std::string const &, Options)

Stops a Managed Notebook Runtime.

Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instancehttps://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopRuntime(google::cloud::notebooks::v1::StopRuntimeRequest const &, Options)

Stops a Managed Notebook Runtime.

Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instancehttps://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request google::cloud::notebooks::v1::StopRuntimeRequest 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.StopRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SwitchRuntime(std::string const &, Options)

Switch a Managed Notebook Runtime.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SwitchRuntime(google::cloud::notebooks::v1::SwitchRuntimeRequest const &, Options)

Switch a Managed Notebook Runtime.

Parameters
Name Description
request google::cloud::notebooks::v1::SwitchRuntimeRequest 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.SwitchRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResetRuntime(std::string const &, Options)

Resets a Managed Notebook Runtime.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResetRuntime(google::cloud::notebooks::v1::ResetRuntimeRequest const &, Options)

Resets a Managed Notebook Runtime.

Parameters
Name Description
request google::cloud::notebooks::v1::ResetRuntimeRequest 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.ResetRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeRuntime(std::string const &, Options)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeRuntime(google::cloud::notebooks::v1::UpgradeRuntimeRequest const &, Options)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
request google::cloud::notebooks::v1::UpgradeRuntimeRequest 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.UpgradeRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReportRuntimeEvent(std::string const &, Options)

Report and process a runtime event.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
opts Options

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

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

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReportRuntimeEvent(google::cloud::notebooks::v1::ReportRuntimeEventRequest const &, Options)

Report and process a runtime event.

Parameters
Name Description
request google::cloud::notebooks::v1::ReportRuntimeEventRequest 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.ReportRuntimeEventRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RefreshRuntimeTokenInternal(std::string const &, std::string const &, Options)

Gets an access token for the consumer service account that the customer attached to the runtime.

Only accessible from the tenant instance.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
vm_id std::string const &

Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
opts Options

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

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

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

RefreshRuntimeTokenInternal(google::cloud::notebooks::v1::RefreshRuntimeTokenInternalRequest const &, Options)

Gets an access token for the consumer service account that the customer attached to the runtime.

Only accessible from the tenant instance.

Parameters
Name Description
request google::cloud::notebooks::v1::RefreshRuntimeTokenInternalRequest 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.RefreshRuntimeTokenInternalRequest. 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::RefreshRuntimeTokenInternalResponse >

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

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

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtimes_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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DiagnoseRuntime(google::cloud::notebooks::v1::DiagnoseRuntimeRequest const &, Options)

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
request google::cloud::notebooks::v1::DiagnoseRuntimeRequest 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.DiagnoseRuntimeRequest. 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::Runtime > >

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.Runtime proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.