com.microsoft.azure.sdk.iot.service.jobs

Class JobResult

java.lang.Object

com.microsoft.azure.sdk.iot.service.jobs.JobResult

public class JobResult
extends Object

Collection with the result of a job operation.

Method Summary

Modifier and Type	Method and Description
String	getCloudToDeviceMethod() Getter for cloud to device method json
Date	getCreatedTime() Getter for create time
String	getDeviceId() Getter for the device Id
Date	getEndTime() Getter for the end time UTC Represents the time the job stopped processing
String	getError() getter for the error
String	getFailureReason() Getter for failure reason
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
Date	getLastUpdatedDateTime() Getter for last updated time in UTC
Long	getMaxExecutionTimeInSeconds() Getter for max execution time in seconds
String	getOutcome() Deprecated. As of release 1.7.23, replaced by getOutcomeResult()
MethodResult	getOutcomeResult() Outcome for the device method job
String	getParentJobId() Getter for the parent jobId
String	getQueryCondition() Getter for query condition
Date	getStartTime() Getter for start time UTC
String	getStatusMessage() Getter for the status message
DeviceTwinDevice	getUpdateTwin() Getter for update twin json
String	toString() Return a string with a pretty print json with the content of this class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getJobId

public String getJobId()

Getter for the Job identifier

Returns:

Job identifier

getQueryCondition

public String getQueryCondition()

Getter for query condition

Returns:

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

getCreatedTime

public Date getCreatedTime()

Getter for create time

Returns:

the scheduled job start time in UTC

getStartTime

public Date getStartTime()

Getter for start time UTC

Returns:

the system generated start time in UTC

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

getMaxExecutionTimeInSeconds

public Long getMaxExecutionTimeInSeconds()

Getter for max execution time in seconds

Returns:

the max execution time in seconds (ttl duration)

getJobType

public JobType getJobType()

Getter for the job type

Returns:

the type of job to execute

getJobStatus

public JobStatus getJobStatus()

Getter for the jobs status

Returns:

the status of this job

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

getUpdateTwin

public DeviceTwinDevice getUpdateTwin()

Getter for update twin json

Returns:

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

getFailureReason

public String getFailureReason()

Getter for failure reason

Returns:

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

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

getJobStatistics

public JobStatistics getJobStatistics()

Getter for jobs statistics

Returns:

a set of counters with the jobs statistics

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)

getParentJobId

public String getParentJobId()

Getter for the parent jobId

Returns:

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

getLastUpdatedDateTime

public Date getLastUpdatedDateTime()

Getter for last updated time in UTC

Returns:

System generated last updated time in UTC

getOutcome

@Deprecated
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

getError

public String getError()

getter for the error

Returns:

returns the json formatted error as string

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

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