API v1 service for Cloud AI Platform 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
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::v1::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::v1::ListInstancesRequest, Options)
Lists instances in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::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::v1::Instance > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstance(google::cloud::notebooks::v1::GetInstanceRequest const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateInstance(std::string const &, google::cloud::notebooks::v1::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::v1::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::v1::Instance > > |
A |
CreateInstance(NoAwaitTag, std::string const &, google::cloud::notebooks::v1::Instance const &, std::string const &, Options)
Creates a new Instance 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 &
|
instance |
google::cloud::notebooks::v1::Instance const &
|
instance_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::cloud::notebooks::v1::CreateInstanceRequest const &, Options)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
CreateInstance(NoAwaitTag, google::cloud::notebooks::v1::CreateInstanceRequest const &, Options)
Creates a new Instance 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::CreateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::longrunning::Operation const &, Options)
Creates a new Instance 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::Instance > > |
RegisterInstance(google::cloud::notebooks::v1::RegisterInstanceRequest const &, Options)
Registers an existing legacy notebook instance to the Notebooks API server.
Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::RegisterInstanceRequest 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::v1::Instance > > |
A |
RegisterInstance(NoAwaitTag, google::cloud::notebooks::v1::RegisterInstanceRequest const &, Options)
Registers an existing legacy notebook instance to the Notebooks API server.
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::RegisterInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RegisterInstance(google::longrunning::Operation const &, Options)
Registers an existing legacy notebook instance to the Notebooks API server.
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::Instance > > |
SetInstanceAccelerator(google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &, Options)
Updates the guest accelerators of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::SetInstanceAcceleratorRequest 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::v1::Instance > > |
A |
SetInstanceAccelerator(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceAcceleratorRequest const &, Options)
Updates the guest accelerators of a single Instance.
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::SetInstanceAcceleratorRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SetInstanceAccelerator(google::longrunning::Operation const &, Options)
Updates the guest accelerators of a single Instance.
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::Instance > > |
SetInstanceMachineType(google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &, Options)
Updates the machine type of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::SetInstanceMachineTypeRequest 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::v1::Instance > > |
A |
SetInstanceMachineType(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceMachineTypeRequest const &, Options)
Updates the machine type of a single Instance.
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::SetInstanceMachineTypeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SetInstanceMachineType(google::longrunning::Operation const &, Options)
Updates the machine type of a single Instance.
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::Instance > > |
UpdateInstanceConfig(google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &, Options)
Update Notebook Instance configurations.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::UpdateInstanceConfigRequest 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::v1::Instance > > |
A |
UpdateInstanceConfig(NoAwaitTag, google::cloud::notebooks::v1::UpdateInstanceConfigRequest const &, Options)
Update Notebook Instance configurations.
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::UpdateInstanceConfigRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstanceConfig(google::longrunning::Operation const &, Options)
Update Notebook Instance configurations.
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::Instance > > |
UpdateShieldedInstanceConfig(google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &, Options)
Updates the Shielded instance configuration of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest 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::v1::Instance > > |
A |
UpdateShieldedInstanceConfig(NoAwaitTag, google::cloud::notebooks::v1::UpdateShieldedInstanceConfigRequest const &, Options)
Updates the Shielded instance configuration of a single Instance.
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::UpdateShieldedInstanceConfigRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateShieldedInstanceConfig(google::longrunning::Operation const &, Options)
Updates the Shielded instance configuration of a single Instance.
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::Instance > > |
SetInstanceLabels(google::cloud::notebooks::v1::SetInstanceLabelsRequest const &, Options)
Replaces all the labels of an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::SetInstanceLabelsRequest 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::v1::Instance > > |
A |
SetInstanceLabels(NoAwaitTag, google::cloud::notebooks::v1::SetInstanceLabelsRequest const &, Options)
Replaces all the labels of an Instance.
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::SetInstanceLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SetInstanceLabels(google::longrunning::Operation const &, Options)
Replaces all the labels of an Instance.
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::Instance > > |
UpdateInstanceMetadataItems(google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest const &, Options)
Add/update metadata items for an instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::UpdateInstanceMetadataItemsRequest 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::v1::UpdateInstanceMetadataItemsResponse > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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::v1::OperationMetadata > > |
A |
DeleteInstance(NoAwaitTag, std::string const &, Options)
Deletes a single Instance.
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 > |
DeleteInstance(google::cloud::notebooks::v1::DeleteInstanceRequest const &, Options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::OperationMetadata > > |
A |
DeleteInstance(NoAwaitTag, google::cloud::notebooks::v1::DeleteInstanceRequest const &, Options)
Deletes a single Instance.
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::DeleteInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteInstance(google::longrunning::Operation const &, Options)
Deletes a single Instance.
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 > > |
StartInstance(google::cloud::notebooks::v1::StartInstanceRequest const &, Options)
Starts a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
StartInstance(NoAwaitTag, google::cloud::notebooks::v1::StartInstanceRequest const &, Options)
Starts a notebook instance.
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::StartInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StartInstance(google::longrunning::Operation const &, Options)
Starts a notebook instance.
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::Instance > > |
StopInstance(google::cloud::notebooks::v1::StopInstanceRequest const &, Options)
Stops a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
StopInstance(NoAwaitTag, google::cloud::notebooks::v1::StopInstanceRequest const &, Options)
Stops a notebook instance.
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::StopInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StopInstance(google::longrunning::Operation const &, Options)
Stops a notebook instance.
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::Instance > > |
ResetInstance(google::cloud::notebooks::v1::ResetInstanceRequest const &, Options)
Resets a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
ResetInstance(NoAwaitTag, google::cloud::notebooks::v1::ResetInstanceRequest const &, Options)
Resets a notebook instance.
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::ResetInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ResetInstance(google::longrunning::Operation const &, Options)
Resets a notebook instance.
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::Instance > > |
ReportInstanceInfo(google::cloud::notebooks::v1::ReportInstanceInfoRequest const &, Options)
Allows notebook instances to report their latest instance information to the Notebooks API server.
The server will merge the reported information to the instance metadata store. Do not use this method directly.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::ReportInstanceInfoRequest 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::v1::Instance > > |
A |
ReportInstanceInfo(NoAwaitTag, google::cloud::notebooks::v1::ReportInstanceInfoRequest const &, Options)
Allows notebook instances to report their latest instance information to the Notebooks API server.
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::ReportInstanceInfoRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ReportInstanceInfo(google::longrunning::Operation const &, Options)
Allows notebook instances to report their latest instance information to the Notebooks API server.
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::Instance > > |
IsInstanceUpgradeable(google::cloud::notebooks::v1::IsInstanceUpgradeableRequest const &, Options)
Check if a notebook instance is upgradable.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::IsInstanceUpgradeableRequest 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::v1::IsInstanceUpgradeableResponse > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.IsInstanceUpgradeableResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstanceHealth(std::string const &, Options)
Check if a notebook instance is healthy.
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::v1::GetInstanceHealthResponse > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.GetInstanceHealthResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstanceHealth(google::cloud::notebooks::v1::GetInstanceHealthRequest const &, Options)
Check if a notebook instance is healthy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::GetInstanceHealthRequest 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::v1::GetInstanceHealthResponse > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.GetInstanceHealthResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpgradeInstance(google::cloud::notebooks::v1::UpgradeInstanceRequest const &, Options)
Upgrades a notebook instance to the latest version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
UpgradeInstance(NoAwaitTag, google::cloud::notebooks::v1::UpgradeInstanceRequest const &, Options)
Upgrades a notebook instance 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::UpgradeInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpgradeInstance(google::longrunning::Operation const &, Options)
Upgrades a notebook instance 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::Instance > > |
RollbackInstance(google::cloud::notebooks::v1::RollbackInstanceRequest const &, Options)
Rollbacks a notebook instance to the previous version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
RollbackInstance(NoAwaitTag, google::cloud::notebooks::v1::RollbackInstanceRequest const &, Options)
Rollbacks a notebook instance to the previous 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::RollbackInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RollbackInstance(google::longrunning::Operation const &, Options)
Rollbacks a notebook instance to the previous 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::Instance > > |
DiagnoseInstance(std::string const &, google::cloud::notebooks::v1::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::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::Instance > > |
A |
DiagnoseInstance(NoAwaitTag, std::string const &, google::cloud::notebooks::v1::DiagnosticConfig const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
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 > |
DiagnoseInstance(google::cloud::notebooks::v1::DiagnoseInstanceRequest const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::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::v1::Instance > > |
A |
DiagnoseInstance(NoAwaitTag, google::cloud::notebooks::v1::DiagnoseInstanceRequest const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
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::DiagnoseInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DiagnoseInstance(google::longrunning::Operation const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
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::Instance > > |
UpgradeInstanceInternal(google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &, Options)
Allows notebook instances to call this endpoint to upgrade themselves.
Do not use this method directly.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::UpgradeInstanceInternalRequest 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::v1::Instance > > |
A |
UpgradeInstanceInternal(NoAwaitTag, google::cloud::notebooks::v1::UpgradeInstanceInternalRequest const &, Options)
Allows notebook instances to call this endpoint to upgrade themselves.
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::UpgradeInstanceInternalRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpgradeInstanceInternal(google::longrunning::Operation const &, Options)
Allows notebook instances to call this endpoint to upgrade themselves.
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::Instance > > |
ListEnvironments(std::string const &, Options)
Lists environments in a project.
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::v1::Environment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEnvironments(google::cloud::notebooks::v1::ListEnvironmentsRequest, Options)
Lists environments in a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::ListEnvironmentsRequest
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::v1::Environment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetEnvironment(std::string const &, Options)
Gets details of a single Environment.
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::v1::Environment > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEnvironment(google::cloud::notebooks::v1::GetEnvironmentRequest const &, Options)
Gets details of a single Environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::GetEnvironmentRequest 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::v1::Environment > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateEnvironment(std::string const &, google::cloud::notebooks::v1::Environment const &, std::string const &, Options)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
environment |
google::cloud::notebooks::v1::Environment const &
Required. The environment to be created. |
environment_id |
std::string const &
Required. User-defined unique ID of this environment. The |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v1::Environment > > |
A |
CreateEnvironment(NoAwaitTag, std::string const &, google::cloud::notebooks::v1::Environment const &, std::string const &, Options)
Creates a new Environment.
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 &
|
environment |
google::cloud::notebooks::v1::Environment const &
|
environment_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEnvironment(google::cloud::notebooks::v1::CreateEnvironmentRequest const &, Options)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::CreateEnvironmentRequest 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::v1::Environment > > |
A |
CreateEnvironment(NoAwaitTag, google::cloud::notebooks::v1::CreateEnvironmentRequest const &, Options)
Creates a new Environment.
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::CreateEnvironmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEnvironment(google::longrunning::Operation const &, Options)
Creates a new Environment.
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::Environment > > |
DeleteEnvironment(std::string const &, Options)
Deletes a single Environment.
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::v1::OperationMetadata > > |
A |
DeleteEnvironment(NoAwaitTag, std::string const &, Options)
Deletes a single Environment.
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 > |
DeleteEnvironment(google::cloud::notebooks::v1::DeleteEnvironmentRequest const &, Options)
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::DeleteEnvironmentRequest 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::v1::OperationMetadata > > |
A |
DeleteEnvironment(NoAwaitTag, google::cloud::notebooks::v1::DeleteEnvironmentRequest const &, Options)
Deletes a single Environment.
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::DeleteEnvironmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteEnvironment(google::longrunning::Operation const &, Options)
Deletes a single Environment.
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 > > |
ListSchedules(std::string const &, Options)
Lists schedules 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::v1::Schedule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSchedules(google::cloud::notebooks::v1::ListSchedulesRequest, Options)
Lists schedules in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::ListSchedulesRequest
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::v1::Schedule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetSchedule(std::string const &, Options)
Gets details of schedule.
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::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSchedule(google::cloud::notebooks::v1::GetScheduleRequest const &, Options)
Gets details of schedule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::GetScheduleRequest 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::v1::Schedule > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Schedule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSchedule(std::string const &, Options)
Deletes schedule and all underlying jobs.
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::v1::OperationMetadata > > |
A |
DeleteSchedule(NoAwaitTag, std::string const &, Options)
Deletes schedule and all underlying jobs.
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 > |
DeleteSchedule(google::cloud::notebooks::v1::DeleteScheduleRequest const &, Options)
Deletes schedule and all underlying jobs.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::DeleteScheduleRequest 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::v1::OperationMetadata > > |
A |
DeleteSchedule(NoAwaitTag, google::cloud::notebooks::v1::DeleteScheduleRequest const &, Options)
Deletes schedule and all underlying jobs.
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::DeleteScheduleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteSchedule(google::longrunning::Operation const &, Options)
Deletes schedule and all underlying jobs.
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 > > |
CreateSchedule(std::string const &, google::cloud::notebooks::v1::Schedule const &, std::string const &, Options)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
schedule |
google::cloud::notebooks::v1::Schedule const &
Required. The schedule to be created. |
schedule_id |
std::string const &
Required. User-defined unique ID of this schedule. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v1::Schedule > > |
A |
CreateSchedule(NoAwaitTag, std::string const &, google::cloud::notebooks::v1::Schedule const &, std::string const &, Options)
Creates a new Scheduled Notebook 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 &
|
schedule |
google::cloud::notebooks::v1::Schedule const &
|
schedule_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSchedule(google::cloud::notebooks::v1::CreateScheduleRequest const &, Options)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::CreateScheduleRequest 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::v1::Schedule > > |
A |
CreateSchedule(NoAwaitTag, google::cloud::notebooks::v1::CreateScheduleRequest const &, Options)
Creates a new Scheduled Notebook 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::CreateScheduleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSchedule(google::longrunning::Operation const &, Options)
Creates a new Scheduled Notebook 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::Schedule > > |
TriggerSchedule(google::cloud::notebooks::v1::TriggerScheduleRequest const &, Options)
Triggers execution of an existing schedule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::TriggerScheduleRequest 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::v1::Schedule > > |
A |
TriggerSchedule(NoAwaitTag, google::cloud::notebooks::v1::TriggerScheduleRequest const &, Options)
Triggers execution of an existing schedule.
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::TriggerScheduleRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
TriggerSchedule(google::longrunning::Operation const &, Options)
Triggers execution of an existing schedule.
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::Schedule > > |
ListExecutions(std::string const &, Options)
Lists executions 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::v1::Execution > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListExecutions(google::cloud::notebooks::v1::ListExecutionsRequest, Options)
Lists executions in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::ListExecutionsRequest
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::v1::Execution > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetExecution(std::string const &, Options)
Gets details of executions.
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::v1::Execution > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetExecution(google::cloud::notebooks::v1::GetExecutionRequest const &, Options)
Gets details of executions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::GetExecutionRequest 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::v1::Execution > |
the result of the RPC. The response message type (google.cloud.notebooks.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteExecution(std::string const &, Options)
Deletes execution.
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::v1::OperationMetadata > > |
A |
DeleteExecution(NoAwaitTag, std::string const &, Options)
Deletes execution.
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 > |
DeleteExecution(google::cloud::notebooks::v1::DeleteExecutionRequest const &, Options)
Deletes execution.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::DeleteExecutionRequest 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::v1::OperationMetadata > > |
A |
DeleteExecution(NoAwaitTag, google::cloud::notebooks::v1::DeleteExecutionRequest const &, Options)
Deletes execution.
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::DeleteExecutionRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteExecution(google::longrunning::Operation const &, Options)
Deletes execution.
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 > > |
CreateExecution(std::string const &, google::cloud::notebooks::v1::Execution const &, std::string const &, Options)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
execution |
google::cloud::notebooks::v1::Execution const &
Required. The execution to be created. |
execution_id |
std::string const &
Required. User-defined unique ID of this execution. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v1::Execution > > |
A |
CreateExecution(NoAwaitTag, std::string const &, google::cloud::notebooks::v1::Execution const &, std::string const &, Options)
Creates a new Execution 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 &
|
execution |
google::cloud::notebooks::v1::Execution const &
|
execution_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateExecution(google::cloud::notebooks::v1::CreateExecutionRequest const &, Options)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v1::CreateExecutionRequest 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::v1::Execution > > |
A |
CreateExecution(NoAwaitTag, google::cloud::notebooks::v1::CreateExecutionRequest const &, Options)
Creates a new Execution 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::CreateExecutionRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateExecution(google::longrunning::Operation const &, Options)
Creates a new Execution 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::Execution > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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 |
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
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::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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 |
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 |
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 |
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 |
DeleteOperation(google::longrunning::DeleteOperationRequest 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 |
request |
google::longrunning::DeleteOperationRequest 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 |
Status |
a |
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 |
CancelOperation(google::longrunning::CancelOperationRequest 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 |
request |
google::longrunning::CancelOperationRequest 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 |
Status |
a |