Class NetAppClient (2.16.0)

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.

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.

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.

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.

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(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.

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(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.

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(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.

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(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.

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.

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.

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.