Class AzureVmWorkloadProtectedItem
java.lang.Object
com.azure.resourcemanager.recoveryservicesbackup.models.ProtectedItem
com.azure.resourcemanager.recoveryservicesbackup.models.AzureVmWorkloadProtectedItem
- Direct Known Subclasses:
AzureVmWorkloadSapAseDatabaseProtectedItem
,AzureVmWorkloadSapHanaDatabaseProtectedItem
,AzureVmWorkloadSapHanaDBInstanceProtectedItem
,AzureVmWorkloadSqlDatabaseProtectedItem
Azure VM workload-specific protected item.
-
Constructor Summary
ConstructorDescriptionCreates an instance of AzureVmWorkloadProtectedItem class. -
Method Summary
Modifier and TypeMethodDescriptionGet the extendedInfo property: Additional information for this backup item.Get the friendlyName property: Friendly name of the DB represented by this backup item.Get the kpisHealths property: Health details of different KPIs.Get the lastBackupErrorDetail property: Error details in last backup.Get the lastBackupStatus property: Last backup operation status.Get the lastBackupTime property: Timestamp of the last backup operation on this backup item.Get the parentName property: Parent name of the DB such as Instance or Availability Group.Get the parentType property: Parent type of protected item, example: for a DB, standalone server or distributed.Get the protectedItemDataSourceId property: Data ID of the protected item.Get the protectedItemHealthStatus property: Health status of the backup item, evaluated based on last heartbeat received.Get the protectionState property: Backup state of this backup item.Get the protectionStatus property: Backup status of this backup item.Get the serverName property: Host/Cluster Name for instance or AG.void
validate()
Validates the instance.withBackupSetName
(String backupSetName) Set the backupSetName property: Name of the backup set the backup item belongs to.withContainerName
(String containerName) Set the containerName property: Unique name of container.withCreateMode
(CreateMode createMode) Set the createMode property: Create mode to indicate recovery of existing soft deleted data source or creation of new data source.withDeferredDeleteTimeInUtc
(OffsetDateTime deferredDeleteTimeInUtc) Set the deferredDeleteTimeInUtc property: Time for deferred deletion in UTC.withDeferredDeleteTimeRemaining
(String deferredDeleteTimeRemaining) Set the deferredDeleteTimeRemaining property: Time remaining before the DS marked for deferred delete is permanently deleted.withExtendedInfo
(AzureVmWorkloadProtectedItemExtendedInfo extendedInfo) Set the extendedInfo property: Additional information for this backup item.withIsArchiveEnabled
(Boolean isArchiveEnabled) Set the isArchiveEnabled property: Flag to identify whether datasource is protected in archive.withIsDeferredDeleteScheduleUpcoming
(Boolean isDeferredDeleteScheduleUpcoming) Set the isDeferredDeleteScheduleUpcoming property: Flag to identify whether the deferred deleted DS is to be purged soon.withIsRehydrate
(Boolean isRehydrate) Set the isRehydrate property: Flag to identify that deferred deleted DS is to be moved into Pause state.withIsScheduledForDeferredDelete
(Boolean isScheduledForDeferredDelete) Set the isScheduledForDeferredDelete property: Flag to identify whether the DS is scheduled for deferred delete.withKpisHealths
(Map<String, KpiResourceHealthDetails> kpisHealths) Set the kpisHealths property: Health details of different KPIs.withLastBackupErrorDetail
(ErrorDetail lastBackupErrorDetail) Set the lastBackupErrorDetail property: Error details in last backup.withLastBackupStatus
(LastBackupStatus lastBackupStatus) Set the lastBackupStatus property: Last backup operation status.withLastBackupTime
(OffsetDateTime lastBackupTime) Set the lastBackupTime property: Timestamp of the last backup operation on this backup item.withLastRecoveryPoint
(OffsetDateTime lastRecoveryPoint) Set the lastRecoveryPoint property: Timestamp when the last (latest) backup copy was created for this backup item.withParentName
(String parentName) Set the parentName property: Parent name of the DB such as Instance or Availability Group.withParentType
(String parentType) Set the parentType property: Parent type of protected item, example: for a DB, standalone server or distributed.withPolicyId
(String policyId) Set the policyId property: ID of the backup policy with which this item is backed up.withPolicyName
(String policyName) Set the policyName property: Name of the policy used for protection.withProtectedItemDataSourceId
(String protectedItemDataSourceId) Set the protectedItemDataSourceId property: Data ID of the protected item.withProtectedItemHealthStatus
(ProtectedItemHealthStatus protectedItemHealthStatus) Set the protectedItemHealthStatus property: Health status of the backup item, evaluated based on last heartbeat received.withProtectionState
(ProtectionState protectionState) Set the protectionState property: Backup state of this backup item.withResourceGuardOperationRequests
(List<String> resourceGuardOperationRequests) Set the resourceGuardOperationRequests property: ResourceGuardOperationRequests on which LAC check will be performed.withServerName
(String serverName) Set the serverName property: Host/Cluster Name for instance or AG.withSoftDeleteRetentionPeriod
(Integer softDeleteRetentionPeriod) Set the softDeleteRetentionPeriod property: Soft delete retention period in days.withSourceResourceId
(String sourceResourceId) Set the sourceResourceId property: ARM ID of the resource to be backed up.Methods inherited from class com.azure.resourcemanager.recoveryservicesbackup.models.ProtectedItem
backupManagementType, backupSetName, containerName, createMode, deferredDeleteTimeInUtc, deferredDeleteTimeRemaining, isArchiveEnabled, isDeferredDeleteScheduleUpcoming, isRehydrate, isScheduledForDeferredDelete, lastRecoveryPoint, policyId, policyName, resourceGuardOperationRequests, softDeleteRetentionPeriod, sourceResourceId, workloadType
-
Constructor Details
-
AzureVmWorkloadProtectedItem
public AzureVmWorkloadProtectedItem()Creates an instance of AzureVmWorkloadProtectedItem class.
-
-
Method Details
-
friendlyName
Get the friendlyName property: Friendly name of the DB represented by this backup item.- Returns:
- the friendlyName value.
-
serverName
Get the serverName property: Host/Cluster Name for instance or AG.- Returns:
- the serverName value.
-
withServerName
Set the serverName property: Host/Cluster Name for instance or AG.- Parameters:
serverName
- the serverName value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
parentName
Get the parentName property: Parent name of the DB such as Instance or Availability Group.- Returns:
- the parentName value.
-
withParentName
Set the parentName property: Parent name of the DB such as Instance or Availability Group.- Parameters:
parentName
- the parentName value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
parentType
Get the parentType property: Parent type of protected item, example: for a DB, standalone server or distributed.- Returns:
- the parentType value.
-
withParentType
Set the parentType property: Parent type of protected item, example: for a DB, standalone server or distributed.- Parameters:
parentType
- the parentType value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
protectionStatus
Get the protectionStatus property: Backup status of this backup item.- Returns:
- the protectionStatus value.
-
protectionState
Get the protectionState property: Backup state of this backup item.- Returns:
- the protectionState value.
-
withProtectionState
Set the protectionState property: Backup state of this backup item.- Parameters:
protectionState
- the protectionState value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
lastBackupStatus
Get the lastBackupStatus property: Last backup operation status. Possible values: Healthy, Unhealthy.- Returns:
- the lastBackupStatus value.
-
withLastBackupStatus
Set the lastBackupStatus property: Last backup operation status. Possible values: Healthy, Unhealthy.- Parameters:
lastBackupStatus
- the lastBackupStatus value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
lastBackupTime
Get the lastBackupTime property: Timestamp of the last backup operation on this backup item.- Returns:
- the lastBackupTime value.
-
withLastBackupTime
Set the lastBackupTime property: Timestamp of the last backup operation on this backup item.- Parameters:
lastBackupTime
- the lastBackupTime value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
lastBackupErrorDetail
Get the lastBackupErrorDetail property: Error details in last backup.- Returns:
- the lastBackupErrorDetail value.
-
withLastBackupErrorDetail
Set the lastBackupErrorDetail property: Error details in last backup.- Parameters:
lastBackupErrorDetail
- the lastBackupErrorDetail value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
protectedItemDataSourceId
Get the protectedItemDataSourceId property: Data ID of the protected item.- Returns:
- the protectedItemDataSourceId value.
-
withProtectedItemDataSourceId
Set the protectedItemDataSourceId property: Data ID of the protected item.- Parameters:
protectedItemDataSourceId
- the protectedItemDataSourceId value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
protectedItemHealthStatus
Get the protectedItemHealthStatus property: Health status of the backup item, evaluated based on last heartbeat received.- Returns:
- the protectedItemHealthStatus value.
-
withProtectedItemHealthStatus
public AzureVmWorkloadProtectedItem withProtectedItemHealthStatus(ProtectedItemHealthStatus protectedItemHealthStatus) Set the protectedItemHealthStatus property: Health status of the backup item, evaluated based on last heartbeat received.- Parameters:
protectedItemHealthStatus
- the protectedItemHealthStatus value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
extendedInfo
Get the extendedInfo property: Additional information for this backup item.- Returns:
- the extendedInfo value.
-
withExtendedInfo
public AzureVmWorkloadProtectedItem withExtendedInfo(AzureVmWorkloadProtectedItemExtendedInfo extendedInfo) Set the extendedInfo property: Additional information for this backup item.- Parameters:
extendedInfo
- the extendedInfo value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
kpisHealths
Get the kpisHealths property: Health details of different KPIs.- Returns:
- the kpisHealths value.
-
withKpisHealths
public AzureVmWorkloadProtectedItem withKpisHealths(Map<String, KpiResourceHealthDetails> kpisHealths) Set the kpisHealths property: Health details of different KPIs.- Parameters:
kpisHealths
- the kpisHealths value to set.- Returns:
- the AzureVmWorkloadProtectedItem object itself.
-
withContainerName
Set the containerName property: Unique name of container.- Overrides:
withContainerName
in classProtectedItem
- Parameters:
containerName
- the containerName value to set.- Returns:
- the ProtectedItem object itself.
-
withSourceResourceId
Set the sourceResourceId property: ARM ID of the resource to be backed up.- Overrides:
withSourceResourceId
in classProtectedItem
- Parameters:
sourceResourceId
- the sourceResourceId value to set.- Returns:
- the ProtectedItem object itself.
-
withPolicyId
Set the policyId property: ID of the backup policy with which this item is backed up.- Overrides:
withPolicyId
in classProtectedItem
- Parameters:
policyId
- the policyId value to set.- Returns:
- the ProtectedItem object itself.
-
withLastRecoveryPoint
Set the lastRecoveryPoint property: Timestamp when the last (latest) backup copy was created for this backup item.- Overrides:
withLastRecoveryPoint
in classProtectedItem
- Parameters:
lastRecoveryPoint
- the lastRecoveryPoint value to set.- Returns:
- the ProtectedItem object itself.
-
withBackupSetName
Set the backupSetName property: Name of the backup set the backup item belongs to.- Overrides:
withBackupSetName
in classProtectedItem
- Parameters:
backupSetName
- the backupSetName value to set.- Returns:
- the ProtectedItem object itself.
-
withCreateMode
Set the createMode property: Create mode to indicate recovery of existing soft deleted data source or creation of new data source.- Overrides:
withCreateMode
in classProtectedItem
- Parameters:
createMode
- the createMode value to set.- Returns:
- the ProtectedItem object itself.
-
withDeferredDeleteTimeInUtc
public AzureVmWorkloadProtectedItem withDeferredDeleteTimeInUtc(OffsetDateTime deferredDeleteTimeInUtc) Set the deferredDeleteTimeInUtc property: Time for deferred deletion in UTC.- Overrides:
withDeferredDeleteTimeInUtc
in classProtectedItem
- Parameters:
deferredDeleteTimeInUtc
- the deferredDeleteTimeInUtc value to set.- Returns:
- the ProtectedItem object itself.
-
withIsScheduledForDeferredDelete
public AzureVmWorkloadProtectedItem withIsScheduledForDeferredDelete(Boolean isScheduledForDeferredDelete) Set the isScheduledForDeferredDelete property: Flag to identify whether the DS is scheduled for deferred delete.- Overrides:
withIsScheduledForDeferredDelete
in classProtectedItem
- Parameters:
isScheduledForDeferredDelete
- the isScheduledForDeferredDelete value to set.- Returns:
- the ProtectedItem object itself.
-
withDeferredDeleteTimeRemaining
public AzureVmWorkloadProtectedItem withDeferredDeleteTimeRemaining(String deferredDeleteTimeRemaining) Set the deferredDeleteTimeRemaining property: Time remaining before the DS marked for deferred delete is permanently deleted.- Overrides:
withDeferredDeleteTimeRemaining
in classProtectedItem
- Parameters:
deferredDeleteTimeRemaining
- the deferredDeleteTimeRemaining value to set.- Returns:
- the ProtectedItem object itself.
-
withIsDeferredDeleteScheduleUpcoming
public AzureVmWorkloadProtectedItem withIsDeferredDeleteScheduleUpcoming(Boolean isDeferredDeleteScheduleUpcoming) Set the isDeferredDeleteScheduleUpcoming property: Flag to identify whether the deferred deleted DS is to be purged soon.- Overrides:
withIsDeferredDeleteScheduleUpcoming
in classProtectedItem
- Parameters:
isDeferredDeleteScheduleUpcoming
- the isDeferredDeleteScheduleUpcoming value to set.- Returns:
- the ProtectedItem object itself.
-
withIsRehydrate
Set the isRehydrate property: Flag to identify that deferred deleted DS is to be moved into Pause state.- Overrides:
withIsRehydrate
in classProtectedItem
- Parameters:
isRehydrate
- the isRehydrate value to set.- Returns:
- the ProtectedItem object itself.
-
withResourceGuardOperationRequests
public AzureVmWorkloadProtectedItem withResourceGuardOperationRequests(List<String> resourceGuardOperationRequests) Set the resourceGuardOperationRequests property: ResourceGuardOperationRequests on which LAC check will be performed.- Overrides:
withResourceGuardOperationRequests
in classProtectedItem
- Parameters:
resourceGuardOperationRequests
- the resourceGuardOperationRequests value to set.- Returns:
- the ProtectedItem object itself.
-
withIsArchiveEnabled
Set the isArchiveEnabled property: Flag to identify whether datasource is protected in archive.- Overrides:
withIsArchiveEnabled
in classProtectedItem
- Parameters:
isArchiveEnabled
- the isArchiveEnabled value to set.- Returns:
- the ProtectedItem object itself.
-
withPolicyName
Set the policyName property: Name of the policy used for protection.- Overrides:
withPolicyName
in classProtectedItem
- Parameters:
policyName
- the policyName value to set.- Returns:
- the ProtectedItem object itself.
-
withSoftDeleteRetentionPeriod
public AzureVmWorkloadProtectedItem withSoftDeleteRetentionPeriod(Integer softDeleteRetentionPeriod) Set the softDeleteRetentionPeriod property: Soft delete retention period in days.- Overrides:
withSoftDeleteRetentionPeriod
in classProtectedItem
- Parameters:
softDeleteRetentionPeriod
- the softDeleteRetentionPeriod value to set.- Returns:
- the ProtectedItem object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classProtectedItem
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-