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 | |
---|---|
Name | Description |
|
NotebookServiceClient const &
|
NotebookServiceClient(NotebookServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient &&
|
NotebookServiceClient(std::shared_ptr< NotebookServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< NotebookServiceConnection >
|
opts |
Options
|
Operators
operator=(NotebookServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient const &
|
Returns | |
---|---|
Type | Description |
NotebookServiceClient & |
operator=(NotebookServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient &&
|
Returns | |
---|---|
Type | Description |
NotebookServiceClient & |
Functions
ListInstances(std::string const &, Options)
Lists instances in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
ListInstances(google::cloud::notebooks::v2::ListInstancesRequest, Options)
Lists instances in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::ListInstancesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
GetInstance(std::string const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
GetInstance(google::cloud::notebooks::v2::GetInstanceRequest const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::GetInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
CreateInstance(google::cloud::notebooks::v2::CreateInstanceRequest const &, Options)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::CreateInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
UpdateInstance(google::cloud::notebooks::v2::Instance const &, google::protobuf::FieldMask const &, Options)
UpdateInstance updates an Instance.
Parameters | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
UpdateInstance(google::cloud::notebooks::v2::UpdateInstanceRequest const &, Options)
UpdateInstance updates an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::UpdateInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
DeleteInstance(std::string const &, Options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::OperationMetadata > > | A |
DeleteInstance(google::cloud::notebooks::v2::DeleteInstanceRequest const &, Options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::DeleteInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::OperationMetadata > > | A |
StartInstance(google::cloud::notebooks::v2::StartInstanceRequest const &, Options)
Starts a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::StartInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
StopInstance(google::cloud::notebooks::v2::StopInstanceRequest const &, Options)
Stops a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::StopInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
ResetInstance(google::cloud::notebooks::v2::ResetInstanceRequest const &, Options)
Resets a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::ResetInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
CheckInstanceUpgradability(google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &, Options)
Checks whether a notebook instance is upgradable.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
UpgradeInstance(google::cloud::notebooks::v2::UpgradeInstanceRequest const &, Options)
Upgrades a notebook instance to the latest version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::UpgradeInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
RollbackInstance(google::cloud::notebooks::v2::RollbackInstanceRequest const &, Options)
Rollbacks a notebook instance to the previous version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::RollbackInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
DiagnoseInstance(std::string const &, google::cloud::notebooks::v2::DiagnosticConfig const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |
DiagnoseInstance(google::cloud::notebooks::v2::DiagnoseInstanceRequest const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::DiagnoseInstanceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > | A |