public class FileSystems extends ProjectResources<FileShareRestRep> implements TaskResources<FileShareRestRep>
Base URL: /file/filesystems
| Constructor and Description | 
|---|
FileSystems(ViPRCoreClient parent,
           RestClient client)  | 
| Modifier and Type | Method and Description | 
|---|---|
Task<FileShareRestRep> | 
associateFilePolicy(java.net.URI fileSystemId,
                   java.net.URI filePolicyId)
Associate a file policy to a given file system 
 | 
Task<FileShareRestRep> | 
changeFileVirtualPool(java.net.URI id,
                     FileSystemVirtualPoolChangeParam input)
Changes the virtual pool for the given file system. 
 | 
Task<FileShareRestRep> | 
create(java.net.URI projectId,
      FileSystemParam input)
Begins creating a file system in the given project. 
 | 
Task<FileShareRestRep> | 
createFileContinuousCopies(java.net.URI id,
                          FileReplicationCreateParam input)
Begins creating a continuous copies for the given file system. 
 | 
Task<FileShareRestRep> | 
deactivate(java.net.URI id,
          FileSystemDeleteParam input)
Begins deactivating the given file system by ID. 
 | 
Task<FileShareRestRep> | 
deactivateFileContinuousCopies(java.net.URI id,
                              FileSystemDeleteParam input)
Begins deactivating a number of continuous copies for the given file system. 
 | 
Task<FileShareRestRep> | 
deleteAllExport(java.net.URI id,
               java.lang.Boolean allDir)  | 
Task<FileShareRestRep> | 
deleteAllExport(java.net.URI id,
               java.lang.Boolean allDir,
               java.lang.Boolean unmountExport)  | 
Task<FileShareRestRep> | 
deleteAllNfsAcl(java.net.URI id,
               java.lang.String subDir)
Delete file system acl
 
 API Call: DELETE /file/filesystems/{id}/acl 
 | 
Task<FileShareRestRep> | 
deleteExport(java.net.URI id,
            java.lang.Boolean allDir,
            java.lang.String subDir)
Delete file system export rules
 
 API Call: DELETE /file/filesystems/{id}/export 
 | 
Task<FileShareRestRep> | 
deleteExport(java.net.URI id,
            java.lang.Boolean allDir,
            java.lang.String subDir,
            java.lang.Boolean unmountExport)  | 
Task<FileShareRestRep> | 
deleteShareACL(java.net.URI id,
              java.lang.String shareName)
Begins removing a share ACL from the given file system by ID. 
 | 
Task<FileShareRestRep> | 
dissociateFilePolicy(java.net.URI fileSystemId,
                    java.net.URI filePolicyId)
Dissociate a file policy to a given file system 
 | 
Task<FileShareRestRep> | 
expand(java.net.URI id,
      FileSystemExpandParam input)
Begins expanding the given file system by ID. 
 | 
Task<FileShareRestRep> | 
export(java.net.URI id,
      FileSystemExportParam input)
Exports the given file system by ID. 
 | 
Tasks<FileShareRestRep> | 
failBackContinousCopies(java.net.URI id,
                       FileReplicationParam input)
FailBack replication operation on a file system by ID 
 | 
Tasks<FileShareRestRep> | 
failover(java.net.URI id,
        FileReplicationParam input)
Begins initiating failover for a given file system. 
 | 
java.util.List<NfsACL> | 
getAllNfsACLs(java.net.URI id)
Gets the all NFS ACLs for the given file system by ID. 
 | 
java.util.List<ExportRule> | 
getExport(java.net.URI id,
         boolean allDirs,
         java.lang.String subDir)
Gets the list of export rules for the given file system by ID. 
 | 
java.util.List<FileSystemExportParam> | 
getExports(java.net.URI id)
Gets the list of exports for the given file system by ID. 
 | 
java.util.List<NamedRelatedResourceRep> | 
getFileContinuousCopies(java.net.URI id)
Gets the list of continuous copies for the given File System. 
 | 
