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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
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 InputObject
            Represents the PoshRS.PowerShell.RSJob object being sent to command.

        .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

        .NOTES
            Name: Receive-RSJob
            Author: Boe Prox

        .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(Position=0,ValueFromPipeline=$True,ParameterSetName='Job')]
        [PoshRS.PowerShell.RSJob[]]$InputObject,
        [parameter(Position=1,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Name')]
        [string[]]$Name,
        [parameter(Position=2,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Id')]
        [int[]]$Id,
        [parameter(Position=3,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Guid')]
        [guid[]]$InstanceID,
        [parameter(Position=4,ValueFromPipelineByPropertyName=$True,
        ParameterSetName='Batch')]
        [string[]]$Batch
    )
    Begin {
        If ($PSBoundParameters['Debug']) {
            $DebugPreference = 'Continue'
        }        
        $List = New-Object System.Collections.ArrayList
        $StringBuilder = New-Object System.Text.StringBuilder
        $Bound = $False

        #Take care of bound parameters
        If ($PSBoundParameters['Name']) {
            [void]$list.AddRange($Name)
            $Bound = $True
        }
        If ($PSBoundParameters['Id']) {
            [void]$list.AddRange($Id)
            $Bound = $True
        }
        If ($PSBoundParameters['InstanceId']) {
            [void]$list.AddRange($InstanceId)
            $Bound = $True
        }
        If ($PSBoundParameters['InputObject']) {
            [void]$list.AddRange($InputObject)
            $Bound = $True
        }
        If ($PSBoundParameters['Batch']) {
            [void]$list.AddRange($Batch)
            $Bound = $True
        }
        Write-Verbose "Bound: $Bound"
    }
    Process {
        If (-NOT $Bound -and $InputObject) {
            $_ | WriteStream
        }
        elseif (-Not $Bound) {
            [void]$List.Add($_)
        }
    }
    End {
        Write-Verbose "ParameterSet: $($PSCmdlet.parametersetname)"
        Switch ($PSCmdlet.parametersetname) {
            'Name' {
                $Items = '"{0}"' -f (($list | ForEach {"^{0}$" -f $_}) -join '|') -replace '\*','.*'
                [void]$StringBuilder.Append("`$_.Name -match $Items") 
                $ScriptBlock = [scriptblock]::Create($StringBuilder.ToString())                    
            }
            'Id' {
                $Items = '"{0}"' -f (($list | ForEach {"^{0}$" -f $_}) -join '|')
                [void]$StringBuilder.Append("`$_.Id -match $Items") 
                $ScriptBlock = [scriptblock]::Create($StringBuilder.ToString())                
            }
            'Guid' {
                $Items = '"{0}"' -f (($list | ForEach {"^{0}$" -f $_}) -join '|')
                [void]$StringBuilder.Append("`$_.InstanceId -match $Items")   
                $ScriptBlock = [scriptblock]::Create($StringBuilder.ToString())   
            }
            'Batch' {
                $Items = '"{0}"' -f (($list | ForEach {"^{0}$" -f $_}) -join '|')
                [void]$StringBuilder.Append("`$_.batch -match $Items")   
                $ScriptBlock = [scriptblock]::Create($StringBuilder.ToString()) 
            }     
            Default {$ScriptBlock=$Null}
        }
        Write-Verbose "ScriptBlock: $($ScriptBlock)"
        If ($ScriptBlock) {
            Write-Verbose "Running Scriptblock"
            $PoshRS_jobs | Where $ScriptBlock | WriteStream
        } ElseIf ($Bound) {
            $PoshRS_jobs | WriteStream
        }
    }
}