com.microsoft.azure.sdk.iot.service

Class JobProperties

java.lang.Object

com.microsoft.azure.sdk.iot.service.JobProperties

public class JobProperties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobProperties.JobStatus
static class	JobProperties.JobType

Constructor Summary

Constructors

Constructor and Description
JobProperties()

Method Summary

Modifier and Type	Method and Description
Date	getEndTimeUtc()
boolean	getExcludeKeysInExport()
String	getFailureReason()
String	getInputBlobContainerUri()
String	getJobId()
String	getOutputBlobContainerUri()
int	getProgress()
Date	getStartTimeUtc()
JobProperties.JobStatus	getStatus()
JobProperties.JobType	getType()
void	setEndTimeUtc(Date endTimeUtc)
void	setExcludeKeysInExport(boolean excludeKeysInExport)
void	setFailureReason(String failureReason)
void	setInputBlobContainerUri(String inputBlobContainerUri)
void	setJobId(String jobId)
void	setOutputBlobContainerUri(String outputBlobContainerUri)
void	setProgress(int progress)
void	setStartTimeUtc(Date startTimeUtc)
void	setStatus(JobProperties.JobStatus status)
void	setType(JobProperties.JobType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobProperties

public JobProperties()

Method Detail

getJobId

public String getJobId()

Returns:

the system generated job id. Ignored at creation.

setJobId

public void setJobId(String jobId)
              throws IllegalArgumentException

Parameters:

jobId - the job id

Throws:

IllegalArgumentException - if the provided jobId is null

getStartTimeUtc

public Date getStartTimeUtc()

Returns:

the system generated UTC job start time. Ignored at creation.

setStartTimeUtc

public void setStartTimeUtc(Date startTimeUtc)

Parameters:

startTimeUtc - the UTC job start time.

getEndTimeUtc

public Date getEndTimeUtc()

Returns:

the UTC job end time. Ignored at creation. Represents the time the job stopped processing.

setEndTimeUtc

public void setEndTimeUtc(Date endTimeUtc)

Parameters:

endTimeUtc - the UTC job end time.

getType

public JobProperties.JobType getType()

Returns:

the type of job to execute.

setType

public void setType(JobProperties.JobType type)

Parameters:

type - the type of job to execute.

getStatus

public JobProperties.JobStatus getStatus()

Returns:

the system generated job status. Ignored at creation.

setStatus

public void setStatus(JobProperties.JobStatus status)

Parameters:

status - the job status.

getProgress

public int getProgress()

Returns:

the system generated job progress. Ignored at creation. Represents the completion percentage.

setProgress

public void setProgress(int progress)

Parameters:

progress - the job progress.

getInputBlobContainerUri

public String getInputBlobContainerUri()

Returns:

URI containing SAS token to a blob container that contains registry data to sync.

setInputBlobContainerUri

public void setInputBlobContainerUri(String inputBlobContainerUri)

Parameters:

inputBlobContainerUri - the input blob container URI.

getOutputBlobContainerUri

public String getOutputBlobContainerUri()

Returns:

URI containing SAS token to a blob container. This is used to output the status of the job and the results.

setOutputBlobContainerUri

public void setOutputBlobContainerUri(String outputBlobContainerUri)

Parameters:

outputBlobContainerUri - the output blob container URI.

getExcludeKeysInExport

public boolean getExcludeKeysInExport()

Returns:

whether the keys are included in export or not.

setExcludeKeysInExport

public void setExcludeKeysInExport(boolean excludeKeysInExport)

Parameters:

excludeKeysInExport - optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included in export output. Keys are exported as null otherwise.

getFailureReason

public String getFailureReason()

Returns:

System generated. Ignored at creation. If status == failure, this represents a string containing the reason.

setFailureReason

public void setFailureReason(String failureReason)

Parameters:

failureReason - the failure reason.