New-FilesExpectation
Create Expectation.
Syntax
Description
Create Expectation.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Create Expectation
Writes the expectation returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Name
Expectation name.
- Type:
System.String - Parameter sets:
(All)
-Description
Expectation description.
- Type:
System.String - Parameter sets:
(All)
-Path
Path scope for the expectation. Supports workspace-relative presentation.
- Type:
System.String - Parameter sets:
(All)
-Source
Source glob used to select candidate files.
- Type:
System.String - Parameter sets:
(All)
-ExcludePattern
Optional source exclusion glob.
- Type:
System.String - Parameter sets:
(All)
-Disabled
If true, the expectation is disabled.
- Type:
System.Boolean - Parameter sets:
(All)
-Trigger
How this expectation opens windows.
- Type:
System.String - Parameter sets:
(All)
-Interval
If trigger is daily, this specifies how often to run the expectation.
- Type:
System.String - Parameter sets:
(All)
-RecurringDay
If trigger is daily, this selects the day number inside the chosen interval.
- Type:
System.Int64 - Parameter sets:
(All)
-RecurringDays
If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
- Type:
System.Int64[] - Parameter sets:
(All)
-ScheduleId
If trigger is custom_schedule, the reusable Schedule used instead of the Expectation's schedule fields.
- Type:
System.Int64 - Parameter sets:
(All)
-ScheduleDaysOfWeek
If trigger is custom_schedule, the 0-based weekdays used by the schedule.
- Type:
System.Int64[] - Parameter sets:
(All)
-ScheduleTimesOfDay
Times of day in HH:MM format for the Expectation schedule.
- Type:
System.String[] - Parameter sets:
(All)
-ScheduleTimeZone
Time zone used by the Expectation schedule.
- Type:
System.String - Parameter sets:
(All)
-HolidayRegion
Optional holiday region used by the Expectation schedule.
- Type:
System.String - Parameter sets:
(All)
-LookbackInterval
How many seconds before the due boundary the window starts.
- Type:
System.Int64 - Parameter sets:
(All)
-LateAcceptanceInterval
How many seconds a schedule-driven window may remain eligible to close as late.
- Type:
System.Int64 - Parameter sets:
(All)
-InactivityInterval
How many quiet seconds are required before final closure.
- Type:
System.Int64 - Parameter sets:
(All)
-MaxOpenInterval
Hard-stop duration in seconds for unscheduled expectations.
- Type:
System.Int64 - Parameter sets:
(All)
-Criteria
Versioned success criteria definition for the expectation, including optional Files Transform Script content validation in criteria v2. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
(All)
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - Parameter sets:
(All)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-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)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: Medium. At the default
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes it ask before each change.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.Expectation: the expectation as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.