public sealed class CloudFilestoreManagerClientImpl : CloudFilestoreManagerClient
CloudFilestoreManager client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Filestore.V1Assembly
Google.Cloud.Filestore.V1.dll
Remarks
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1.
The file.googleapis.com
service implements the Cloud Filestore API and
defines the following resource model for managing instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of instances and backups, named:
/instances/*
and/backups/*
respectively. - As such, Cloud Filestore instances are resources of the form:
/projects/{project_number}/locations/{location_id}/instances/{instance_id}
and backups are resources of the form:/projects/{project_number}/locations/{location_id}/backup/{backup_id}
Note that location_id must be a GCP zone
for instances and but to a GCP
region
for backups; for example:
projects/12345/locations/us-central1-c/instances/my-filestore
projects/12345/locations/us-central1/backups/my-backup
Constructors
CloudFilestoreManagerClientImpl(CloudFilestoreManager.CloudFilestoreManagerClient, CloudFilestoreManagerSettings, ILogger)
public CloudFilestoreManagerClientImpl(CloudFilestoreManager.CloudFilestoreManagerClient grpcClient, CloudFilestoreManagerSettings settings, ILogger logger)
Constructs a client wrapper for the CloudFilestoreManager service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | CloudFilestoreManager.CloudFilestoreManagerClient The underlying gRPC client. |
settings | CloudFilestoreManagerSettings The base CloudFilestoreManagerSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
CreateBackupOperationsClient
public override OperationsClient CreateBackupOperationsClient { get; }
The long-running operations client for CreateBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteBackupOperationsClient
public override OperationsClient DeleteBackupOperationsClient { get; }
The long-running operations client for DeleteBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteInstanceOperationsClient
public override OperationsClient DeleteInstanceOperationsClient { get; }
The long-running operations client for DeleteInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override CloudFilestoreManager.CloudFilestoreManagerClient GrpcClient { get; }
The underlying gRPC CloudFilestoreManager client
Property Value | |
---|---|
Type | Description |
CloudFilestoreManager.CloudFilestoreManagerClient |
RestoreInstanceOperationsClient
public override OperationsClient RestoreInstanceOperationsClient { get; }
The long-running operations client for RestoreInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateBackupOperationsClient
public override OperationsClient UpdateBackupOperationsClient { get; }
The long-running operations client for UpdateBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateInstanceOperationsClient
public override OperationsClient UpdateInstanceOperationsClient { get; }
The long-running operations client for UpdateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateBackup(CreateBackupRequest, CallSettings)
public override Operation<Backup, OperationMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)
Creates a backup.
Parameters | |
---|---|
Name | Description |
request | CreateBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Backup, OperationMetadata> | The RPC response. |
CreateBackupAsync(CreateBackupRequest, CallSettings)
public override async Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)
Creates a backup.
Parameters | |
---|---|
Name | Description |
request | CreateBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Backup, OperationMetadata>> | A Task containing the RPC response. |
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)
Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)
Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
DeleteBackup(DeleteBackupRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)
Deletes a backup.
Parameters | |
---|---|
Name | Description |
request | DeleteBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteBackupAsync(DeleteBackupRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)
Deletes a backup.
Parameters | |
---|---|
Name | Description |
request | DeleteBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteInstance(DeleteInstanceRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes an instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes an instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
GetBackup(GetBackupRequest, CallSettings)
public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)
Gets the details of a specific backup.
Parameters | |
---|---|
Name | Description |
request | GetBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Backup | The RPC response. |
GetBackupAsync(GetBackupRequest, CallSettings)
public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)
Gets the details of a specific backup.
Parameters | |
---|---|
Name | Description |
request | GetBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Backup> | A Task containing the RPC response. |
GetInstance(GetInstanceRequest, CallSettings)
public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)
Gets the details of a specific instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Instance | The RPC response. |
GetInstanceAsync(GetInstanceRequest, CallSettings)
public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)
Gets the details of a specific instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Instance> | A Task containing the RPC response. |
ListBackups(ListBackupsRequest, CallSettings)
public override PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)
Lists all backups in a project for either a specified location or for all locations.
Parameters | |
---|---|
Name | Description |
request | ListBackupsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListBackupsResponse, Backup> | A pageable sequence of Backup resources. |
ListBackupsAsync(ListBackupsRequest, CallSettings)
public override PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)
Lists all backups in a project for either a specified location or for all locations.
Parameters | |
---|---|
Name | Description |
request | ListBackupsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListBackupsResponse, Backup> | A pageable asynchronous sequence of Backup resources. |
ListInstances(ListInstancesRequest, CallSettings)
public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)
Lists all instances in a project for either a specified location or for all locations.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListInstancesResponse, Instance> | A pageable sequence of Instance resources. |
ListInstancesAsync(ListInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)
Lists all instances in a project for either a specified location or for all locations.
Parameters | |
---|---|
Name | Description |
request | ListInstancesRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListInstancesResponse, Instance> | A pageable asynchronous sequence of Instance resources. |
RestoreInstance(RestoreInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> RestoreInstance(RestoreInstanceRequest request, CallSettings callSettings = null)
Restores an existing instance's file share from a backup.
The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Parameters | |
---|---|
Name | Description |
request | RestoreInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
RestoreInstanceAsync(RestoreInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> RestoreInstanceAsync(RestoreInstanceRequest request, CallSettings callSettings = null)
Restores an existing instance's file share from a backup.
The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Parameters | |
---|---|
Name | Description |
request | RestoreInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
UpdateBackup(UpdateBackupRequest, CallSettings)
public override Operation<Backup, OperationMetadata> UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)
Updates the settings of a specific backup.
Parameters | |
---|---|
Name | Description |
request | UpdateBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Backup, OperationMetadata> | The RPC response. |
UpdateBackupAsync(UpdateBackupRequest, CallSettings)
public override async Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)
Updates the settings of a specific backup.
Parameters | |
---|---|
Name | Description |
request | UpdateBackupRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Backup, OperationMetadata>> | A Task containing the RPC response. |
UpdateInstance(UpdateInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)
Updates the settings of a specific instance.
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)
Updates the settings of a specific instance.
Parameters | |
---|---|
Name | Description |
request | UpdateInstanceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |