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

Class JobsParser

java.lang.Object

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

public class JobsParser
extends Object

Representation of a single Jobs collection with a Json serializer.

Constructor Summary

Constructors

Constructor and Description
JobsParser(String jobId, MethodParser cloudToDeviceMethod, String queryCondition, Date startTime, long maxExecutionTimeInSeconds) CONSTRUCTOR
JobsParser(String jobId, TwinParser updateTwin, String queryCondition, Date startTime, long maxExecutionTimeInSeconds) Deprecated. As of release 0.4.0, replaced by JobsParser(String, TwinState, String, Date, long)
JobsParser(String jobId, TwinState updateTwin, String queryCondition, Date startTime, long maxExecutionTimeInSeconds) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
String	toJson() Getter for the string with the json.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsParser

public JobsParser(String jobId,
                  MethodParser cloudToDeviceMethod,
                  String queryCondition,
                  Date startTime,
                  long maxExecutionTimeInSeconds)
           throws IllegalArgumentException

CONSTRUCTOR

Parameters:

jobId - is a string with the job identification. Cannot be null or empty.

cloudToDeviceMethod - is the class that contains the json for the cloud to Device Method. Cannot be null.

queryCondition - is a string with the deviceId or an IoT Hub Query Condition. Cannot be null or empty.

startTime - is the date and time to start the job. Cannot be null.

maxExecutionTimeInSeconds - is the maximum time that the device can expend to execute the job. Cannot be negative

Throws:

IllegalArgumentException - if one of the parameter is not valid.

JobsParser

@Deprecated
public JobsParser(String jobId,
                               TwinParser updateTwin,
                               String queryCondition,
                               Date startTime,
                               long maxExecutionTimeInSeconds)
                        throws IllegalArgumentException

Deprecated. As of release 0.4.0, replaced by JobsParser(String, TwinState, String, Date, long)

CONSTRUCTOR

Parameters:

jobId - is a string with the job identification. Cannot be null or empty.

updateTwin - is the class that contains the json for the update twin properties. Cannot be null.

queryCondition - is a string with the deviceId or an IoT Hub Query Condition. Cannot be null or empty.

startTime - is the date and time to start the job. Cannot be null.

maxExecutionTimeInSeconds - is the maximum time that the device can expend to execute the job. Cannot be negative

Throws:

IllegalArgumentException - if one of the parameter is not valid.

JobsParser

public JobsParser(String jobId,
                  TwinState updateTwin,
                  String queryCondition,
                  Date startTime,
                  long maxExecutionTimeInSeconds)
           throws IllegalArgumentException

CONSTRUCTOR

Parameters:

jobId - is a string with the job identification. Cannot be null or empty.

updateTwin - is the class that contains the json for the update twin properties. Cannot be null.

queryCondition - is a string with the deviceId or an IoT Hub Query Condition. Cannot be null or empty.

startTime - is the date and time to start the job. Cannot be null.

maxExecutionTimeInSeconds - is the maximum time that the device can expend to execute the job. Cannot be negative

Throws:

IllegalArgumentException - if one of the parameter is not valid.

Method Detail

toJson

public String toJson()

Getter for the string with the json.

Returns:

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