Partager via

JobResult Class

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

public class JobResult

Collection with the result of a job operation.

Method Summary

Modifier and Type Method and Description
java.lang.String getCloudToDeviceMethod()

Getter for cloud to device method json
java.util.Date getCreatedTime()

Getter for create time
java.lang.String getDeviceId()

Getter for the device Id
java.util.Date getEndTime()

Getter for the end time UTC Represents the time the job stopped processing
java.lang.String getError()

getter for the error
java.lang.String getFailureReason()

Getter for failure reason
java.lang.String getJobId()

Getter for the Job identifier
JobStatistics getJobStatistics()

Getter for jobs statistics
JobStatus getJobStatus()

Getter for the jobs status
JobType getJobType()

Getter for the job type
java.util.Date getLastUpdatedDateTime()

Getter for last updated time in UTC
java.lang.Long getMaxExecutionTimeInSeconds()

Getter for max execution time in seconds
java.lang.String getOutcome()

Deprecated

As of release 1.7.23, replaced by getOutcomeResult()

Outcome for the device method job
MethodResult getOutcomeResult()

Outcome for the device method job
java.lang.String getParentJobId()

Getter for the parent jobId
java.lang.String getQueryCondition()

Getter for query condition
java.util.Date getStartTime()

Getter for start time UTC
java.lang.String getStatusMessage()

Getter for the status message
DeviceTwinDevice getUpdateTwin()

Getter for update twin json
java.lang.String toString()

Return a string with a pretty print json with the content of this class

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

getCloudToDeviceMethod

public String getCloudToDeviceMethod()

Getter for cloud to device method json

Returns:

the json of cloud to device method. It is null if jobType is not scheduleDeviceMethod

getCreatedTime

public Date getCreatedTime()

Getter for create time

Returns:

the scheduled job start time in UTC

getDeviceId

public String getDeviceId()

Getter for the device Id

Returns:

the deviceId related to this response. It can be null (e.g. in case of a parent orchestration)

getEndTime

public Date getEndTime()

Getter for the end time UTC Represents the time the job stopped processing

Returns:

the system generated end time in UTC

getError

public String getError()

getter for the error

Returns:

returns the json formatted error as string

getFailureReason

public String getFailureReason()

Getter for failure reason

Returns:

If status == failure, this represents a string containing the reason. It can be null

getJobId

public String getJobId()

Getter for the Job identifier

Returns:

Job identifier

getJobStatistics

public JobStatistics getJobStatistics()

Getter for jobs statistics

Returns:

a set of counters with the jobs statistics

getJobStatus

public JobStatus getJobStatus()

Getter for the jobs status

Returns:

the status of this job

getJobType

public JobType getJobType()

Getter for the job type

Returns:

the type of job to execute

getLastUpdatedDateTime

public Date getLastUpdatedDateTime()

Getter for last updated time in UTC

Returns:

System generated last updated time in UTC

getMaxExecutionTimeInSeconds

public Long getMaxExecutionTimeInSeconds()

Getter for max execution time in seconds

Returns:

the max execution time in seconds (ttl duration)

getOutcome


public String getOutcome()

Deprecated

As of release 1.7.23, replaced by getOutcomeResult()

Outcome for the device method job

Returns:

outcome for device method job

getOutcomeResult

public MethodResult getOutcomeResult()

Outcome for the device method job

Returns:

outcome for device method job

getParentJobId

public String getParentJobId()

Getter for the parent jobId

Returns:

the jobId of the parent orchestration, if any. It can be null

getQueryCondition

public String getQueryCondition()

Getter for query condition

Returns:

the condition for device query to get devices to execute the job on

getStartTime

public Date getStartTime()

Getter for start time UTC

Returns:

the system generated start time in UTC

getStatusMessage

public String getStatusMessage()

Getter for the status message

Returns:

a string containing a message with status about the job execution. It can be null

getUpdateTwin

public DeviceTwinDevice getUpdateTwin()

Getter for update twin json

Returns:

the json of update twin. It is null if jobType is not scheduleUpdateTwin

toString

public String toString()

Return a string with a pretty print json with the content of this class

Overrides:

JobResult.toString()

Returns:

a String with a json that represents the content of this class

Applies to