-
Notifications
You must be signed in to change notification settings - Fork 11
/
IRemoteCommand.xml
272 lines (272 loc) · 16.5 KB
/
IRemoteCommand.xml
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<Type Name="IRemoteCommand" FullName="Microsoft.Hpc.Scheduler.IRemoteCommand">
<TypeSignature Language="C#" Value="public interface IRemoteCommand" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IRemoteCommand" />
<TypeSignature Language="DocId" Value="T:Microsoft.Hpc.Scheduler.IRemoteCommand" />
<TypeSignature Language="VB.NET" Value="Public Interface IRemoteCommand" />
<TypeSignature Language="F#" Value="type IRemoteCommand = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("f8d669bc-0579-41b9-ac26-384c3c8e06f8")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Defines a command to execute on one or more nodes in the cluster.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Cancel() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Scheduler.IRemoteCommand.Cancel" />
<MemberSignature Language="VB.NET" Value="Public Sub Cancel ()" />
<MemberSignature Language="F#" Value="abstract member Cancel : unit -> unit" Usage="iRemoteCommand.Cancel " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels the command.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommandLine">
<MemberSignature Language="C#" Value="public string CommandLine { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CommandLine" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Scheduler.IRemoteCommand.CommandLine" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CommandLine As String" />
<MemberSignature Language="F#" Value="member this.CommandLine : string" Usage="Microsoft.Hpc.Scheduler.IRemoteCommand.CommandLine" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the command line to execute.</summary>
<value>The command line.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public int Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Scheduler.IRemoteCommand.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As Integer" />
<MemberSignature Language="F#" Value="member this.Id : int" Usage="Microsoft.Hpc.Scheduler.IRemoteCommand.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the command identifier that uniquely identifies the command in the scheduler.</summary>
<value>The identifier that uniquely identifies the command.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeNames">
<MemberSignature Language="C#" Value="public Microsoft.Hpc.Scheduler.IStringCollection NodeNames { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Hpc.Scheduler.IStringCollection NodeNames" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Scheduler.IRemoteCommand.NodeNames" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeNames As IStringCollection" />
<MemberSignature Language="F#" Value="member this.NodeNames : Microsoft.Hpc.Scheduler.IStringCollection" Usage="Microsoft.Hpc.Scheduler.IRemoteCommand.NodeNames" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Hpc.Scheduler.IStringCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the collection of node names on which the command will run or has run.</summary>
<value>An <see cref="T:Microsoft.Hpc.Scheduler.IStringCollection"></see> interface that contains the collection of node names.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCommandJobState">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Hpc.Scheduler.JobStateEventArg> OnCommandJobState;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Hpc.Scheduler.JobStateEventArg> OnCommandJobState" />
<MemberSignature Language="DocId" Value="E:Microsoft.Hpc.Scheduler.IRemoteCommand.OnCommandJobState" />
<MemberSignature Language="VB.NET" Value="Event OnCommandJobState As EventHandler(Of JobStateEventArg) " />
<MemberSignature Language="F#" Value="member this.OnCommandJobState : EventHandler<Microsoft.Hpc.Scheduler.JobStateEventArg> " Usage="member this.OnCommandJobState : System.EventHandler<Microsoft.Hpc.Scheduler.JobStateEventArg> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Hpc.Scheduler.JobStateEventArg></ReturnType>
</ReturnValue>
<Docs>
<summary>An event that is raised when the state of the job that contains the command changes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCommandOutput">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Hpc.Scheduler.CommandOutputEventArg> OnCommandOutput;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Hpc.Scheduler.CommandOutputEventArg> OnCommandOutput" />
<MemberSignature Language="DocId" Value="E:Microsoft.Hpc.Scheduler.IRemoteCommand.OnCommandOutput" />
<MemberSignature Language="VB.NET" Value="Event OnCommandOutput As EventHandler(Of CommandOutputEventArg) " />
<MemberSignature Language="F#" Value="member this.OnCommandOutput : EventHandler<Microsoft.Hpc.Scheduler.CommandOutputEventArg> " Usage="member this.OnCommandOutput : System.EventHandler<Microsoft.Hpc.Scheduler.CommandOutputEventArg> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Hpc.Scheduler.CommandOutputEventArg></ReturnType>
</ReturnValue>
<Docs>
<summary>An event that is raised when the command generates a line of output.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCommandRawOutput">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Hpc.Scheduler.CommandRawOutputEventArg> OnCommandRawOutput;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Hpc.Scheduler.CommandRawOutputEventArg> OnCommandRawOutput" />
<MemberSignature Language="DocId" Value="E:Microsoft.Hpc.Scheduler.IRemoteCommand.OnCommandRawOutput" />
<MemberSignature Language="VB.NET" Value="Event OnCommandRawOutput As EventHandler(Of CommandRawOutputEventArg) " />
<MemberSignature Language="F#" Value="member this.OnCommandRawOutput : EventHandler<Microsoft.Hpc.Scheduler.CommandRawOutputEventArg> " Usage="member this.OnCommandRawOutput : System.EventHandler<Microsoft.Hpc.Scheduler.CommandRawOutputEventArg> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Hpc.Scheduler.CommandRawOutputEventArg></ReturnType>
</ReturnValue>
<Docs>
<summary>An event that is raised when the command generates output. The output is provided as a byte blob without encoding.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCommandTaskState">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Hpc.Scheduler.CommandTaskStateEventArg> OnCommandTaskState;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Hpc.Scheduler.CommandTaskStateEventArg> OnCommandTaskState" />
<MemberSignature Language="DocId" Value="E:Microsoft.Hpc.Scheduler.IRemoteCommand.OnCommandTaskState" />
<MemberSignature Language="VB.NET" Value="Event OnCommandTaskState As EventHandler(Of CommandTaskStateEventArg) " />
<MemberSignature Language="F#" Value="member this.OnCommandTaskState : EventHandler<Microsoft.Hpc.Scheduler.CommandTaskStateEventArg> " Usage="member this.OnCommandTaskState : System.EventHandler<Microsoft.Hpc.Scheduler.CommandTaskStateEventArg> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Hpc.Scheduler.CommandTaskStateEventArg></ReturnType>
</ReturnValue>
<Docs>
<summary>An event that is raised when the state of the command changes on a node.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutputEncoding">
<MemberSignature Language="C#" Value="public System.Text.Encoding OutputEncoding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding OutputEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Scheduler.IRemoteCommand.OutputEncoding" />
<MemberSignature Language="VB.NET" Value="Public Property OutputEncoding As Encoding" />
<MemberSignature Language="F#" Value="member this.OutputEncoding : System.Text.Encoding with get, set" Usage="Microsoft.Hpc.Scheduler.IRemoteCommand.OutputEncoding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves or sets the encoding to use on the output that the command generates.</summary>
<value>An <see cref="T:System.Text.Encoding"></see> object that specifies the encoding to apply to the output that is sent to your <see cref="T:Microsoft.Hpc.Scheduler.CommandOutputHandler"></see> event handler in response to an <see cref="E:Microsoft.Hpc.Scheduler.IRemoteCommand.OnCommandOutput"></see> event. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProxyTaskId">
<MemberSignature Language="C#" Value="public int ProxyTaskId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ProxyTaskId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Scheduler.IRemoteCommand.ProxyTaskId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProxyTaskId As Integer" />
<MemberSignature Language="F#" Value="member this.ProxyTaskId : int" Usage="Microsoft.Hpc.Scheduler.IRemoteCommand.ProxyTaskId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the unique task identifier for the proxy task in a remote command job. The proxy task is the task that forwards the output and error streams from all of the nodes in a remote command to the client.</summary>
<value>An <see cref="T:System.Int32"></see> object that specifies the unique task identifier for the proxy task in a remote command job.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public void Start ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Start() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Scheduler.IRemoteCommand.Start" />
<MemberSignature Language="VB.NET" Value="Public Sub Start ()" />
<MemberSignature Language="F#" Value="abstract member Start : unit -> unit" Usage="iRemoteCommand.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Runs the command.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartWithCredentials">
<MemberSignature Language="C#" Value="public void StartWithCredentials (string userName, string password);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void StartWithCredentials(string userName, string password) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Scheduler.IRemoteCommand.StartWithCredentials(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub StartWithCredentials (userName As String, password As String)" />
<MemberSignature Language="F#" Value="abstract member StartWithCredentials : string * string -> unit" Usage="iRemoteCommand.StartWithCredentials (userName, password)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Scheduler</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userName" Type="System.String" />
<Parameter Name="password" Type="System.String" />
</Parameters>
<Docs>
<param name="userName">The name of the RunAs user, in the form domain\username. The user name is limited to 80 characters. If this parameter is NULL, the method uses the owner of the job. If this parameter is an empty string, the service searches the credentials cache for the credentials to use. If the cache contains the credentials for a single user, those credentials are used. However, if multiple credentials exist in the cache, the user is prompted for the credentials.</param>
<param name="password">The password for the RunAs user. The password is limited to 127 characters.If this parameter is null or empty, the method uses the cached password if cached; otherwise, the user is prompted for the password.</param>
<summary>Runs the command using the specified credentials.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>