- 1.54.0 (latest)
- 1.53.0
- 1.52.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.2.0
The interfaces provided are listed below, along with usage samples.
CloudFilestoreManagerClient
Service Description: Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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);
}
Classes
Backup
A Cloud Filestore backup.
Protobuf type google.cloud.filestore.v1beta1.Backup
Backup.Builder
A Cloud Filestore backup.
Protobuf type google.cloud.filestore.v1beta1.Backup
BackupName
BackupName.Builder
Builder for projects/{project}/locations/{location}/backups/{backup}.
CloudFilestoreManagerClient
Service Description: Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the CloudFilestoreManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of CloudFilestoreManagerSettings to create(). For example:
To customize credentials:
// 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
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
CloudFilestoreManagerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
To customize the endpoint:
// 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
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
CloudFilestoreManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
CloudFilestoreManagerSettings.newBuilder()
.setTransportChannelProvider(
CloudFilestoreManagerSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
CloudFilestoreManagerClient.ListBackupsFixedSizeCollection
CloudFilestoreManagerClient.ListBackupsPage
CloudFilestoreManagerClient.ListBackupsPagedResponse
CloudFilestoreManagerClient.ListInstancesFixedSizeCollection
CloudFilestoreManagerClient.ListInstancesPage
CloudFilestoreManagerClient.ListInstancesPagedResponse
CloudFilestoreManagerGrpc
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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 GCPzone
orregion
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
CloudFilestoreManagerGrpc.CloudFilestoreManagerBlockingStub
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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 GCPzone
orregion
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
CloudFilestoreManagerGrpc.CloudFilestoreManagerFutureStub
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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 GCPzone
orregion
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
CloudFilestoreManagerGrpc.CloudFilestoreManagerImplBase
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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 GCPzone
orregion
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
CloudFilestoreManagerGrpc.CloudFilestoreManagerStub
Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud 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, Cloud 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 GCPzone
orregion
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
CloudFilestoreManagerSettings
Settings class to configure an instance of CloudFilestoreManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (file.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getInstance to 30 seconds:
// 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
CloudFilestoreManagerSettings.Builder cloudFilestoreManagerSettingsBuilder =
CloudFilestoreManagerSettings.newBuilder();
cloudFilestoreManagerSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
cloudFilestoreManagerSettingsBuilder
.getInstanceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
cloudFilestoreManagerSettingsBuilder.build();
CloudFilestoreManagerSettings.Builder
Builder for CloudFilestoreManagerSettings.
CloudFilestoreServiceProto
CreateBackupRequest
CreateBackupRequest creates a backup.
Protobuf type google.cloud.filestore.v1beta1.CreateBackupRequest
CreateBackupRequest.Builder
CreateBackupRequest creates a backup.
Protobuf type google.cloud.filestore.v1beta1.CreateBackupRequest
CreateInstanceRequest
CreateInstanceRequest creates an instance.
Protobuf type google.cloud.filestore.v1beta1.CreateInstanceRequest
CreateInstanceRequest.Builder
CreateInstanceRequest creates an instance.
Protobuf type google.cloud.filestore.v1beta1.CreateInstanceRequest
DeleteBackupRequest
DeleteBackupRequest deletes a backup.
Protobuf type google.cloud.filestore.v1beta1.DeleteBackupRequest
DeleteBackupRequest.Builder
DeleteBackupRequest deletes a backup.
Protobuf type google.cloud.filestore.v1beta1.DeleteBackupRequest
DeleteInstanceRequest
DeleteInstanceRequest deletes an instance.
Protobuf type google.cloud.filestore.v1beta1.DeleteInstanceRequest
DeleteInstanceRequest.Builder
DeleteInstanceRequest deletes an instance.
Protobuf type google.cloud.filestore.v1beta1.DeleteInstanceRequest
FileShareConfig
File share configuration for the instance.
Protobuf type google.cloud.filestore.v1beta1.FileShareConfig
FileShareConfig.Builder
File share configuration for the instance.
Protobuf type google.cloud.filestore.v1beta1.FileShareConfig
GetBackupRequest
GetBackupRequest gets the state of a backup.
Protobuf type google.cloud.filestore.v1beta1.GetBackupRequest
GetBackupRequest.Builder
GetBackupRequest gets the state of a backup.
Protobuf type google.cloud.filestore.v1beta1.GetBackupRequest
GetInstanceRequest
GetInstanceRequest gets the state of an instance.
Protobuf type google.cloud.filestore.v1beta1.GetInstanceRequest
GetInstanceRequest.Builder
GetInstanceRequest gets the state of an instance.
Protobuf type google.cloud.filestore.v1beta1.GetInstanceRequest
Instance
A Cloud Filestore instance.
Protobuf type google.cloud.filestore.v1beta1.Instance
Instance.Builder
A Cloud Filestore instance.
Protobuf type google.cloud.filestore.v1beta1.Instance
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}.
ListBackupsRequest
ListBackupsRequest lists backups.
Protobuf type google.cloud.filestore.v1beta1.ListBackupsRequest
ListBackupsRequest.Builder
ListBackupsRequest lists backups.
Protobuf type google.cloud.filestore.v1beta1.ListBackupsRequest
ListBackupsResponse
ListBackupsResponse is the result of ListBackupsRequest.
Protobuf type google.cloud.filestore.v1beta1.ListBackupsResponse
ListBackupsResponse.Builder
ListBackupsResponse is the result of ListBackupsRequest.
Protobuf type google.cloud.filestore.v1beta1.ListBackupsResponse
ListInstancesRequest
ListInstancesRequest lists instances.
Protobuf type google.cloud.filestore.v1beta1.ListInstancesRequest
ListInstancesRequest.Builder
ListInstancesRequest lists instances.
Protobuf type google.cloud.filestore.v1beta1.ListInstancesRequest
ListInstancesResponse
ListInstancesResponse is the result of ListInstancesRequest.
Protobuf type google.cloud.filestore.v1beta1.ListInstancesResponse
ListInstancesResponse.Builder
ListInstancesResponse is the result of ListInstancesRequest.
Protobuf type google.cloud.filestore.v1beta1.ListInstancesResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
NetworkConfig
Network configuration for the instance.
Protobuf type google.cloud.filestore.v1beta1.NetworkConfig
NetworkConfig.Builder
Network configuration for the instance.
Protobuf type google.cloud.filestore.v1beta1.NetworkConfig
NfsExportOptions
NFS export options specifications.
Protobuf type google.cloud.filestore.v1beta1.NfsExportOptions
NfsExportOptions.Builder
NFS export options specifications.
Protobuf type google.cloud.filestore.v1beta1.NfsExportOptions
RestoreInstanceRequest
RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.
Protobuf type google.cloud.filestore.v1beta1.RestoreInstanceRequest
RestoreInstanceRequest.Builder
RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.
Protobuf type google.cloud.filestore.v1beta1.RestoreInstanceRequest
Snapshot
A Cloud Filestore snapshot.
Protobuf type google.cloud.filestore.v1beta1.Snapshot
Snapshot.Builder
A Cloud Filestore snapshot.
Protobuf type google.cloud.filestore.v1beta1.Snapshot
SnapshotName
SnapshotName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}/snapshots/{snapshot}.
UpdateBackupRequest
UpdateBackupRequest updates description and/or labels for a backup.
Protobuf type google.cloud.filestore.v1beta1.UpdateBackupRequest
UpdateBackupRequest.Builder
UpdateBackupRequest updates description and/or labels for a backup.
Protobuf type google.cloud.filestore.v1beta1.UpdateBackupRequest
UpdateInstanceRequest
UpdateInstanceRequest updates the settings of an instance.
Protobuf type google.cloud.filestore.v1beta1.UpdateInstanceRequest
UpdateInstanceRequest.Builder
UpdateInstanceRequest updates the settings of an instance.
Protobuf type google.cloud.filestore.v1beta1.UpdateInstanceRequest
Interfaces
BackupOrBuilder
CreateBackupRequestOrBuilder
CreateInstanceRequestOrBuilder
DeleteBackupRequestOrBuilder
DeleteInstanceRequestOrBuilder
FileShareConfigOrBuilder
GetBackupRequestOrBuilder
GetInstanceRequestOrBuilder
InstanceOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
NetworkConfigOrBuilder
NfsExportOptionsOrBuilder
RestoreInstanceRequestOrBuilder
SnapshotOrBuilder
UpdateBackupRequestOrBuilder
UpdateInstanceRequestOrBuilder
Enums
Backup.State
The backup state.
Protobuf enum google.cloud.filestore.v1beta1.Backup.State
FileShareConfig.SourceCase
Instance.State
The instance state.
Protobuf enum google.cloud.filestore.v1beta1.Instance.State
Instance.Tier
Available service tiers.
Protobuf enum google.cloud.filestore.v1beta1.Instance.Tier
NetworkConfig.AddressMode
Internet protocol versions supported by Cloud Filestore.
Protobuf enum google.cloud.filestore.v1beta1.NetworkConfig.AddressMode
NfsExportOptions.AccessMode
The access mode.
Protobuf enum google.cloud.filestore.v1beta1.NfsExportOptions.AccessMode
NfsExportOptions.SquashMode
The squash mode.
Protobuf enum google.cloud.filestore.v1beta1.NfsExportOptions.SquashMode
RestoreInstanceRequest.SourceCase
Snapshot.State
The snapshot state.
Protobuf enum google.cloud.filestore.v1beta1.Snapshot.State