Wait-FilesFileAction
Waits until Files.com has finished a copy or move, or until nothing is left at a path after a delete.
Syntax
Action (Default)
Removed
Description
Copy-FilesFile, Move-FilesFile and Remove-FilesFile return once Files.com accepts the request, which it may finish in the background. Wait-FilesFileAction waits until it has: for an action from Copy-FilesFile or Move-FilesFile, until its migration is completed, failed or cancelled, and with -Path and -Removed, until Files.com answers that nothing is at the path. It checks every -PollIntervalSeconds, one request each time, retried as the connection's requests are.
An action is checked with the connection, the address and the workspace its command used, so an action from a command that moved to its site's region is checked there. A failed or cancelled migration is Files.FileActionFailed, with the migration's ID and status; what it did before then stays done. Stopping the command, or -Timeout, stops only the wait: the action goes on at Files.com.
Examples
Example 1: Copy a folder and wait for the copy to finish
Writes the completed migration, with the number of files it processed.
Example 2: Delete a folder, wait until it is gone, then upload again
Starts the new upload only once Files.com has finished deleting the old folder.
Parameters
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-InputObject
A copy or move written by Copy-FilesFile or Move-FilesFile. It is checked with the connection, the address and the workspace its command used.
- Type:
FilesCom.PowerShell.Models.FileAction - Parameter sets:
Action(required, pipeline input)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Path
The remote path to wait on, such as a folder deleted with its contents, which Files.com can finish after it answers.
- Type:
System.String - Parameter sets:
Removed(required, position 0)
-PollIntervalSeconds
How long to wait between checks, in seconds; by default 1. Each check is one request.
- Type:
System.Double - Parameter sets:
(All)
-Removed
Waits until Files.com has nothing at -Path.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
Removed(required)
-Timeout
The longest to wait. The command then fails with Files.OperationTimeout, and the action goes on at Files.com.
- Type:
System.TimeSpan - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace instead of the connection's, including workspace 0. The connection itself is unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
Common Parameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
FilesCom.PowerShell.Models.FileAction: Actions from Copy-FilesFile and Move-FilesFile, as -InputObject.
Outputs
FilesCom.PowerShell.Models.FileMigration: For an action with a migration, the completed migration. Nothing for an action Files.com had completed when it answered, or with -Removed.
Notes
A delete Files.com finishes before it answers needs no wait: -Removed then returns after one check. See about_FilesCom for connections, errors and previewing changes.
Related Links
Get-Help about_FilesCom