com.oracle.bmc.filestorage

Interface FileStorageAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FileStorageAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public interface FileStorageAsync
extends AutoCloseable

API for the File Storage service. Use this API to manage file systems, mount targets, and snapshots. For more information, see Overview of File Storage.

Method Summary

Modifier and Type	Method and Description
Future<ChangeFileSystemCompartmentResponse>	changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request, AsyncHandler<ChangeFileSystemCompartmentRequest,ChangeFileSystemCompartmentResponse> handler) Moves a file system and its associated snapshots into a different compartment within the same tenancy.
Future<ChangeMountTargetCompartmentResponse>	changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request, AsyncHandler<ChangeMountTargetCompartmentRequest,ChangeMountTargetCompartmentResponse> handler) Moves a mount target and its associated export set into a different compartment within the same tenancy.
Future<CreateExportResponse>	createExport(CreateExportRequest request, AsyncHandler<CreateExportRequest,CreateExportResponse> handler) Creates a new export in the specified export set, path, and file system.
Future<CreateFileSystemResponse>	createFileSystem(CreateFileSystemRequest request, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResponse> handler) Creates a new file system in the specified compartment and availability domain.
Future<CreateMountTargetResponse>	createMountTarget(CreateMountTargetRequest request, AsyncHandler<CreateMountTargetRequest,CreateMountTargetResponse> handler) Creates a new mount target in the specified compartment and subnet.
Future<CreateSnapshotResponse>	createSnapshot(CreateSnapshotRequest request, AsyncHandler<CreateSnapshotRequest,CreateSnapshotResponse> handler) Creates a new snapshot of the specified file system.
Future<DeleteExportResponse>	deleteExport(DeleteExportRequest request, AsyncHandler<DeleteExportRequest,DeleteExportResponse> handler) Deletes the specified export.
Future<DeleteFileSystemResponse>	deleteFileSystem(DeleteFileSystemRequest request, AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResponse> handler) Deletes the specified file system.
Future<DeleteMountTargetResponse>	deleteMountTarget(DeleteMountTargetRequest request, AsyncHandler<DeleteMountTargetRequest,DeleteMountTargetResponse> handler) Deletes the specified mount target.
Future<DeleteSnapshotResponse>	deleteSnapshot(DeleteSnapshotRequest request, AsyncHandler<DeleteSnapshotRequest,DeleteSnapshotResponse> handler) Deletes the specified snapshot.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetExportResponse>	getExport(GetExportRequest request, AsyncHandler<GetExportRequest,GetExportResponse> handler) Gets the specified export’s information.
Future<GetExportSetResponse>	getExportSet(GetExportSetRequest request, AsyncHandler<GetExportSetRequest,GetExportSetResponse> handler) Gets the specified export set’s information.
Future<GetFileSystemResponse>	getFileSystem(GetFileSystemRequest request, AsyncHandler<GetFileSystemRequest,GetFileSystemResponse> handler) Gets the specified file system’s information.
Future<GetMountTargetResponse>	getMountTarget(GetMountTargetRequest request, AsyncHandler<GetMountTargetRequest,GetMountTargetResponse> handler) Gets the specified mount target’s information.
Future<GetSnapshotResponse>	getSnapshot(GetSnapshotRequest request, AsyncHandler<GetSnapshotRequest,GetSnapshotResponse> handler) Gets the specified snapshot’s information.
Future<ListExportsResponse>	listExports(ListExportsRequest request, AsyncHandler<ListExportsRequest,ListExportsResponse> handler) Lists export resources by compartment, file system, or export set.
Future<ListExportSetsResponse>	listExportSets(ListExportSetsRequest request, AsyncHandler<ListExportSetsRequest,ListExportSetsResponse> handler) Lists the export set resources in the specified compartment.
Future<ListFileSystemsResponse>	listFileSystems(ListFileSystemsRequest request, AsyncHandler<ListFileSystemsRequest,ListFileSystemsResponse> handler) Lists the file system resources in the specified compartment.
Future<ListMountTargetsResponse>	listMountTargets(ListMountTargetsRequest request, AsyncHandler<ListMountTargetsRequest,ListMountTargetsResponse> handler) Lists the mount target resources in the specified compartment.
Future<ListSnapshotsResponse>	listSnapshots(ListSnapshotsRequest request, AsyncHandler<ListSnapshotsRequest,ListSnapshotsResponse> handler) Lists snapshots of the specified file system.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateExportResponse>	updateExport(UpdateExportRequest request, AsyncHandler<UpdateExportRequest,UpdateExportResponse> handler) Updates the specified export’s information.
Future<UpdateExportSetResponse>	updateExportSet(UpdateExportSetRequest request, AsyncHandler<UpdateExportSetRequest,UpdateExportSetResponse> handler) Updates the specified export set’s information.
Future<UpdateFileSystemResponse>	updateFileSystem(UpdateFileSystemRequest request, AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResponse> handler) Updates the specified file system’s information.
Future<UpdateMountTargetResponse>	updateMountTarget(UpdateMountTargetRequest request, AsyncHandler<UpdateMountTargetRequest,UpdateMountTargetResponse> handler) Updates the specified mount target’s information.
Future<UpdateSnapshotResponse>	updateSnapshot(UpdateSnapshotRequest request, AsyncHandler<UpdateSnapshotRequest,UpdateSnapshotResponse> handler) Updates the specified snapshot’s information.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

changeFileSystemCompartment

Future<ChangeFileSystemCompartmentResponse> changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request,
                                                                        AsyncHandler<ChangeFileSystemCompartmentRequest,ChangeFileSystemCompartmentResponse> handler)

Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeMountTargetCompartment

