Class NotebookServiceClient (2.32.0)

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: `parent=projects/{project_id}/locations/{location}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::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.v1.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::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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

StreamRange< google::cloud::notebooks::v1::Instance >

GetInstance(std::string const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
`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
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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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
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 `StatusOr` contains the error details.

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: `parent=projects/{project_id}/locations/{location}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.notebooks.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.RegisterInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.SetInstanceAcceleratorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.SetInstanceMachineTypeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.UpdateInstanceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.SetInstanceLabelsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

DeleteInstance(std::string const &, Options)

Deletes a single Instance.

Parameters
Name	Description
`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

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.ReportInstanceInfoRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.IsInstanceUpgradeableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

GetInstanceHealth(std::string const &, Options)

Check if a notebook instance is healthy.

Parameters
Name	Description
`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
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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.GetInstanceHealthRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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: `projects/{project_id}/locations/{location}/instances/{instance_id}`
`diagnostic_config`	`google::cloud::notebooks::v1::DiagnosticConfig const &` Required. Defines flags that are used to run the diagnostic tool
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.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

Type Description

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.UpgradeInstanceInternalRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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: `projects/{project_id}/locations/{location}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Environment >

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.ListEnvironmentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Environment >

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

GetEnvironment(std::string const &, Options)

Gets details of a single Environment.

Parameters
Name	Description
`name`	`std::string const &` Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.GetEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

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: `projects/{project_id}/locations/{location}`
`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 `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.notebooks.v1.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.CreateEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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: `projects/{project_id}/locations/{location}/environments/{environment_id}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.DeleteEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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: `parent=projects/{project_id}/locations/{location}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Schedule >

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.ListSchedulesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Schedule >

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

GetSchedule(std::string const &, Options)

Gets details of schedule.

Parameters
Name	Description
`name`	`std::string const &` Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.GetScheduleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

DeleteSchedule(std::string const &, Options)

Deletes schedule and all underlying jobs.

Parameters
Name	Description
`name`	`std::string const &` Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.DeleteScheduleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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: `parent=projects/{project_id}/locations/{location}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.notebooks.v1.Schedule proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.CreateScheduleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.TriggerScheduleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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: `parent=projects/{project_id}/locations/{location}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Execution >

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.ListExecutionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::notebooks::v1::Execution >

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

GetExecution(std::string const &, Options)

Gets details of executions.

Parameters
Name	Description
`name`	`std::string const &` Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.GetExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::notebooks::v1::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 `StatusOr` contains the error details.

DeleteExecution(std::string const &, Options)

Deletes execution.

Parameters
Name	Description
`name`	`std::string const &` Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.DeleteExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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: `parent=projects/{project_id}/locations/{location}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.notebooks.v1.Execution proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.notebooks.v1.CreateExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::location::Location >

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

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

Gets information about a location.

Parameters
Name	Description
`request`	`google::cloud::location::GetLocationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

Gets the access control policy for a resource.

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

Parameters
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

Returns permissions that a caller has on the specified resource.

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

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

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

Lists operations that match the specified filter in the request.

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

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

Returns

Type Description

StreamRange< google::longrunning::Operation >

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

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

Lists operations that match the specified filter in the request.

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

Parameters
Name	Description
`request`	`google::longrunning::ListOperationsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

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

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

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

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

Gets the latest state of a long-running operation.

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

Parameters
Name	Description
`request`	`google::longrunning::GetOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

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

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

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

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

Deletes a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::DeleteOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

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

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

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

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

Starts asynchronous cancellation on a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::CancelOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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