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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
DeleteSnapshot(std::string const &, Options)
Deletes a snapshot.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The snapshot resource name, in the format |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
DeleteReplication(std::string const &, Options)
Deletes a replication.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The replication resource name, in the format |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |