WaitJobCommand Class

Definition

This cmdlet waits for job to complete.

public ref class WaitJobCommand : Microsoft::PowerShell::Commands::JobCmdletBase, IDisposable
public class WaitJobCommand : Microsoft.PowerShell.Commands.JobCmdletBase, IDisposable
[System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096902")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Job) })]
public class WaitJobCommand : Microsoft.PowerShell.Commands.JobCmdletBase, IDisposable
[System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096902")]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.Job))]
public class WaitJobCommand : Microsoft.PowerShell.Commands.JobCmdletBase, IDisposable
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Job) })]
[System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113422")]
public class WaitJobCommand : Microsoft.PowerShell.Commands.JobCmdletBase, IDisposable
type WaitJobCommand = class
    inherit JobCmdletBase
    interface IDisposable
[<System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096902")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Job) })>]
type WaitJobCommand = class
    inherit JobCmdletBase
    interface IDisposable
[<System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096902")>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.Job))>]
type WaitJobCommand = class
    inherit JobCmdletBase
    interface IDisposable
[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Job) })>]
[<System.Management.Automation.Cmdlet("Wait", "Job", DefaultParameterSetName="SessionIdParameterSet", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113422")>]
type WaitJobCommand = class
    inherit JobCmdletBase
    interface IDisposable
Public Class WaitJobCommand
Inherits JobCmdletBase
Implements IDisposable
Inheritance
Attributes
Implements

Constructors

WaitJobCommand()

Fields

ComputerInstanceIdParameterSet

Computername with session instance ID parameter set.

(Inherited from PSRemotingCmdlet)
ComputerNameParameterSet

Computername parameter set.

(Inherited from PSRemotingCmdlet)
ContainerIdParameterSet

Container ID parameter set.

(Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellAppName

Default application name for the connection uri.

(Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellName

Default shellname.

(Inherited from PSRemotingCmdlet)
SessionParameterSet

Runspace parameter set.

(Inherited from PSRemotingCmdlet)
SSHHostHashParameterSet

SSH host parmeter set supporting hash connection parameters.

(Inherited from PSRemotingCmdlet)
SSHHostParameterSet

SSH host parameter set.

(Inherited from PSRemotingCmdlet)
UseWindowsPowerShellParameterSet

Parameter set to use Windows PowerShell.

(Inherited from PSRemotingCmdlet)
VMIdParameterSet

VM guid parameter set.

(Inherited from PSRemotingCmdlet)
VMNameParameterSet

VM name parameter set.

(Inherited from PSRemotingCmdlet)

Properties

Any

Complete the cmdlet when any of the job is completed, instead of waiting for all of them to be completed.

Command
CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction.

(Inherited from Cmdlet)
Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Filter

All the job objects matching the values in filter.

(Inherited from JobCmdletBase)
Force

Forces the cmdlet to wait for Finished states (Completed, Failed, Stopped) instead of persistent states, which also include Suspended and Disconnected.

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
Id

SessionId for which job need to be obtained.

(Inherited from JobCmdletBase)
InstanceId

InstanceIds for which job need to be obtained.

(Inherited from JobCmdletBase)
InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
Job

Specifies the Jobs objects which need to be removed.

JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository

Repository for jobs.

(Inherited from PSCmdlet)
MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
Name

Name of the jobs to retrieve.

(Inherited from JobCmdletBase)
PagingParameters

If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null.

(Inherited from PSCmdlet)
ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
State

All the job objects having this state.

(Inherited from JobCmdletBase)
Stopping

Is this command stopping?

(Inherited from Cmdlet)
Timeout

If timeout is specified, the cmdlet will only wait for this number of seconds. Value of -1 means never timeout.

Methods

BeginProcessing()

In this method, we initialize the timer if timeout parameter is specified.

CurrentProviderLocation(String) (Inherited from PSCmdlet)
Dispose()

Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this).

EndProcessing()

Wait on the collected Jobs.

GetResolvedProviderPathFromPSPath(String, ProviderInfo) (Inherited from PSCmdlet)
GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String) (Inherited from PSCmdlet)
GetVariableValue(String) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (Inherited from PSCmdlet)
Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord()

This method just collects the Jobs which will be waited on in the EndProcessing method.

ResolveAppName(String)

Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan.

(Inherited from PSRemotingCmdlet)
ResolveComputerName(String)

Resolves a computer name. If its null or empty its assumed to be localhost.

(Inherited from PSRemotingCmdlet)
ResolveComputerNames(String[], String[])

Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost.

(Inherited from PSRemotingCmdlet)
ResolveShell(String)

Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell.

(Inherited from PSRemotingCmdlet)
ShouldContinue(String, String)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldProcess(String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

(Inherited from Cmdlet)
ShouldProcess(String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify text for both the target resource and the action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
StopProcessing()

Cancel the Wait-Job cmdlet.

ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error.

(Inherited from Cmdlet)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String)

Display debug information.

(Inherited from Cmdlet)
WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean)

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

(Inherited from Cmdlet)
WriteProgress(ProgressRecord)

Display progress information.

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information.

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information.

(Inherited from Cmdlet)

Applies to