Notebooks API C++ Client 2.10.1
A C++ Client Library for the Notebooks API
|
API v1 service for Managed Notebooks. More...
#include <google/cloud/notebooks/v1/managed_notebook_client.h>
Public Member Functions | |
ManagedNotebookServiceClient (std::shared_ptr< ManagedNotebookServiceConnection > connection, Options opts={}) | |
~ManagedNotebookServiceClient () | |
StreamRange< google::cloud::notebooks::v1::Runtime > | ListRuntimes (std::string const &parent, Options opts={}) |
Lists Runtimes in a given project and location. More... | |
StreamRange< google::cloud::notebooks::v1::Runtime > | ListRuntimes (google::cloud::notebooks::v1::ListRuntimesRequest request, Options opts={}) |
Lists Runtimes in a given project and location. More... | |
StatusOr< google::cloud::notebooks::v1::Runtime > | GetRuntime (std::string const &name, Options opts={}) |
Gets details of a single Runtime. More... | |
StatusOr< google::cloud::notebooks::v1::Runtime > | GetRuntime (google::cloud::notebooks::v1::GetRuntimeRequest const &request, Options opts={}) |
Gets details of a single Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | CreateRuntime (std::string const &parent, std::string const &runtime_id, google::cloud::notebooks::v1::Runtime const &runtime, Options opts={}) |
Creates a new Runtime in a given project and location. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | CreateRuntime (google::cloud::notebooks::v1::CreateRuntimeRequest const &request, Options opts={}) |
Creates a new Runtime in a given project and location. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | UpdateRuntime (google::cloud::notebooks::v1::Runtime const &runtime, google::protobuf::FieldMask const &update_mask, Options opts={}) |
Update Notebook Runtime configuration. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | UpdateRuntime (google::cloud::notebooks::v1::UpdateRuntimeRequest const &request, Options opts={}) |
Update Notebook Runtime configuration. More... | |
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > > | DeleteRuntime (std::string const &name, Options opts={}) |
Deletes a single Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > > | DeleteRuntime (google::cloud::notebooks::v1::DeleteRuntimeRequest const &request, Options opts={}) |
Deletes a single Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | StartRuntime (std::string const &name, Options opts={}) |
Starts a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | StartRuntime (google::cloud::notebooks::v1::StartRuntimeRequest const &request, Options opts={}) |
Starts a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | StopRuntime (std::string const &name, Options opts={}) |
Stops a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | StopRuntime (google::cloud::notebooks::v1::StopRuntimeRequest const &request, Options opts={}) |
Stops a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | SwitchRuntime (std::string const &name, Options opts={}) |
Switch a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | SwitchRuntime (google::cloud::notebooks::v1::SwitchRuntimeRequest const &request, Options opts={}) |
Switch a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | ResetRuntime (std::string const &name, Options opts={}) |
Resets a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | ResetRuntime (google::cloud::notebooks::v1::ResetRuntimeRequest const &request, Options opts={}) |
Resets a Managed Notebook Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | UpgradeRuntime (std::string const &name, Options opts={}) |
Upgrades a Managed Notebook Runtime to the latest version. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | UpgradeRuntime (google::cloud::notebooks::v1::UpgradeRuntimeRequest const &request, Options opts={}) |
Upgrades a Managed Notebook Runtime to the latest version. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | ReportRuntimeEvent (std::string const &name, Options opts={}) |
Report and process a runtime event. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | ReportRuntimeEvent (google::cloud::notebooks::v1::ReportRuntimeEventRequest const &request, Options opts={}) |
Report and process a runtime event. More... | |
StatusOr< google::cloud::notebooks::v1::RefreshRuntimeTokenInternalResponse > | RefreshRuntimeTokenInternal (std::string const &name, std::string const &vm_id, Options opts={}) |
Gets an access token for the consumer service account that the customer attached to the runtime. More... | |
StatusOr< google::cloud::notebooks::v1::RefreshRuntimeTokenInternalResponse > | RefreshRuntimeTokenInternal (google::cloud::notebooks::v1::RefreshRuntimeTokenInternalRequest const &request, Options opts={}) |
Gets an access token for the consumer service account that the customer attached to the runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | DiagnoseRuntime (std::string const &name, google::cloud::notebooks::v1::DiagnosticConfig const &diagnostic_config, Options opts={}) |
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. More... | |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > | DiagnoseRuntime (google::cloud::notebooks::v1::DiagnoseRuntimeRequest const &request, Options opts={}) |
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. More... | |
Copy and move support | |
ManagedNotebookServiceClient (ManagedNotebookServiceClient const &)=default | |
ManagedNotebookServiceClient & | operator= (ManagedNotebookServiceClient const &)=default |
ManagedNotebookServiceClient (ManagedNotebookServiceClient &&)=default | |
ManagedNotebookServiceClient & | operator= (ManagedNotebookServiceClient &&)=default |
Friends | |
Equality | |
bool | operator== (ManagedNotebookServiceClient const &a, ManagedNotebookServiceClient const &b) |
bool | operator!= (ManagedNotebookServiceClient const &a, ManagedNotebookServiceClient const &b) |
API v1 service for Managed Notebooks.
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.
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.
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.
|
explicit |
google::cloud::notebooks_v1::ManagedNotebookServiceClient::~ManagedNotebookServiceClient | ( | ) |
|
default |
|
default |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::CreateRuntime | ( | google::cloud::notebooks::v1::CreateRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Creates a new Runtime in a given project and location.
request | google::cloud::notebooks::v1::CreateRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::CreateRuntime | ( | std::string const & | parent, |
std::string const & | runtime_id, | ||
google::cloud::notebooks::v1::Runtime const & | runtime, | ||
Options | opts = {} |
||
) |
Creates a new Runtime in a given project and location.
parent | Required. Format: parent=projects/{project_id}/locations/{location} |
runtime_id | Required. User-defined unique ID of this Runtime. |
runtime | Required. The Runtime to be created. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::DeleteRuntime | ( | google::cloud::notebooks::v1::DeleteRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Deletes a single Runtime.
request | google::cloud::notebooks::v1::DeleteRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::OperationMetadata > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::DeleteRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Deletes a single Runtime.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::DiagnoseRuntime | ( | google::cloud::notebooks::v1::DiagnoseRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
request | google::cloud::notebooks::v1::DiagnoseRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::DiagnoseRuntime | ( | std::string const & | name, |
google::cloud::notebooks::v1::DiagnosticConfig const & | diagnostic_config, | ||
Options | opts = {} |
||
) |
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtimes_id} |
diagnostic_config | Required. Defines flags that are used to run the diagnostic tool |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::notebooks::v1::Runtime > google::cloud::notebooks_v1::ManagedNotebookServiceClient::GetRuntime | ( | google::cloud::notebooks::v1::GetRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Gets details of a single Runtime.
The location must be a regional endpoint rather than zonal.
request | google::cloud::notebooks::v1::GetRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::notebooks::v1::Runtime > google::cloud::notebooks_v1::ManagedNotebookServiceClient::GetRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Gets details of a single Runtime.
The location must be a regional endpoint rather than zonal.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StreamRange< google::cloud::notebooks::v1::Runtime > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ListRuntimes | ( | google::cloud::notebooks::v1::ListRuntimesRequest | request, |
Options | opts = {} |
||
) |
Lists Runtimes in a given project and location.
request | google::cloud::notebooks::v1::ListRuntimesRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StreamRange< google::cloud::notebooks::v1::Runtime > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ListRuntimes | ( | std::string const & | parent, |
Options | opts = {} |
||
) |
Lists Runtimes in a given project and location.
parent | Required. Format: parent=projects/{project_id}/locations/{location} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
|
default |
|
default |
StatusOr< google::cloud::notebooks::v1::RefreshRuntimeTokenInternalResponse > google::cloud::notebooks_v1::ManagedNotebookServiceClient::RefreshRuntimeTokenInternal | ( | google::cloud::notebooks::v1::RefreshRuntimeTokenInternalRequest const & | request, |
Options | opts = {} |
||
) |
Gets an access token for the consumer service account that the customer attached to the runtime.
Only accessible from the tenant instance.
request | google::cloud::notebooks::v1::RefreshRuntimeTokenInternalRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::notebooks::v1::RefreshRuntimeTokenInternalResponse > google::cloud::notebooks_v1::ManagedNotebookServiceClient::RefreshRuntimeTokenInternal | ( | std::string const & | name, |
std::string const & | vm_id, | ||
Options | opts = {} |
||
) |
Gets an access token for the consumer service account that the customer attached to the runtime.
Only accessible from the tenant instance.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
vm_id | Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ReportRuntimeEvent | ( | google::cloud::notebooks::v1::ReportRuntimeEventRequest const & | request, |
Options | opts = {} |
||
) |
Report and process a runtime event.
request | google::cloud::notebooks::v1::ReportRuntimeEventRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ReportRuntimeEvent | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Report and process a runtime event.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ResetRuntime | ( | google::cloud::notebooks::v1::ResetRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Resets a Managed Notebook Runtime.
request | google::cloud::notebooks::v1::ResetRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::ResetRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Resets a Managed Notebook Runtime.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::StartRuntime | ( | google::cloud::notebooks::v1::StartRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Starts a Managed Notebook Runtime.
Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
request | google::cloud::notebooks::v1::StartRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::StartRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Starts a Managed Notebook Runtime.
Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::StopRuntime | ( | google::cloud::notebooks::v1::StopRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Stops a Managed Notebook Runtime.
Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
request | google::cloud::notebooks::v1::StopRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::StopRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Stops a Managed Notebook Runtime.
Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::SwitchRuntime | ( | google::cloud::notebooks::v1::SwitchRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Switch a Managed Notebook Runtime.
request | google::cloud::notebooks::v1::SwitchRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::SwitchRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Switch a Managed Notebook Runtime.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::UpdateRuntime | ( | google::cloud::notebooks::v1::Runtime const & | runtime, |
google::protobuf::FieldMask const & | update_mask, | ||
Options | opts = {} |
||
) |
Update Notebook Runtime configuration.
runtime | Required. The Runtime to be updated. |
update_mask | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::UpdateRuntime | ( | google::cloud::notebooks::v1::UpdateRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Update Notebook Runtime configuration.
request | google::cloud::notebooks::v1::UpdateRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::UpgradeRuntime | ( | google::cloud::notebooks::v1::UpgradeRuntimeRequest const & | request, |
Options | opts = {} |
||
) |
Upgrades a Managed Notebook Runtime to the latest version.
request | google::cloud::notebooks::v1::UpgradeRuntimeRequest |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::notebooks::v1::Runtime > > google::cloud::notebooks_v1::ManagedNotebookServiceClient::UpgradeRuntime | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Upgrades a Managed Notebook Runtime to the latest version.
name | Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
|
friend |
|
friend |