Class NetAppClient (2.27.0-rc)

NetApp Files Google Cloud Service.

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

NetAppClient(NetAppClient const &)

Copy and move support

Parameter
Name Description
NetAppClient const &

NetAppClient(NetAppClient &&)

Copy and move support

Parameter
Name Description
NetAppClient &&

NetAppClient(std::shared_ptr< NetAppConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< NetAppConnection >
opts Options

Operators

operator=(NetAppClient const &)

Copy and move support

Parameter
Name Description
NetAppClient const &
Returns
Type Description
NetAppClient &

operator=(NetAppClient &&)

Copy and move support

Parameter
Name Description
NetAppClient &&
Returns
Type Description
NetAppClient &

Functions

ListStoragePools(std::string const &, Options)

Returns descriptions of all storage pools owned by the caller.

Parameters
Name Description
parent std::string const &

Required. Parent value

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::StoragePool >

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

ListStoragePools(google::cloud::netapp::v1::ListStoragePoolsRequest, Options)

Returns descriptions of all storage pools owned by the caller.

Parameters
Name Description
request google::cloud::netapp::v1::ListStoragePoolsRequest

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.netapp.v1.ListStoragePoolsRequest. 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::netapp::v1::StoragePool >

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

CreateStoragePool(std::string const &, google::cloud::netapp::v1::StoragePool const &, std::string const &, Options)

Creates a new storage pool.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

storage_pool google::cloud::netapp::v1::StoragePool const &

Required. The required parameters to create a new storage pool.

storage_pool_id std::string const &

Required. Id of the requesting storage pool If auto-generating Id server-side, remove this field and id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::StoragePool > >

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.netapp.v1.StoragePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateStoragePool(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::StoragePool const &, std::string const &, Options)

Creates a new storage pool.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
storage_pool google::cloud::netapp::v1::StoragePool const &
storage_pool_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateStoragePool(google::cloud::netapp::v1::CreateStoragePoolRequest const &, Options)

Creates a new storage pool.

Parameters
Name Description
request google::cloud::netapp::v1::CreateStoragePoolRequest 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.netapp.v1.CreateStoragePoolRequest. 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::netapp::v1::StoragePool > >

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.netapp.v1.StoragePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateStoragePool(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateStoragePoolRequest const &, Options)

Creates a new storage pool.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateStoragePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateStoragePool(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new storage pool.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::StoragePool > >

GetStoragePool(std::string const &, Options)

Returns the description of the specified storage pool by poolId.

Parameters
Name Description
name std::string const &

Required. Name of the storage pool

opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::StoragePool >

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

GetStoragePool(google::cloud::netapp::v1::GetStoragePoolRequest const &, Options)

Returns the description of the specified storage pool by poolId.

Parameters
Name Description
request google::cloud::netapp::v1::GetStoragePoolRequest 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.netapp.v1.GetStoragePoolRequest. 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::netapp::v1::StoragePool >

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

UpdateStoragePool(google::cloud::netapp::v1::StoragePool const &, google::protobuf::FieldMask const &, Options)

Updates the storage pool properties with the full spec.

Parameters
Name Description
storage_pool google::cloud::netapp::v1::StoragePool const &

Required. The pool being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the StoragePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::StoragePool > >

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.netapp.v1.StoragePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateStoragePool(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::StoragePool const &, google::protobuf::FieldMask const &, Options)

Updates the storage pool properties with the full spec.

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
ExperimentalTag
NoAwaitTag
storage_pool google::cloud::netapp::v1::StoragePool const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateStoragePool(google::cloud::netapp::v1::UpdateStoragePoolRequest const &, Options)

Updates the storage pool properties with the full spec.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateStoragePoolRequest 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.netapp.v1.UpdateStoragePoolRequest. 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::netapp::v1::StoragePool > >

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.netapp.v1.StoragePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateStoragePool(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateStoragePoolRequest const &, Options)

Updates the storage pool properties with the full spec.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateStoragePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateStoragePool(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the storage pool properties with the full spec.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::StoragePool > >

DeleteStoragePool(std::string const &, Options)

Warning! This operation will permanently delete the storage pool.

Parameters
Name Description
name std::string const &

Required. Name of the storage pool

opts Options

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

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

DeleteStoragePool(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Warning! This operation will permanently delete the storage pool.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteStoragePool(google::cloud::netapp::v1::DeleteStoragePoolRequest const &, Options)

Warning! This operation will permanently delete the storage pool.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteStoragePoolRequest 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.netapp.v1.DeleteStoragePoolRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteStoragePool(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteStoragePoolRequest const &, Options)

Warning! This operation will permanently delete the storage pool.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteStoragePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteStoragePool(ExperimentalTag, google::longrunning::Operation const &, Options)

Warning! This operation will permanently delete the storage pool.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

ListVolumes(std::string const &, Options)

Lists Volumes in a given project.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListVolumesRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::Volume >

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

ListVolumes(google::cloud::netapp::v1::ListVolumesRequest, Options)

Lists Volumes in a given project.

Parameters
Name Description
request google::cloud::netapp::v1::ListVolumesRequest

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.netapp.v1.ListVolumesRequest. 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::netapp::v1::Volume >

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

GetVolume(std::string const &, Options)

Gets details of a single Volume.

Parameters
Name Description
name std::string const &

Required. Name of the volume

opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::Volume >

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

GetVolume(google::cloud::netapp::v1::GetVolumeRequest const &, Options)

Gets details of a single Volume.

Parameters
Name Description
request google::cloud::netapp::v1::GetVolumeRequest 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.netapp.v1.GetVolumeRequest. 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::netapp::v1::Volume >

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

CreateVolume(std::string const &, google::cloud::netapp::v1::Volume const &, std::string const &, Options)

Creates a new Volume in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

volume google::cloud::netapp::v1::Volume const &

Required. The volume being created.

volume_id std::string const &

Required. Id of the requesting volume If auto-generating Id server-side, remove this field and Id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Volume > >

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.netapp.v1.Volume proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVolume(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::Volume const &, std::string const &, Options)

Creates a new Volume 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
ExperimentalTag
NoAwaitTag
parent std::string const &
volume google::cloud::netapp::v1::Volume const &
volume_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateVolume(google::cloud::netapp::v1::CreateVolumeRequest const &, Options)

Creates a new Volume in a given project and location.

Parameters
Name Description
request google::cloud::netapp::v1::CreateVolumeRequest 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.netapp.v1.CreateVolumeRequest. 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::netapp::v1::Volume > >

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.netapp.v1.Volume proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVolume(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateVolumeRequest const &, Options)

Creates a new Volume 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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateVolumeRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateVolume(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new Volume 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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Volume > >

UpdateVolume(google::cloud::netapp::v1::Volume const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Volume.

Parameters
Name Description
volume google::cloud::netapp::v1::Volume const &

Required. The volume being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Volume resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Volume > >

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.netapp.v1.Volume proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateVolume(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::Volume const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Volume.

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
ExperimentalTag
NoAwaitTag
volume google::cloud::netapp::v1::Volume const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateVolume(google::cloud::netapp::v1::UpdateVolumeRequest const &, Options)

Updates the parameters of a single Volume.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateVolumeRequest 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.netapp.v1.UpdateVolumeRequest. 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::netapp::v1::Volume > >

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.netapp.v1.Volume proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateVolume(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateVolumeRequest const &, Options)

Updates the parameters of a single Volume.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateVolumeRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateVolume(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the parameters of a single Volume.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Volume > >

DeleteVolume(std::string const &, Options)

Deletes a single Volume.

Parameters
Name Description
name std::string const &

Required. Name of the volume

opts Options

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

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

DeleteVolume(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single Volume.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteVolume(google::cloud::netapp::v1::DeleteVolumeRequest const &, Options)

Deletes a single Volume.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteVolumeRequest 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.netapp.v1.DeleteVolumeRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVolume(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteVolumeRequest const &, Options)

Deletes a single Volume.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteVolumeRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteVolume(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single Volume.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

RevertVolume(google::cloud::netapp::v1::RevertVolumeRequest const &, Options)

Revert an existing volume to a specified snapshot.

Warning! This operation will permanently revert all changes made after the snapshot was created.

Parameters
Name Description
request google::cloud::netapp::v1::RevertVolumeRequest 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.netapp.v1.RevertVolumeRequest. 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::netapp::v1::Volume > >

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.netapp.v1.Volume proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RevertVolume(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::RevertVolumeRequest const &, Options)

Revert an existing volume to a specified snapshot.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::RevertVolumeRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RevertVolume(ExperimentalTag, google::longrunning::Operation const &, Options)

Revert an existing volume to a specified snapshot.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Volume > >

ListSnapshots(std::string const &, Options)

Returns descriptions of all snapshots for a volume.

Parameters
Name Description
parent std::string const &

Required. The volume for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::Snapshot >

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

ListSnapshots(google::cloud::netapp::v1::ListSnapshotsRequest, Options)

Returns descriptions of all snapshots for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::ListSnapshotsRequest

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.netapp.v1.ListSnapshotsRequest. 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::netapp::v1::Snapshot >

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

GetSnapshot(std::string const &, Options)

Describe a snapshot for a volume.

Parameters
Name Description
name std::string const &

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::Snapshot >

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

GetSnapshot(google::cloud::netapp::v1::GetSnapshotRequest const &, Options)

Describe a snapshot for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::GetSnapshotRequest 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.netapp.v1.GetSnapshotRequest. 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::netapp::v1::Snapshot >

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

CreateSnapshot(std::string const &, google::cloud::netapp::v1::Snapshot const &, std::string const &, Options)

Create a new snapshot for a volume.

Parameters
Name Description
parent std::string const &

Required. The NetApp volume to create the snapshots of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}
snapshot google::cloud::netapp::v1::Snapshot const &

Required. A snapshot resource

snapshot_id std::string const &

Required. ID of the snapshot to create. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Snapshot > >

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.netapp.v1.Snapshot proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSnapshot(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::Snapshot const &, std::string const &, Options)

Create a new snapshot for a volume.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
snapshot google::cloud::netapp::v1::Snapshot const &
snapshot_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateSnapshot(google::cloud::netapp::v1::CreateSnapshotRequest const &, Options)

Create a new snapshot for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::CreateSnapshotRequest 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.netapp.v1.CreateSnapshotRequest. 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::netapp::v1::Snapshot > >

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.netapp.v1.Snapshot proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateSnapshotRequest const &, Options)

Create a new snapshot for a volume.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateSnapshotRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)

Create a new snapshot for a volume.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Snapshot > >

DeleteSnapshot(std::string const &, Options)

Deletes a snapshot.

Parameters
Name Description
name std::string const &

Required. The snapshot resource name, in the format projects/*/locations/*/volumes/*/snapshots/{snapshot_id}
opts Options

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

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

DeleteSnapshot(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a snapshot.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteSnapshot(google::cloud::netapp::v1::DeleteSnapshotRequest const &, Options)

Deletes a snapshot.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteSnapshotRequest 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.netapp.v1.DeleteSnapshotRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteSnapshotRequest const &, Options)

Deletes a snapshot.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteSnapshotRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a snapshot.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

UpdateSnapshot(google::cloud::netapp::v1::Snapshot const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific snapshot.

Parameters
Name Description
snapshot google::cloud::netapp::v1::Snapshot const &

Required. A snapshot resource

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Snapshot > >

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.netapp.v1.Snapshot proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::Snapshot const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific snapshot.

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
ExperimentalTag
NoAwaitTag
snapshot google::cloud::netapp::v1::Snapshot const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateSnapshot(google::cloud::netapp::v1::UpdateSnapshotRequest const &, Options)

Updates the settings of a specific snapshot.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateSnapshotRequest 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.netapp.v1.UpdateSnapshotRequest. 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::netapp::v1::Snapshot > >

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.netapp.v1.Snapshot proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateSnapshotRequest const &, Options)

Updates the settings of a specific snapshot.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateSnapshotRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the settings of a specific snapshot.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Snapshot > >

ListActiveDirectories(std::string const &, Options)

Lists active directories.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListActiveDirectoriesRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::ActiveDirectory >

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

ListActiveDirectories(google::cloud::netapp::v1::ListActiveDirectoriesRequest, Options)

Lists active directories.

Parameters
Name Description
request google::cloud::netapp::v1::ListActiveDirectoriesRequest

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.netapp.v1.ListActiveDirectoriesRequest. 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::netapp::v1::ActiveDirectory >

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

GetActiveDirectory(std::string const &, Options)

Describes a specified active directory.

Parameters
Name Description
name std::string const &

Required. Name of the active directory.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::ActiveDirectory >

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

GetActiveDirectory(google::cloud::netapp::v1::GetActiveDirectoryRequest const &, Options)

Describes a specified active directory.

Parameters
Name Description
request google::cloud::netapp::v1::GetActiveDirectoryRequest 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.netapp.v1.GetActiveDirectoryRequest. 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::netapp::v1::ActiveDirectory >

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

CreateActiveDirectory(std::string const &, google::cloud::netapp::v1::ActiveDirectory const &, std::string const &, Options)

CreateActiveDirectory Creates the active directory specified in the request.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

active_directory google::cloud::netapp::v1::ActiveDirectory const &

Required. Fields of the to be created active directory.

active_directory_id std::string const &

Required. ID of the active directory to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::ActiveDirectory > >

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.netapp.v1.ActiveDirectory proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateActiveDirectory(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::ActiveDirectory const &, std::string const &, Options)

CreateActiveDirectory Creates the active directory specified in the request.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
active_directory google::cloud::netapp::v1::ActiveDirectory const &
active_directory_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateActiveDirectory(google::cloud::netapp::v1::CreateActiveDirectoryRequest const &, Options)

CreateActiveDirectory Creates the active directory specified in the request.

Parameters
Name Description
request google::cloud::netapp::v1::CreateActiveDirectoryRequest 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.netapp.v1.CreateActiveDirectoryRequest. 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::netapp::v1::ActiveDirectory > >

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.netapp.v1.ActiveDirectory proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateActiveDirectory(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateActiveDirectoryRequest const &, Options)

CreateActiveDirectory Creates the active directory specified in the request.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateActiveDirectoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateActiveDirectory(ExperimentalTag, google::longrunning::Operation const &, Options)

CreateActiveDirectory Creates the active directory specified in the request.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::ActiveDirectory > >

UpdateActiveDirectory(google::cloud::netapp::v1::ActiveDirectory const &, google::protobuf::FieldMask const &, Options)

Update the parameters of an active directories.

Parameters
Name Description
active_directory google::cloud::netapp::v1::ActiveDirectory const &

Required. The volume being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::ActiveDirectory > >

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.netapp.v1.ActiveDirectory proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateActiveDirectory(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::ActiveDirectory const &, google::protobuf::FieldMask const &, Options)

Update the parameters of an active directories.

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
ExperimentalTag
NoAwaitTag
active_directory google::cloud::netapp::v1::ActiveDirectory const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateActiveDirectory(google::cloud::netapp::v1::UpdateActiveDirectoryRequest const &, Options)

Update the parameters of an active directories.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateActiveDirectoryRequest 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.netapp.v1.UpdateActiveDirectoryRequest. 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::netapp::v1::ActiveDirectory > >

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.netapp.v1.ActiveDirectory proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateActiveDirectory(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateActiveDirectoryRequest const &, Options)

Update the parameters of an active directories.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateActiveDirectoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateActiveDirectory(ExperimentalTag, google::longrunning::Operation const &, Options)

Update the parameters of an active directories.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::ActiveDirectory > >

DeleteActiveDirectory(std::string const &, Options)

Delete the active directory specified in the request.

Parameters
Name Description
name std::string const &

Required. Name of the active directory.

opts Options

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

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

DeleteActiveDirectory(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Delete the active directory specified in the request.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteActiveDirectory(google::cloud::netapp::v1::DeleteActiveDirectoryRequest const &, Options)

Delete the active directory specified in the request.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteActiveDirectoryRequest 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.netapp.v1.DeleteActiveDirectoryRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteActiveDirectory(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteActiveDirectoryRequest const &, Options)

Delete the active directory specified in the request.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteActiveDirectoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteActiveDirectory(ExperimentalTag, google::longrunning::Operation const &, Options)

Delete the active directory specified in the request.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

ListKmsConfigs(std::string const &, Options)

Returns descriptions of all KMS configs owned by the caller.

Parameters
Name Description
parent std::string const &

Required. Parent value

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::KmsConfig >

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

ListKmsConfigs(google::cloud::netapp::v1::ListKmsConfigsRequest, Options)

Returns descriptions of all KMS configs owned by the caller.

Parameters
Name Description
request google::cloud::netapp::v1::ListKmsConfigsRequest

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.netapp.v1.ListKmsConfigsRequest. 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::netapp::v1::KmsConfig >

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

CreateKmsConfig(std::string const &, google::cloud::netapp::v1::KmsConfig const &, std::string const &, Options)

Creates a new KMS config.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

kms_config google::cloud::netapp::v1::KmsConfig const &

Required. The required parameters to create a new KmsConfig.

kms_config_id std::string const &

Required. Id of the requesting KmsConfig If auto-generating Id server-side, remove this field and id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::KmsConfig > >

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.netapp.v1.KmsConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateKmsConfig(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::KmsConfig const &, std::string const &, Options)

Creates a new KMS config.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
kms_config google::cloud::netapp::v1::KmsConfig const &
kms_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateKmsConfig(google::cloud::netapp::v1::CreateKmsConfigRequest const &, Options)

Creates a new KMS config.

Parameters
Name Description
request google::cloud::netapp::v1::CreateKmsConfigRequest 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.netapp.v1.CreateKmsConfigRequest. 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::netapp::v1::KmsConfig > >

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.netapp.v1.KmsConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateKmsConfig(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateKmsConfigRequest const &, Options)

Creates a new KMS config.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateKmsConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateKmsConfig(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a new KMS config.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::KmsConfig > >

GetKmsConfig(std::string const &, Options)

Returns the description of the specified KMS config by kms_config_id.

Parameters
Name Description
name std::string const &

Required. Name of the KmsConfig

opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::KmsConfig >

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

GetKmsConfig(google::cloud::netapp::v1::GetKmsConfigRequest const &, Options)

Returns the description of the specified KMS config by kms_config_id.

Parameters
Name Description
request google::cloud::netapp::v1::GetKmsConfigRequest 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.netapp.v1.GetKmsConfigRequest. 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::netapp::v1::KmsConfig >

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

UpdateKmsConfig(google::cloud::netapp::v1::KmsConfig const &, google::protobuf::FieldMask const &, Options)

Updates the Kms config properties with the full spec.

Parameters
Name Description
kms_config google::cloud::netapp::v1::KmsConfig const &

Required. The KmsConfig being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::KmsConfig > >

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.netapp.v1.KmsConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateKmsConfig(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::KmsConfig const &, google::protobuf::FieldMask const &, Options)

Updates the Kms config properties with the full spec.

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
ExperimentalTag
NoAwaitTag
kms_config google::cloud::netapp::v1::KmsConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateKmsConfig(google::cloud::netapp::v1::UpdateKmsConfigRequest const &, Options)

Updates the Kms config properties with the full spec.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateKmsConfigRequest 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.netapp.v1.UpdateKmsConfigRequest. 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::netapp::v1::KmsConfig > >

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.netapp.v1.KmsConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateKmsConfig(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateKmsConfigRequest const &, Options)

Updates the Kms config properties with the full spec.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateKmsConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateKmsConfig(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the Kms config properties with the full spec.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::KmsConfig > >

EncryptVolumes(google::cloud::netapp::v1::EncryptVolumesRequest const &, Options)

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

Parameters
Name Description
request google::cloud::netapp::v1::EncryptVolumesRequest 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.netapp.v1.EncryptVolumesRequest. 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::netapp::v1::KmsConfig > >

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.netapp.v1.KmsConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

EncryptVolumes(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::EncryptVolumesRequest const &, Options)

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::EncryptVolumesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

EncryptVolumes(ExperimentalTag, google::longrunning::Operation const &, Options)

Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::KmsConfig > >

VerifyKmsConfig(google::cloud::netapp::v1::VerifyKmsConfigRequest const &, Options)

Verifies KMS config reachability.

Parameters
Name Description
request google::cloud::netapp::v1::VerifyKmsConfigRequest 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.netapp.v1.VerifyKmsConfigRequest. 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::netapp::v1::VerifyKmsConfigResponse >

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

DeleteKmsConfig(std::string const &, Options)

Warning! This operation will permanently delete the Kms config.

Parameters
Name Description
name std::string const &

Required. Name of the KmsConfig.

opts Options

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

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

DeleteKmsConfig(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Warning! This operation will permanently delete the Kms config.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteKmsConfig(google::cloud::netapp::v1::DeleteKmsConfigRequest const &, Options)

Warning! This operation will permanently delete the Kms config.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteKmsConfigRequest 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.netapp.v1.DeleteKmsConfigRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteKmsConfig(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteKmsConfigRequest const &, Options)

Warning! This operation will permanently delete the Kms config.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteKmsConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteKmsConfig(ExperimentalTag, google::longrunning::Operation const &, Options)

Warning! This operation will permanently delete the Kms config.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

ListReplications(std::string const &, Options)

Returns descriptions of all replications for a volume.

Parameters
Name Description
parent std::string const &

Required. The volume for which to retrieve replication information, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::Replication >

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

ListReplications(google::cloud::netapp::v1::ListReplicationsRequest, Options)

Returns descriptions of all replications for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::ListReplicationsRequest

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.netapp.v1.ListReplicationsRequest. 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::netapp::v1::Replication >

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

GetReplication(std::string const &, Options)

Describe a replication for a volume.

Parameters
Name Description
name std::string const &

Required. The replication resource name, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::Replication >

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

GetReplication(google::cloud::netapp::v1::GetReplicationRequest const &, Options)

Describe a replication for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::GetReplicationRequest 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.netapp.v1.GetReplicationRequest. 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::netapp::v1::Replication >

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

CreateReplication(std::string const &, google::cloud::netapp::v1::Replication const &, std::string const &, Options)

Create a new replication for a volume.

Parameters
Name Description
parent std::string const &

Required. The NetApp volume to create the replications of, in the format projects/{project_id}/locations/{location}/volumes/{volume_id}
replication google::cloud::netapp::v1::Replication const &

Required. A replication resource

replication_id std::string const &

Required. ID of the replication to create. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateReplication(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::Replication const &, std::string const &, Options)

Create a new replication for a volume.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
replication google::cloud::netapp::v1::Replication const &
replication_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateReplication(google::cloud::netapp::v1::CreateReplicationRequest const &, Options)

Create a new replication for a volume.

Parameters
Name Description
request google::cloud::netapp::v1::CreateReplicationRequest 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.netapp.v1.CreateReplicationRequest. 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::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateReplicationRequest const &, Options)

Create a new replication for a volume.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateReplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateReplication(ExperimentalTag, google::longrunning::Operation const &, Options)

Create a new replication for a volume.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

DeleteReplication(std::string const &, Options)

Deletes a replication.

Parameters
Name Description
name std::string const &

Required. The replication resource name, in the format projects/*/locations/*/volumes/*/replications/{replication_id}
opts Options

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

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

DeleteReplication(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a replication.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteReplication(google::cloud::netapp::v1::DeleteReplicationRequest const &, Options)

Deletes a replication.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteReplicationRequest 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.netapp.v1.DeleteReplicationRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteReplicationRequest const &, Options)

Deletes a replication.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteReplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteReplication(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a replication.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

UpdateReplication(google::cloud::netapp::v1::Replication const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific replication.

Parameters
Name Description
replication google::cloud::netapp::v1::Replication const &

Required. A replication resource

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::Replication const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific replication.

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
ExperimentalTag
NoAwaitTag
replication google::cloud::netapp::v1::Replication const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateReplication(google::cloud::netapp::v1::UpdateReplicationRequest const &, Options)

Updates the settings of a specific replication.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateReplicationRequest 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.netapp.v1.UpdateReplicationRequest. 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::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateReplicationRequest const &, Options)

Updates the settings of a specific replication.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateReplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateReplication(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the settings of a specific replication.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

StopReplication(google::cloud::netapp::v1::StopReplicationRequest const &, Options)

Stop Cross Region Replication.

Parameters
Name Description
request google::cloud::netapp::v1::StopReplicationRequest 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.netapp.v1.StopReplicationRequest. 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::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::StopReplicationRequest const &, Options)

Stop Cross Region Replication.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::StopReplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

StopReplication(ExperimentalTag, google::longrunning::Operation const &, Options)

Stop Cross Region Replication.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

ResumeReplication(google::cloud::netapp::v1::ResumeReplicationRequest const &, Options)

Resume Cross Region Replication.

Parameters
Name Description
request google::cloud::netapp::v1::ResumeReplicationRequest 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.netapp.v1.ResumeReplicationRequest. 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::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResumeReplication(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::ResumeReplicationRequest const &, Options)

Resume Cross Region Replication.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::ResumeReplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ResumeReplication(ExperimentalTag, google::longrunning::Operation const &, Options)

Resume Cross Region Replication.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

ReverseReplicationDirection(google::cloud::netapp::v1::ReverseReplicationDirectionRequest const &, Options)

Reverses direction of replication.

Source becomes destination and destination becomes source.

Parameters
Name Description
request google::cloud::netapp::v1::ReverseReplicationDirectionRequest 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.netapp.v1.ReverseReplicationDirectionRequest. 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::netapp::v1::Replication > >

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.netapp.v1.Replication proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReverseReplicationDirection(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::ReverseReplicationDirectionRequest const &, Options)

Reverses direction of replication.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::ReverseReplicationDirectionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ReverseReplicationDirection(ExperimentalTag, google::longrunning::Operation const &, Options)

Reverses direction of replication.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Replication > >

CreateBackupVault(std::string const &, google::cloud::netapp::v1::BackupVault const &, std::string const &, Options)

Creates new backup vault.

Parameters
Name Description
parent std::string const &

Required. The location to create the backup vaults, in the format projects/{project_id}/locations/{location}
backup_vault google::cloud::netapp::v1::BackupVault const &

Required. A backupVault resource

backup_vault_id std::string const &

Required. The ID to use for the backupVault. The ID must be unique within the specified location. The max supported length is 63 characters. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupVault > >

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.netapp.v1.BackupVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupVault(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::BackupVault const &, std::string const &, Options)

Creates new backup vault.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
backup_vault google::cloud::netapp::v1::BackupVault const &
backup_vault_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackupVault(google::cloud::netapp::v1::CreateBackupVaultRequest const &, Options)

Creates new backup vault.

Parameters
Name Description
request google::cloud::netapp::v1::CreateBackupVaultRequest 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.netapp.v1.CreateBackupVaultRequest. 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::netapp::v1::BackupVault > >

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.netapp.v1.BackupVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupVault(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateBackupVaultRequest const &, Options)

Creates new backup vault.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateBackupVaultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackupVault(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates new backup vault.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupVault > >

GetBackupVault(std::string const &, Options)

Returns the description of the specified backup vault.

Parameters
Name Description
name std::string const &

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::BackupVault >

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

GetBackupVault(google::cloud::netapp::v1::GetBackupVaultRequest const &, Options)

Returns the description of the specified backup vault.

Parameters
Name Description
request google::cloud::netapp::v1::GetBackupVaultRequest 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.netapp.v1.GetBackupVaultRequest. 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::netapp::v1::BackupVault >

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

ListBackupVaults(std::string const &, Options)

Returns list of all available backup vaults.

Parameters
Name Description
parent std::string const &

Required. The location for which to retrieve backupVault information, in the 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::netapp::v1::BackupVault >

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

ListBackupVaults(google::cloud::netapp::v1::ListBackupVaultsRequest, Options)

Returns list of all available backup vaults.

Parameters
Name Description
request google::cloud::netapp::v1::ListBackupVaultsRequest

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.netapp.v1.ListBackupVaultsRequest. 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::netapp::v1::BackupVault >

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

UpdateBackupVault(google::cloud::netapp::v1::BackupVault const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific backup vault.

Parameters
Name Description
backup_vault google::cloud::netapp::v1::BackupVault const &

Required. The backupVault being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupVault > >

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.netapp.v1.BackupVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupVault(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::BackupVault const &, google::protobuf::FieldMask const &, Options)

Updates the settings of a specific backup vault.

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
ExperimentalTag
NoAwaitTag
backup_vault google::cloud::netapp::v1::BackupVault const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackupVault(google::cloud::netapp::v1::UpdateBackupVaultRequest const &, Options)

Updates the settings of a specific backup vault.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateBackupVaultRequest 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.netapp.v1.UpdateBackupVaultRequest. 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::netapp::v1::BackupVault > >

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.netapp.v1.BackupVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupVault(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateBackupVaultRequest const &, Options)

Updates the settings of a specific backup vault.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateBackupVaultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackupVault(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the settings of a specific backup vault.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupVault > >

DeleteBackupVault(std::string const &, Options)

Warning! This operation will permanently delete the backup vault.

Parameters
Name Description
name std::string const &

Required. The backupVault resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
opts Options

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

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

DeleteBackupVault(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Warning! This operation will permanently delete the backup vault.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackupVault(google::cloud::netapp::v1::DeleteBackupVaultRequest const &, Options)

Warning! This operation will permanently delete the backup vault.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteBackupVaultRequest 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.netapp.v1.DeleteBackupVaultRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackupVault(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteBackupVaultRequest const &, Options)

Warning! This operation will permanently delete the backup vault.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteBackupVaultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackupVault(ExperimentalTag, google::longrunning::Operation const &, Options)

Warning! This operation will permanently delete the backup vault.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

CreateBackup(std::string const &, google::cloud::netapp::v1::Backup const &, std::string const &, Options)

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

Parameters
Name Description
parent std::string const &

Required. The NetApp backupVault to create the backups of, in the format projects/*/locations/*/backupVaults/{backup_vault_id}
backup google::cloud::netapp::v1::Backup const &

Required. A backup resource

backup_id std::string const &

Required. The ID to use for the backup. The ID must be unique within the specified backupVault. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Backup > >

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.netapp.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackup(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::Backup const &, std::string const &, Options)

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
backup google::cloud::netapp::v1::Backup const &
backup_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackup(google::cloud::netapp::v1::CreateBackupRequest const &, Options)

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

Parameters
Name Description
request google::cloud::netapp::v1::CreateBackupRequest 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.netapp.v1.CreateBackupRequest. 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::netapp::v1::Backup > >

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.netapp.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackup(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateBackupRequest const &, Options)

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateBackupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackup(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Backup > >

GetBackup(std::string const &, Options)

Returns the description of the specified backup.

Parameters
Name Description
name std::string const &

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::Backup >

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

GetBackup(google::cloud::netapp::v1::GetBackupRequest const &, Options)

Returns the description of the specified backup.

Parameters
Name Description
request google::cloud::netapp::v1::GetBackupRequest 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.netapp.v1.GetBackupRequest. 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::netapp::v1::Backup >

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

ListBackups(std::string const &, Options)

Returns descriptions of all backups for a backupVault.

Parameters
Name Description
parent std::string const &

Required. The backupVault for which to retrieve backup information, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}. To retrieve backup information for all locations, use "-" for the {location} value. To retrieve backup information for all backupVaults, use "-" for the {backup_vault_id} value. To retrieve backup information for a volume, use "-" for the {backup_vault_id} value and specify volume full name with the filter.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::Backup >

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

ListBackups(google::cloud::netapp::v1::ListBackupsRequest, Options)

Returns descriptions of all backups for a backupVault.

Parameters
Name Description
request google::cloud::netapp::v1::ListBackupsRequest

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.netapp.v1.ListBackupsRequest. 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::netapp::v1::Backup >

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

DeleteBackup(std::string const &, Options)

Warning! This operation will permanently delete the backup.

Parameters
Name Description
name std::string const &

Required. The backup resource name, in the format projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}
opts Options

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

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

DeleteBackup(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Warning! This operation will permanently delete the backup.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackup(google::cloud::netapp::v1::DeleteBackupRequest const &, Options)

Warning! This operation will permanently delete the backup.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteBackupRequest 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.netapp.v1.DeleteBackupRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackup(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteBackupRequest const &, Options)

Warning! This operation will permanently delete the backup.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteBackupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackup(ExperimentalTag, google::longrunning::Operation const &, Options)

Warning! This operation will permanently delete the backup.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >

UpdateBackup(google::cloud::netapp::v1::Backup const &, google::protobuf::FieldMask const &, Options)

Update backup with full spec.

Parameters
Name Description
backup google::cloud::netapp::v1::Backup const &

Required. The backup being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Backup resource to be updated. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Backup > >

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.netapp.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::Backup const &, google::protobuf::FieldMask const &, Options)

Update backup with full spec.

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
ExperimentalTag
NoAwaitTag
backup google::cloud::netapp::v1::Backup const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackup(google::cloud::netapp::v1::UpdateBackupRequest const &, Options)

Update backup with full spec.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateBackupRequest 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.netapp.v1.UpdateBackupRequest. 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::netapp::v1::Backup > >

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.netapp.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateBackupRequest const &, Options)

Update backup with full spec.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateBackupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackup(ExperimentalTag, google::longrunning::Operation const &, Options)

Update backup with full spec.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::Backup > >

CreateBackupPolicy(std::string const &, google::cloud::netapp::v1::BackupPolicy const &, std::string const &, Options)

Creates new backup policy.

Parameters
Name Description
parent std::string const &

Required. The location to create the backup policies of, in the format projects/{project_id}/locations/{location}
backup_policy google::cloud::netapp::v1::BackupPolicy const &

Required. A backupPolicy resource

backup_policy_id std::string const &

Required. The ID to use for the backup policy. The ID must be unique within the specified location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupPolicy > >

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.netapp.v1.BackupPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupPolicy(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::netapp::v1::BackupPolicy const &, std::string const &, Options)

Creates new backup policy.

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
ExperimentalTag
NoAwaitTag
parent std::string const &
backup_policy google::cloud::netapp::v1::BackupPolicy const &
backup_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackupPolicy(google::cloud::netapp::v1::CreateBackupPolicyRequest const &, Options)

Creates new backup policy.

Parameters
Name Description
request google::cloud::netapp::v1::CreateBackupPolicyRequest 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.netapp.v1.CreateBackupPolicyRequest. 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::netapp::v1::BackupPolicy > >

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.netapp.v1.BackupPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupPolicy(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::CreateBackupPolicyRequest const &, Options)

Creates new backup policy.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::CreateBackupPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackupPolicy(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates new backup policy.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupPolicy > >

GetBackupPolicy(std::string const &, Options)

Returns the description of the specified backup policy by backup_policy_id.

Parameters
Name Description
name std::string const &

Required. The backupPolicy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}
opts Options

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

Returns
Type Description
StatusOr< google::cloud::netapp::v1::BackupPolicy >

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

GetBackupPolicy(google::cloud::netapp::v1::GetBackupPolicyRequest const &, Options)

Returns the description of the specified backup policy by backup_policy_id.

Parameters
Name Description
request google::cloud::netapp::v1::GetBackupPolicyRequest 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.netapp.v1.GetBackupPolicyRequest. 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::netapp::v1::BackupPolicy >

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

ListBackupPolicies(std::string const &, Options)

Returns list of all available backup policies.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListBackupPoliciesRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::netapp::v1::BackupPolicy >

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

ListBackupPolicies(google::cloud::netapp::v1::ListBackupPoliciesRequest, Options)

Returns list of all available backup policies.

Parameters
Name Description
request google::cloud::netapp::v1::ListBackupPoliciesRequest

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.netapp.v1.ListBackupPoliciesRequest. 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::netapp::v1::BackupPolicy >

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

UpdateBackupPolicy(google::cloud::netapp::v1::BackupPolicy const &, google::protobuf::FieldMask const &, Options)

Updates settings of a specific backup policy.

Parameters
Name Description
backup_policy google::cloud::netapp::v1::BackupPolicy const &

Required. The backup policy being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupPolicy > >

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.netapp.v1.BackupPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupPolicy(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::BackupPolicy const &, google::protobuf::FieldMask const &, Options)

Updates settings of a specific backup policy.

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
ExperimentalTag
NoAwaitTag
backup_policy google::cloud::netapp::v1::BackupPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackupPolicy(google::cloud::netapp::v1::UpdateBackupPolicyRequest const &, Options)

Updates settings of a specific backup policy.

Parameters
Name Description
request google::cloud::netapp::v1::UpdateBackupPolicyRequest 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.netapp.v1.UpdateBackupPolicyRequest. 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::netapp::v1::BackupPolicy > >

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.netapp.v1.BackupPolicy proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupPolicy(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::UpdateBackupPolicyRequest const &, Options)

Updates settings of a specific backup policy.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::UpdateBackupPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBackupPolicy(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates settings of a specific backup policy.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::BackupPolicy > >

DeleteBackupPolicy(std::string const &, Options)

Warning! This operation will permanently delete the backup policy.

Parameters
Name Description
name std::string const &

Required. The backup policy resource name, in the format projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}
opts Options

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

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

DeleteBackupPolicy(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Warning! This operation will permanently delete the backup policy.

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
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackupPolicy(google::cloud::netapp::v1::DeleteBackupPolicyRequest const &, Options)

Warning! This operation will permanently delete the backup policy.

Parameters
Name Description
request google::cloud::netapp::v1::DeleteBackupPolicyRequest 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.netapp.v1.DeleteBackupPolicyRequest. 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::netapp::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.netapp.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackupPolicy(ExperimentalTag, NoAwaitTag, google::cloud::netapp::v1::DeleteBackupPolicyRequest const &, Options)

Warning! This operation will permanently delete the backup policy.

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
ExperimentalTag
NoAwaitTag
request google::cloud::netapp::v1::DeleteBackupPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBackupPolicy(ExperimentalTag, google::longrunning::Operation const &, Options)

Warning! This operation will permanently delete the backup policy.

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
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::netapp::v1::OperationMetadata > >