com.microsoft.azure.sdk.iot.service.registry

Class RegistryJob

java.lang.Object

com.microsoft.azure.sdk.iot.service.registry.RegistryJob

public class RegistryJob
extends Object

Contains properties of a ScheduledJob. See online documentation for more information.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RegistryJob()

Method Summary

Modifier and Type	Method and Description
static RegistryJob	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport) Creates an instance of RegistryJob with parameters ready to start an Export job
static RegistryJob	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport, StorageAuthenticationType storageAuthenticationType) Creates an instance of RegistryJob with parameters ready to start an Export job
static RegistryJob	createForExportJob(String outputBlobContainerUri, Boolean excludeKeysInExport, StorageAuthenticationType storageAuthenticationType, ManagedIdentity identity) Creates an instance of RegistryJob with parameters ready to start an Export job
static RegistryJob	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri) Creates an instance of RegistryJob with parameters ready to start an Import job
static RegistryJob	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri, StorageAuthenticationType storageAuthenticationType) Creates an instance of RegistryJob with parameters ready to start an Import job
static RegistryJob	createForImportJob(String inputBlobContainerUri, String outputBlobContainerUri, StorageAuthenticationType storageAuthenticationType, ManagedIdentity identity) Creates an instance of RegistryJob with parameters ready to start an Import job
boolean	getExcludeKeysInExport()
void	setExcludeKeysInExport(boolean excludeKeysInExport)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryJob

public RegistryJob()

Method Detail

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.

createForImportJob

public static RegistryJob createForImportJob(String inputBlobContainerUri,
                                             String outputBlobContainerUri)

Creates an instance of RegistryJob 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 RegistryJob

createForImportJob

public static RegistryJob createForImportJob(String inputBlobContainerUri,
                                             String outputBlobContainerUri,
                                             StorageAuthenticationType storageAuthenticationType)

Creates an instance of RegistryJob 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 RegistryJob

createForImportJob

public static RegistryJob createForImportJob(String inputBlobContainerUri,
                                             String outputBlobContainerUri,
                                             StorageAuthenticationType storageAuthenticationType,
                                             ManagedIdentity identity)

Creates an instance of RegistryJob 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 RegistryJob

createForExportJob

public static RegistryJob createForExportJob(String outputBlobContainerUri,
                                             Boolean excludeKeysInExport)

Creates an instance of RegistryJob 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 RegistryJob

createForExportJob

public static RegistryJob createForExportJob(String outputBlobContainerUri,
                                             Boolean excludeKeysInExport,
                                             StorageAuthenticationType storageAuthenticationType)

Creates an instance of RegistryJob 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 RegistryJob

createForExportJob

public static RegistryJob createForExportJob(String outputBlobContainerUri,
                                             Boolean excludeKeysInExport,
                                             StorageAuthenticationType storageAuthenticationType,
                                             ManagedIdentity identity)

Creates an instance of RegistryJob 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 RegistryJob