com.oracle.bmc.filestorage

Class FileStorageAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.filestorage.FileStorageAsyncClient

All Implemented Interfaces:

FileStorageAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public class FileStorageAsyncClient
extends BaseAsyncClient
implements FileStorageAsync

Async client implementation for FileStorage service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileStorageAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for FileStorage.

Constructor Summary

Constructors

Constructor and Description
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static FileStorageAsyncClient.Builder	builder() Create a builder for this client.
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<ChangeReplicationCompartmentResponse>	changeReplicationCompartment(ChangeReplicationCompartmentRequest request, AsyncHandler<ChangeReplicationCompartmentRequest,ChangeReplicationCompartmentResponse> handler) Moves a replication and its replication target into a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
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<CreateReplicationResponse>	createReplication(CreateReplicationRequest request, AsyncHandler<CreateReplicationRequest,CreateReplicationResponse> handler) Creates a new replication in the specified compartment.
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<DeleteReplicationResponse>	deleteReplication(DeleteReplicationRequest request, AsyncHandler<DeleteReplicationRequest,DeleteReplicationResponse> handler) Deletes the specified replication and the the associated replication target.
Future<DeleteReplicationTargetResponse>	deleteReplicationTarget(DeleteReplicationTargetRequest request, AsyncHandler<DeleteReplicationTargetRequest,DeleteReplicationTargetResponse> handler) Deletes the specified replication target.
Future<DeleteSnapshotResponse>	deleteSnapshot(DeleteSnapshotRequest request, AsyncHandler<DeleteSnapshotRequest,DeleteSnapshotResponse> handler) Deletes the specified snapshot.
Future<EstimateReplicationResponse>	estimateReplication(EstimateReplicationRequest request, AsyncHandler<EstimateReplicationRequest,EstimateReplicationResponse> handler) Provides estimates for replication created using specific file system.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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<GetReplicationResponse>	getReplication(GetReplicationRequest request, AsyncHandler<GetReplicationRequest,GetReplicationResponse> handler) Gets the specified replication’s information.
Future<GetReplicationTargetResponse>	getReplicationTarget(GetReplicationTargetRequest request, AsyncHandler<GetReplicationTargetRequest,GetReplicationTargetResponse> handler) Gets the specified replication 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<ListReplicationsResponse>	listReplications(ListReplicationsRequest request, AsyncHandler<ListReplicationsRequest,ListReplicationsResponse> handler) Lists the replication resources in the specified compartment.
Future<ListReplicationTargetsResponse>	listReplicationTargets(ListReplicationTargetsRequest request, AsyncHandler<ListReplicationTargetsRequest,ListReplicationTargetsResponse> handler) Lists the replication target resources in the specified compartment.
Future<ListSnapshotsResponse>	listSnapshots(ListSnapshotsRequest request, AsyncHandler<ListSnapshotsRequest,ListSnapshotsResponse> handler) Lists snapshots of the specified file system.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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<UpdateReplicationResponse>	updateReplication(UpdateReplicationRequest request, AsyncHandler<UpdateReplicationRequest,UpdateReplicationResponse> handler) Updates the information for the specified replication and its associated replication target.
Future<UpdateSnapshotResponse>	updateSnapshot(UpdateSnapshotRequest request, AsyncHandler<UpdateSnapshotRequest,UpdateSnapshotResponse> handler) Updates the specified snapshot’s information.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.filestorage.FileStorageAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FileStorage.

Constructor Detail

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          List<ClientConfigurator> additionalClientConfigurators,
                                          String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

FileStorageAsyncClient

@Deprecated
public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration,
                                          ClientConfigurator clientConfigurator,
                                          RequestSignerFactory defaultRequestSignerFactory,
                                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                          List<ClientConfigurator> additionalClientConfigurators,
                                          String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FileStorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static FileStorageAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FileStorageAsync

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.

Specified by:

setRegion in interface FileStorageAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FileStorageAsync

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.

Specified by:

setRegion in interface FileStorageAsync

Parameters:

regionId - The public region ID.

changeFileSystemCompartment

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

Description copied from interface: FileStorageAsync

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

Specified by:

changeFileSystemCompartment in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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

Specified by:

changeMountTargetCompartment in interface FileStorageAsync

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.

changeReplicationCompartment

public Future<ChangeReplicationCompartmentResponse> changeReplicationCompartment(ChangeReplicationCompartmentRequest request,
                                                                                 AsyncHandler<ChangeReplicationCompartmentRequest,ChangeReplicationCompartmentResponse> handler)

Description copied from interface: FileStorageAsync

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

Specified by:

changeReplicationCompartment in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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

Specified by:

createExport in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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.

Specified by:

createFileSystem in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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.

Specified by:

createMountTarget in interface FileStorageAsync

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.

createReplication

