70 строки
4.8 KiB
YAML
70 строки
4.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Job"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Job"
|
|
name: "Job"
|
|
nameWithType: "Job"
|
|
summary: "Representation of a single Job scheduled on the Iothub."
|
|
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 **Job**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.cancel()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.cancel()"
|
|
name: "cancel()"
|
|
nameWithType: "Job.cancel()"
|
|
summary: "Cancel a current jod on the Io<wbr>THub"
|
|
syntax: "public JobResult cancel()"
|
|
exceptions:
|
|
- description: "if the function failed to cancel the job with the current job information"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if the function failed to cancel the job with the current job information"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Cancel a current jod on the IoTHub"
|
|
returns:
|
|
description: "a jobResult object with the current job status."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.jobs.JobResult?alt=com.microsoft.azure.sdk.iot.service.jobs.JobResult&text=JobResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.get()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.get()"
|
|
name: "get()"
|
|
nameWithType: "Job.get()"
|
|
summary: "Get the current job status on the iot<wbr>Hub."
|
|
syntax: "public JobResult get()"
|
|
exceptions:
|
|
- description: "if the function failed to get the status with the current job information"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if the function failed to get the status with the current job information"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Get the current job status on the iotHub."
|
|
returns:
|
|
description: "a jobResult object with the current job status."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.jobs.JobResult?alt=com.microsoft.azure.sdk.iot.service.jobs.JobResult&text=JobResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.getJobId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Job.getJobId()"
|
|
name: "getJobId()"
|
|
nameWithType: "Job.getJobId()"
|
|
summary: "Getter for the Job<wbr>Id."
|
|
syntax: "public String getJobId()"
|
|
desc: "Getter for the JobId."
|
|
returns:
|
|
description: "the current jobId."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Representation of a single Job scheduled on the Iothub."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service.devicetwin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|