FilePolicyList | 
getFilePolicies(java.net.URI fileSystemId)
Get File Policy associated with a File System 
 | 
ScheduleSnapshotList | 
getFilePolicySnapshots(java.net.URI fileSystemId,
                      java.net.URI filePolicyId)
Get list of snapshot created by file policy 
 | 
java.util.List<NfsACL> | 
getNfsACLs(java.net.URI id,
          java.lang.String subDir)
Gets the NFS ACLs for the given file system by ID. 
 | 
MountInfoList | 
getNFSMounts(java.net.URI fileSystemId)
Get all nfs mounts 
 | 
java.util.List<MountInfo> | 
getNfsMountsByHost(java.net.URI id)
Gets the NFS mounts for the given host 
 | 
java.util.List<ShareACL> | 
getShareACLs(java.net.URI id,
            java.lang.String shareName)
Gets the share ACLs for the given file system by ID. 
 | 
java.util.List<SmbShareResponse> | 
getShares(java.net.URI id)
Gets the shares for the given file system by ID. 
 | 
Task<FileShareRestRep> | 
getTask(java.net.URI id,
       java.net.URI taskId)
Gets a single task associated with a given resource by ID. 
 | 
Tasks<FileShareRestRep> | 
getTasks(java.net.URI id)
Gets the tasks associated with a given resource by ID. 
 | 
Task<FileShareRestRep> | 
mountNFS(java.net.URI id,
        FileSystemMountParam input)
mounts a file export 
 | 
Tasks<FileShareRestRep> | 
pauseFileContinuousCopies(java.net.URI id,
                         FileReplicationParam input)
Begins pausing a number of continuous copies for a given file system. 
 | 
Task<FileShareRestRep> | 
removeExport(java.net.URI id,
            java.lang.String protocol,
            java.lang.String securityType,
            java.lang.String permissions,
            java.lang.String rootUserMapping)
Removes an export from the given file system by ID. 
 | 
Task<FileShareRestRep> | 
removeExport(java.net.URI id,
            java.lang.String protocol,
            java.lang.String securityType,
            java.lang.String permissions,
            java.lang.String rootUserMapping,
            java.lang.String subDirectory)
Removes an export from the given file system by ID. 
 | 
Task<FileShareRestRep> | 
removeShare(java.net.URI id,
           java.lang.String shareName)
Begins removing a share from the given file system by ID. 
 | 
Tasks<FileShareRestRep> | 
replicationInfo(java.net.URI id,
               FileReplicationParam param)
Get details of replication copy on a file system by ID 
 | 
Tasks<FileShareRestRep> | 
resumeContinousCopies(java.net.URI id,
                     FileReplicationParam param)
Resume replication operation on a file system by ID 
 | 
Task<FileShareRestRep> | 
share(java.net.URI id,
     FileSystemShareParam input)
Begins sharing a file system by ID. 
 | 
Tasks<FileShareRestRep> | 
startFileContinuousCopies(java.net.URI id,
                         FileReplicationParam input)
Begins creating a continuous copies for the given file system. 
 | 
Tasks<FileShareRestRep> | 
stopFileContinuousCopies(java.net.URI id,
                        FileReplicationParam input)
Stop a number of continuous copies for a given file system. 
 | 
Task<FileShareRestRep> | 
unmountNFS(java.net.URI id,
          FileSystemUnmountParam input)
unmounts a file export 
 | 
Task<FileShareRestRep> | 
update(java.net.URI id,
      FileSystemUpdateParam input)
Begins updating the given file system by ID. 
 | 
Task<FileShareRestRep> | 
updateExport(java.net.URI id,
            java.lang.String subDirectory,
            FileShareExportUpdateParams input)
Update file system exports
 
 API Call: PUT /file/filesystems/{id}/export 
 | 
Task<FileShareRestRep> | 
updateExport(java.net.URI id,
            java.lang.String protocol,
            java.lang.String securityType,
            java.lang.String permissions,
            java.lang.String rootUserMapping,
            FileExportUpdateParam update)
