/
ScheduledJob.xml
218 lines (218 loc) · 11.4 KB
/
ScheduledJob.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
<Type Name="ScheduledJob" FullName="Microsoft.Azure.Devices.ScheduledJob">
<TypeSignature Language="C#" Value="public class ScheduledJob : Microsoft.Azure.Devices.IotHubScheduledJobResponse" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ScheduledJob extends Microsoft.Azure.Devices.IotHubScheduledJobResponse" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.ScheduledJob" />
<TypeSignature Language="VB.NET" Value="Public Class ScheduledJob
Inherits IotHubScheduledJobResponse" />
<TypeSignature Language="F#" Value="type ScheduledJob = class
 inherit IotHubScheduledJobResponse" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.IotHubScheduledJobResponse</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides current job report when fetched.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal ScheduledJob ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ScheduledJob.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
This constructor is for deserialization and unit test mocking purposes.
</summary>
<remarks>
To unit test methods that use this type as a response, inherit from this class and give it a constructor
that can set the properties you want.
</remarks>
</Docs>
</Member>
<Member MemberName="DeviceId">
<MemberSignature Language="C#" Value="public string DeviceId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.DeviceId" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceId As String" />
<MemberSignature Language="F#" Value="member this.DeviceId : string with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.DeviceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="deviceId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="deviceId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Id of the device for this response.
</summary>
<value>To be added.</value>
<remarks>
It can be null (e.g., in case of a parent orchestration).
</remarks>
</Docs>
</Member>
<Member MemberName="DeviceJobStatistics">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.DeviceJobStatistics DeviceJobStatistics { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.DeviceJobStatistics DeviceJobStatistics" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.DeviceJobStatistics" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceJobStatistics As DeviceJobStatistics" />
<MemberSignature Language="F#" Value="member this.DeviceJobStatistics : Microsoft.Azure.Devices.DeviceJobStatistics with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.DeviceJobStatistics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="deviceJobStatistics")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="deviceJobStatistics")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.DeviceJobStatistics</ReturnType>
</ReturnValue>
<Docs>
<summary>
Different number of devices in the job.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JobType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.JobType JobType { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.JobType JobType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.JobType" />
<MemberSignature Language="VB.NET" Value="Public Property JobType As JobType" />
<MemberSignature Language="F#" Value="member this.JobType : Microsoft.Azure.Devices.JobType with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.JobType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="jobType")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="jobType")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.JobType</ReturnType>
</ReturnValue>
<Docs>
<summary>
The type of job to execute.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxExecutionTime">
<MemberSignature Language="C#" Value="public TimeSpan MaxExecutionTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxExecutionTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.MaxExecutionTime" />
<MemberSignature Language="VB.NET" Value="Public Property MaxExecutionTime As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxExecutionTime : TimeSpan with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.MaxExecutionTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Max execution time.
</summary>
<value>To be added.</value>
<remarks>The precision on this is in seconds.</remarks>
</Docs>
</Member>
<Member MemberName="ParentJobId">
<MemberSignature Language="C#" Value="public string ParentJobId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ParentJobId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.ParentJobId" />
<MemberSignature Language="VB.NET" Value="Public Property ParentJobId As String" />
<MemberSignature Language="F#" Value="member this.ParentJobId : string with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.ParentJobId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="parentJobId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="parentJobId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The job Id of the parent orchestration, if any.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueryCondition">
<MemberSignature Language="C#" Value="public string QueryCondition { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string QueryCondition" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ScheduledJob.QueryCondition" />
<MemberSignature Language="VB.NET" Value="Public Property QueryCondition As String" />
<MemberSignature Language="F#" Value="member this.QueryCondition : string with get, set" Usage="Microsoft.Azure.Devices.ScheduledJob.QueryCondition" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="queryCondition")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="queryCondition")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Device query condition.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>