Cloud Filestore v1 API - Class CloudFilestoreManager.CloudFilestoreManagerClient (2.5.0)

public class CloudFilestoreManager.CloudFilestoreManagerClient : ClientBase<CloudFilestoreManager.CloudFilestoreManagerClient>

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

Client for CloudFilestoreManager

Inheritance

object > ClientBase > ClientBaseCloudFilestoreManagerCloudFilestoreManagerClient > CloudFilestoreManager.CloudFilestoreManagerClient

Namespace

Google.Cloud.Filestore.V1

Assembly

Google.Cloud.Filestore.V1.dll

Constructors

CloudFilestoreManagerClient()

protected CloudFilestoreManagerClient()

Protected parameterless constructor to allow creation of test doubles.

CloudFilestoreManagerClient(CallInvoker)

public CloudFilestoreManagerClient(CallInvoker callInvoker)

Creates a new client for CloudFilestoreManager that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudFilestoreManagerClient(ChannelBase)

public CloudFilestoreManagerClient(ChannelBase channel)

Creates a new client for CloudFilestoreManager

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudFilestoreManagerClient(ClientBaseConfiguration)

protected CloudFilestoreManagerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateBackup(CreateBackupRequest, CallOptions)

public virtual Operation CreateBackup(CreateBackupRequest request, CallOptions options)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateBackup(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateBackup(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateBackupAsync(CreateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, CallOptions options)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateBackupAsync(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a backup.

Parameters
NameDescription
requestCreateBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateSnapshot(CreateSnapshotRequest, CallOptions)

public virtual Operation CreateSnapshot(CreateSnapshotRequest request, CallOptions options)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateSnapshot(CreateSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateSnapshot(CreateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateSnapshotAsync(CreateSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateSnapshotAsync(CreateSnapshotRequest request, CallOptions options)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateSnapshotAsync(CreateSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateSnapshotAsync(CreateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Operation DeleteBackup(DeleteBackupRequest request, CallOptions options)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteSnapshot(DeleteSnapshotRequest, CallOptions)

public virtual Operation DeleteSnapshot(DeleteSnapshotRequest request, CallOptions options)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteSnapshot(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteSnapshot(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteSnapshotAsync(DeleteSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteSnapshotAsync(DeleteSnapshotRequest request, CallOptions options)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteSnapshotAsync(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteSnapshotAsync(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Backup

The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Backup

The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackup

The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBackup

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstance

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstance

The call object.

GetSnapshot(GetSnapshotRequest, CallOptions)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, CallOptions options)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Snapshot

The response received from the server.

GetSnapshot(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Snapshot

The response received from the server.

GetSnapshotAsync(GetSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallOptions options)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSnapshot

The call object.

GetSnapshotAsync(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific snapshot.

Parameters
NameDescription
requestGetSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSnapshot

The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListBackupsResponse

The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListBackupsResponse

The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListBackupsResponse

The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListBackupsResponse

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListInstancesResponse

The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListInstancesResponse

The call object.

ListSnapshots(ListSnapshotsRequest, CallOptions)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListSnapshotsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSnapshotsResponse

The response received from the server.

ListSnapshots(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListSnapshotsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListSnapshotsResponse

The response received from the server.

ListSnapshotsAsync(ListSnapshotsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListSnapshotsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListSnapshotsResponse

The call object.

ListSnapshotsAsync(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListSnapshotsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListSnapshotsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CloudFilestoreManager.CloudFilestoreManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
CloudFilestoreManagerCloudFilestoreManagerClient
Overrides

RestoreInstance(RestoreInstanceRequest, CallOptions)

public virtual Operation RestoreInstance(RestoreInstanceRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RestoreInstance(RestoreInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestoreInstance(RestoreInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RestoreInstanceAsync(RestoreInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreInstanceAsync(RestoreInstanceRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RestoreInstanceAsync(RestoreInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreInstanceAsync(RestoreInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RevertInstance(RevertInstanceRequest, CallOptions)

public virtual Operation RevertInstance(RevertInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestRevertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RevertInstance(RevertInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RevertInstance(RevertInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestRevertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RevertInstanceAsync(RevertInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RevertInstanceAsync(RevertInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestRevertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RevertInstanceAsync(RevertInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RevertInstanceAsync(RevertInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestRevertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateBackup(UpdateBackupRequest, CallOptions)

public virtual Operation UpdateBackup(UpdateBackupRequest request, CallOptions options)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateBackup(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateBackup(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateBackupAsync(UpdateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateBackupAsync(UpdateBackupRequest request, CallOptions options)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateBackupAsync(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateBackupAsync(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific backup.

Parameters
NameDescription
requestUpdateBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstance(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateInstanceAsync(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific instance.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateSnapshot(UpdateSnapshotRequest, CallOptions)

public virtual Operation UpdateSnapshot(UpdateSnapshotRequest request, CallOptions options)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateSnapshot(UpdateSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateSnapshot(UpdateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateSnapshotAsync(UpdateSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateSnapshotAsync(UpdateSnapshotRequest request, CallOptions options)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateSnapshotAsync(UpdateSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateSnapshotAsync(UpdateSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the settings of a specific snapshot.

Parameters
NameDescription
requestUpdateSnapshotRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.