public Future<CreateReplicationResponse> createReplication(CreateReplicationRequest request,
                                                           AsyncHandler<CreateReplicationRequest,CreateReplicationResponse> handler)

Description copied from interface: FileStorageAsync

Creates a new replication in the specified compartment. Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget located in another availability domain. The associated replication target resource is automatically created along with the replication resource. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which retrieves the delta and applies it to the target file system. Only unexported file systems can be used as target file systems. For more information, see Using Replication.

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 replications, 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.

Specified by:

createReplication in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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

Specified by:

createSnapshot in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Deletes the specified export.

Specified by:

deleteExport in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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.

Specified by:

deleteFileSystem in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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

Specified by:

deleteMountTarget in interface FileStorageAsync

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.

deleteReplication

public Future<DeleteReplicationResponse> deleteReplication(DeleteReplicationRequest request,
                                                           AsyncHandler<DeleteReplicationRequest,DeleteReplicationResponse> handler)

Description copied from interface: FileStorageAsync

Deletes the specified replication and the the associated replication target.

Specified by:

deleteReplication in interface FileStorageAsync

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.

deleteReplicationTarget

public Future<DeleteReplicationTargetResponse> deleteReplicationTarget(DeleteReplicationTargetRequest request,
                                                                       AsyncHandler<DeleteReplicationTargetRequest,DeleteReplicationTargetResponse> handler)

Description copied from interface: FileStorageAsync

Deletes the specified replication target. This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.

Specified by:

deleteReplicationTarget in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Deletes the specified snapshot.

Specified by:

deleteSnapshot in interface FileStorageAsync

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.

estimateReplication

public Future<EstimateReplicationResponse> estimateReplication(EstimateReplicationRequest request,
                                                               AsyncHandler<EstimateReplicationRequest,EstimateReplicationResponse> handler)

Description copied from interface: FileStorageAsync

Provides estimates for replication created using specific file system.

Specified by:

estimateReplication in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Gets the specified export’s information.

Specified by:

getExport in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Gets the specified export set’s information.

Specified by:

getExportSet in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Gets the specified file system’s information.

Specified by:

getFileSystem in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Gets the specified mount target’s information.

Specified by:

getMountTarget in interface FileStorageAsync

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.

getReplication

public Future<GetReplicationResponse> getReplication(GetReplicationRequest request,
                                                     AsyncHandler<GetReplicationRequest,GetReplicationResponse> handler)

Description copied from interface: FileStorageAsync

Gets the specified replication’s information.

Specified by:

getReplication in interface FileStorageAsync

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.

getReplicationTarget

public Future<GetReplicationTargetResponse> getReplicationTarget(GetReplicationTargetRequest request,
                                                                 AsyncHandler<GetReplicationTargetRequest,GetReplicationTargetResponse> handler)

Description copied from interface: FileStorageAsync

Gets the specified replication target’s information.

Specified by:

getReplicationTarget in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Gets the specified snapshot’s information.

Specified by:

getSnapshot in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Lists the export set resources in the specified compartment.

Specified by:

listExportSets in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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.

Specified by:

listExports in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Lists the file system resources in the specified compartment.

Specified by:

listFileSystems in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Lists the mount target resources in the specified compartment.

Specified by:

listMountTargets in interface FileStorageAsync

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.

listReplicationTargets

public Future<ListReplicationTargetsResponse> listReplicationTargets(ListReplicationTargetsRequest request,
                                                                     AsyncHandler<ListReplicationTargetsRequest,ListReplicationTargetsResponse> handler)

Description copied from interface: FileStorageAsync

Lists the replication target resources in the specified compartment.

Specified by:

listReplicationTargets in interface FileStorageAsync

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.

listReplications

public Future<ListReplicationsResponse> listReplications(ListReplicationsRequest request,
                                                         AsyncHandler<ListReplicationsRequest,ListReplicationsResponse> handler)

Description copied from interface: FileStorageAsync

Lists the replication resources in the specified compartment.

Specified by:

listReplications in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Lists snapshots of the specified file system.

Specified by:

listSnapshots in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Updates the specified export’s information.

Specified by:

updateExport in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Updates the specified export set’s information.

Specified by:

updateExportSet in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

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

Specified by:

updateFileSystem in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Updates the specified mount target’s information.

Specified by:

updateMountTarget in interface FileStorageAsync

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.

updateReplication

public Future<UpdateReplicationResponse> updateReplication(UpdateReplicationRequest request,
                                                           AsyncHandler<UpdateReplicationRequest,UpdateReplicationResponse> handler)

Description copied from interface: FileStorageAsync

Updates the information for the specified replication and its associated replication target.

Specified by:

updateReplication in interface FileStorageAsync

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

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

Description copied from interface: FileStorageAsync

Updates the specified snapshot’s information.

Specified by:

updateSnapshot in interface FileStorageAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)