com.microsoft.azure.sdk.iot.service

Class JobProperties

java.lang.Object

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

public class JobProperties
extends Object

Contains properties of a Job. See online documentation for more infomration.

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
static JobProperties	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport) Creates an instance of JobProperties with parameters ready to start an Export job
static JobProperties	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport, com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType) Creates an instance of JobProperties with parameters ready to start an Export job
static JobProperties	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport, com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType, com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity) Creates an instance of JobProperties with parameters ready to start an Export job
static JobProperties	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri) Creates an instance of JobProperties with parameters ready to start an Import job
static JobProperties	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri, com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType) Creates an instance of JobProperties with parameters ready to start an Import job
static JobProperties	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri, com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType, com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity) Creates an instance of JobProperties with parameters ready to start an Import job
Date	getEndTimeUtc()
boolean	getExcludeKeysInExport()
String	getFailureReason()
com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity	getIdentity()
String	getInputBlobContainerUri()
String	getJobId()
String	getOutputBlobContainerUri()
int	getProgress()
Date	getStartTimeUtc()
JobProperties.JobStatus	getStatus()
com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType	getStorageAuthenticationType()
JobProperties.JobType	getType()
void	setEndTimeUtc(Date endTimeUtc)
void	setExcludeKeysInExport(boolean excludeKeysInExport)
void	setFailureReason(String failureReason)
void	setIdentity(com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity)
void	setInputBlobContainerUri(String inputBlobContainerUri)
void	setJobId(String jobId) Deprecated.
void	setJobIdFinal(String jobId)
void	setOutputBlobContainerUri(String outputBlobContainerUri)
void	setProgress(int progress)
void	setStartTimeUtc(Date startTimeUtc)
void	setStatus(JobProperties.JobStatus status)
void	setStorageAuthenticationType(com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType)
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

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.

getJobId

public String getJobId()

Returns:

the system generated job id. Ignored at creation.

setJobId

@Deprecated
public void setJobId(String jobId)
                           throws IllegalArgumentException

Deprecated.

Parameters:

jobId - the job id

Throws:

IllegalArgumentException - if the provided jobId is null

setJobIdFinal

public final void setJobIdFinal(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.

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.

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.

getInputBlobContainerUri

public String getInputBlobContainerUri()

Returns:

URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType

setInputBlobContainerUri

public void setInputBlobContainerUri(String inputBlobContainerUri)

Parameters:

inputBlobContainerUri - URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType

getOutputBlobContainerUri

public String getOutputBlobContainerUri()

Returns:

URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

setOutputBlobContainerUri

public void setOutputBlobContainerUri(String outputBlobContainerUri)

Parameters:

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

getStorageAuthenticationType

public com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType getStorageAuthenticationType()

Returns:

authentication type being used for connecting to storage account

setStorageAuthenticationType

public void setStorageAuthenticationType(com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType)

Parameters:

storageAuthenticationType - Specifies authentication type being used for connecting to storage account

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.

getIdentity

public com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity getIdentity()

Returns:

The managed identity used to access the storage account for import and export jobs.

setIdentity

public void setIdentity(com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity)

Parameters:

identity - The managed identity used to access the storage account for import and export jobs.

createForImportJob

public static JobProperties createForImportJob(String inputBlobContainerUri,
                                               String outputBlobContainerUri)

Creates an instance of JobProperties with parameters ready to start an Import job

Parameters:

inputBlobContainerUri - URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

Returns:

An instance of JobProperties

createForImportJob

public static JobProperties createForImportJob(String inputBlobContainerUri,
                                               String outputBlobContainerUri,
                                               com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType)

Creates an instance of JobProperties with parameters ready to start an Import job

Parameters:

inputBlobContainerUri - URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

storageAuthenticationType - Specifies authentication type being used for connecting to storage account

Returns:

An instance of JobProperties

createForImportJob

public static JobProperties createForImportJob(String inputBlobContainerUri,
                                               String outputBlobContainerUri,
                                               com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType,
                                               com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity)

Creates an instance of JobProperties with parameters ready to start an Import job

Parameters:

inputBlobContainerUri - URI to a blob container that contains registry data to sync. Including a SAS token is dependent on the StorageAuthenticationType

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

storageAuthenticationType - Specifies authentication type being used for connecting to storage account

identity - the managed identity used to access the storage account for import jobs.

Returns:

An instance of JobProperties

createForExportJob

public static JobProperties createForExportJob(String outputBlobContainerUri,
                                               Boolean excludeKeysInExport)

Creates an instance of JobProperties with parameters ready to start an Export job

Parameters:

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

excludeKeysInExport - Indicates if authorization keys are included in export output

Returns:

An instance of JobProperties

createForExportJob

public static JobProperties createForExportJob(String outputBlobContainerUri,
                                               Boolean excludeKeysInExport,
                                               com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType)

Creates an instance of JobProperties with parameters ready to start an Export job

Parameters:

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

excludeKeysInExport - Indicates if authorization keys are included in export output

storageAuthenticationType - Specifies authentication type being used for connecting to storage account

Returns:

An instance of JobProperties

createForExportJob

public static JobProperties createForExportJob(String outputBlobContainerUri,
                                               Boolean excludeKeysInExport,
                                               com.microsoft.azure.sdk.iot.deps.serializer.StorageAuthenticationType storageAuthenticationType,
                                               com.microsoft.azure.sdk.iot.deps.serializer.ManagedIdentity identity)

Creates an instance of JobProperties with parameters ready to start an Export job

Parameters:

outputBlobContainerUri - URI to a blob container. This is used to output the status of the job and the results. Including a SAS token is dependent on the StorageAuthenticationType

excludeKeysInExport - Indicates if authorization keys are included in export output

storageAuthenticationType - Specifies authentication type being used for connecting to storage account

identity - the managed identity used to access the storage account for export jobs.

Returns:

An instance of JobProperties