Class AzureBackupJob


  • public final class AzureBackupJob
    extends Object
    AzureBackup Job Class.
    • Constructor Detail

      • AzureBackupJob

        public AzureBackupJob()
    • Method Detail

      • activityId

        public String activityId()
        Get the activityId property: Job Activity Id.
        Returns:
        the activityId value.
      • withActivityId

        public AzureBackupJob withActivityId​(String activityId)
        Set the activityId property: Job Activity Id.
        Parameters:
        activityId - the activityId value to set.
        Returns:
        the AzureBackupJob object itself.
      • backupInstanceFriendlyName

        public String backupInstanceFriendlyName()
        Get the backupInstanceFriendlyName property: Name of the Backup Instance.
        Returns:
        the backupInstanceFriendlyName value.
      • withBackupInstanceFriendlyName

        public AzureBackupJob withBackupInstanceFriendlyName​(String backupInstanceFriendlyName)
        Set the backupInstanceFriendlyName property: Name of the Backup Instance.
        Parameters:
        backupInstanceFriendlyName - the backupInstanceFriendlyName value to set.
        Returns:
        the AzureBackupJob object itself.
      • backupInstanceId

        public String backupInstanceId()
        Get the backupInstanceId property: ARM ID of the Backup Instance.
        Returns:
        the backupInstanceId value.
      • dataSourceId

        public String dataSourceId()
        Get the dataSourceId property: ARM ID of the DataSource.
        Returns:
        the dataSourceId value.
      • withDataSourceId

        public AzureBackupJob withDataSourceId​(String dataSourceId)
        Set the dataSourceId property: ARM ID of the DataSource.
        Parameters:
        dataSourceId - the dataSourceId value to set.
        Returns:
        the AzureBackupJob object itself.
      • dataSourceLocation

        public String dataSourceLocation()
        Get the dataSourceLocation property: Location of the DataSource.
        Returns:
        the dataSourceLocation value.
      • withDataSourceLocation

        public AzureBackupJob withDataSourceLocation​(String dataSourceLocation)
        Set the dataSourceLocation property: Location of the DataSource.
        Parameters:
        dataSourceLocation - the dataSourceLocation value to set.
        Returns:
        the AzureBackupJob object itself.
      • dataSourceName

        public String dataSourceName()
        Get the dataSourceName property: User Friendly Name of the DataSource.
        Returns:
        the dataSourceName value.
      • withDataSourceName

        public AzureBackupJob withDataSourceName​(String dataSourceName)
        Set the dataSourceName property: User Friendly Name of the DataSource.
        Parameters:
        dataSourceName - the dataSourceName value to set.
        Returns:
        the AzureBackupJob object itself.
      • dataSourceSetName

        public String dataSourceSetName()
        Get the dataSourceSetName property: Data Source Set Name of the DataSource.
        Returns:
        the dataSourceSetName value.
      • withDataSourceSetName

        public AzureBackupJob withDataSourceSetName​(String dataSourceSetName)
        Set the dataSourceSetName property: Data Source Set Name of the DataSource.
        Parameters:
        dataSourceSetName - the dataSourceSetName value to set.
        Returns:
        the AzureBackupJob object itself.
      • dataSourceType

        public String dataSourceType()
        Get the dataSourceType property: Type of DataSource.
        Returns:
        the dataSourceType value.
      • withDataSourceType

        public AzureBackupJob withDataSourceType​(String dataSourceType)
        Set the dataSourceType property: Type of DataSource.
        Parameters:
        dataSourceType - the dataSourceType value to set.
        Returns:
        the AzureBackupJob object itself.
      • duration

        public String duration()
        Get the duration property: Total run time of the job. ISO 8601 format.
        Returns:
        the duration value.
      • withDuration

        public AzureBackupJob withDuration​(String duration)
        Set the duration property: Total run time of the job. ISO 8601 format.
        Parameters:
        duration - the duration value to set.
        Returns:
        the AzureBackupJob object itself.
      • endTime

        public OffsetDateTime endTime()
        Get the endTime property: EndTime of the job(in UTC).
        Returns:
        the endTime value.
      • errorDetails

        public List<UserFacingError> errorDetails()
        Get the errorDetails property: A List, detailing the errors related to the job.
        Returns:
        the errorDetails value.
      • extendedInfo

        public JobExtendedInfo extendedInfo()
        Get the extendedInfo property: Extended Information about the job.
        Returns:
        the extendedInfo value.
      • isUserTriggered

        public boolean isUserTriggered()
        Get the isUserTriggered property: Indicated that whether the job is adhoc(true) or scheduled(false).
        Returns:
        the isUserTriggered value.
      • withIsUserTriggered

        public AzureBackupJob withIsUserTriggered​(boolean isUserTriggered)
        Set the isUserTriggered property: Indicated that whether the job is adhoc(true) or scheduled(false).
        Parameters:
        isUserTriggered - the isUserTriggered value to set.
        Returns:
        the AzureBackupJob object itself.
      • operation

        public String operation()
        Get the operation property: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure.
        Returns:
        the operation value.
      • withOperation

        public AzureBackupJob withOperation​(String operation)
        Set the operation property: It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure.
        Parameters:
        operation - the operation value to set.
        Returns:
        the AzureBackupJob object itself.
      • operationCategory

        public String operationCategory()
        Get the operationCategory property: It indicates the type of Job i.e. Backup/Restore/Tiering/Management.
        Returns:
        the operationCategory value.
      • withOperationCategory

        public AzureBackupJob withOperationCategory​(String operationCategory)
        Set the operationCategory property: It indicates the type of Job i.e. Backup/Restore/Tiering/Management.
        Parameters:
        operationCategory - the operationCategory value to set.
        Returns:
        the AzureBackupJob object itself.
      • policyId

        public String policyId()
        Get the policyId property: ARM ID of the policy.
        Returns:
        the policyId value.
      • policyName

        public String policyName()
        Get the policyName property: Name of the policy.
        Returns:
        the policyName value.
      • progressEnabled

        public boolean progressEnabled()
        Get the progressEnabled property: Indicated whether progress is enabled for the job.
        Returns:
        the progressEnabled value.
      • withProgressEnabled

        public AzureBackupJob withProgressEnabled​(boolean progressEnabled)
        Set the progressEnabled property: Indicated whether progress is enabled for the job.
        Parameters:
        progressEnabled - the progressEnabled value to set.
        Returns:
        the AzureBackupJob object itself.
      • progressUrl

        public String progressUrl()
        Get the progressUrl property: Url which contains job's progress.
        Returns:
        the progressUrl value.
      • restoreType

        public String restoreType()
        Get the restoreType property: It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR.
        Returns:
        the restoreType value.
      • sourceResourceGroup

        public String sourceResourceGroup()
        Get the sourceResourceGroup property: Resource Group Name of the Datasource.
        Returns:
        the sourceResourceGroup value.
      • withSourceResourceGroup

        public AzureBackupJob withSourceResourceGroup​(String sourceResourceGroup)
        Set the sourceResourceGroup property: Resource Group Name of the Datasource.
        Parameters:
        sourceResourceGroup - the sourceResourceGroup value to set.
        Returns:
        the AzureBackupJob object itself.
      • sourceSubscriptionId

        public String sourceSubscriptionId()
        Get the sourceSubscriptionId property: SubscriptionId corresponding to the DataSource.
        Returns:
        the sourceSubscriptionId value.
      • withSourceSubscriptionId

        public AzureBackupJob withSourceSubscriptionId​(String sourceSubscriptionId)
        Set the sourceSubscriptionId property: SubscriptionId corresponding to the DataSource.
        Parameters:
        sourceSubscriptionId - the sourceSubscriptionId value to set.
        Returns:
        the AzureBackupJob object itself.
      • startTime

        public OffsetDateTime startTime()
        Get the startTime property: StartTime of the job(in UTC).
        Returns:
        the startTime value.
      • withStartTime

        public AzureBackupJob withStartTime​(OffsetDateTime startTime)
        Set the startTime property: StartTime of the job(in UTC).
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the AzureBackupJob object itself.
      • status

        public String status()
        Get the status property: Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning.
        Returns:
        the status value.
      • withStatus

        public AzureBackupJob withStatus​(String status)
        Set the status property: Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning.
        Parameters:
        status - the status value to set.
        Returns:
        the AzureBackupJob object itself.
      • subscriptionId

        public String subscriptionId()
        Get the subscriptionId property: Subscription Id of the corresponding backup vault.
        Returns:
        the subscriptionId value.
      • withSubscriptionId

        public AzureBackupJob withSubscriptionId​(String subscriptionId)
        Set the subscriptionId property: Subscription Id of the corresponding backup vault.
        Parameters:
        subscriptionId - the subscriptionId value to set.
        Returns:
        the AzureBackupJob object itself.
      • supportedActions

        public List<String> supportedActions()
        Get the supportedActions property: List of supported actions.
        Returns:
        the supportedActions value.
      • withSupportedActions

        public AzureBackupJob withSupportedActions​(List<String> supportedActions)
        Set the supportedActions property: List of supported actions.
        Parameters:
        supportedActions - the supportedActions value to set.
        Returns:
        the AzureBackupJob object itself.
      • vaultName

        public String vaultName()
        Get the vaultName property: Name of the vault.
        Returns:
        the vaultName value.
      • withVaultName

        public AzureBackupJob withVaultName​(String vaultName)
        Set the vaultName property: Name of the vault.
        Parameters:
        vaultName - the vaultName value to set.
        Returns:
        the AzureBackupJob object itself.
      • etag

        public String etag()
        Get the etag property: The etag property.
        Returns:
        the etag value.
      • withEtag

        public AzureBackupJob withEtag​(String etag)
        Set the etag property: The etag property.
        Parameters:
        etag - the etag value to set.
        Returns:
        the AzureBackupJob object itself.
      • sourceDataStoreName

        public String sourceDataStoreName()
        Get the sourceDataStoreName property: The sourceDataStoreName property.
        Returns:
        the sourceDataStoreName value.
      • withSourceDataStoreName

        public AzureBackupJob withSourceDataStoreName​(String sourceDataStoreName)
        Set the sourceDataStoreName property: The sourceDataStoreName property.
        Parameters:
        sourceDataStoreName - the sourceDataStoreName value to set.
        Returns:
        the AzureBackupJob object itself.
      • destinationDataStoreName

        public String destinationDataStoreName()
        Get the destinationDataStoreName property: The destinationDataStoreName property.
        Returns:
        the destinationDataStoreName value.
      • withDestinationDataStoreName

        public AzureBackupJob withDestinationDataStoreName​(String destinationDataStoreName)
        Set the destinationDataStoreName property: The destinationDataStoreName property.
        Parameters:
        destinationDataStoreName - the destinationDataStoreName value to set.
        Returns:
        the AzureBackupJob object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.