@Generated("by gapic-generator-java")
Package com.google.cloud.filestore.v1
A client to Cloud Filestore API
The interfaces provided are listed below, along with usage samples.
======================= CloudFilestoreManagerClient =======================
Service Description: 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`
Sample for CloudFilestoreManagerClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = cloudFilestoreManagerClient.getInstance(name);
}
-
Class Summary Class Description Backup A Filestore backup.Backup.Builder A Filestore backup.BackupName BackupName.Builder Builder for projects/{project}/locations/{location}/backups/{backup}.CloudFilestoreManagerClient Service Description: Configures and manages Filestore resources.CloudFilestoreManagerClient.ListBackupsFixedSizeCollection CloudFilestoreManagerClient.ListBackupsPage CloudFilestoreManagerClient.ListBackupsPagedResponse CloudFilestoreManagerClient.ListInstancesFixedSizeCollection CloudFilestoreManagerClient.ListInstancesPage CloudFilestoreManagerClient.ListInstancesPagedResponse CloudFilestoreManagerClient.ListSnapshotsFixedSizeCollection CloudFilestoreManagerClient.ListSnapshotsPage CloudFilestoreManagerClient.ListSnapshotsPagedResponse CloudFilestoreManagerGrpc Configures and manages Filestore resources.CloudFilestoreManagerGrpc.CloudFilestoreManagerBlockingStub A stub to allow clients to do synchronous rpc calls to service CloudFilestoreManager.CloudFilestoreManagerGrpc.CloudFilestoreManagerFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CloudFilestoreManager.CloudFilestoreManagerGrpc.CloudFilestoreManagerImplBase Base class for the server implementation of the service CloudFilestoreManager.CloudFilestoreManagerGrpc.CloudFilestoreManagerStub A stub to allow clients to do asynchronous rpc calls to service CloudFilestoreManager.CloudFilestoreManagerSettings Settings class to configure an instance ofCloudFilestoreManagerClient
.CloudFilestoreManagerSettings.Builder Builder for CloudFilestoreManagerSettings.CloudFilestoreServiceProto CreateBackupRequest CreateBackupRequest creates a backup.CreateBackupRequest.Builder CreateBackupRequest creates a backup.CreateInstanceRequest CreateInstanceRequest creates an instance.CreateInstanceRequest.Builder CreateInstanceRequest creates an instance.CreateSnapshotRequest CreateSnapshotRequest creates a snapshot.CreateSnapshotRequest.Builder CreateSnapshotRequest creates a snapshot.DeleteBackupRequest DeleteBackupRequest deletes a backup.DeleteBackupRequest.Builder DeleteBackupRequest deletes a backup.DeleteInstanceRequest DeleteInstanceRequest deletes an instance.DeleteInstanceRequest.Builder DeleteInstanceRequest deletes an instance.DeleteSnapshotRequest DeleteSnapshotRequest deletes a snapshot.DeleteSnapshotRequest.Builder DeleteSnapshotRequest deletes a snapshot.FileShareConfig File share configuration for the instance.FileShareConfig.Builder File share configuration for the instance.GetBackupRequest GetBackupRequest gets the state of a backup.GetBackupRequest.Builder GetBackupRequest gets the state of a backup.GetInstanceRequest GetInstanceRequest gets the state of an instance.GetInstanceRequest.Builder GetInstanceRequest gets the state of an instance.GetSnapshotRequest GetSnapshotRequest gets the state of a snapshot.GetSnapshotRequest.Builder GetSnapshotRequest gets the state of a snapshot.Instance A Filestore instance.Instance.Builder A Filestore instance.InstanceName InstanceName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}.ListBackupsRequest ListBackupsRequest lists backups.ListBackupsRequest.Builder ListBackupsRequest lists backups.ListBackupsResponse ListBackupsResponse is the result of ListBackupsRequest.ListBackupsResponse.Builder ListBackupsResponse is the result of ListBackupsRequest.ListInstancesRequest ListInstancesRequest lists instances.ListInstancesRequest.Builder ListInstancesRequest lists instances.ListInstancesResponse ListInstancesResponse is the result of ListInstancesRequest.ListInstancesResponse.Builder ListInstancesResponse is the result of ListInstancesRequest.ListSnapshotsRequest ListSnapshotsRequest lists snapshots.ListSnapshotsRequest.Builder ListSnapshotsRequest lists snapshots.ListSnapshotsResponse ListSnapshotsResponse is the result of ListSnapshotsRequest.ListSnapshotsResponse.Builder ListSnapshotsResponse is the result of ListSnapshotsRequest.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.NetworkConfig Network configuration for the instance.NetworkConfig.Builder Network configuration for the instance.NfsExportOptions NFS export options specifications.NfsExportOptions.Builder NFS export options specifications.RestoreInstanceRequest RestoreInstanceRequest restores an existing instance's file share from a backup.RestoreInstanceRequest.Builder RestoreInstanceRequest restores an existing instance's file share from a backup.Snapshot A Filestore snapshot.Snapshot.Builder A Filestore snapshot.SnapshotName SnapshotName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}/snapshots/{snapshot}.UpdateBackupRequest UpdateBackupRequest updates description and/or labels for a backup.UpdateBackupRequest.Builder UpdateBackupRequest updates description and/or labels for a backup.UpdateInstanceRequest UpdateInstanceRequest updates the settings of an instance.UpdateInstanceRequest.Builder UpdateInstanceRequest updates the settings of an instance.UpdateSnapshotRequest UpdateSnapshotRequest updates description and/or labels for a snapshot.UpdateSnapshotRequest.Builder UpdateSnapshotRequest updates description and/or labels for a snapshot. -
Enum Summary Enum Description Backup.State The backup state.FileShareConfig.SourceCase Instance.State The instance state.Instance.SuspensionReason SuspensionReason contains the possible reasons for a suspension.Instance.Tier Available service tiers.NetworkConfig.AddressMode Internet protocol versions supported by Filestore.NetworkConfig.ConnectMode Available connection modes.NfsExportOptions.AccessMode The access mode.NfsExportOptions.SquashMode The squash mode.RestoreInstanceRequest.SourceCase Snapshot.State The snapshot state.