/
com.microsoft.azure.sdk.iot.service.jobs.JobResult.yml
232 lines (232 loc) · 13.9 KB
/
com.microsoft.azure.sdk.iot.service.jobs.JobResult.yml
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
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult"
name: "JobResult"
nameWithType: "JobResult"
summary: "Collection with the result of a job operation."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **JobResult**"
methods:
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getCloudToDeviceMethod()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getCloudToDeviceMethod()"
name: "getCloudToDeviceMethod()"
nameWithType: "JobResult.getCloudToDeviceMethod()"
summary: "Getter for cloud to device method json"
syntax: "public String getCloudToDeviceMethod()"
desc: "Getter for cloud to device method json"
returns:
description: "the json of cloud to device method. It is <code>null</code> if jobType\n is not scheduleDeviceMethod"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getCreatedTime()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getCreatedTime()"
name: "getCreatedTime()"
nameWithType: "JobResult.getCreatedTime()"
summary: "Getter for create time"
syntax: "public Date getCreatedTime()"
desc: "Getter for create time"
returns:
description: "the scheduled job start time in UTC"
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getDeviceId()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getDeviceId()"
name: "getDeviceId()"
nameWithType: "JobResult.getDeviceId()"
summary: "Getter for the device Id"
syntax: "public String getDeviceId()"
desc: "Getter for the device Id"
returns:
description: "the deviceId related to this response. It can be <code>null</code>\n (e.g. in case of a parent orchestration)"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getEndTime()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getEndTime()"
name: "getEndTime()"
nameWithType: "JobResult.getEndTime()"
summary: "Getter for the end time UTC Represents the time the job stopped processing"
syntax: "public Date getEndTime()"
desc: "Getter for the end time UTC Represents the time the job stopped processing"
returns:
description: "the system generated end time in UTC"
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getError()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getError()"
name: "getError()"
nameWithType: "JobResult.getError()"
summary: "getter for the error"
syntax: "public String getError()"
desc: "getter for the error"
returns:
description: "returns the json formatted error as string"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getFailureReason()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getFailureReason()"
name: "getFailureReason()"
nameWithType: "JobResult.getFailureReason()"
summary: "Getter for failure reason"
syntax: "public String getFailureReason()"
desc: "Getter for failure reason"
returns:
description: "If status == failure, this represents a string containing the\n reason. It can be <code>null</code>"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobId()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobId()"
name: "getJobId()"
nameWithType: "JobResult.getJobId()"
summary: "Getter for the Job identifier"
syntax: "public String getJobId()"
desc: "Getter for the Job identifier"
returns:
description: "Job identifier"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobStatistics()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobStatistics()"
name: "getJobStatistics()"
nameWithType: "JobResult.getJobStatistics()"
summary: "Getter for jobs statistics"
syntax: "public JobStatistics getJobStatistics()"
desc: "Getter for jobs statistics"
returns:
description: "a set of counters with the jobs statistics"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.jobs.JobStatistics?alt=com.microsoft.azure.sdk.iot.service.jobs.JobStatistics&text=JobStatistics\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobStatus()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobStatus()"
name: "getJobStatus()"
nameWithType: "JobResult.getJobStatus()"
summary: "Getter for the jobs status"
syntax: "public JobStatus getJobStatus()"
desc: "Getter for the jobs status"
returns:
description: "the status of this job"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.jobs.JobStatus?alt=com.microsoft.azure.sdk.iot.service.jobs.JobStatus&text=JobStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobType()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getJobType()"
name: "getJobType()"
nameWithType: "JobResult.getJobType()"
summary: "Getter for the job type"
syntax: "public JobType getJobType()"
desc: "Getter for the job type"
returns:
description: "the type of job to execute"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.jobs.JobType?alt=com.microsoft.azure.sdk.iot.service.jobs.JobType&text=JobType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getLastUpdatedDateTime()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getLastUpdatedDateTime()"
name: "getLastUpdatedDateTime()"
nameWithType: "JobResult.getLastUpdatedDateTime()"
summary: "Getter for last updated time in UTC"
syntax: "public Date getLastUpdatedDateTime()"
desc: "Getter for last updated time in UTC"
returns:
description: "System generated last updated time in UTC"
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getMaxExecutionTimeInSeconds()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getMaxExecutionTimeInSeconds()"
name: "getMaxExecutionTimeInSeconds()"
nameWithType: "JobResult.getMaxExecutionTimeInSeconds()"
summary: "Getter for max execution time in seconds"
syntax: "public Long getMaxExecutionTimeInSeconds()"
desc: "Getter for max execution time in seconds"
returns:
description: "the max execution time in seconds (ttl duration)"
type: "<xref href=\"java.lang.Long?alt=java.lang.Long&text=Long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getOutcome()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getOutcome()"
name: "getOutcome()"
nameWithType: "JobResult.getOutcome()"
summary: "Outcome for the device method job"
deprecatedTag: "As of release 1.7.23, replaced by <xref uid=\"com.microsoft.azure.sdk.iot.service.jobs.JobResult.getOutcomeResult()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getOutcomeResult()\"></xref>"
syntax: "</br>public String getOutcome()"
desc: "Outcome for the device method job"
hasDeprecatedTag: true
returns:
description: "outcome for device method job"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getOutcomeResult()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getOutcomeResult()"
name: "getOutcomeResult()"
nameWithType: "JobResult.getOutcomeResult()"
summary: "Outcome for the device method job"
syntax: "public MethodResult getOutcomeResult()"
desc: "Outcome for the device method job"
returns:
description: "outcome for device method job"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.MethodResult?alt=com.microsoft.azure.sdk.iot.service.devicetwin.MethodResult&text=MethodResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getParentJobId()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getParentJobId()"
name: "getParentJobId()"
nameWithType: "JobResult.getParentJobId()"
summary: "Getter for the parent job<wbr>Id"
syntax: "public String getParentJobId()"
desc: "Getter for the parent jobId"
returns:
description: "the jobId of the parent orchestration, if any. It can be <code>null</code>"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getQueryCondition()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getQueryCondition()"
name: "getQueryCondition()"
nameWithType: "JobResult.getQueryCondition()"
summary: "Getter for query condition"
syntax: "public String getQueryCondition()"
desc: "Getter for query condition"
returns:
description: "the condition for device query to get devices to execute the job on"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getStartTime()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getStartTime()"
name: "getStartTime()"
nameWithType: "JobResult.getStartTime()"
summary: "Getter for start time UTC"
syntax: "public Date getStartTime()"
desc: "Getter for start time UTC"
returns:
description: "the system generated start time in UTC"
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getStatusMessage()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getStatusMessage()"
name: "getStatusMessage()"
nameWithType: "JobResult.getStatusMessage()"
summary: "Getter for the status message"
syntax: "public String getStatusMessage()"
desc: "Getter for the status message"
returns:
description: "a string containing a message with status about the job\n execution. It can be <code>null</code>"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getUpdateTwin()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.getUpdateTwin()"
name: "getUpdateTwin()"
nameWithType: "JobResult.getUpdateTwin()"
summary: "Getter for update twin json"
syntax: "public DeviceTwinDevice getUpdateTwin()"
desc: "Getter for update twin json"
returns:
description: "the json of update twin. It is <code>null</code> if jobType\n is not scheduleUpdateTwin"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.DeviceTwinDevice?alt=com.microsoft.azure.sdk.iot.service.devicetwin.DeviceTwinDevice&text=DeviceTwinDevice\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.toString()"
fullName: "com.microsoft.azure.sdk.iot.service.jobs.JobResult.toString()"
name: "toString()"
nameWithType: "JobResult.toString()"
summary: "Return a string with a pretty print json with the content of this class"
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Return a string with a pretty print json with the content of this class"
returns:
description: "a String with a json that represents the content of this class"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Collection with the result of a job operation."
metadata: {}
package: "com.microsoft.azure.sdk.iot.service.jobs"
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0