google-cloud-filestore overview (1.24.0)

com.google.cloud.common

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);
 }
 

com.google.cloud.filestore.v1.stub

com.google.cloud.filestore.v1beta1

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 v1beta1.

The file.googleapis.com service implements the Filestore API and defines the following model for managing resources:

  • 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_id}/locations/{location_id}/instances/{instance_id} backups are resources of the form: /projects/{project_id}/locations/{location_id}/backup/{backup_id}

Note that location_id can represent a GCP zone or region depending on the resource. for example: A zonal Filestore instance:

  • projects/my-project/locations/us-central1-c/instances/my-basic-tier-filer A regional Filestore instance:
  • projects/my-project/locations/us-central1/instances/my-enterprise-filer

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);
 }
 

com.google.cloud.filestore.v1beta1.stub