- 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
public class CloudFilestoreManagerClient implements BackgroundResource
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:
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:
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
CloudFilestoreManagerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
To customize the endpoint:
CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
CloudFilestoreManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final CloudFilestoreManagerClient create()
Constructs an instance of CloudFilestoreManagerClient with default settings.
Type | Description |
CloudFilestoreManagerClient |
Type | Description |
IOException |
create(CloudFilestoreManagerSettings settings)
public static final CloudFilestoreManagerClient create(CloudFilestoreManagerSettings settings)
Constructs an instance of CloudFilestoreManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | CloudFilestoreManagerSettings |
Type | Description |
CloudFilestoreManagerClient |
Type | Description |
IOException |
create(CloudFilestoreManagerStub stub)
public static final CloudFilestoreManagerClient create(CloudFilestoreManagerStub stub)
Constructs an instance of CloudFilestoreManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudFilestoreManagerSettings).
Name | Description |
stub | CloudFilestoreManagerStub |
Type | Description |
CloudFilestoreManagerClient |
Constructors
CloudFilestoreManagerClient(CloudFilestoreManagerSettings settings)
protected CloudFilestoreManagerClient(CloudFilestoreManagerSettings settings)
Constructs an instance of CloudFilestoreManagerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Name | Description |
settings | CloudFilestoreManagerSettings |
CloudFilestoreManagerClient(CloudFilestoreManagerStub stub)
protected CloudFilestoreManagerClient(CloudFilestoreManagerStub stub)
Name | Description |
stub | CloudFilestoreManagerStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createBackupAsync(CreateBackupRequest request)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request)
Creates a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackup(Backup.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
Backup response = cloudFilestoreManagerClient.createBackupAsync(request).get();
}
Name | Description |
request | CreateBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(LocationName parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(LocationName parent, Backup backup, String backupId)
Creates a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response =
cloudFilestoreManagerClient.createBackupAsync(parent, backup, backupId).get();
}
Name | Description |
parent | LocationName Required. The backup's project and location, in the format
|
backup | Backup Required. A backup resource |
backupId | String Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(String parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId)
Creates a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response =
cloudFilestoreManagerClient.createBackupAsync(parent, backup, backupId).get();
}
Name | Description |
parent | String Required. The backup's project and location, in the format
|
backup | Backup Required. A backup resource |
backupId | String Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupCallable()
public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()
Creates a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackup(Backup.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.createBackupCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateBackupRequest,Operation> |
createBackupOperationCallable()
public final OperationCallable<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationCallable()
Creates a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackup(Backup.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
OperationFuture<Backup, OperationMetadata> future =
cloudFilestoreManagerClient.createBackupOperationCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Type | Description |
OperationCallable<CreateBackupRequest,Backup,OperationMetadata> |
createInstanceAsync(CreateInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.build();
Instance response = cloudFilestoreManagerClient.createInstanceAsync(request).get();
}
Name | Description |
request | CreateInstanceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(LocationName parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(LocationName parent, Instance instance, String instanceId)
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
cloudFilestoreManagerClient.createInstanceAsync(parent, instance, instanceId).get();
}
Name | Description |
parent | LocationName Required. The instance's project and location, in the format
|
instance | Instance Required. An instance resource |
instanceId | String Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(String parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
cloudFilestoreManagerClient.createInstanceAsync(parent, instance, instanceId).get();
}
Name | Description |
parent | String Required. The instance's project and location, in the format
|
instance | Instance Required. An instance resource |
instanceId | String Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceCallable()
public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.createInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateInstanceRequest,Operation> |
createInstanceOperationCallable()
public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.build();
OperationFuture<Instance, OperationMetadata> future =
cloudFilestoreManagerClient.createInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Type | Description |
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> |
deleteBackupAsync(BackupName name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(BackupName name)
Deletes a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]");
cloudFilestoreManagerClient.deleteBackupAsync(name).get();
}
Name | Description |
name | BackupName Required. The backup resource name, in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(DeleteBackupRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)
Deletes a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.build();
cloudFilestoreManagerClient.deleteBackupAsync(request).get();
}
Name | Description |
request | DeleteBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)
Deletes a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString();
cloudFilestoreManagerClient.deleteBackupAsync(name).get();
}
Name | Description |
name | String Required. The backup resource name, in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupCallable()
public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()
Deletes a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.deleteBackupCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteBackupRequest,Operation> |
deleteBackupOperationCallable()
public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()
Deletes a backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
cloudFilestoreManagerClient.deleteBackupOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> |
deleteInstanceAsync(DeleteInstanceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)
Deletes an instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
cloudFilestoreManagerClient.deleteInstanceAsync(request).get();
}
Name | Description |
request | DeleteInstanceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceAsync(InstanceName name)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(InstanceName name)
Deletes an instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
cloudFilestoreManagerClient.deleteInstanceAsync(name).get();
}
Name | Description |
name | InstanceName Required. The instance resource name, in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(String name)
Deletes an instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
cloudFilestoreManagerClient.deleteInstanceAsync(name).get();
}
Name | Description |
name | String Required. The instance resource name, in the format
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceCallable()
public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()
Deletes an instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.deleteInstanceCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteInstanceRequest,Operation> |
deleteInstanceOperationCallable()
public final OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationCallable()
Deletes an instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
cloudFilestoreManagerClient.deleteInstanceOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> |
getBackup(BackupName name)
public final Backup getBackup(BackupName name)
Gets the details of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]");
Backup response = cloudFilestoreManagerClient.getBackup(name);
}
Name | Description |
name | BackupName Required. The backup resource name, in the format
|
Type | Description |
Backup |
getBackup(GetBackupRequest request)
public final Backup getBackup(GetBackupRequest request)
Gets the details of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.build();
Backup response = cloudFilestoreManagerClient.getBackup(request);
}
Name | Description |
request | GetBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
Backup |
getBackup(String name)
public final Backup getBackup(String name)
Gets the details of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString();
Backup response = cloudFilestoreManagerClient.getBackup(name);
}
Name | Description |
name | String Required. The backup resource name, in the format
|
Type | Description |
Backup |
getBackupCallable()
public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()
Gets the details of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.build();
ApiFuture<Backup> future =
cloudFilestoreManagerClient.getBackupCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Type | Description |
UnaryCallable<GetBackupRequest,Backup> |
getInstance(GetInstanceRequest request)
public final Instance getInstance(GetInstanceRequest request)
Gets the details of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
Instance response = cloudFilestoreManagerClient.getInstance(request);
}
Name | Description |
request | GetInstanceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Instance |
getInstance(InstanceName name)
public final Instance getInstance(InstanceName name)
Gets the details of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = cloudFilestoreManagerClient.getInstance(name);
}
Name | Description |
name | InstanceName Required. The instance resource name, in the format
|
Type | Description |
Instance |
getInstance(String name)
public final Instance getInstance(String name)
Gets the details of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
Instance response = cloudFilestoreManagerClient.getInstance(name);
}
Name | Description |
name | String Required. The instance resource name, in the format
|
Type | Description |
Instance |
getInstanceCallable()
public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()
Gets the details of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
ApiFuture<Instance> future =
cloudFilestoreManagerClient.getInstanceCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Type | Description |
UnaryCallable<GetInstanceRequest,Instance> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getSettings()
public final CloudFilestoreManagerSettings getSettings()
Type | Description |
CloudFilestoreManagerSettings |
getStub()
public CloudFilestoreManagerStub getStub()
Type | Description |
CloudFilestoreManagerStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listBackups(ListBackupsRequest request)
public final CloudFilestoreManagerClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)
Lists all backups in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
for (Backup element : cloudFilestoreManagerClient.listBackups(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListBackupsRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudFilestoreManagerClient.ListBackupsPagedResponse |
listBackups(LocationName parent)
public final CloudFilestoreManagerClient.ListBackupsPagedResponse listBackups(LocationName parent)
Lists all backups in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Backup element : cloudFilestoreManagerClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The project and location for which to retrieve backup information, in
the format |
Type | Description |
CloudFilestoreManagerClient.ListBackupsPagedResponse |
listBackups(String parent)
public final CloudFilestoreManagerClient.ListBackupsPagedResponse listBackups(String parent)
Lists all backups in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Backup element : cloudFilestoreManagerClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The project and location for which to retrieve backup information, in
the format |
Type | Description |
CloudFilestoreManagerClient.ListBackupsPagedResponse |
listBackupsCallable()
public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()
Lists all backups in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
while (true) {
ListBackupsResponse response =
cloudFilestoreManagerClient.listBackupsCallable().call(request);
for (Backup element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsResponse> |
listBackupsPagedCallable()
public final UnaryCallable<ListBackupsRequest,CloudFilestoreManagerClient.ListBackupsPagedResponse> listBackupsPagedCallable()
Lists all backups in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
ApiFuture<Backup> future =
cloudFilestoreManagerClient.listBackupsPagedCallable().futureCall(request);
// Do something.
for (Backup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse> |
listInstances(ListInstancesRequest request)
public final CloudFilestoreManagerClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)
Lists all instances in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
for (Instance element : cloudFilestoreManagerClient.listInstances(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListInstancesRequest The request object containing all of the parameters for the API call. |
Type | Description |
CloudFilestoreManagerClient.ListInstancesPagedResponse |
listInstances(LocationName parent)
public final CloudFilestoreManagerClient.ListInstancesPagedResponse listInstances(LocationName parent)
Lists all instances in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Instance element : cloudFilestoreManagerClient.listInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The project and location for which to retrieve instance information, in
the format |
Type | Description |
CloudFilestoreManagerClient.ListInstancesPagedResponse |
listInstances(String parent)
public final CloudFilestoreManagerClient.ListInstancesPagedResponse listInstances(String parent)
Lists all instances in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Instance element : cloudFilestoreManagerClient.listInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The project and location for which to retrieve instance information, in
the format |
Type | Description |
CloudFilestoreManagerClient.ListInstancesPagedResponse |
listInstancesCallable()
public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()
Lists all instances in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
while (true) {
ListInstancesResponse response =
cloudFilestoreManagerClient.listInstancesCallable().call(request);
for (Instance element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesResponse> |
listInstancesPagedCallable()
public final UnaryCallable<ListInstancesRequest,CloudFilestoreManagerClient.ListInstancesPagedResponse> listInstancesPagedCallable()
Lists all instances in a project for either a specified location or for all locations.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setFilter("filter-1274492040")
.build();
ApiFuture<Instance> future =
cloudFilestoreManagerClient.listInstancesPagedCallable().futureCall(request);
// Do something.
for (Instance element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse> |
restoreInstanceAsync(RestoreInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> restoreInstanceAsync(RestoreInstanceRequest request)
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
RestoreInstanceRequest request =
RestoreInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setFileShare("fileShare-1327728701")
.build();
Instance response = cloudFilestoreManagerClient.restoreInstanceAsync(request).get();
}
Name | Description |
request | RestoreInstanceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Instance,OperationMetadata> |
restoreInstanceCallable()
public final UnaryCallable<RestoreInstanceRequest,Operation> restoreInstanceCallable()
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
RestoreInstanceRequest request =
RestoreInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setFileShare("fileShare-1327728701")
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.restoreInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<RestoreInstanceRequest,Operation> |
restoreInstanceOperationCallable()
public final OperationCallable<RestoreInstanceRequest,Instance,OperationMetadata> restoreInstanceOperationCallable()
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).
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
RestoreInstanceRequest request =
RestoreInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setFileShare("fileShare-1327728701")
.build();
OperationFuture<Instance, OperationMetadata> future =
cloudFilestoreManagerClient.restoreInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Type | Description |
OperationCallable<RestoreInstanceRequest,Instance,OperationMetadata> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateBackupAsync(Backup backup, FieldMask updateMask)
public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(Backup backup, FieldMask updateMask)
Updates the settings of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
Backup backup = Backup.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Backup response = cloudFilestoreManagerClient.updateBackupAsync(backup, updateMask).get();
}
Name | Description |
backup | Backup Required. A backup resource |
updateMask | FieldMask Required. Mask of fields to update. At least one path must be supplied in this field. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
updateBackupAsync(UpdateBackupRequest request)
public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(UpdateBackupRequest request)
Updates the settings of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateBackupRequest request =
UpdateBackupRequest.newBuilder()
.setBackup(Backup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Backup response = cloudFilestoreManagerClient.updateBackupAsync(request).get();
}
Name | Description |
request | UpdateBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
updateBackupCallable()
public final UnaryCallable<UpdateBackupRequest,Operation> updateBackupCallable()
Updates the settings of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateBackupRequest request =
UpdateBackupRequest.newBuilder()
.setBackup(Backup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.updateBackupCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateBackupRequest,Operation> |
updateBackupOperationCallable()
public final OperationCallable<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationCallable()
Updates the settings of a specific backup.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateBackupRequest request =
UpdateBackupRequest.newBuilder()
.setBackup(Backup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Backup, OperationMetadata> future =
cloudFilestoreManagerClient.updateBackupOperationCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Type | Description |
OperationCallable<UpdateBackupRequest,Backup,OperationMetadata> |
updateInstanceAsync(Instance instance, FieldMask updateMask)
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, FieldMask updateMask)
Updates the settings of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
Instance instance = Instance.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Instance response =
cloudFilestoreManagerClient.updateInstanceAsync(instance, updateMask).get();
}
Name | Description |
instance | Instance Required. Only fields specified in update_mask are updated. |
updateMask | FieldMask Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields:
|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
updateInstanceAsync(UpdateInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)
Updates the settings of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.build();
Instance response = cloudFilestoreManagerClient.updateInstanceAsync(request).get();
}
Name | Description |
request | UpdateInstanceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Instance,OperationMetadata> |
updateInstanceCallable()
public final UnaryCallable<UpdateInstanceRequest,Operation> updateInstanceCallable()
Updates the settings of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.build();
ApiFuture<Operation> future =
cloudFilestoreManagerClient.updateInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateInstanceRequest,Operation> |
updateInstanceOperationCallable()
public final OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()
Updates the settings of a specific instance.
Sample code:
try (CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.build();
OperationFuture<Instance, OperationMetadata> future =
cloudFilestoreManagerClient.updateInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Type | Description |
OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> |