Class ManagedNotebookServiceClient (2.34.0-rc)

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 >

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(NoAwaitTag, std::string const &, std::string const &, google::cloud::notebooks::v1::Runtime const &, Options)

Creates a new Runtime in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`runtime_id`	`std::string const &`
`runtime`	`google::cloud::notebooks::v1::Runtime const &`
`opts`	`Options`

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

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 > >

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

Creates a new Runtime in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::CreateRuntimeRequest const &`
`opts`	`Options`

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

CreateRuntime(google::longrunning::Operation const &, Options)

Creates a new Runtime in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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. For more information, see UpdateRuntimeRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::notebooks::v1::Runtime > >

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

Update Notebook Runtime configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`runtime`	`google::cloud::notebooks::v1::Runtime const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

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 > >

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

Update Notebook Runtime configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::UpdateRuntimeRequest const &`
`opts`	`Options`

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

UpdateRuntime(google::longrunning::Operation const &, Options)

Update Notebook Runtime configuration.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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(NoAwaitTag, std::string const &, Options)

Deletes a single Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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.

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

Deletes a single Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::DeleteRuntimeRequest const &`
`opts`	`Options`

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

DeleteRuntime(google::longrunning::Operation const &, Options)

Deletes a single Runtime.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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-instance https://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 > >

StartRuntime(NoAwaitTag, std::string const &, Options)

Starts a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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

Starts a Managed Notebook Runtime.

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 > >

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

Starts a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::StartRuntimeRequest const &`
`opts`	`Options`

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

StartRuntime(google::longrunning::Operation const &, Options)

Starts a Managed Notebook Runtime.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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-instance https://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 > >

StopRuntime(NoAwaitTag, std::string const &, Options)

Stops a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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

Stops a Managed Notebook Runtime.

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 > >

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

Stops a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::StopRuntimeRequest const &`
`opts`	`Options`

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

StopRuntime(google::longrunning::Operation const &, Options)

Stops a Managed Notebook Runtime.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 > >

SwitchRuntime(NoAwaitTag, std::string const &, Options)

Switch a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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 > >

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

Switch a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::SwitchRuntimeRequest const &`
`opts`	`Options`

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

SwitchRuntime(google::longrunning::Operation const &, Options)

Switch a Managed Notebook Runtime.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 > >

ResetRuntime(NoAwaitTag, std::string const &, Options)

Resets a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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 > >

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

Resets a Managed Notebook Runtime.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::ResetRuntimeRequest const &`
`opts`	`Options`

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

ResetRuntime(google::longrunning::Operation const &, Options)

Resets a Managed Notebook Runtime.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 > >

UpgradeRuntime(NoAwaitTag, std::string const &, Options)

Upgrades a Managed Notebook Runtime to the latest version.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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 > >

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

Upgrades a Managed Notebook Runtime to the latest version.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::UpgradeRuntimeRequest const &`
`opts`	`Options`

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

UpgradeRuntime(google::longrunning::Operation const &, Options)

Upgrades a Managed Notebook Runtime to the latest version.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 > >

ReportRuntimeEvent(NoAwaitTag, std::string const &, Options)

Report and process a runtime event.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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 > >

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

Report and process a runtime event.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::ReportRuntimeEventRequest const &`
`opts`	`Options`

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

ReportRuntimeEvent(google::longrunning::Operation const &, Options)

Report and process a runtime event.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 > >

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

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

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`diagnostic_config`	`google::cloud::notebooks::v1::DiagnosticConfig const &`
`opts`	`Options`

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

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 > >

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

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

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::notebooks::v1::DiagnoseRuntimeRequest const &`
`opts`	`Options`

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

DiagnoseRuntime(google::longrunning::Operation const &, Options)

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

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`google::cloud::location::ListLocationsRequest` 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.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

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

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

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

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

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

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

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation's parent resource.
`filter`	`std::string const &` The standard list filter.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`request`	`google::longrunning::ListOperationsRequest` 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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be deleted.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be cancelled.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.