Public/Receive-RSJob.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Function Receive-RSJob {
    <#
        .SYNOPSIS
            Gets the results of the Windows PowerShell runspace jobs in the current session.
 
        .DESCRIPTION
            Gets the results of the Windows PowerShell runspace jobs in the current session. You can use
            Get-RSJob and pipe the results into this function to get the results as well.
 
        .PARAMETER Job
            Represents the RSJob object to receive available data from.
 
        .PARAMETER Name
            The name of the jobs to receive available data from.
 
        .PARAMETER ID
            The ID of the jobs to receive available data from.
 
        .PARAMETER InstanceID
            The GUID of the jobs to receive available data from.
 
        .PARAMETER Batch
            Name of the set of jobs to receive available data from.
 
        .NOTES
            Name: Receive-RSJob
            Author: Boe Prox/Max Kozlov
 
        .EXAMPLE
            Get-RSJob -State Completed | Receive-RSJob
 
            Description
            -----------
            Retrieves any available data that is outputted from completed RSJobs.
 
        .EXAMPLE
            Receive-RSJob -ID 1,5,78
 
            Description
            -----------
            Receives data from RSJob with IDs 1,5,78.
 
        .EXAMPLE
            Receive-RSJob -InputObject (Get-RSJob)
 
            Description
            -----------
            Receives data from all RSJobs.
    #>

    [cmdletbinding(
        DefaultParameterSetName='Job'
    )]
    Param (
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Job', Position=0)]
        [Alias('InputObject')]
        [RSJob[]]$Job,
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Name', Position=0)]
        [string[]]$Name,
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Id', Position=0)]
        [int[]]$Id,
        [parameter(ValueFromPipelineByPropertyName=$True,
        ParameterSetName='InstanceID')]
        [string[]]$InstanceID,
        [parameter(ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Batch')]
        [string[]]$Batch
    )
    Begin {
        If ($PSBoundParameters['Debug']) {
            $DebugPreference = 'Continue'
        }
        $List = New-Object System.Collections.ArrayList
    }
    Process {
        Write-Debug "ParameterSet: $($PSCmdlet.ParameterSetName)"
        $Property = $PSCmdlet.ParameterSetName
        if ($PSBoundParameters[$Property]) {
            Write-Verbose "Adding $($PSBoundParameters[$Property])"
            [void]$List.AddRange($PSBoundParameters[$Property])
        }
    }
    End {
        if (-not $List.Count) { return } # No jobs selected to search
        $PSBoundParameters[$Property] = $List
        [array]$ToReceive = Get-RSJob @PSBoundParameters

        if ($ToReceive.Count) {
            $ToReceive | ForEach-Object{
                $_ | WriteStream
                if (@("Completed", "Failed", "Stopped") -contains $_.State) {
                    $_ | SetIsReceived -SetTrue
                }
            }
        }
    }
}