Interface CloudFilestoreManagerGrpc.AsyncService (1.15.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
NameDescription
requestCreateBackupRequest
responseObserverio.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
NameDescription
requestCreateInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createSnapshot(CreateSnapshotRequest request, StreamObserver<Operation> responseObserver)

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

Creates a snapshot.

Parameters
NameDescription
requestCreateSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Deletes an instance.

Parameters
NameDescription
requestDeleteInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a snapshot.

Parameters
NameDescription
requestDeleteSnapshotRequest
responseObserverio.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
NameDescription
requestGetBackupRequest
responseObserverio.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
NameDescription
requestGetInstanceRequest
responseObserverio.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
NameDescription
requestGetSnapshotRequest
responseObserverio.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
NameDescription
requestListBackupsRequest
responseObserverio.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
NameDescription
requestListInstancesRequest
responseObserverio.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
NameDescription
requestListSnapshotsRequest
responseObserverio.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
NameDescription
requestRestoreInstanceRequest
responseObserverio.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
NameDescription
requestUpdateBackupRequest
responseObserverio.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
NameDescription
requestUpdateInstanceRequest
responseObserverio.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
NameDescription
requestUpdateSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<Operation>