Interface FileStorageAsync

    • 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.
      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
      • addExportLock

        Future<AddExportLockResponse> addExportLock​(AddExportLockRequest request,
                                                    AsyncHandler<AddExportLockRequest,​AddExportLockResponse> handler)
        Adds a lock to a resource.
        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.
      • addFileSystemLock

        Future<AddFileSystemLockResponse> addFileSystemLock​(AddFileSystemLockRequest request,
                                                            AsyncHandler<AddFileSystemLockRequest,​AddFileSystemLockResponse> handler)
        Adds a lock to a resource.
        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.
      • addMountTargetLock

        Future<AddMountTargetLockResponse> addMountTargetLock​(AddMountTargetLockRequest request,
                                                              AsyncHandler<AddMountTargetLockRequest,​AddMountTargetLockResponse> handler)
        Adds a lock to a resource.
        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.
      • addReplicationLock

        Future<AddReplicationLockResponse> addReplicationLock​(AddReplicationLockRequest request,
                                                              AsyncHandler<AddReplicationLockRequest,​AddReplicationLockResponse> handler)
        Adds a lock to a resource.
        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.
      • addSnapshotLock

        Future<AddSnapshotLockResponse> addSnapshotLock​(AddSnapshotLockRequest request,
                                                        AsyncHandler<AddSnapshotLockRequest,​AddSnapshotLockResponse> handler)
        Adds a lock to a resource.
        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.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

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

        For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.
      • createFilesystemSnapshotPolicy

        Future<CreateFilesystemSnapshotPolicyResponse> createFilesystemSnapshotPolicy​(CreateFilesystemSnapshotPolicyRequest request,
                                                                                      AsyncHandler<CreateFilesystemSnapshotPolicyRequest,​CreateFilesystemSnapshotPolicyResponse> handler)
        Creates a new file system snapshot policy in the specified compartment and availability domain.

        After you create a file system snapshot policy, you can associate it with file systems.

        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.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

        For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.
      • createOutboundConnector

        Future<CreateOutboundConnectorResponse> createOutboundConnector​(CreateOutboundConnectorRequest request,
                                                                        AsyncHandler<CreateOutboundConnectorRequest,​CreateOutboundConnectorResponse> handler)
        Creates a new outbound connector in the specified compartment.

        You can associate an outbound connector with a mount target only when they exist in the same availability domain.

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

        For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/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 outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.oracle.com/iaas/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.
      • createQuotaRule

        Future<CreateQuotaRuleResponse> createQuotaRule​(CreateQuotaRuleRequest request,
                                                        AsyncHandler<CreateQuotaRuleRequest,​CreateQuotaRuleResponse> handler)
        Create a file system, user, or group quota rule given the fileSystemId, principalId, principalType and isHardQuota parameters.
        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

        Future<CreateReplicationResponse> createReplication​(CreateReplicationRequest request,
                                                            AsyncHandler<CreateReplicationRequest,​CreateReplicationResponse> handler)
        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.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

        For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/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.oracle.com/iaas/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.
      • deleteQuotaRule

        Future<DeleteQuotaRuleResponse> deleteQuotaRule​(DeleteQuotaRuleRequest request,
                                                        AsyncHandler<DeleteQuotaRuleRequest,​DeleteQuotaRuleResponse> handler)
        Remove a file system, user, or group quota rule given the fileSystemId and quotaRuleId parameters.
        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

        Future<DeleteReplicationResponse> deleteReplication​(DeleteReplicationRequest request,
                                                            AsyncHandler<DeleteReplicationRequest,​DeleteReplicationResponse> handler)
        Deletes the specified replication and the the associated replication target.
        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

        Future<DeleteReplicationTargetResponse> deleteReplicationTarget​(DeleteReplicationTargetRequest request,
                                                                        AsyncHandler<DeleteReplicationTargetRequest,​DeleteReplicationTargetResponse> handler)
        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.

        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.
      • detachClone

        Future<DetachCloneResponse> detachClone​(DetachCloneRequest request,
                                                AsyncHandler<DetachCloneRequest,​DetachCloneResponse> handler)
        Detaches the file system from its parent 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.
      • estimateReplication

        Future<EstimateReplicationResponse> estimateReplication​(EstimateReplicationRequest request,
                                                                AsyncHandler<EstimateReplicationRequest,​EstimateReplicationResponse> handler)
        Provides estimates for replication created using specific 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.
      • 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.
      • getOutboundConnector

        Future<GetOutboundConnectorResponse> getOutboundConnector​(GetOutboundConnectorRequest request,
                                                                  AsyncHandler<GetOutboundConnectorRequest,​GetOutboundConnectorResponse> handler)
        Gets the specified outbound connector’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.
      • getQuotaRule

        Future<GetQuotaRuleResponse> getQuotaRule​(GetQuotaRuleRequest request,
                                                  AsyncHandler<GetQuotaRuleRequest,​GetQuotaRuleResponse> handler)
        Get a file system, user, or group quota rule given the fileSystemId and quotaRuleId parameters.
        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

        Future<GetReplicationResponse> getReplication​(GetReplicationRequest request,
                                                      AsyncHandler<GetReplicationRequest,​GetReplicationResponse> handler)
        Gets the specified replication’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.
      • getReplicationTarget

        Future<GetReplicationTargetResponse> getReplicationTarget​(GetReplicationTargetRequest request,
                                                                  AsyncHandler<GetReplicationTargetRequest,​GetReplicationTargetResponse> handler)
        Gets the specified replication 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, or by the specified compartment and file system snapshot policy.
        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.
      • listOutboundConnectors

        Future<ListOutboundConnectorsResponse> listOutboundConnectors​(ListOutboundConnectorsRequest request,
                                                                      AsyncHandler<ListOutboundConnectorsRequest,​ListOutboundConnectorsResponse> handler)
        Lists the outbound connector 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.
      • listQuotaRules

        Future<ListQuotaRulesResponse> listQuotaRules​(ListQuotaRulesRequest request,
                                                      AsyncHandler<ListQuotaRulesRequest,​ListQuotaRulesResponse> handler)
        List user or group usages and their quota rules by certain principal type.
        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

        Future<ListReplicationTargetsResponse> listReplicationTargets​(ListReplicationTargetsRequest request,
                                                                      AsyncHandler<ListReplicationTargetsRequest,​ListReplicationTargetsResponse> handler)
        Lists the replication 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.
      • listReplications

        Future<ListReplicationsResponse> listReplications​(ListReplicationsRequest request,
                                                          AsyncHandler<ListReplicationsRequest,​ListReplicationsResponse> handler)
        Lists the replication 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, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.

        If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified.

        Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID (sort by name is NOT supported for listing snapshots by policy and 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.
      • pauseFilesystemSnapshotPolicy

        Future<PauseFilesystemSnapshotPolicyResponse> pauseFilesystemSnapshotPolicy​(PauseFilesystemSnapshotPolicyRequest request,
                                                                                    AsyncHandler<PauseFilesystemSnapshotPolicyRequest,​PauseFilesystemSnapshotPolicyResponse> handler)
        This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE.

        When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted.

        If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.

        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.
      • removeExportLock

        Future<RemoveExportLockResponse> removeExportLock​(RemoveExportLockRequest request,
                                                          AsyncHandler<RemoveExportLockRequest,​RemoveExportLockResponse> handler)
        Removes a lock to a resource.
        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.
      • removeFileSystemLock

        Future<RemoveFileSystemLockResponse> removeFileSystemLock​(RemoveFileSystemLockRequest request,
                                                                  AsyncHandler<RemoveFileSystemLockRequest,​RemoveFileSystemLockResponse> handler)
        Removes a lock to a resource.
        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.
      • removeMountTargetLock

        Future<RemoveMountTargetLockResponse> removeMountTargetLock​(RemoveMountTargetLockRequest request,
                                                                    AsyncHandler<RemoveMountTargetLockRequest,​RemoveMountTargetLockResponse> handler)
        Removes a lock to a resource.
        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.
      • removeReplicationLock

        Future<RemoveReplicationLockResponse> removeReplicationLock​(RemoveReplicationLockRequest request,
                                                                    AsyncHandler<RemoveReplicationLockRequest,​RemoveReplicationLockResponse> handler)
        Removes a lock to a resource.
        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.
      • removeSnapshotLock

        Future<RemoveSnapshotLockResponse> removeSnapshotLock​(RemoveSnapshotLockRequest request,
                                                              AsyncHandler<RemoveSnapshotLockRequest,​RemoveSnapshotLockResponse> handler)
        Removes a lock to a resource.
        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.
      • toggleQuotaRules

        Future<ToggleQuotaRulesResponse> toggleQuotaRules​(ToggleQuotaRulesRequest request,
                                                          AsyncHandler<ToggleQuotaRulesRequest,​ToggleQuotaRulesResponse> handler)
        Enable or disable quota enforcement for the file system.

        If areQuotaRulesEnabled = true, then the quota enforcement will be enabled. If areQuotaRulesEnabled = false, then the quota enforcement will be disabled.

        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.
      • unpauseFilesystemSnapshotPolicy

        Future<UnpauseFilesystemSnapshotPolicyResponse> unpauseFilesystemSnapshotPolicy​(UnpauseFilesystemSnapshotPolicyRequest request,
                                                                                        AsyncHandler<UnpauseFilesystemSnapshotPolicyRequest,​UnpauseFilesystemSnapshotPolicyResponse> handler)
        This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE.

        By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy.

        If the policy is already in the ACTIVE state, you cannot unpause it. You can't unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.

        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.
      • updateOutboundConnector

        Future<UpdateOutboundConnectorResponse> updateOutboundConnector​(UpdateOutboundConnectorRequest request,
                                                                        AsyncHandler<UpdateOutboundConnectorRequest,​UpdateOutboundConnectorResponse> handler)
        Updates the specified outbound connector’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.
      • updateQuotaRule

        Future<UpdateQuotaRuleResponse> updateQuotaRule​(UpdateQuotaRuleRequest request,
                                                        AsyncHandler<UpdateQuotaRuleRequest,​UpdateQuotaRuleResponse> handler)
        Edit a file system, user, or group quota rule given the fileSystemId and quotaRuleId parameters.
        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

        Future<UpdateReplicationResponse> updateReplication​(UpdateReplicationRequest request,
                                                            AsyncHandler<UpdateReplicationRequest,​UpdateReplicationResponse> handler)
        Updates the information for the specified replication and its associated replication target.
        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.
      • validateKeyTabs

        Future<ValidateKeyTabsResponse> validateKeyTabs​(ValidateKeyTabsRequest request,
                                                        AsyncHandler<ValidateKeyTabsRequest,​ValidateKeyTabsResponse> handler)
        Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request.

        The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.

        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.