Class CloudFilestoreManagerClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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`
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().
| Method | Description | Method Variants |
|---|---|---|
ListInstances |
Lists all instances in a project for either a specified location or for all locations. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetInstance |
Gets the details of a specific instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateInstance |
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). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateInstance |
Updates the settings of a specific instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RestoreInstance |
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). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RevertInstance |
Revert an existing instance's file system to a specified snapshot. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteInstance |
Deletes an instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListSnapshots |
Lists all snapshots in a project for either a specified location or for all locations. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetSnapshot |
Gets the details of a specific snapshot. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateSnapshot |
Creates a snapshot. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteSnapshot |
Deletes a snapshot. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateSnapshot |
Updates the settings of a specific snapshot. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListBackups |
Lists all backups in a project for either a specified location or for all locations. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetBackup |
Gets the details of a specific backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateBackup |
Creates a backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteBackup |
Deletes a backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateBackup |
Updates the settings of a specific backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
PromoteReplica |
Promote the standby instance (replica). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.newHttpJsonBuilder().build();
CloudFilestoreManagerClient cloudFilestoreManagerClient =
CloudFilestoreManagerClient.create(cloudFilestoreManagerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of CloudFilestoreManagerClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final CloudFilestoreManagerClientcreate()Constructs an instance of CloudFilestoreManagerClient with default settings.static final CloudFilestoreManagerClientcreate(CloudFilestoreManagerSettings settings) Constructs an instance of CloudFilestoreManagerClient, using the given settings.static final CloudFilestoreManagerClientConstructs an instance of CloudFilestoreManagerClient, using the given stub for making calls.createBackupAsync(CreateBackupRequest request) Creates a backup.createBackupAsync(LocationName parent, Backup backup, String backupId) Creates a backup.createBackupAsync(String parent, Backup backup, String backupId) Creates a backup.Creates a backup.Creates a backup.createInstanceAsync(CreateInstanceRequest request) Creates an instance.createInstanceAsync(LocationName parent, Instance instance, String instanceId) Creates an instance.createInstanceAsync(String parent, Instance instance, String instanceId) Creates an instance.Creates an instance.Creates an instance.createSnapshotAsync(CreateSnapshotRequest request) Creates a snapshot.createSnapshotAsync(InstanceName parent, Snapshot snapshot, String snapshotId) Creates a snapshot.createSnapshotAsync(String parent, Snapshot snapshot, String snapshotId) Creates a snapshot.Creates a snapshot.Creates a snapshot.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(BackupName name) Deletes a backup.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request) Deletes a backup.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(String name) Deletes a backup.Deletes a backup.final OperationCallable<DeleteBackupRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a backup.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request) Deletes an instance.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes an instance.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(String name) Deletes an instance.Deletes an instance.final OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty, OperationMetadata> Deletes an instance.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteSnapshotAsync(DeleteSnapshotRequest request) Deletes a snapshot.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a snapshot.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteSnapshotAsync(String name) Deletes a snapshot.Deletes a snapshot.final OperationCallable<DeleteSnapshotRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a snapshot.final BackupgetBackup(BackupName name) Gets the details of a specific backup.final BackupgetBackup(GetBackupRequest request) Gets the details of a specific backup.final BackupGets the details of a specific backup.final UnaryCallable<GetBackupRequest,Backup> Gets the details of a specific backup.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final InstancegetInstance(GetInstanceRequest request) Gets the details of a specific instance.final InstancegetInstance(InstanceName name) Gets the details of a specific instance.final InstancegetInstance(String name) Gets the details of a specific instance.Gets the details of a specific instance.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final SnapshotgetSnapshot(GetSnapshotRequest request) Gets the details of a specific snapshot.final SnapshotgetSnapshot(SnapshotName name) Gets the details of a specific snapshot.final SnapshotgetSnapshot(String name) Gets the details of a specific snapshot.Gets the details of a specific snapshot.getStub()booleanbooleanlistBackups(ListBackupsRequest request) Lists all backups in a project for either a specified location or for all locations.listBackups(LocationName parent) Lists all backups in a project for either a specified location or for all locations.listBackups(String parent) Lists all backups in a project for either a specified location or for all locations.Lists all backups in a project for either a specified location or for all locations.Lists all backups in a project for either a specified location or for all locations.listInstances(ListInstancesRequest request) Lists all instances in a project for either a specified location or for all locations.listInstances(LocationName parent) Lists all instances in a project for either a specified location or for all locations.listInstances(String parent) Lists all instances in a project for either a specified location or for all locations.Lists all instances in a project for either a specified location or for all locations.Lists all instances in a project for either a specified location or for all locations.listSnapshots(InstanceName parent) Lists all snapshots in a project for either a specified location or for all locations.listSnapshots(ListSnapshotsRequest request) Lists all snapshots in a project for either a specified location or for all locations.listSnapshots(String parent) Lists all snapshots in a project for either a specified location or for all locations.Lists all snapshots in a project for either a specified location or for all locations.Lists all snapshots in a project for either a specified location or for all locations.promoteReplicaAsync(PromoteReplicaRequest request) Promote the standby instance (replica).Promote the standby instance (replica).Promote the standby instance (replica).Restores an existing instance's file share from a backup.Restores an existing instance's file share from a backup.Restores an existing instance's file share from a backup.revertInstanceAsync(RevertInstanceRequest request) Revert an existing instance's file system to a specified snapshot.Revert an existing instance's file system to a specified snapshot.Revert an existing instance's file system to a specified snapshot.voidshutdown()voidupdateBackupAsync(Backup backup, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific backup.updateBackupAsync(UpdateBackupRequest request) Updates the settings of a specific backup.Updates the settings of a specific backup.Updates the settings of a specific backup.updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific instance.updateInstanceAsync(UpdateInstanceRequest request) Updates the settings of a specific instance.Updates the settings of a specific instance.Updates the settings of a specific instance.updateSnapshotAsync(Snapshot snapshot, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific snapshot.updateSnapshotAsync(UpdateSnapshotRequest request) Updates the settings of a specific snapshot.Updates the settings of a specific snapshot.Updates the settings of a specific snapshot.
-
Constructor Details
-
CloudFilestoreManagerClient
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.- Throws:
IOException
-
CloudFilestoreManagerClient
-
-
Method Details
-
create
Constructs an instance of CloudFilestoreManagerClient with default settings.- Throws:
IOException
-
create
public static final CloudFilestoreManagerClient create(CloudFilestoreManagerSettings settings) throws IOException 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.- Throws:
IOException
-
create
Constructs an instance of CloudFilestoreManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudFilestoreManagerSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listInstances
public final CloudFilestoreManagerClient.ListInstancesPagedResponse listInstances(LocationName parent) Lists all instances in a project for either a specified location or for all locations.Sample code:
// 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()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Instance element : cloudFilestoreManagerClient.listInstances(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example- *us-west1-b**. To retrieve instance information for all locations, use "-" for the `{location}` value.
- Throws:
ApiException- if the remote call fails
-
listInstances
Lists all instances in a project for either a specified location or for all locations.Sample code:
// 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()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Instance element : cloudFilestoreManagerClient.listInstances(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example- *us-west1-b**. To retrieve instance information for all locations, use "-" for the `{location}` value.
- Throws:
ApiException- if the remote call fails
-
listInstances
public final CloudFilestoreManagerClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request) Lists all instances in a project for either a specified location or for all locations.Sample code:
// 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()) { 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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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:
// 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()) { 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); } } -
listInstancesCallable
Lists all instances in a project for either a specified location or for all locations.Sample code:
// 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()) { 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.getInstancesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getInstance
Gets the details of a specific instance.Sample code:
// 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); }- Parameters:
name- Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.- Throws:
ApiException- if the remote call fails
-
getInstance
Gets the details of a specific instance.Sample code:
// 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()) { String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString(); Instance response = cloudFilestoreManagerClient.getInstance(name); }- Parameters:
name- Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.- Throws:
ApiException- if the remote call fails
-
getInstance
Gets the details of a specific instance.Sample code:
// 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()) { GetInstanceRequest request = GetInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); Instance response = cloudFilestoreManagerClient.getInstance(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getInstanceCallable
Gets the details of a specific instance.Sample code:
// 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()) { 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(); } -
createInstanceAsync
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:
// 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()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Instance instance = Instance.newBuilder().build(); String instanceId = "instanceId902024336"; Instance response = cloudFilestoreManagerClient.createInstanceAsync(parent, instance, instanceId).get(); }- Parameters:
parent- Required. The instance's project and location, in the format `projects/{project_id}/locations/{location}`. In Filestore, locations map to Google Cloud zones, for example **us-west1-b**.instance- Required. An [instance resource][google.cloud.filestore.v1.Instance]instanceId- Required. The name of the instance to create. The name must be unique for the specified project and location.- Throws:
ApiException- if the remote call fails
-
createInstanceAsync
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:
// 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()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Instance instance = Instance.newBuilder().build(); String instanceId = "instanceId902024336"; Instance response = cloudFilestoreManagerClient.createInstanceAsync(parent, instance, instanceId).get(); }- Parameters:
parent- Required. The instance's project and location, in the format `projects/{project_id}/locations/{location}`. In Filestore, locations map to Google Cloud zones, for example **us-west1-b**.instance- Required. An [instance resource][google.cloud.filestore.v1.Instance]instanceId- Required. The name of the instance to create. The name must be unique for the specified project and location.- Throws:
ApiException- if the remote call fails
-
createInstanceAsync
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:
// 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()) { CreateInstanceRequest request = CreateInstanceRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setInstanceId("instanceId902024336") .setInstance(Instance.newBuilder().build()) .build(); Instance response = cloudFilestoreManagerClient.createInstanceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createInstanceOperationCallable
public final OperationCallable<CreateInstanceRequest,Instance, createInstanceOperationCallable()OperationMetadata> 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:
// 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()) { 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(); } -
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:
// 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()) { 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(); } -
updateInstanceAsync
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific instance.Sample code:
// 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()) { Instance instance = Instance.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Instance response = cloudFilestoreManagerClient.updateInstanceAsync(instance, updateMask).get(); }- Parameters:
instance- Only fields specified in update_mask are updated.updateMask- 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:- "description"
- "file_shares"
- "labels"
- "performance_config"
- "deletion_protection_enabled"
- "deletion_protection_reason"
- Throws:
ApiException- if the remote call fails
-
updateInstanceAsync
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request) Updates the settings of a specific instance.Sample code:
// 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()) { UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setInstance(Instance.newBuilder().build()) .build(); Instance response = cloudFilestoreManagerClient.updateInstanceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateInstanceOperationCallable
public final OperationCallable<UpdateInstanceRequest,Instance, updateInstanceOperationCallable()OperationMetadata> Updates the settings of a specific instance.Sample code:
// 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()) { 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(); } -
updateInstanceCallable
Updates the settings of a specific instance.Sample code:
// 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()) { 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(); } -
restoreInstanceAsync
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:
// 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()) { RestoreInstanceRequest request = RestoreInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setFileShare("fileShare-1327728701") .build(); Instance response = cloudFilestoreManagerClient.restoreInstanceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
restoreInstanceOperationCallable
public final OperationCallable<RestoreInstanceRequest,Instance, restoreInstanceOperationCallable()OperationMetadata> 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:
// 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()) { 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(); } -
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:
// 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()) { 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(); } -
revertInstanceAsync
public final OperationFuture<Instance,OperationMetadata> revertInstanceAsync(RevertInstanceRequest request) Revert an existing instance's file system to a specified snapshot.Sample code:
// 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()) { RevertInstanceRequest request = RevertInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setTargetSnapshotId("targetSnapshotId-2099459472") .build(); Instance response = cloudFilestoreManagerClient.revertInstanceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
revertInstanceOperationCallable
public final OperationCallable<RevertInstanceRequest,Instance, revertInstanceOperationCallable()OperationMetadata> Revert an existing instance's file system to a specified snapshot.Sample code:
// 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()) { RevertInstanceRequest request = RevertInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setTargetSnapshotId("targetSnapshotId-2099459472") .build(); OperationFuture<Instance, OperationMetadata> future = cloudFilestoreManagerClient.revertInstanceOperationCallable().futureCall(request); // Do something. Instance response = future.get(); } -
revertInstanceCallable
Revert an existing instance's file system to a specified snapshot.Sample code:
// 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()) { RevertInstanceRequest request = RevertInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setTargetSnapshotId("targetSnapshotId-2099459472") .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.revertInstanceCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteInstanceAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(InstanceName name) Deletes an instance.Sample code:
// 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]"); cloudFilestoreManagerClient.deleteInstanceAsync(name).get(); }- Parameters:
name- Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`- Throws:
ApiException- if the remote call fails
-
deleteInstanceAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(String name) Deletes an instance.Sample code:
// 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()) { String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString(); cloudFilestoreManagerClient.deleteInstanceAsync(name).get(); }- Parameters:
name- Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`- Throws:
ApiException- if the remote call fails
-
deleteInstanceAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request) Deletes an instance.Sample code:
// 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()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setForce(true) .build(); cloudFilestoreManagerClient.deleteInstanceAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteInstanceOperationCallable
public final OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty, deleteInstanceOperationCallable()OperationMetadata> Deletes an instance.Sample code:
// 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()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setForce(true) .build(); OperationFuture<Empty, OperationMetadata> future = cloudFilestoreManagerClient.deleteInstanceOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteInstanceCallable
Deletes an instance.Sample code:
// 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()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setForce(true) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.deleteInstanceCallable().futureCall(request); // Do something. future.get(); } -
listSnapshots
public final CloudFilestoreManagerClient.ListSnapshotsPagedResponse listSnapshots(InstanceName parent) Lists all snapshots in a project for either a specified location or for all locations.Sample code:
// 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 parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]"); for (Snapshot element : cloudFilestoreManagerClient.listSnapshots(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.- Throws:
ApiException- if the remote call fails
-
listSnapshots
Lists all snapshots in a project for either a specified location or for all locations.Sample code:
// 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()) { String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString(); for (Snapshot element : cloudFilestoreManagerClient.listSnapshots(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.- Throws:
ApiException- if the remote call fails
-
listSnapshots
public final CloudFilestoreManagerClient.ListSnapshotsPagedResponse listSnapshots(ListSnapshotsRequest request) Lists all snapshots in a project for either a specified location or for all locations.Sample code:
// 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()) { ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .setReturnPartialSuccess(true) .build(); for (Snapshot element : cloudFilestoreManagerClient.listSnapshots(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listSnapshotsPagedCallable
public final UnaryCallable<ListSnapshotsRequest,CloudFilestoreManagerClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()Lists all snapshots in a project for either a specified location or for all locations.Sample code:
// 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()) { ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .setReturnPartialSuccess(true) .build(); ApiFuture<Snapshot> future = cloudFilestoreManagerClient.listSnapshotsPagedCallable().futureCall(request); // Do something. for (Snapshot element : future.get().iterateAll()) { // doThingsWith(element); } } -
listSnapshotsCallable
Lists all snapshots in a project for either a specified location or for all locations.Sample code:
// 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()) { ListSnapshotsRequest request = ListSnapshotsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setOrderBy("orderBy-1207110587") .setFilter("filter-1274492040") .setReturnPartialSuccess(true) .build(); while (true) { ListSnapshotsResponse response = cloudFilestoreManagerClient.listSnapshotsCallable().call(request); for (Snapshot element : response.getSnapshotsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getSnapshot
Gets the details of a specific snapshot.Sample code:
// 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()) { SnapshotName name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]"); Snapshot response = cloudFilestoreManagerClient.getSnapshot(name); }- Parameters:
name- Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`- Throws:
ApiException- if the remote call fails
-
getSnapshot
Gets the details of a specific snapshot.Sample code:
// 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()) { String name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString(); Snapshot response = cloudFilestoreManagerClient.getSnapshot(name); }- Parameters:
name- Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`- Throws:
ApiException- if the remote call fails
-
getSnapshot
Gets the details of a specific snapshot.Sample code:
// 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()) { GetSnapshotRequest request = GetSnapshotRequest.newBuilder() .setName( SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString()) .build(); Snapshot response = cloudFilestoreManagerClient.getSnapshot(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getSnapshotCallable
Gets the details of a specific snapshot.Sample code:
// 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()) { GetSnapshotRequest request = GetSnapshotRequest.newBuilder() .setName( SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString()) .build(); ApiFuture<Snapshot> future = cloudFilestoreManagerClient.getSnapshotCallable().futureCall(request); // Do something. Snapshot response = future.get(); } -
createSnapshotAsync
public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(InstanceName parent, Snapshot snapshot, String snapshotId) Creates a snapshot.Sample code:
// 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 parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]"); Snapshot snapshot = Snapshot.newBuilder().build(); String snapshotId = "snapshotId-1113817601"; Snapshot response = cloudFilestoreManagerClient.createSnapshotAsync(parent, snapshot, snapshotId).get(); }- Parameters:
parent- Required. The Filestore Instance to create the snapshots of, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`snapshot- Required. A snapshot resource.snapshotId- Required. The ID to use for the snapshot. The ID must be unique within the specified instance.This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
- Throws:
ApiException- if the remote call fails
-
createSnapshotAsync
public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(String parent, Snapshot snapshot, String snapshotId) Creates a snapshot.Sample code:
// 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()) { String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString(); Snapshot snapshot = Snapshot.newBuilder().build(); String snapshotId = "snapshotId-1113817601"; Snapshot response = cloudFilestoreManagerClient.createSnapshotAsync(parent, snapshot, snapshotId).get(); }- Parameters:
parent- Required. The Filestore Instance to create the snapshots of, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`snapshot- Required. A snapshot resource.snapshotId- Required. The ID to use for the snapshot. The ID must be unique within the specified instance.This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
- Throws:
ApiException- if the remote call fails
-
createSnapshotAsync
public final OperationFuture<Snapshot,OperationMetadata> createSnapshotAsync(CreateSnapshotRequest request) Creates a snapshot.Sample code:
// 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()) { CreateSnapshotRequest request = CreateSnapshotRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setSnapshotId("snapshotId-1113817601") .setSnapshot(Snapshot.newBuilder().build()) .build(); Snapshot response = cloudFilestoreManagerClient.createSnapshotAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createSnapshotOperationCallable
public final OperationCallable<CreateSnapshotRequest,Snapshot, createSnapshotOperationCallable()OperationMetadata> Creates a snapshot.Sample code:
// 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()) { CreateSnapshotRequest request = CreateSnapshotRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setSnapshotId("snapshotId-1113817601") .setSnapshot(Snapshot.newBuilder().build()) .build(); OperationFuture<Snapshot, OperationMetadata> future = cloudFilestoreManagerClient.createSnapshotOperationCallable().futureCall(request); // Do something. Snapshot response = future.get(); } -
createSnapshotCallable
Creates a snapshot.Sample code:
// 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()) { CreateSnapshotRequest request = CreateSnapshotRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setSnapshotId("snapshotId-1113817601") .setSnapshot(Snapshot.newBuilder().build()) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.createSnapshotCallable().futureCall(request); // Do something. Operation response = future.get(); } -
deleteSnapshotAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteSnapshotAsync(SnapshotName name) Deletes a snapshot.Sample code:
// 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()) { SnapshotName name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]"); cloudFilestoreManagerClient.deleteSnapshotAsync(name).get(); }- Parameters:
name- Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`- Throws:
ApiException- if the remote call fails
-
deleteSnapshotAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteSnapshotAsync(String name) Deletes a snapshot.Sample code:
// 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()) { String name = SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString(); cloudFilestoreManagerClient.deleteSnapshotAsync(name).get(); }- Parameters:
name- Required. The snapshot resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`- Throws:
ApiException- if the remote call fails
-
deleteSnapshotAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteSnapshotAsync(DeleteSnapshotRequest request) Deletes a snapshot.Sample code:
// 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()) { DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder() .setName( SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString()) .build(); cloudFilestoreManagerClient.deleteSnapshotAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteSnapshotOperationCallable
public final OperationCallable<DeleteSnapshotRequest,com.google.protobuf.Empty, deleteSnapshotOperationCallable()OperationMetadata> Deletes a snapshot.Sample code:
// 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()) { DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder() .setName( SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString()) .build(); OperationFuture<Empty, OperationMetadata> future = cloudFilestoreManagerClient.deleteSnapshotOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteSnapshotCallable
Deletes a snapshot.Sample code:
// 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()) { DeleteSnapshotRequest request = DeleteSnapshotRequest.newBuilder() .setName( SnapshotName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[SNAPSHOT]").toString()) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.deleteSnapshotCallable().futureCall(request); // Do something. future.get(); } -
updateSnapshotAsync
public final OperationFuture<Snapshot,OperationMetadata> updateSnapshotAsync(Snapshot snapshot, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific snapshot.Sample code:
// 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()) { Snapshot snapshot = Snapshot.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Snapshot response = cloudFilestoreManagerClient.updateSnapshotAsync(snapshot, updateMask).get(); }- Parameters:
snapshot- Required. A snapshot resource.updateMask- Required. Mask of fields to update. At least one path must be supplied in this field.- Throws:
ApiException- if the remote call fails
-
updateSnapshotAsync
public final OperationFuture<Snapshot,OperationMetadata> updateSnapshotAsync(UpdateSnapshotRequest request) Updates the settings of a specific snapshot.Sample code:
// 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()) { UpdateSnapshotRequest request = UpdateSnapshotRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setSnapshot(Snapshot.newBuilder().build()) .build(); Snapshot response = cloudFilestoreManagerClient.updateSnapshotAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateSnapshotOperationCallable
public final OperationCallable<UpdateSnapshotRequest,Snapshot, updateSnapshotOperationCallable()OperationMetadata> Updates the settings of a specific snapshot.Sample code:
// 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()) { UpdateSnapshotRequest request = UpdateSnapshotRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setSnapshot(Snapshot.newBuilder().build()) .build(); OperationFuture<Snapshot, OperationMetadata> future = cloudFilestoreManagerClient.updateSnapshotOperationCallable().futureCall(request); // Do something. Snapshot response = future.get(); } -
updateSnapshotCallable
Updates the settings of a specific snapshot.Sample code:
// 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()) { UpdateSnapshotRequest request = UpdateSnapshotRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setSnapshot(Snapshot.newBuilder().build()) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.updateSnapshotCallable().futureCall(request); // Do something. Operation response = future.get(); } -
listBackups
Lists all backups in a project for either a specified location or for all locations.Sample code:
// 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()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Backup element : cloudFilestoreManagerClient.listBackups(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location for which to retrieve backup information, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**. To retrieve backup information for all locations, use "-" for the `{location}` value.- Throws:
ApiException- if the remote call fails
-
listBackups
Lists all backups in a project for either a specified location or for all locations.Sample code:
// 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()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Backup element : cloudFilestoreManagerClient.listBackups(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location for which to retrieve backup information, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**. To retrieve backup information for all locations, use "-" for the `{location}` value.- Throws:
ApiException- if the remote call fails
-
listBackups
public final CloudFilestoreManagerClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request) Lists all backups in a project for either a specified location or for all locations.Sample code:
// 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()) { 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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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:
// 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()) { 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); } } -
listBackupsCallable
Lists all backups in a project for either a specified location or for all locations.Sample code:
// 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()) { 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.getBackupsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } } -
getBackup
Gets the details of a specific backup.Sample code:
// 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()) { BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]"); Backup response = cloudFilestoreManagerClient.getBackup(name); }- Parameters:
name- Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}`.- Throws:
ApiException- if the remote call fails
-
getBackup
Gets the details of a specific backup.Sample code:
// 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()) { String name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString(); Backup response = cloudFilestoreManagerClient.getBackup(name); }- Parameters:
name- Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}`.- Throws:
ApiException- if the remote call fails
-
getBackup
Gets the details of a specific backup.Sample code:
// 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()) { GetBackupRequest request = GetBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString()) .build(); Backup response = cloudFilestoreManagerClient.getBackup(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getBackupCallable
Gets the details of a specific backup.Sample code:
// 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()) { 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(); } -
createBackupAsync
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(LocationName parent, Backup backup, String backupId) Creates a backup.Sample code:
// 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()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Backup backup = Backup.newBuilder().build(); String backupId = "backupId2121930365"; Backup response = cloudFilestoreManagerClient.createBackupAsync(parent, backup, backupId).get(); }- Parameters:
parent- Required. The backup's project and location, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**.backup- Required. A [backup resource][google.cloud.filestore.v1.Backup]backupId- 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. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
- Throws:
ApiException- if the remote call fails
-
createBackupAsync
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId) Creates a backup.Sample code:
// 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()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Backup backup = Backup.newBuilder().build(); String backupId = "backupId2121930365"; Backup response = cloudFilestoreManagerClient.createBackupAsync(parent, backup, backupId).get(); }- Parameters:
parent- Required. The backup's project and location, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**.backup- Required. A [backup resource][google.cloud.filestore.v1.Backup]backupId- 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. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
- Throws:
ApiException- if the remote call fails
-
createBackupAsync
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request) Creates a backup.Sample code:
// 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()) { CreateBackupRequest request = CreateBackupRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setBackup(Backup.newBuilder().build()) .setBackupId("backupId2121930365") .build(); Backup response = cloudFilestoreManagerClient.createBackupAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createBackupOperationCallable
public final OperationCallable<CreateBackupRequest,Backup, createBackupOperationCallable()OperationMetadata> Creates a backup.Sample code:
// 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()) { 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(); } -
createBackupCallable
Creates a backup.Sample code:
// 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()) { 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(); } -
deleteBackupAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(BackupName name) Deletes a backup.Sample code:
// 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()) { BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]"); cloudFilestoreManagerClient.deleteBackupAsync(name).get(); }- Parameters:
name- Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}`- Throws:
ApiException- if the remote call fails
-
deleteBackupAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(String name) Deletes a backup.Sample code:
// 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()) { String name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString(); cloudFilestoreManagerClient.deleteBackupAsync(name).get(); }- Parameters:
name- Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}`- Throws:
ApiException- if the remote call fails
-
deleteBackupAsync
public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request) Deletes a backup.Sample code:
// 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()) { DeleteBackupRequest request = DeleteBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString()) .build(); cloudFilestoreManagerClient.deleteBackupAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteBackupOperationCallable
public final OperationCallable<DeleteBackupRequest,com.google.protobuf.Empty, deleteBackupOperationCallable()OperationMetadata> Deletes a backup.Sample code:
// 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()) { DeleteBackupRequest request = DeleteBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString()) .build(); OperationFuture<Empty, OperationMetadata> future = cloudFilestoreManagerClient.deleteBackupOperationCallable().futureCall(request); // Do something. future.get(); } -
deleteBackupCallable
Deletes a backup.Sample code:
// 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()) { DeleteBackupRequest request = DeleteBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString()) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.deleteBackupCallable().futureCall(request); // Do something. future.get(); } -
updateBackupAsync
public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(Backup backup, com.google.protobuf.FieldMask updateMask) Updates the settings of a specific backup.Sample code:
// 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()) { Backup backup = Backup.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Backup response = cloudFilestoreManagerClient.updateBackupAsync(backup, updateMask).get(); }- Parameters:
backup- Required. A [backup resource][google.cloud.filestore.v1.Backup]updateMask- Required. Mask of fields to update. At least one path must be supplied in this field.- Throws:
ApiException- if the remote call fails
-
updateBackupAsync
public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(UpdateBackupRequest request) Updates the settings of a specific backup.Sample code:
// 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()) { UpdateBackupRequest request = UpdateBackupRequest.newBuilder() .setBackup(Backup.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Backup response = cloudFilestoreManagerClient.updateBackupAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateBackupOperationCallable
public final OperationCallable<UpdateBackupRequest,Backup, updateBackupOperationCallable()OperationMetadata> Updates the settings of a specific backup.Sample code:
// 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()) { 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(); } -
updateBackupCallable
Updates the settings of a specific backup.Sample code:
// 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()) { 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(); } -
promoteReplicaAsync
public final OperationFuture<Instance,OperationMetadata> promoteReplicaAsync(PromoteReplicaRequest request) Promote the standby instance (replica).Sample code:
// 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()) { PromoteReplicaRequest request = PromoteReplicaRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPeerInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); Instance response = cloudFilestoreManagerClient.promoteReplicaAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
promoteReplicaOperationCallable
public final OperationCallable<PromoteReplicaRequest,Instance, promoteReplicaOperationCallable()OperationMetadata> Promote the standby instance (replica).Sample code:
// 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()) { PromoteReplicaRequest request = PromoteReplicaRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPeerInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); OperationFuture<Instance, OperationMetadata> future = cloudFilestoreManagerClient.promoteReplicaOperationCallable().futureCall(request); // Do something. Instance response = future.get(); } -
promoteReplicaCallable
Promote the standby instance (replica).Sample code:
// 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()) { PromoteReplicaRequest request = PromoteReplicaRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .setPeerInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); ApiFuture<Operation> future = cloudFilestoreManagerClient.promoteReplicaCallable().futureCall(request); // Do something. Operation response = future.get(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-