Interface CloudFilestoreManagerGrpc.AsyncService (1.55.0)

public static interface CloudFilestoreManagerGrpc.AsyncService

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

Methods

createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

public default void createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

Creates a backup.

Parameters
Name Description
request CreateBackupRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

createSnapshot(CreateSnapshotRequest request, StreamObserver<Operation> responseObserver)

public default void createSnapshot(CreateSnapshotRequest request, StreamObserver<Operation> responseObserver)

Creates a snapshot.

Parameters
Name Description
request CreateSnapshotRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

public default void deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

Deletes a backup.

Parameters
Name Description
request DeleteBackupRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

Deletes an instance.

Parameters
Name Description
request DeleteInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Operation> responseObserver)

public default void deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Operation> responseObserver)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

public default void getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest
responseObserver io.grpc.stub.StreamObserver<Backup>

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets the details of a specific instance.

Parameters
Name Description
request GetInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Instance>

getSnapshot(GetSnapshotRequest request, StreamObserver<Snapshot> responseObserver)

public default void getSnapshot(GetSnapshotRequest request, StreamObserver<Snapshot> responseObserver)

Gets the details of a specific snapshot.

Parameters
Name Description
request GetSnapshotRequest
responseObserver io.grpc.stub.StreamObserver<Snapshot>

listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

public default void listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

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

Parameters
Name Description
request ListBackupsRequest
responseObserver io.grpc.stub.StreamObserver<ListBackupsResponse>

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

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

Parameters
Name Description
request ListInstancesRequest
responseObserver io.grpc.stub.StreamObserver<ListInstancesResponse>

listSnapshots(ListSnapshotsRequest request, StreamObserver<ListSnapshotsResponse> responseObserver)

public default void listSnapshots(ListSnapshotsRequest request, StreamObserver<ListSnapshotsResponse> responseObserver)

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

Parameters
Name Description
request ListSnapshotsRequest
responseObserver io.grpc.stub.StreamObserver<ListSnapshotsResponse>

restoreInstance(RestoreInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void restoreInstance(RestoreInstanceRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

revertInstance(RevertInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void revertInstance(RevertInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request RevertInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateBackup(UpdateBackupRequest request, StreamObserver<Operation> responseObserver)

public default void updateBackup(UpdateBackupRequest request, StreamObserver<Operation> responseObserver)

Updates the settings of a specific backup.

Parameters
Name Description
request UpdateBackupRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

Updates the settings of a specific instance.

Parameters
Name Description
request UpdateInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateSnapshot(UpdateSnapshotRequest request, StreamObserver<Operation> responseObserver)

public default void updateSnapshot(UpdateSnapshotRequest request, StreamObserver<Operation> responseObserver)

Updates the settings of a specific snapshot.

Parameters
Name Description
request UpdateSnapshotRequest
responseObserver io.grpc.stub.StreamObserver<Operation>