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

Class JobPropertiesParser

java.lang.Object

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

public class JobPropertiesParser
extends Object

Constructor Summary

Constructors

Constructor and Description
JobPropertiesParser() Empty constructor: Used only to keep GSON happy.
JobPropertiesParser(String json) Constructor for a JobPropertiesParser object that is built from the provided Json

Method Summary

Modifier and Type	Method and Description
Date	getEndTimeUtc() Getter for endTimeUtc
String	getFailureReason() Getter for failureReason
String	getInputBlobContainerUri() Getter for inputBlobContainerUri
String	getJobId() Deprecated. as of Deps version 0.7.1, please use getJobIdFinal()
String	getJobIdFinal() Getter for jobId
String	getOutputBlobContainerUri() Getter for outputBlobContainerUri
int	getProgress() Getter for progress
Date	getStartTimeUtc() Getter for startTimeUtc
String	getStatus() Getter for status
String	getType() Getter for type
boolean	isExcludeKeysInExport() Getter for excludeKeysInExport
void	setEndTimeUtc(Date endTimeUtc) Setter for EndTimeUtc
void	setExcludeKeysInExport(boolean excludeKeysInExport) Setter for ExcludeKeysInExport
void	setFailureReason(String failureReason) Setter for FailureReason
void	setInputBlobContainerUri(String inputBlobContainerUri) Setter for InputBlobContainerUri
void	setJobId(String jobId) Setter for jobId
void	setOutputBlobContainerUri(String outputBlobContainerUri) Setter for OutputBlobContainerUri
void	setProgress(int progress) Setter for Progress
void	setStartTimeUtc(Date startTimeUtc) Setter for StartTimeUtc
void	setStatus(String status) Setter for Status
void	setType(String type) Setter for Type
String	toJson() Converts this into json and returns it

Methods inherited from class java.lang.Object

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

Constructor Detail

JobPropertiesParser

public JobPropertiesParser()

Empty constructor: Used only to keep GSON happy.

JobPropertiesParser

public JobPropertiesParser(String json)
                    throws IllegalArgumentException

Constructor for a JobPropertiesParser object that is built from the provided Json

Parameters:

json - the json to build the JobPropertiesParser from

Throws:

IllegalArgumentException - if the provided Json is null, empty, cannot be parsed, or if the provided Json is missing any of the type, inputBlobContainerUri or outputBlobContainerUri fields

Method Detail

toJson

public String toJson()

Converts this into json and returns it

Returns:

the json representation of this

getType

public String getType()

Getter for type

Returns:

The value of type

getInputBlobContainerUri

public String getInputBlobContainerUri()

Getter for inputBlobContainerUri

Returns:

The value of inputBlobContainerUri

getOutputBlobContainerUri

public String getOutputBlobContainerUri()

Getter for outputBlobContainerUri

Returns:

The value of outputBlobContainerUri

getJobId

@Deprecated
public String getJobId()

Deprecated. as of Deps version 0.7.1, please use getJobIdFinal()

Getter for jobId

Returns:

The value of jobId

getJobIdFinal

public final String getJobIdFinal()

Getter for jobId

Returns:

The value of jobId

setJobId

public void setJobId(String jobId)
              throws IllegalArgumentException

Setter for jobId

Parameters:

jobId - the value to set jobId to

Throws:

IllegalArgumentException - if the provided jobId is null

getStartTimeUtc

public Date getStartTimeUtc()

Getter for startTimeUtc

Returns:

The value of startTimeUtc

getEndTimeUtc

public Date getEndTimeUtc()

Getter for endTimeUtc

Returns:

The value of endTimeUtc

getStatus

public String getStatus()

Getter for status

Returns:

The value of status

getProgress

public int getProgress()

Getter for progress

Returns:

The value of progress

isExcludeKeysInExport

public boolean isExcludeKeysInExport()

Getter for excludeKeysInExport

Returns:

The value of excludeKeysInExport

getFailureReason

public String getFailureReason()

Getter for failureReason

Returns:

The value of failureReason

setStartTimeUtc

public void setStartTimeUtc(Date startTimeUtc)

Setter for StartTimeUtc

Parameters:

startTimeUtc - the value to set StartTimeUtc to

setEndTimeUtc

public void setEndTimeUtc(Date endTimeUtc)

Setter for EndTimeUtc

Parameters:

endTimeUtc - the value to set EndTimeUtc to

setType

public void setType(String type)

Setter for Type

Parameters:

type - the value to set Type to

setStatus

public void setStatus(String status)

Setter for Status

Parameters:

status - the value to set Status to

setProgress

public void setProgress(int progress)

Setter for Progress

Parameters:

progress - the value to set Progress to

setInputBlobContainerUri

public void setInputBlobContainerUri(String inputBlobContainerUri)

Setter for InputBlobContainerUri

Parameters:

inputBlobContainerUri - the value to set InputBlobContainerUri to

setOutputBlobContainerUri

public void setOutputBlobContainerUri(String outputBlobContainerUri)

Setter for OutputBlobContainerUri

Parameters:

outputBlobContainerUri - the value to set OutputBlobContainerUri to

setExcludeKeysInExport

public void setExcludeKeysInExport(boolean excludeKeysInExport)

Setter for ExcludeKeysInExport

Parameters:

excludeKeysInExport - the value to set ExcludeKeysInExport to

setFailureReason

public void setFailureReason(String failureReason)

Setter for FailureReason

Parameters:

failureReason - the value to set FailureReason to