Interface FileStorage
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
FileStorageClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public interface FileStorage extends AutoCloseable
Use the File Storage service API to manage file systems, mount targets, and snapshots.For more information, see Overview of File Storage.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddExportLockResponse
addExportLock(AddExportLockRequest request)
Adds a lock to a resource.AddFileSystemLockResponse
addFileSystemLock(AddFileSystemLockRequest request)
Adds a lock to a resource.AddFilesystemSnapshotPolicyLockResponse
addFilesystemSnapshotPolicyLock(AddFilesystemSnapshotPolicyLockRequest request)
Adds a lock to a resource.AddMountTargetLockResponse
addMountTargetLock(AddMountTargetLockRequest request)
Adds a lock to a resource.AddOutboundConnectorLockResponse
addOutboundConnectorLock(AddOutboundConnectorLockRequest request)
Adds a lock to a resource.AddReplicationLockResponse
addReplicationLock(AddReplicationLockRequest request)
Adds a lock to a resource.AddSnapshotLockResponse
addSnapshotLock(AddSnapshotLockRequest request)
Adds a lock to a resource.CancelDowngradeShapeMountTargetResponse
cancelDowngradeShapeMountTarget(CancelDowngradeShapeMountTargetRequest request)
Cancel scheduled downgrade shape request for mount target.ChangeFileSystemCompartmentResponse
changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
Moves a file system and its associated snapshots into a different compartment within the same tenancy.ChangeFilesystemSnapshotPolicyCompartmentResponse
changeFilesystemSnapshotPolicyCompartment(ChangeFilesystemSnapshotPolicyCompartmentRequest request)
Moves a file system snapshot policy into a different compartment within the same tenancy.ChangeMountTargetCompartmentResponse
changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
Moves a mount target and its associated export set or share set into a different compartment within the same tenancy.ChangeOutboundConnectorCompartmentResponse
changeOutboundConnectorCompartment(ChangeOutboundConnectorCompartmentRequest request)
Moves an outbound connector into a different compartment within the same tenancy.ChangeReplicationCompartmentResponse
changeReplicationCompartment(ChangeReplicationCompartmentRequest request)
Moves a replication and its replication target into a different compartment within the same tenancy.CreateExportResponse
createExport(CreateExportRequest request)
Creates a new export in the specified export set, path, and file system.CreateFileSystemResponse
createFileSystem(CreateFileSystemRequest request)
Creates a new file system in the specified compartment and availability domain.CreateFilesystemSnapshotPolicyResponse
createFilesystemSnapshotPolicy(CreateFilesystemSnapshotPolicyRequest request)
Creates a new file system snapshot policy in the specified compartment and availability domain.CreateMountTargetResponse
createMountTarget(CreateMountTargetRequest request)
Creates a new mount target in the specified compartment and subnet.CreateOutboundConnectorResponse
createOutboundConnector(CreateOutboundConnectorRequest request)
Creates a new outbound connector in the specified compartment.CreateQuotaRuleResponse
createQuotaRule(CreateQuotaRuleRequest request)
Create a file system, user, or group quota rule given thefileSystemId
,principalId
,principalType
andisHardQuota
parameters.CreateReplicationResponse
createReplication(CreateReplicationRequest request)
Creates a new replication in the specified compartment.CreateSnapshotResponse
createSnapshot(CreateSnapshotRequest request)
Creates a new snapshot of the specified file system.DeleteExportResponse
deleteExport(DeleteExportRequest request)
Deletes the specified export.DeleteFileSystemResponse
deleteFileSystem(DeleteFileSystemRequest request)
Deletes the specified file system.DeleteFilesystemSnapshotPolicyResponse
deleteFilesystemSnapshotPolicy(DeleteFilesystemSnapshotPolicyRequest request)
Deletes the specified file system snapshot policy.DeleteMountTargetResponse
deleteMountTarget(DeleteMountTargetRequest request)
Deletes the specified mount target.DeleteOutboundConnectorResponse
deleteOutboundConnector(DeleteOutboundConnectorRequest request)
Deletes the specified outbound connector.DeleteQuotaRuleResponse
deleteQuotaRule(DeleteQuotaRuleRequest request)
Remove a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.DeleteReplicationResponse
deleteReplication(DeleteReplicationRequest request)
Deletes the specified replication and the the associated replication target.DeleteReplicationTargetResponse
deleteReplicationTarget(DeleteReplicationTargetRequest request)
Deletes the specified replication target.DeleteSnapshotResponse
deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.DetachCloneResponse
detachClone(DetachCloneRequest request)
Detaches the file system from its parent file systemEstimateReplicationResponse
estimateReplication(EstimateReplicationRequest request)
Provides estimates for replication created using specific file system.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)GetExportResponse
getExport(GetExportRequest request)
Gets the specified export’s information.GetExportSetResponse
getExportSet(GetExportSetRequest request)
Gets the specified export set’s information.GetFileSystemResponse
getFileSystem(GetFileSystemRequest request)
Gets the specified file system’s information.GetFilesystemSnapshotPolicyResponse
getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyRequest request)
Gets the specified file system snapshot policy’s information.GetMountTargetResponse
getMountTarget(GetMountTargetRequest request)
Gets the specified mount target’s information.GetOutboundConnectorResponse
getOutboundConnector(GetOutboundConnectorRequest request)
Gets the specified outbound connector’s information.FileStoragePaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetQuotaRuleResponse
getQuotaRule(GetQuotaRuleRequest request)
Get a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.GetReplicationResponse
getReplication(GetReplicationRequest request)
Gets the specified replication’s information.GetReplicationTargetResponse
getReplicationTarget(GetReplicationTargetRequest request)
Gets the specified replication target’s information.GetSnapshotResponse
getSnapshot(GetSnapshotRequest request)
Gets the specified snapshot’s information.FileStorageWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListExportsResponse
listExports(ListExportsRequest request)
Lists export resources by compartment, file system, or export set.ListExportSetsResponse
listExportSets(ListExportSetsRequest request)
Lists the export set resources in the specified compartment.ListFileSystemsResponse
listFileSystems(ListFileSystemsRequest request)
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.ListFilesystemSnapshotPoliciesResponse
listFilesystemSnapshotPolicies(ListFilesystemSnapshotPoliciesRequest request)
Lists file system snapshot policies in the specified compartment.ListMountTargetsResponse
listMountTargets(ListMountTargetsRequest request)
Lists the mount target resources in the specified compartment.ListOutboundConnectorsResponse
listOutboundConnectors(ListOutboundConnectorsRequest request)
Lists the outbound connector resources in the specified compartment.ListQuotaRulesResponse
listQuotaRules(ListQuotaRulesRequest request)
List user or group usages and their quota rules by certain principal type.ListReplicationsResponse
listReplications(ListReplicationsRequest request)
Lists the replication resources in the specified compartment.ListReplicationTargetsResponse
listReplicationTargets(ListReplicationTargetsRequest request)
Lists the replication target resources in the specified compartment.ListSnapshotsResponse
listSnapshots(ListSnapshotsRequest request)
Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.PauseFilesystemSnapshotPolicyResponse
pauseFilesystemSnapshotPolicy(PauseFilesystemSnapshotPolicyRequest request)
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.void
refreshClient()
Rebuilds the client from scratch.RemoveExportLockResponse
removeExportLock(RemoveExportLockRequest request)
Removes a lock to a resource.RemoveFileSystemLockResponse
removeFileSystemLock(RemoveFileSystemLockRequest request)
Removes a lock to a resource.RemoveFilesystemSnapshotPolicyLockResponse
removeFilesystemSnapshotPolicyLock(RemoveFilesystemSnapshotPolicyLockRequest request)
Removes a lock to a resource.RemoveMountTargetLockResponse
removeMountTargetLock(RemoveMountTargetLockRequest request)
Removes a lock to a resource.RemoveOutboundConnectorLockResponse
removeOutboundConnectorLock(RemoveOutboundConnectorLockRequest request)
Removes a lock to a resource.RemoveReplicationLockResponse
removeReplicationLock(RemoveReplicationLockRequest request)
Removes a lock to a resource.RemoveSnapshotLockResponse
removeSnapshotLock(RemoveSnapshotLockRequest request)
Removes a lock to a resource.ScheduleDowngradeShapeMountTargetResponse
scheduleDowngradeShapeMountTarget(ScheduleDowngradeShapeMountTargetRequest request)
Schedule a downgrade shape of the mount target.void
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).ToggleQuotaRulesResponse
toggleQuotaRules(ToggleQuotaRulesRequest request)
Enable or disable quota enforcement for the file system.UnpauseFilesystemSnapshotPolicyResponse
unpauseFilesystemSnapshotPolicy(UnpauseFilesystemSnapshotPolicyRequest request)
This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE.UpdateExportResponse
updateExport(UpdateExportRequest request)
Updates the specified export’s information.UpdateExportSetResponse
updateExportSet(UpdateExportSetRequest request)
Updates the specified export set’s information.UpdateFileSystemResponse
updateFileSystem(UpdateFileSystemRequest request)
Updates the specified file system’s information.UpdateFilesystemSnapshotPolicyResponse
updateFilesystemSnapshotPolicy(UpdateFilesystemSnapshotPolicyRequest request)
Updates the specified file system snapshot policy’s information.UpdateMountTargetResponse
updateMountTarget(UpdateMountTargetRequest request)
Updates the specified mount target’s information.UpdateOutboundConnectorResponse
updateOutboundConnector(UpdateOutboundConnectorRequest request)
Updates the specified outbound connector’s information.UpdateQuotaRuleResponse
updateQuotaRule(UpdateQuotaRuleRequest request)
Edit a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.UpdateReplicationResponse
updateReplication(UpdateReplicationRequest request)
Updates the information for the specified replication and its associated replication target.UpdateSnapshotResponse
updateSnapshot(UpdateSnapshotRequest request)
Updates the specified snapshot’s information.UpgradeShapeMountTargetResponse
upgradeShapeMountTarget(UpgradeShapeMountTargetRequest request)
Upgrade shape request for mount target.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.ValidateKeyTabsResponse
validateKeyTabs(ValidateKeyTabsRequest request)
Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
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 callsetEndpoint
.- 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
AddExportLockResponse addExportLock(AddExportLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddExportLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddExportLock API.
-
addFileSystemLock
AddFileSystemLockResponse addFileSystemLock(AddFileSystemLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddFileSystemLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddFileSystemLock API.
-
addFilesystemSnapshotPolicyLock
AddFilesystemSnapshotPolicyLockResponse addFilesystemSnapshotPolicyLock(AddFilesystemSnapshotPolicyLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddFilesystemSnapshotPolicyLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddFilesystemSnapshotPolicyLock API.
-
addMountTargetLock
AddMountTargetLockResponse addMountTargetLock(AddMountTargetLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddMountTargetLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddMountTargetLock API.
-
addOutboundConnectorLock
AddOutboundConnectorLockResponse addOutboundConnectorLock(AddOutboundConnectorLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddOutboundConnectorLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddOutboundConnectorLock API.
-
addReplicationLock
AddReplicationLockResponse addReplicationLock(AddReplicationLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddReplicationLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddReplicationLock API.
-
addSnapshotLock
AddSnapshotLockResponse addSnapshotLock(AddSnapshotLockRequest request)
Adds a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/AddSnapshotLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddSnapshotLock API.
-
cancelDowngradeShapeMountTarget
CancelDowngradeShapeMountTargetResponse cancelDowngradeShapeMountTarget(CancelDowngradeShapeMountTargetRequest request)
Cancel scheduled downgrade shape request for mount target.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CancelDowngradeShapeMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelDowngradeShapeMountTarget API.
-
changeFileSystemCompartment
ChangeFileSystemCompartmentResponse changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
Moves a file system and its associated snapshots into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ChangeFileSystemCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeFileSystemCompartment API.
-
changeFilesystemSnapshotPolicyCompartment
ChangeFilesystemSnapshotPolicyCompartmentResponse changeFilesystemSnapshotPolicyCompartment(ChangeFilesystemSnapshotPolicyCompartmentRequest request)
Moves a file system snapshot policy into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ChangeFilesystemSnapshotPolicyCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeFilesystemSnapshotPolicyCompartment API.
-
changeMountTargetCompartment
ChangeMountTargetCompartmentResponse changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
Moves a mount target and its associated export set or share set into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ChangeMountTargetCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeMountTargetCompartment API.
-
changeOutboundConnectorCompartment
ChangeOutboundConnectorCompartmentResponse changeOutboundConnectorCompartment(ChangeOutboundConnectorCompartmentRequest request)
Moves an outbound connector into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ChangeOutboundConnectorCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOutboundConnectorCompartment API.
-
changeReplicationCompartment
ChangeReplicationCompartmentResponse changeReplicationCompartment(ChangeReplicationCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ChangeReplicationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeReplicationCompartment API.
-
createExport
CreateExportResponse createExport(CreateExportRequest request)
Creates a new export in the specified export set, path, and file system.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateExportExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateExport API.
-
createFileSystem
CreateFileSystemResponse createFileSystem(CreateFileSystemRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateFileSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFileSystem API.
-
createFilesystemSnapshotPolicy
CreateFilesystemSnapshotPolicyResponse createFilesystemSnapshotPolicy(CreateFilesystemSnapshotPolicyRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFilesystemSnapshotPolicy API.
-
createMountTarget
CreateMountTargetResponse createMountTarget(CreateMountTargetRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateMountTarget API.
-
createOutboundConnector
CreateOutboundConnectorResponse createOutboundConnector(CreateOutboundConnectorRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateOutboundConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOutboundConnector API.
-
createQuotaRule
CreateQuotaRuleResponse createQuotaRule(CreateQuotaRuleRequest request)
Create a file system, user, or group quota rule given thefileSystemId
,principalId
,principalType
andisHardQuota
parameters.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateQuotaRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateQuotaRule API.
-
createReplication
CreateReplicationResponse createReplication(CreateReplicationRequest request)
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 associatedReplicationTarget
, 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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateReplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateReplication API.
-
createSnapshot
CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/CreateSnapshotExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSnapshot API.
-
deleteExport
DeleteExportResponse deleteExport(DeleteExportRequest request)
Deletes the specified export.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteExportExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteExport API.
-
deleteFileSystem
DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteFileSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFileSystem API.
-
deleteFilesystemSnapshotPolicy
DeleteFilesystemSnapshotPolicyResponse deleteFilesystemSnapshotPolicy(DeleteFilesystemSnapshotPolicyRequest request)
Deletes the specified file system snapshot policy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFilesystemSnapshotPolicy API.
-
deleteMountTarget
DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest request)
Deletes the specified mount target.This operation also deletes the mount target’s VNICs.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteMountTarget API.
-
deleteOutboundConnector
DeleteOutboundConnectorResponse deleteOutboundConnector(DeleteOutboundConnectorRequest request)
Deletes the specified outbound connector.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteOutboundConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOutboundConnector API.
-
deleteQuotaRule
DeleteQuotaRuleResponse deleteQuotaRule(DeleteQuotaRuleRequest request)
Remove a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteQuotaRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteQuotaRule API.
-
deleteReplication
DeleteReplicationResponse deleteReplication(DeleteReplicationRequest request)
Deletes the specified replication and the the associated replication target.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteReplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteReplication API.
-
deleteReplicationTarget
DeleteReplicationTargetResponse deleteReplicationTarget(DeleteReplicationTargetRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteReplicationTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteReplicationTarget API.
-
deleteSnapshot
DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DeleteSnapshotExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSnapshot API.
-
detachClone
DetachCloneResponse detachClone(DetachCloneRequest request)
Detaches the file system from its parent file system- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/DetachCloneExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachClone API.
-
estimateReplication
EstimateReplicationResponse estimateReplication(EstimateReplicationRequest request)
Provides estimates for replication created using specific file system.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/EstimateReplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EstimateReplication API.
-
getExport
GetExportResponse getExport(GetExportRequest request)
Gets the specified export’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetExportExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetExport API.
-
getExportSet
GetExportSetResponse getExportSet(GetExportSetRequest request)
Gets the specified export set’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetExportSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetExportSet API.
-
getFileSystem
GetFileSystemResponse getFileSystem(GetFileSystemRequest request)
Gets the specified file system’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetFileSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFileSystem API.
-
getFilesystemSnapshotPolicy
GetFilesystemSnapshotPolicyResponse getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyRequest request)
Gets the specified file system snapshot policy’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFilesystemSnapshotPolicy API.
-
getMountTarget
GetMountTargetResponse getMountTarget(GetMountTargetRequest request)
Gets the specified mount target’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMountTarget API.
-
getOutboundConnector
GetOutboundConnectorResponse getOutboundConnector(GetOutboundConnectorRequest request)
Gets the specified outbound connector’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetOutboundConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOutboundConnector API.
-
getQuotaRule
GetQuotaRuleResponse getQuotaRule(GetQuotaRuleRequest request)
Get a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetQuotaRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetQuotaRule API.
-
getReplication
GetReplicationResponse getReplication(GetReplicationRequest request)
Gets the specified replication’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetReplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetReplication API.
-
getReplicationTarget
GetReplicationTargetResponse getReplicationTarget(GetReplicationTargetRequest request)
Gets the specified replication target’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetReplicationTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetReplicationTarget API.
-
getSnapshot
GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
Gets the specified snapshot’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/GetSnapshotExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSnapshot API.
-
listExportSets
ListExportSetsResponse listExportSets(ListExportSetsRequest request)
Lists the export set resources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListExportSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExportSets API.
-
listExports
ListExportsResponse listExports(ListExportsRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListExportsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExports API.
-
listFileSystems
ListFileSystemsResponse listFileSystems(ListFileSystemsRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListFileSystemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFileSystems API.
-
listFilesystemSnapshotPolicies
ListFilesystemSnapshotPoliciesResponse listFilesystemSnapshotPolicies(ListFilesystemSnapshotPoliciesRequest request)
Lists file system snapshot policies in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListFilesystemSnapshotPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFilesystemSnapshotPolicies API.
-
listMountTargets
ListMountTargetsResponse listMountTargets(ListMountTargetsRequest request)
Lists the mount target resources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListMountTargetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMountTargets API.
-
listOutboundConnectors
ListOutboundConnectorsResponse listOutboundConnectors(ListOutboundConnectorsRequest request)
Lists the outbound connector resources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListOutboundConnectorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOutboundConnectors API.
-
listQuotaRules
ListQuotaRulesResponse listQuotaRules(ListQuotaRulesRequest request)
List user or group usages and their quota rules by certain principal type.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListQuotaRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListQuotaRules API.
-
listReplicationTargets
ListReplicationTargetsResponse listReplicationTargets(ListReplicationTargetsRequest request)
Lists the replication target resources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListReplicationTargetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListReplicationTargets API.
-
listReplications
ListReplicationsResponse listReplications(ListReplicationsRequest request)
Lists the replication resources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListReplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListReplications API.
-
listSnapshots
ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ListSnapshotsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSnapshots API.
-
pauseFilesystemSnapshotPolicy
PauseFilesystemSnapshotPolicyResponse pauseFilesystemSnapshotPolicy(PauseFilesystemSnapshotPolicyRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/PauseFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PauseFilesystemSnapshotPolicy API.
-
removeExportLock
RemoveExportLockResponse removeExportLock(RemoveExportLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveExportLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveExportLock API.
-
removeFileSystemLock
RemoveFileSystemLockResponse removeFileSystemLock(RemoveFileSystemLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveFileSystemLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveFileSystemLock API.
-
removeFilesystemSnapshotPolicyLock
RemoveFilesystemSnapshotPolicyLockResponse removeFilesystemSnapshotPolicyLock(RemoveFilesystemSnapshotPolicyLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveFilesystemSnapshotPolicyLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveFilesystemSnapshotPolicyLock API.
-
removeMountTargetLock
RemoveMountTargetLockResponse removeMountTargetLock(RemoveMountTargetLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveMountTargetLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveMountTargetLock API.
-
removeOutboundConnectorLock
RemoveOutboundConnectorLockResponse removeOutboundConnectorLock(RemoveOutboundConnectorLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveOutboundConnectorLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveOutboundConnectorLock API.
-
removeReplicationLock
RemoveReplicationLockResponse removeReplicationLock(RemoveReplicationLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveReplicationLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveReplicationLock API.
-
removeSnapshotLock
RemoveSnapshotLockResponse removeSnapshotLock(RemoveSnapshotLockRequest request)
Removes a lock to a resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/RemoveSnapshotLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveSnapshotLock API.
-
scheduleDowngradeShapeMountTarget
ScheduleDowngradeShapeMountTargetResponse scheduleDowngradeShapeMountTarget(ScheduleDowngradeShapeMountTargetRequest request)
Schedule a downgrade shape of the mount target.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ScheduleDowngradeShapeMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ScheduleDowngradeShapeMountTarget API.
-
toggleQuotaRules
ToggleQuotaRulesResponse toggleQuotaRules(ToggleQuotaRulesRequest request)
Enable or disable quota enforcement for the file system.If
areQuotaRulesEnabled
=true
, then the quota enforcement will be enabled. IfareQuotaRulesEnabled
=false
, then the quota enforcement will be disabled.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ToggleQuotaRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ToggleQuotaRules API.
-
unpauseFilesystemSnapshotPolicy
UnpauseFilesystemSnapshotPolicyResponse unpauseFilesystemSnapshotPolicy(UnpauseFilesystemSnapshotPolicyRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UnpauseFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UnpauseFilesystemSnapshotPolicy API.
-
updateExport
UpdateExportResponse updateExport(UpdateExportRequest request)
Updates the specified export’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateExportExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateExport API.
-
updateExportSet
UpdateExportSetResponse updateExportSet(UpdateExportSetRequest request)
Updates the specified export set’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateExportSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateExportSet API.
-
updateFileSystem
UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateFileSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFileSystem API.
-
updateFilesystemSnapshotPolicy
UpdateFilesystemSnapshotPolicyResponse updateFilesystemSnapshotPolicy(UpdateFilesystemSnapshotPolicyRequest request)
Updates the specified file system snapshot policy’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateFilesystemSnapshotPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFilesystemSnapshotPolicy API.
-
updateMountTarget
UpdateMountTargetResponse updateMountTarget(UpdateMountTargetRequest request)
Updates the specified mount target’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateMountTarget API.
-
updateOutboundConnector
UpdateOutboundConnectorResponse updateOutboundConnector(UpdateOutboundConnectorRequest request)
Updates the specified outbound connector’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateOutboundConnectorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOutboundConnector API.
-
updateQuotaRule
UpdateQuotaRuleResponse updateQuotaRule(UpdateQuotaRuleRequest request)
Edit a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateQuotaRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateQuotaRule API.
-
updateReplication
UpdateReplicationResponse updateReplication(UpdateReplicationRequest request)
Updates the information for the specified replication and its associated replication target.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateReplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateReplication API.
-
updateSnapshot
UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest request)
Updates the specified snapshot’s information.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpdateSnapshotExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSnapshot API.
-
upgradeShapeMountTarget
UpgradeShapeMountTargetResponse upgradeShapeMountTarget(UpgradeShapeMountTargetRequest request)
Upgrade shape request for mount target.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/UpgradeShapeMountTargetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpgradeShapeMountTarget API.
-
validateKeyTabs
ValidateKeyTabsResponse validateKeyTabs(ValidateKeyTabsRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/filestorage/ValidateKeyTabsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateKeyTabs API.
-
getWaiters
FileStorageWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
FileStoragePaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Returns:
- The service paginators.
-
-