Updates an export from the given file system by ID. 
 | 
Task<FileShareRestRep> | 
updateNfsACL(java.net.URI id,
            FileNfsACLUpdateParams param)
Update file system NFSv4 ACL
 
 API Call: PUT /file/filesystems/{id}/acl 
 | 
Task<FileShareRestRep> | 
updateShareACL(java.net.URI id,
              java.lang.String shareName,
              FileCifsShareACLUpdateParams param)
Update file system share ACL
 
 API Call: PUT /file/filesystems/{id}/shares/{shareName}/acl 
 | 
FileSystems | 
withInactive(boolean inactive)
Configures the fetch operations to include inactive resources. 
 | 
FileSystems | 
withInternal(boolean internal)
Configures the fetch operations to include internal resources. 
 | 
findByProject, findByProject, findByProject, findByProject, searchgetByIds, getByRefs, listBulkIdsaddTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTagsequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetByIds, getByRefsaddTags, get, get, getTags, removeTags, updateTagspublic FileSystems(ViPRCoreClient parent, RestClient client)
public FileSystems withInactive(boolean inactive)
AbstractResourceswithInactive in class AbstractResources<FileShareRestRep>inactive - whether to include inactive resources.public FileSystems withInternal(boolean internal)
AbstractResourceswithInternal in class AbstractResources<FileShareRestRep>internal - whether to include internal resources.public Tasks<FileShareRestRep> getTasks(java.net.URI id)
TaskResourcesAPI Call: GET baseUrl/{id}/tasks
getTasks in interface TaskResources<FileShareRestRep>id - the resource ID.public Task<FileShareRestRep> getTask(java.net.URI id, java.net.URI taskId)
TaskResourcesAPI Call: GET baseUrl/{id}/tasks/{taskId}
getTask in interface TaskResources<FileShareRestRep>id - the resource ID.taskId - the task ID.public Task<FileShareRestRep> create(java.net.URI projectId, FileSystemParam input)
API Call: POST /file/filesystems?project={projectId}
projectId - the ID of the project.input - the file system configuration.public Task<FileShareRestRep> update(java.net.URI id, FileSystemUpdateParam input)
API Call: PUT /file/filesystems/{id}
id - the ID of the file system to expand.input - the update configuration.public Task<FileShareRestRep> expand(java.net.URI id, FileSystemExpandParam input)
API Call: POST /file/filesystems/{id}/expand
id - the ID of the file system to expand.input - the expand configuration.public Task<FileShareRestRep> deactivate(java.net.URI id, FileSystemDeleteParam input)
API Call: POST /file/filesystems/{id}/deactivate
id - the ID of the file system to deactivate.input - the delete configuration.public java.util.List<FileSystemExportParam> getExports(java.net.URI id)
API Call: GET /file/filesystems/{id}/exports
id - the ID of the file system.public java.util.List<ExportRule> getExport(java.net.URI id, boolean allDirs, java.lang.String subDir)
API Call: GET /file/filesystems/{id}/export
id - the ID of the file system.allDirs - boolean value for indicating for all directoriessubDir - string indicating on what subdirectory to querypublic Task<FileShareRestRep> export(java.net.URI id, FileSystemExportParam input)
API Call: POST /file/filesystems/{id}/exports
id - the ID of the file system.input - the export configuration.public Task<FileShareRestRep> removeExport(java.net.URI id, java.lang.String protocol, java.lang.String securityType, java.lang.String permissions, java.lang.String rootUserMapping)
API Call: DELETE /file/filesystems/{id}/exports/{protocol},{securityType},{permissions},{rootUserMapping}
id - the ID of the file system.protocol - the protocol of the export.securityType - the security type of the export.permissions - the permissions of the export.rootUserMapping - the root user mapping of the export.public Task<FileShareRestRep> removeExport(java.net.URI id, java.lang.String protocol, java.lang.String securityType, java.lang.String permissions, java.lang.String rootUserMapping, java.lang.String subDirectory)
API Call: DELETE /file/filesystems/{id}/exports/{protocol},{securityType},{permissions},{rootUserMapping}?subDirectory={subDirectory}
id - the ID of the file system.protocol - the protocol of the export.securityType - the security type of the export.permissions - the permissions of the export.rootUserMapping - the root user mapping of the export.subDirectory - the sub directory of the export.public Task<FileShareRestRep> updateExport(java.net.URI id, java.lang.String protocol, java.lang.String securityType, java.lang.String permissions, java.lang.String rootUserMapping, FileExportUpdateParam update)
API Call: PUT /file/filesystems/{id}/exports/{protocol},{securityType},{permissions},{rootUserMapping}
id - the ID of the file system.protocol - the protocol of the export.securityType - the security type of the export.permissions - the permissions of the export.rootUserMapping - the root user mapping of the export.update - the update configuration.public java.util.List<SmbShareResponse> getShares(java.net.URI id)
API Call: GET /file/filesystems/{id}/shares
id - the ID of the file system.public Task<FileShareRestRep> share(java.net.URI id, FileSystemShareParam input)
API Call: POST /file/filesystems/{id}/shares
id - the ID of the file system.input - the share configuration.public Task<FileShareRestRep> removeShare(java.net.URI id, java.lang.String shareName)
API Call: POST /file/filesystems/{id}/shares/{shareName}
id - the ID of the file system.shareName - the name of the share to remove.public Task<FileShareRestRep> updateExport(java.net.URI id, java.lang.String subDirectory, FileShareExportUpdateParams input)
id - the ID of the filesystem.subDirectory - the subdirectory to be exportedinput - the update/create configurationpublic Task<FileShareRestRep> deleteExport(java.net.URI id, java.lang.Boolean allDir, java.lang.String subDir)
id - the ID of the file systemallDir - Boolean to specify all directoriessubDir - specific directory to delete export rulespublic Task<FileShareRestRep> deleteExport(java.net.URI id, java.lang.Boolean allDir, java.lang.String subDir, java.lang.Boolean unmountExport)
public Task<FileShareRestRep> deleteAllExport(java.net.URI id, java.lang.Boolean allDir)
public Task<FileShareRestRep> deleteAllExport(java.net.URI id, java.lang.Boolean allDir, java.lang.Boolean unmountExport)
public Task<FileShareRestRep> deleteAllNfsAcl(java.net.URI id, java.lang.String subDir)
id - the ID of the file systemsubDir - specific directory to delete acl .public java.util.List<ShareACL> getShareACLs(java.net.URI id, java.lang.String shareName)
API Call: GET /file/filesystems/{id}/shares/{shareName}/acl
id - the ID of the file system.shareName - the shareName to get list of ACLS associated.public java.util.List<NfsACL> getAllNfsACLs(java.net.URI id)
API Call: GET /file/filesystems/{id}/acl?allDir=true
id - the ID of the file system.public java.util.List<NfsACL> getNfsACLs(java.net.URI id, java.lang.String subDir)
API Call: GET /file/filesystems/{id}/acl?subDir=subDirId
id - the ID of the file system.subDir - the subDir to get list of ACLS associated.public Task<FileShareRestRep> updateNfsACL(java.net.URI id, FileNfsACLUpdateParams param)
id - the ID of the filesystem.param - the update/create configurationpublic Task<FileShareRestRep> updateShareACL(java.net.URI id, java.lang.String shareName, FileCifsShareACLUpdateParams param)
id - the ID of the filesystem.shareName - the shareName to update associated ACLsparam - the update/create configurationpublic Task<FileShareRestRep> deleteShareACL(java.net.URI id, java.lang.String shareName)
API Call: Delete /file/filesystems/{id}/shares/{shareName}/acl
id - the ID of the file system.shareName - the name of the share to remove associated ACLs.public Task<FileShareRestRep> createFileContinuousCopies(java.net.URI id, FileReplicationCreateParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/create
id - the ID of the file system.input - the configuration of the new continuous copies.public Tasks<FileShareRestRep> startFileContinuousCopies(java.net.URI id, FileReplicationParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/start
id - the ID of the file system.input - the configuration of the new continuous copies.public java.util.List<NamedRelatedResourceRep> getFileContinuousCopies(java.net.URI id)
API Call: GET /file/filesystems/{id}/protection/continuous-copies
id - the ID of the file system.public Task<FileShareRestRep> deactivateFileContinuousCopies(java.net.URI id, FileSystemDeleteParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/deactivate
id - the ID of the file system.input - the file system delete param.public Tasks<FileShareRestRep> pauseFileContinuousCopies(java.net.URI id, FileReplicationParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/pause
id - the ID of the file system.input - the copy configurations.public Tasks<FileShareRestRep> stopFileContinuousCopies(java.net.URI id, FileReplicationParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/stop
id - the ID of the file system.input - the copy configurations.public Tasks<FileShareRestRep> failover(java.net.URI id, FileReplicationParam input)
API Call: POST /file/filesystems/{id}/protection/continuous-copies/failover
id - the ID of the file system.input - the input configuration.public Task<FileShareRestRep> changeFileVirtualPool(java.net.URI id, FileSystemVirtualPoolChangeParam input)
API Call: PUT /file/filesystems/{id}/vpool-change
input - the virtual pool change configuration.public Task<FileShareRestRep> associateFilePolicy(java.net.URI fileSystemId, java.net.URI filePolicyId)
API Call: PUT /file/filesystems/{id}/assign-file-policy/{file_policy_uri}
fileSystemId - the ID of the file system.filePolicyId - the ID of the file policy.public Task<FileShareRestRep> dissociateFilePolicy(java.net.URI fileSystemId, java.net.URI filePolicyId)
API Call: PUT /file/filesystems/{id}/assign-file-policy/{file_policy_uri}
fileSystemId - the ID of the file system.filePolicyId - the ID of the file policy.public FilePolicyList getFilePolicies(java.net.URI fileSystemId)
API Call: GET /file/filesystems/{id}/file-policies
fileSystemId - the ID of the file system.public Tasks<FileShareRestRep> resumeContinousCopies(java.net.URI id, FileReplicationParam param)
API Call: Post /file/filesystems/{id}/protection/continuous-copies/resume
id - the ID of the file system.public Tasks<FileShareRestRep> failBackContinousCopies(java.net.URI id, FileReplicationParam input)
API Call: Post /file/filesystems/{id}/protection/continuous-copies/failback
id - the ID of the file system.public Tasks<FileShareRestRep> replicationInfo(java.net.URI id, FileReplicationParam param)
API Call: Post /file/filesystems/{id}/protection/continuous-copies/{mid}
id - the ID of the file system.public ScheduleSnapshotList getFilePolicySnapshots(java.net.URI fileSystemId, java.net.URI filePolicyId)
API Call: GET /file/filesystems/{fileSystemId}/file-policies/{filePolicyId}/snapshots
fileSystemId - the ID of the file system.filePolicyId - the ID of the policy.public MountInfoList getNFSMounts(java.net.URI fileSystemId)
API Call: GET /file/filesystems/{id}/mount
fileSystemId - the ID of the file system.public Task<FileShareRestRep> mountNFS(java.net.URI id, FileSystemMountParam input)
API Call: POST /file/filesystems/{id}/mount
id - the ID of the file system.input - the file system mount param.public Task<FileShareRestRep> unmountNFS(java.net.URI id, FileSystemUnmountParam input)
API Call: POST /file/filesystems/{id}/unmount
id - the ID of the file system.input - the file system unmount param.public java.util.List<MountInfo> getNfsMountsByHost(java.net.URI id)
API Call: GET /compute/hosts/{id}/filesystem-mounts
id - the ID of the host.