Class FileStorageClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.filestorage.FileStorageClient
-
- All Implemented Interfaces:
FileStorage
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public class FileStorageClient extends BaseSyncClient implements FileStorage
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileStorageClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for FileStorage.
-
Constructor Summary
Constructors Constructor Description FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete 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.static FileStorageClient.Builder
builder()
Create a builder for this client.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.void
close()
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
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
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.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.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)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.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 useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.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 class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.filestorage.FileStorage
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
FileStorageClient
@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
FileStorageClient
@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
FileStorageClient
@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
FileStorageClient
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
FileStorageClient
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
FileStorageClient
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
FileStorageClient
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
FileStorageClient
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeFileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-FileStorageClient.Builder.executorService
-
-
Method Detail
-
builder
public static FileStorageClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:FileStorage
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegion
in interfaceFileStorage
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:FileStorage
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
.- Specified by:
setRegion
in interfaceFileStorage
- Parameters:
regionId
- The public region ID.
-
addExportLock
public AddExportLockResponse addExportLock(AddExportLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addExportLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addFileSystemLock
public AddFileSystemLockResponse addFileSystemLock(AddFileSystemLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addFileSystemLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addFilesystemSnapshotPolicyLock
public AddFilesystemSnapshotPolicyLockResponse addFilesystemSnapshotPolicyLock(AddFilesystemSnapshotPolicyLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addFilesystemSnapshotPolicyLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addMountTargetLock
public AddMountTargetLockResponse addMountTargetLock(AddMountTargetLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addMountTargetLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addOutboundConnectorLock
public AddOutboundConnectorLockResponse addOutboundConnectorLock(AddOutboundConnectorLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addOutboundConnectorLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addReplicationLock
public AddReplicationLockResponse addReplicationLock(AddReplicationLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addReplicationLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addSnapshotLock
public AddSnapshotLockResponse addSnapshotLock(AddSnapshotLockRequest request)
Description copied from interface:FileStorage
Adds a lock to a resource.- Specified by:
addSnapshotLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelDowngradeShapeMountTarget
public CancelDowngradeShapeMountTargetResponse cancelDowngradeShapeMountTarget(CancelDowngradeShapeMountTargetRequest request)
Description copied from interface:FileStorage
Cancel scheduled downgrade shape request for mount target.- Specified by:
cancelDowngradeShapeMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeFileSystemCompartment
public ChangeFileSystemCompartmentResponse changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
Description copied from interface:FileStorage
Moves a file system and its associated snapshots into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment
- Specified by:
changeFileSystemCompartment
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeFilesystemSnapshotPolicyCompartment
public ChangeFilesystemSnapshotPolicyCompartmentResponse changeFilesystemSnapshotPolicyCompartment(ChangeFilesystemSnapshotPolicyCompartmentRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
changeFilesystemSnapshotPolicyCompartment
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeMountTargetCompartment
public ChangeMountTargetCompartmentResponse changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
Description copied from interface:FileStorage
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
- Specified by:
changeMountTargetCompartment
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeOutboundConnectorCompartment
public ChangeOutboundConnectorCompartmentResponse changeOutboundConnectorCompartment(ChangeOutboundConnectorCompartmentRequest request)
Description copied from interface:FileStorage
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
- Specified by:
changeOutboundConnectorCompartment
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeReplicationCompartment
public ChangeReplicationCompartmentResponse changeReplicationCompartment(ChangeReplicationCompartmentRequest request)
Description copied from interface:FileStorage
Moves a replication and its replication target into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeReplicationCompartment
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createExport
public CreateExportResponse createExport(CreateExportRequest request)
Description copied from interface:FileStorage
Creates a new export in the specified export set, path, and file system.- Specified by:
createExport
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFileSystem
public CreateFileSystemResponse createFileSystem(CreateFileSystemRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
createFileSystem
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFilesystemSnapshotPolicy
public CreateFilesystemSnapshotPolicyResponse createFilesystemSnapshotPolicy(CreateFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
createFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMountTarget
public CreateMountTargetResponse createMountTarget(CreateMountTargetRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
createMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOutboundConnector
public CreateOutboundConnectorResponse createOutboundConnector(CreateOutboundConnectorRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
createOutboundConnector
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createQuotaRule
public CreateQuotaRuleResponse createQuotaRule(CreateQuotaRuleRequest request)
Description copied from interface:FileStorage
Create a file system, user, or group quota rule given thefileSystemId
,principalId
,principalType
andisHardQuota
parameters.- Specified by:
createQuotaRule
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createReplication
public CreateReplicationResponse createReplication(CreateReplicationRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
createReplication
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSnapshot
public CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
Description copied from interface:FileStorage
Creates a new snapshot of the specified file system.You can access the snapshot at
.snapshot/<name>
.- Specified by:
createSnapshot
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteExport
public DeleteExportResponse deleteExport(DeleteExportRequest request)
Description copied from interface:FileStorage
Deletes the specified export.- Specified by:
deleteExport
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFileSystem
public DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest request)
Description copied from interface:FileStorage
Deletes the specified file system.Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.
- Specified by:
deleteFileSystem
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFilesystemSnapshotPolicy
public DeleteFilesystemSnapshotPolicyResponse deleteFilesystemSnapshotPolicy(DeleteFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
Deletes the specified file system snapshot policy.- Specified by:
deleteFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMountTarget
public DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest request)
Description copied from interface:FileStorage
Deletes the specified mount target.This operation also deletes the mount target’s VNICs.
- Specified by:
deleteMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOutboundConnector
public DeleteOutboundConnectorResponse deleteOutboundConnector(DeleteOutboundConnectorRequest request)
Description copied from interface:FileStorage
Deletes the specified outbound connector.- Specified by:
deleteOutboundConnector
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteQuotaRule
public DeleteQuotaRuleResponse deleteQuotaRule(DeleteQuotaRuleRequest request)
Description copied from interface:FileStorage
Remove a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Specified by:
deleteQuotaRule
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteReplication
public DeleteReplicationResponse deleteReplication(DeleteReplicationRequest request)
Description copied from interface:FileStorage
Deletes the specified replication and the the associated replication target.- Specified by:
deleteReplication
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteReplicationTarget
public DeleteReplicationTargetResponse deleteReplicationTarget(DeleteReplicationTargetRequest request)
Description copied from interface:FileStorage
Deletes the specified replication target.This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.
- Specified by:
deleteReplicationTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSnapshot
public DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)
Description copied from interface:FileStorage
Deletes the specified snapshot.- Specified by:
deleteSnapshot
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachClone
public DetachCloneResponse detachClone(DetachCloneRequest request)
Description copied from interface:FileStorage
Detaches the file system from its parent file system- Specified by:
detachClone
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
estimateReplication
public EstimateReplicationResponse estimateReplication(EstimateReplicationRequest request)
Description copied from interface:FileStorage
Provides estimates for replication created using specific file system.- Specified by:
estimateReplication
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getExport
public GetExportResponse getExport(GetExportRequest request)
Description copied from interface:FileStorage
Gets the specified export’s information.- Specified by:
getExport
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getExportSet
public GetExportSetResponse getExportSet(GetExportSetRequest request)
Description copied from interface:FileStorage
Gets the specified export set’s information.- Specified by:
getExportSet
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFileSystem
public GetFileSystemResponse getFileSystem(GetFileSystemRequest request)
Description copied from interface:FileStorage
Gets the specified file system’s information.- Specified by:
getFileSystem
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFilesystemSnapshotPolicy
public GetFilesystemSnapshotPolicyResponse getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
Gets the specified file system snapshot policy’s information.- Specified by:
getFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMountTarget
public GetMountTargetResponse getMountTarget(GetMountTargetRequest request)
Description copied from interface:FileStorage
Gets the specified mount target’s information.- Specified by:
getMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOutboundConnector
public GetOutboundConnectorResponse getOutboundConnector(GetOutboundConnectorRequest request)
Description copied from interface:FileStorage
Gets the specified outbound connector’s information.- Specified by:
getOutboundConnector
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getQuotaRule
public GetQuotaRuleResponse getQuotaRule(GetQuotaRuleRequest request)
Description copied from interface:FileStorage
Get a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Specified by:
getQuotaRule
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReplication
public GetReplicationResponse getReplication(GetReplicationRequest request)
Description copied from interface:FileStorage
Gets the specified replication’s information.- Specified by:
getReplication
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReplicationTarget
public GetReplicationTargetResponse getReplicationTarget(GetReplicationTargetRequest request)
Description copied from interface:FileStorage
Gets the specified replication target’s information.- Specified by:
getReplicationTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSnapshot
public GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
Description copied from interface:FileStorage
Gets the specified snapshot’s information.- Specified by:
getSnapshot
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExportSets
public ListExportSetsResponse listExportSets(ListExportSetsRequest request)
Description copied from interface:FileStorage
Lists the export set resources in the specified compartment.- Specified by:
listExportSets
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExports
public ListExportsResponse listExports(ListExportsRequest request)
Description copied from interface:FileStorage
Lists export resources by compartment, file system, or export set.You must specify an export set ID, a file system ID, and / or a compartment ID.
- Specified by:
listExports
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFileSystems
public ListFileSystemsResponse listFileSystems(ListFileSystemsRequest request)
Description copied from interface:FileStorage
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.- Specified by:
listFileSystems
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFilesystemSnapshotPolicies
public ListFilesystemSnapshotPoliciesResponse listFilesystemSnapshotPolicies(ListFilesystemSnapshotPoliciesRequest request)
Description copied from interface:FileStorage
Lists file system snapshot policies in the specified compartment.- Specified by:
listFilesystemSnapshotPolicies
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMountTargets
public ListMountTargetsResponse listMountTargets(ListMountTargetsRequest request)
Description copied from interface:FileStorage
Lists the mount target resources in the specified compartment.- Specified by:
listMountTargets
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOutboundConnectors
public ListOutboundConnectorsResponse listOutboundConnectors(ListOutboundConnectorsRequest request)
Description copied from interface:FileStorage
Lists the outbound connector resources in the specified compartment.- Specified by:
listOutboundConnectors
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listQuotaRules
public ListQuotaRulesResponse listQuotaRules(ListQuotaRulesRequest request)
Description copied from interface:FileStorage
List user or group usages and their quota rules by certain principal type.- Specified by:
listQuotaRules
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReplicationTargets
public ListReplicationTargetsResponse listReplicationTargets(ListReplicationTargetsRequest request)
Description copied from interface:FileStorage
Lists the replication target resources in the specified compartment.- Specified by:
listReplicationTargets
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReplications
public ListReplicationsResponse listReplications(ListReplicationsRequest request)
Description copied from interface:FileStorage
Lists the replication resources in the specified compartment.- Specified by:
listReplications
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSnapshots
public ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
Description copied from interface:FileStorage
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).
- Specified by:
listSnapshots
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
pauseFilesystemSnapshotPolicy
public PauseFilesystemSnapshotPolicyResponse pauseFilesystemSnapshotPolicy(PauseFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
pauseFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeExportLock
public RemoveExportLockResponse removeExportLock(RemoveExportLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeExportLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeFileSystemLock
public RemoveFileSystemLockResponse removeFileSystemLock(RemoveFileSystemLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeFileSystemLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeFilesystemSnapshotPolicyLock
public RemoveFilesystemSnapshotPolicyLockResponse removeFilesystemSnapshotPolicyLock(RemoveFilesystemSnapshotPolicyLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeFilesystemSnapshotPolicyLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeMountTargetLock
public RemoveMountTargetLockResponse removeMountTargetLock(RemoveMountTargetLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeMountTargetLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeOutboundConnectorLock
public RemoveOutboundConnectorLockResponse removeOutboundConnectorLock(RemoveOutboundConnectorLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeOutboundConnectorLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeReplicationLock
public RemoveReplicationLockResponse removeReplicationLock(RemoveReplicationLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeReplicationLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeSnapshotLock
public RemoveSnapshotLockResponse removeSnapshotLock(RemoveSnapshotLockRequest request)
Description copied from interface:FileStorage
Removes a lock to a resource.- Specified by:
removeSnapshotLock
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scheduleDowngradeShapeMountTarget
public ScheduleDowngradeShapeMountTargetResponse scheduleDowngradeShapeMountTarget(ScheduleDowngradeShapeMountTargetRequest request)
Description copied from interface:FileStorage
Schedule a downgrade shape of the mount target.- Specified by:
scheduleDowngradeShapeMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
toggleQuotaRules
public ToggleQuotaRulesResponse toggleQuotaRules(ToggleQuotaRulesRequest request)
Description copied from interface:FileStorage
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.- Specified by:
toggleQuotaRules
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unpauseFilesystemSnapshotPolicy
public UnpauseFilesystemSnapshotPolicyResponse unpauseFilesystemSnapshotPolicy(UnpauseFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
unpauseFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateExport
public UpdateExportResponse updateExport(UpdateExportRequest request)
Description copied from interface:FileStorage
Updates the specified export’s information.- Specified by:
updateExport
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateExportSet
public UpdateExportSetResponse updateExportSet(UpdateExportSetRequest request)
Description copied from interface:FileStorage
Updates the specified export set’s information.- Specified by:
updateExportSet
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFileSystem
public UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest request)
Description copied from interface:FileStorage
Updates the specified file system’s information.You can use this operation to rename a file system.
- Specified by:
updateFileSystem
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFilesystemSnapshotPolicy
public UpdateFilesystemSnapshotPolicyResponse updateFilesystemSnapshotPolicy(UpdateFilesystemSnapshotPolicyRequest request)
Description copied from interface:FileStorage
Updates the specified file system snapshot policy’s information.- Specified by:
updateFilesystemSnapshotPolicy
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMountTarget
public UpdateMountTargetResponse updateMountTarget(UpdateMountTargetRequest request)
Description copied from interface:FileStorage
Updates the specified mount target’s information.- Specified by:
updateMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOutboundConnector
public UpdateOutboundConnectorResponse updateOutboundConnector(UpdateOutboundConnectorRequest request)
Description copied from interface:FileStorage
Updates the specified outbound connector’s information.- Specified by:
updateOutboundConnector
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateQuotaRule
public UpdateQuotaRuleResponse updateQuotaRule(UpdateQuotaRuleRequest request)
Description copied from interface:FileStorage
Edit a file system, user, or group quota rule given thefileSystemId
andquotaRuleId
parameters.- Specified by:
updateQuotaRule
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateReplication
public UpdateReplicationResponse updateReplication(UpdateReplicationRequest request)
Description copied from interface:FileStorage
Updates the information for the specified replication and its associated replication target.- Specified by:
updateReplication
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSnapshot
public UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest request)
Description copied from interface:FileStorage
Updates the specified snapshot’s information.- Specified by:
updateSnapshot
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upgradeShapeMountTarget
public UpgradeShapeMountTargetResponse upgradeShapeMountTarget(UpgradeShapeMountTargetRequest request)
Description copied from interface:FileStorage
Upgrade shape request for mount target.- Specified by:
upgradeShapeMountTarget
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateKeyTabs
public ValidateKeyTabsResponse validateKeyTabs(ValidateKeyTabsRequest request)
Description copied from interface:FileStorage
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.
- Specified by:
validateKeyTabs
in interfaceFileStorage
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public FileStorageWaiters getWaiters()
Description copied from interface:FileStorage
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceFileStorage
- Returns:
- The service waiters.
-
getPaginators
public FileStoragePaginators getPaginators()
Description copied from interface:FileStorage
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.- Specified by:
getPaginators
in interfaceFileStorage
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-