Class NotebookServiceClient (2.16.0-rc)

API v2 service for Workbench Notebooks Instances.

Equality

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

Performance

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

Thread Safety

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

Constructors

NotebookServiceClient(NotebookServiceClient const &)

Copy and move support

Parameter
NameDescription
NotebookServiceClient const &

NotebookServiceClient(NotebookServiceClient &&)

Copy and move support

Parameter
NameDescription
NotebookServiceClient &&

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

Parameters
NameDescription
connection std::shared_ptr< NotebookServiceConnection >
opts Options

Operators

operator=(NotebookServiceClient const &)

Copy and move support

Parameter
NameDescription
NotebookServiceClient const &
Returns
TypeDescription
NotebookServiceClient &

operator=(NotebookServiceClient &&)

Copy and move support

Parameter
NameDescription
NotebookServiceClient &&
Returns
TypeDescription
NotebookServiceClient &

Functions

ListInstances(std::string const &, Options)

Lists instances in a given project and location.

Parameters
NameDescription
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
TypeDescription
StreamRange< google::cloud::notebooks::v2::Instance >

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

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

Lists instances in a given project and location.

Parameters
NameDescription
request google::cloud::notebooks::v2::ListInstancesRequest

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

opts Options

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

Returns
TypeDescription
StreamRange< google::cloud::notebooks::v2::Instance >

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

GetInstance(std::string const &, Options)

Gets details of a single Instance.

Parameters
NameDescription
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::notebooks::v2::Instance >

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

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

Gets details of a single Instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::GetInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::notebooks::v2::Instance >

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

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

Creates a new Instance in a given project and location.

Parameters
NameDescription
parent std::string const &

Required. Format: parent=projects/{project_id}/locations/{location}

instance google::cloud::notebooks::v2::Instance const &

Required. The instance to be created.

instance_id std::string const &

Required. User-defined unique ID of this instance.

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

Creates a new Instance in a given project and location.

Parameters
NameDescription
request google::cloud::notebooks::v2::CreateInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

UpdateInstance(google::cloud::notebooks::v2::Instance const &, google::protobuf::FieldMask const &, Options)

UpdateInstance updates an Instance.

Parameters
NameDescription
instance google::cloud::notebooks::v2::Instance const &

Required. A representation of an instance.

update_mask google::protobuf::FieldMask const &

Required. Mask used to update an instance

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

UpdateInstance(google::cloud::notebooks::v2::UpdateInstanceRequest const &, Options)

UpdateInstance updates an Instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::UpdateInstanceRequest 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.v2.UpdateInstanceRequest. 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
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

DeleteInstance(std::string const &, Options)

Deletes a single Instance.

Parameters
NameDescription
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

opts Options

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

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

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

Deletes a single Instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::DeleteInstanceRequest const &

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

opts Options

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

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

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

Starts a notebook instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::StartInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

Stops a notebook instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::StopInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

Resets a notebook instance.

Parameters
NameDescription
request google::cloud::notebooks::v2::ResetInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

CheckInstanceUpgradability(google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &, Options)

Checks whether a notebook instance is upgradable.

Parameters
NameDescription
request google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest 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.v2.CheckInstanceUpgradabilityRequest. 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
TypeDescription
StatusOr< google::cloud::notebooks::v2::CheckInstanceUpgradabilityResponse >

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

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

Upgrades a notebook instance to the latest version.

Parameters
NameDescription
request google::cloud::notebooks::v2::UpgradeInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

Rollbacks a notebook instance to the previous version.

Parameters
NameDescription
request google::cloud::notebooks::v2::RollbackInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

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

Parameters
NameDescription
name std::string const &

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnostic_config google::cloud::notebooks::v2::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
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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

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

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

Parameters
NameDescription
request google::cloud::notebooks::v2::DiagnoseInstanceRequest const &

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

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::notebooks::v2::Instance > >

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