Share via

Job Class

  • Reference
Package:
com.microsoft.azure.sdk.iot.service.devicetwin
Maven Artifact:
com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
  • java.lang.Object
    • com.microsoft.azure.sdk.iot.service.devicetwin.Job

public class Job

Representation of a single Job scheduled on the Iothub.

Method Summary

Modifier and Type Method and Description
JobResult cancel()

Cancel a current jod on the IoTHub
JobResult get()

Get the current job status on the iotHub.
java.lang.String getJobId()

Getter for the JobId.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

cancel

public JobResult cancel()

Cancel a current jod on the IoTHub

Returns:

a jobResult object with the current job status.

Throws:

java.io.IOException - if the function failed to cancel the job with the current job information
IotHubException - if the function failed to cancel the job with the current job information

get

public JobResult get()

Get the current job status on the iotHub.

Returns:

a jobResult object with the current job status.

Throws:

java.io.IOException - if the function failed to get the status with the current job information
IotHubException - if the function failed to get the status with the current job information

getJobId

public String getJobId()

Getter for the JobId.

Returns:

the current jobId.

Applies to