Cloud Filestore v1 API - Class CloudFilestoreManagerClientImpl (2.4.0)

public sealed class CloudFilestoreManagerClientImpl : CloudFilestoreManagerClient

Reference documentation and code samples for the Cloud Filestore v1 API class CloudFilestoreManagerClientImpl.

CloudFilestoreManager client wrapper implementation, for convenient use.

Inheritance

object > CloudFilestoreManagerClient > CloudFilestoreManagerClientImpl

Namespace

Google.Cloud.Filestore.V1

Assembly

Google.Cloud.Filestore.V1.dll

Remarks

Configures and manages Filestore resources.

Filestore Manager v1.

The file.googleapis.com service implements the 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, 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 Google Cloud zone for instances, but a Google Cloud region for backups; for example:

  • projects/12345/locations/us-central1-c/instances/my-filestore
  • projects/12345/locations/us-central1/backups/my-backup

Constructors

CloudFilestoreManagerClientImpl(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
NameDescription
grpcClientCloudFilestoreManagerCloudFilestoreManagerClient

The underlying gRPC client.

settingsCloudFilestoreManagerSettings

The base CloudFilestoreManagerSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateBackupOperationsClient

public override OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
TypeDescription
OperationsClient
Overrides

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
TypeDescription
OperationsClient
Overrides

CreateSnapshotOperationsClient

public override OperationsClient CreateSnapshotOperationsClient { get; }

The long-running operations client for CreateSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteBackupOperationsClient

public override OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteSnapshotOperationsClient

public override OperationsClient DeleteSnapshotOperationsClient { get; }

The long-running operations client for DeleteSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override CloudFilestoreManager.CloudFilestoreManagerClient GrpcClient { get; }

The underlying gRPC CloudFilestoreManager client

Property Value
TypeDescription
CloudFilestoreManagerCloudFilestoreManagerClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

RestoreInstanceOperationsClient

public override OperationsClient RestoreInstanceOperationsClient { get; }

The long-running operations client for RestoreInstance.

Property Value
TypeDescription
OperationsClient
Overrides

RevertInstanceOperationsClient

public override OperationsClient RevertInstanceOperationsClient { get; }

The long-running operations client for RevertInstance.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateBackupOperationsClient

public override OperationsClient UpdateBackupOperationsClient { get; }

The long-running operations client for UpdateBackup.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateSnapshotOperationsClient

public override OperationsClient UpdateSnapshotOperationsClient { get; }

The long-running operations client for UpdateSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateBackup(CreateBackupRequest, CallSettings)

public override Operation<Backup, OperationMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBackupOperationMetadata

The RPC response.

Overrides

CreateBackupAsync(CreateBackupRequest, CallSettings)

public override Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Overrides

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
NameDescription
requestCreateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The RPC response.

Overrides

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override 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
NameDescription
requestCreateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

CreateSnapshot(CreateSnapshotRequest, CallSettings)

public override Operation<Snapshot, OperationMetadata> CreateSnapshot(CreateSnapshotRequest request, CallSettings callSettings = null)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSnapshotOperationMetadata

The RPC response.

Overrides

CreateSnapshotAsync(CreateSnapshotRequest, CallSettings)

public override Task<Operation<Snapshot, OperationMetadata>> CreateSnapshotAsync(CreateSnapshotRequest request, CallSettings callSettings = null)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSnapshotOperationMetadata

A Task containing the RPC response.

Overrides

DeleteBackup(DeleteBackupRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteSnapshot(DeleteSnapshotRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteSnapshot(DeleteSnapshotRequest request, CallSettings callSettings = null)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteSnapshotAsync(DeleteSnapshotRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteSnapshotAsync(DeleteSnapshotRequest request, CallSettings callSettings = null)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

GetBackup(GetBackupRequest, CallSettings)

public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Backup

The RPC response.

Overrides

GetBackupAsync(GetBackupRequest, CallSettings)

public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskBackup

A Task containing the RPC response.

Overrides

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Instance

The RPC response.

Overrides

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstance

A Task containing the RPC response.

Overrides

GetSnapshot(GetSnapshotRequest, CallSettings)

public override Snapshot GetSnapshot(GetSnapshotRequest request, CallSettings callSettings = null)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Snapshot

The RPC response.

Overrides

GetSnapshotAsync(GetSnapshotRequest, CallSettings)

public override Task<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallSettings callSettings = null)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSnapshot

A Task containing the RPC response.

Overrides

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
NameDescription
requestListBackupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Overrides

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
NameDescription
requestListBackupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Overrides

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
NameDescription
requestListInstancesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.

Overrides

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
NameDescription
requestListInstancesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.

Overrides

ListSnapshots(ListSnapshotsRequest, CallSettings)

public override PagedEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshots(ListSnapshotsRequest request, CallSettings callSettings = null)

Lists all snapshots in a project for either a specified location or for all locations.

Parameters
NameDescription
requestListSnapshotsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListSnapshotsResponseSnapshot

A pageable sequence of Snapshot resources.

Overrides

ListSnapshotsAsync(ListSnapshotsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSnapshotsResponse, Snapshot> ListSnapshotsAsync(ListSnapshotsRequest request, CallSettings callSettings = null)

Lists all snapshots in a project for either a specified location or for all locations.

Parameters
NameDescription
requestListSnapshotsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListSnapshotsResponseSnapshot

A pageable asynchronous sequence of Snapshot resources.

Overrides

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
NameDescription
requestRestoreInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The RPC response.

Overrides

RestoreInstanceAsync(RestoreInstanceRequest, CallSettings)

public override 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
NameDescription
requestRestoreInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

RevertInstance(RevertInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RevertInstance(RevertInstanceRequest request, CallSettings callSettings = null)

Revert an existing instance's file system to a specified snapshot.

Parameters
NameDescription
requestRevertInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The RPC response.

Overrides

RevertInstanceAsync(RevertInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> RevertInstanceAsync(RevertInstanceRequest request, CallSettings callSettings = null)

Revert an existing instance's file system to a specified snapshot.

Parameters
NameDescription
requestRevertInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

UpdateBackup(UpdateBackupRequest, CallSettings)

public override Operation<Backup, OperationMetadata> UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBackupOperationMetadata

The RPC response.

Overrides

UpdateBackupAsync(UpdateBackupRequest, CallSettings)

public override Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Overrides

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The RPC response.

Overrides

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

UpdateSnapshot(UpdateSnapshotRequest, CallSettings)

public override Operation<Snapshot, OperationMetadata> UpdateSnapshot(UpdateSnapshotRequest request, CallSettings callSettings = null)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSnapshotOperationMetadata

The RPC response.

Overrides

UpdateSnapshotAsync(UpdateSnapshotRequest, CallSettings)

public override Task<Operation<Snapshot, OperationMetadata>> UpdateSnapshotAsync(UpdateSnapshotRequest request, CallSettings callSettings = null)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSnapshotOperationMetadata

A Task containing the RPC response.

Overrides