com.microsoft.azure.sdk.iot.deps.serializer

Class JobsResponseParser

java.lang.Object

com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser

public class JobsResponseParser
extends Object

Representation of a single Jobs response collection with a Json deserializer.

Constructor Summary

Constructors

Constructor and Description
JobsResponseParser()

Method Summary

Modifier and Type	Method and Description
static JobsResponseParser	createFromJson(String json) Static constructor to create a instance based on the provided json
MethodParser	getCloudToDeviceMethod() Getter for cloud to device method json
Date	getCreatedTime() Getter for created time
String	getDeviceId() Getter for the device Id
Date	getEndTime() Getter for the end time UTC Represents the time the job stopped processing
JobQueryResponseError	getError() Returns the error as json
String	getFailureReason() Getter for failure reason
String	getJobId() Getter for the Job identifier
String	getJobsStatus() Getter for the jobs status
JobsStatisticsParser	getJobStatistics() Getter for jobs statistics
Date	getLastUpdatedTimeDate() Getter for last updated time in UTC
Long	getMaxExecutionTimeInSeconds() Getter for max execution time in seconds
MethodParser	getOutcome() Getter for the outcome of device method
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
String	getType() Getter for the job type
TwinParser	getUpdateTwin() Deprecated. As of release 0.4.0, replaced by getUpdateTwinState()
TwinState	getUpdateTwinState() Getter for update twin json

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsResponseParser

public JobsResponseParser()

Method Detail

createFromJson

public static JobsResponseParser createFromJson(String json)
                                         throws IllegalArgumentException,
                                                com.google.gson.JsonParseException

Static constructor to create a instance based on the provided json

Parameters:

json - is the string with the json to parse

Returns:

an instance of the JobsResponseParser

Throws:

IllegalArgumentException - if the json is null or empty, or if any date is invalid

com.google.gson.JsonParseException - if the json is not valid

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. It can be null

getCreatedTime

public Date getCreatedTime()

Getter for created time

Returns:

the scheduled job start time in UTC. It can be null

getStartTime

public Date getStartTime()

Getter for start time UTC

Returns:

the system generated start time in UTC. It can be null

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. It can be null

getMaxExecutionTimeInSeconds

public Long getMaxExecutionTimeInSeconds()

Getter for max execution time in seconds

Returns:

the max execution time in seconds (ttl duration). It can be null

getLastUpdatedTimeDate

public Date getLastUpdatedTimeDate()

Getter for last updated time in UTC

Returns:

System generated last updated time in UTC. Can be null

getType

public String getType()

Getter for the job type

Returns:

the type of job to execute

getJobsStatus

public String getJobsStatus()

Getter for the jobs status

Returns:

the status of this job

getCloudToDeviceMethod

public MethodParser getCloudToDeviceMethod()

Getter for cloud to device method json

Returns:

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

getError

public JobQueryResponseError getError()

Returns the error as json

Returns:

the json error returned by IotHub

getOutcome

public MethodParser getOutcome()

Getter for the outcome of device method

Returns:

the outcome in json for device method when querying device method job

getUpdateTwin

@Deprecated
public TwinParser getUpdateTwin()

Deprecated. As of release 0.4.0, replaced by getUpdateTwinState()

Getter for update twin json

Returns:

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

getUpdateTwinState

public TwinState getUpdateTwinState()

Getter for update twin json

Returns:

the json of update twin. It is null if type 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 JobsStatisticsParser getJobStatistics()

Getter for jobs statistics

Returns:

a set of counters with the jobs statistics. It can be null

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