Future<ChangeMountTargetCompartmentResponse> changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request,
                                                                          AsyncHandler<ChangeMountTargetCompartmentRequest,ChangeMountTargetCompartmentResponse> handler)

Moves a mount target and its associated export set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createExport

Future<CreateExportResponse> createExport(CreateExportRequest request,
                                          AsyncHandler<CreateExportRequest,CreateExportResponse> handler)

Creates a new export in the specified export set, path, and file system.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createFileSystem

Future<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest request,
                                                  AsyncHandler<CreateFileSystemRequest,CreateFileSystemResponse> handler)

Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain.

After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target's IP address. You can associate a file system with more than one mount target at a time.

For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).

For information about Network Security Groups access control, see [Network Security Groups](https://docs.cloud.oracle.com/Content/Network/Concepts/networksecuritygroups.htm).

For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createMountTarget

Future<CreateMountTargetResponse> createMountTarget(CreateMountTargetRequest request,
                                                    AsyncHandler<CreateMountTargetRequest,CreateMountTargetResponse> handler)

Creates a new mount target in the specified compartment and subnet. You can associate a file system with a mount target only when they exist in the same availability domain. Instances can connect to mount targets in another availablity domain, but you might see higher latency than with instances in the same availability domain as the mount target.

Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target.

For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).

For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure Services resources, including mount targets, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSnapshot

Future<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest request,
                                              AsyncHandler<CreateSnapshotRequest,CreateSnapshotResponse> handler)

Creates a new snapshot of the specified file system. You can access the snapshot at .snapshot/<name>.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteExport

Future<DeleteExportResponse> deleteExport(DeleteExportRequest request,
                                          AsyncHandler<DeleteExportRequest,DeleteExportResponse> handler)

Deletes the specified export.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteFileSystem

Future<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest request,
                                                  AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResponse> handler)

Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteMountTarget

Future<DeleteMountTargetResponse> deleteMountTarget(DeleteMountTargetRequest request,
                                                    AsyncHandler<DeleteMountTargetRequest,DeleteMountTargetResponse> handler)

Deletes the specified mount target. This operation also deletes the mount target’s VNICs.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSnapshot

Future<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest request,
                                              AsyncHandler<DeleteSnapshotRequest,DeleteSnapshotResponse> handler)

Deletes the specified snapshot.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getExport

Future<GetExportResponse> getExport(GetExportRequest request,
                                    AsyncHandler<GetExportRequest,GetExportResponse> handler)

Gets the specified export’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getExportSet

Future<GetExportSetResponse> getExportSet(GetExportSetRequest request,
                                          AsyncHandler<GetExportSetRequest,GetExportSetResponse> handler)

Gets the specified export set’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getFileSystem

Future<GetFileSystemResponse> getFileSystem(GetFileSystemRequest request,
                                            AsyncHandler<GetFileSystemRequest,GetFileSystemResponse> handler)

Gets the specified file system’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getMountTarget

Future<GetMountTargetResponse> getMountTarget(GetMountTargetRequest request,
                                              AsyncHandler<GetMountTargetRequest,GetMountTargetResponse> handler)

Gets the specified mount target’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSnapshot

Future<GetSnapshotResponse> getSnapshot(GetSnapshotRequest request,
                                        AsyncHandler<GetSnapshotRequest,GetSnapshotResponse> handler)

Gets the specified snapshot’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listExportSets

Future<ListExportSetsResponse> listExportSets(ListExportSetsRequest request,
                                              AsyncHandler<ListExportSetsRequest,ListExportSetsResponse> handler)

Lists the export set resources in the specified compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listExports

Future<ListExportsResponse> listExports(ListExportsRequest request,
                                        AsyncHandler<ListExportsRequest,ListExportsResponse> handler)

Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listFileSystems

Future<ListFileSystemsResponse> listFileSystems(ListFileSystemsRequest request,
                                                AsyncHandler<ListFileSystemsRequest,ListFileSystemsResponse> handler)

Lists the file system resources in the specified compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listMountTargets

Future<ListMountTargetsResponse> listMountTargets(ListMountTargetsRequest request,
                                                  AsyncHandler<ListMountTargetsRequest,ListMountTargetsResponse> handler)

Lists the mount target resources in the specified compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSnapshots

Future<ListSnapshotsResponse> listSnapshots(ListSnapshotsRequest request,
                                            AsyncHandler<ListSnapshotsRequest,ListSnapshotsResponse> handler)

Lists snapshots of the specified file system.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateExport

Future<UpdateExportResponse> updateExport(UpdateExportRequest request,
                                          AsyncHandler<UpdateExportRequest,UpdateExportResponse> handler)

Updates the specified export’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateExportSet

Future<UpdateExportSetResponse> updateExportSet(UpdateExportSetRequest request,
                                                AsyncHandler<UpdateExportSetRequest,UpdateExportSetResponse> handler)

Updates the specified export set’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateFileSystem

Future<UpdateFileSystemResponse> updateFileSystem(UpdateFileSystemRequest request,
                                                  AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResponse> handler)

Updates the specified file system’s information. You can use this operation to rename a file system.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateMountTarget

Future<UpdateMountTargetResponse> updateMountTarget(UpdateMountTargetRequest request,
                                                    AsyncHandler<UpdateMountTargetRequest,UpdateMountTargetResponse> handler)

Updates the specified mount target’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSnapshot

Future<UpdateSnapshotResponse> updateSnapshot(UpdateSnapshotRequest request,
                                              AsyncHandler<UpdateSnapshotRequest,UpdateSnapshotResponse> handler)

Updates the specified snapshot’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.