Class GenericProtectedItem


  • public final class GenericProtectedItem
    extends ProtectedItem
    Base class for backup items.
    • Constructor Detail

      • GenericProtectedItem

        public GenericProtectedItem()
    • Method Detail

      • friendlyName

        public String friendlyName()
        Get the friendlyName property: Friendly name of the container.
        Returns:
        the friendlyName value.
      • withFriendlyName

        public GenericProtectedItem withFriendlyName​(String friendlyName)
        Set the friendlyName property: Friendly name of the container.
        Parameters:
        friendlyName - the friendlyName value to set.
        Returns:
        the GenericProtectedItem object itself.
      • policyState

        public String policyState()
        Get the policyState property: Indicates consistency of policy object and policy applied to this backup item.
        Returns:
        the policyState value.
      • withPolicyState

        public GenericProtectedItem withPolicyState​(String policyState)
        Set the policyState property: Indicates consistency of policy object and policy applied to this backup item.
        Parameters:
        policyState - the policyState value to set.
        Returns:
        the GenericProtectedItem object itself.
      • protectionState

        public ProtectionState protectionState()
        Get the protectionState property: Backup state of this backup item.
        Returns:
        the protectionState value.
      • withProtectionState

        public GenericProtectedItem withProtectionState​(ProtectionState protectionState)
        Set the protectionState property: Backup state of this backup item.
        Parameters:
        protectionState - the protectionState value to set.
        Returns:
        the GenericProtectedItem object itself.
      • protectedItemId

        public Long protectedItemId()
        Get the protectedItemId property: Data Plane Service ID of the protected item.
        Returns:
        the protectedItemId value.
      • withProtectedItemId

        public GenericProtectedItem withProtectedItemId​(Long protectedItemId)
        Set the protectedItemId property: Data Plane Service ID of the protected item.
        Parameters:
        protectedItemId - the protectedItemId value to set.
        Returns:
        the GenericProtectedItem object itself.
      • sourceAssociations

        public Map<String,​String> sourceAssociations()
        Get the sourceAssociations property: Loosely coupled (type, value) associations (example - parent of a protected item).
        Returns:
        the sourceAssociations value.
      • withSourceAssociations

        public GenericProtectedItem withSourceAssociations​(Map<String,​String> sourceAssociations)
        Set the sourceAssociations property: Loosely coupled (type, value) associations (example - parent of a protected item).
        Parameters:
        sourceAssociations - the sourceAssociations value to set.
        Returns:
        the GenericProtectedItem object itself.
      • fabricName

        public String fabricName()
        Get the fabricName property: Name of this backup item's fabric.
        Returns:
        the fabricName value.
      • withFabricName

        public GenericProtectedItem withFabricName​(String fabricName)
        Set the fabricName property: Name of this backup item's fabric.
        Parameters:
        fabricName - the fabricName value to set.
        Returns:
        the GenericProtectedItem object itself.
      • withBackupManagementType

        public GenericProtectedItem withBackupManagementType​(BackupManagementType backupManagementType)
        Set the backupManagementType property: Type of backup management for the backed up item.
        Overrides:
        withBackupManagementType in class ProtectedItem
        Parameters:
        backupManagementType - the backupManagementType value to set.
        Returns:
        the ProtectedItem object itself.
      • withWorkloadType

        public GenericProtectedItem withWorkloadType​(DataSourceType workloadType)
        Set the workloadType property: Type of workload this item represents.
        Overrides:
        withWorkloadType in class ProtectedItem
        Parameters:
        workloadType - the workloadType value to set.
        Returns:
        the ProtectedItem object itself.
      • withContainerName

        public GenericProtectedItem withContainerName​(String containerName)
        Set the containerName property: Unique name of container.
        Overrides:
        withContainerName in class ProtectedItem
        Parameters:
        containerName - the containerName value to set.
        Returns:
        the ProtectedItem object itself.
      • withSourceResourceId

        public GenericProtectedItem withSourceResourceId​(String sourceResourceId)
        Set the sourceResourceId property: ARM ID of the resource to be backed up.
        Overrides:
        withSourceResourceId in class ProtectedItem
        Parameters:
        sourceResourceId - the sourceResourceId value to set.
        Returns:
        the ProtectedItem object itself.
      • withPolicyId

        public GenericProtectedItem withPolicyId​(String policyId)
        Set the policyId property: ID of the backup policy with which this item is backed up.
        Overrides:
        withPolicyId in class ProtectedItem
        Parameters:
        policyId - the policyId value to set.
        Returns:
        the ProtectedItem object itself.
      • withLastRecoveryPoint

        public GenericProtectedItem withLastRecoveryPoint​(OffsetDateTime lastRecoveryPoint)
        Set the lastRecoveryPoint property: Timestamp when the last (latest) backup copy was created for this backup item.
        Overrides:
        withLastRecoveryPoint in class ProtectedItem
        Parameters:
        lastRecoveryPoint - the lastRecoveryPoint value to set.
        Returns:
        the ProtectedItem object itself.
      • withBackupSetName

        public GenericProtectedItem withBackupSetName​(String backupSetName)
        Set the backupSetName property: Name of the backup set the backup item belongs to.
        Overrides:
        withBackupSetName in class ProtectedItem
        Parameters:
        backupSetName - the backupSetName value to set.
        Returns:
        the ProtectedItem object itself.
      • withCreateMode

        public GenericProtectedItem withCreateMode​(CreateMode createMode)
        Set the createMode property: Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
        Overrides:
        withCreateMode in class ProtectedItem
        Parameters:
        createMode - the createMode value to set.
        Returns:
        the ProtectedItem object itself.
      • withDeferredDeleteTimeInUtc

        public GenericProtectedItem withDeferredDeleteTimeInUtc​(OffsetDateTime deferredDeleteTimeInUtc)
        Set the deferredDeleteTimeInUtc property: Time for deferred deletion in UTC.
        Overrides:
        withDeferredDeleteTimeInUtc in class ProtectedItem
        Parameters:
        deferredDeleteTimeInUtc - the deferredDeleteTimeInUtc value to set.
        Returns:
        the ProtectedItem object itself.
      • withIsScheduledForDeferredDelete

        public GenericProtectedItem withIsScheduledForDeferredDelete​(Boolean isScheduledForDeferredDelete)
        Set the isScheduledForDeferredDelete property: Flag to identify whether the DS is scheduled for deferred delete.
        Overrides:
        withIsScheduledForDeferredDelete in class ProtectedItem
        Parameters:
        isScheduledForDeferredDelete - the isScheduledForDeferredDelete value to set.
        Returns:
        the ProtectedItem object itself.
      • withDeferredDeleteTimeRemaining

        public GenericProtectedItem withDeferredDeleteTimeRemaining​(String deferredDeleteTimeRemaining)
        Set the deferredDeleteTimeRemaining property: Time remaining before the DS marked for deferred delete is permanently deleted.
        Overrides:
        withDeferredDeleteTimeRemaining in class ProtectedItem
        Parameters:
        deferredDeleteTimeRemaining - the deferredDeleteTimeRemaining value to set.
        Returns:
        the ProtectedItem object itself.
      • withIsDeferredDeleteScheduleUpcoming

        public GenericProtectedItem withIsDeferredDeleteScheduleUpcoming​(Boolean isDeferredDeleteScheduleUpcoming)
        Set the isDeferredDeleteScheduleUpcoming property: Flag to identify whether the deferred deleted DS is to be purged soon.
        Overrides:
        withIsDeferredDeleteScheduleUpcoming in class ProtectedItem
        Parameters:
        isDeferredDeleteScheduleUpcoming - the isDeferredDeleteScheduleUpcoming value to set.
        Returns:
        the ProtectedItem object itself.
      • withIsRehydrate

        public GenericProtectedItem withIsRehydrate​(Boolean isRehydrate)
        Set the isRehydrate property: Flag to identify that deferred deleted DS is to be moved into Pause state.
        Overrides:
        withIsRehydrate in class ProtectedItem
        Parameters:
        isRehydrate - the isRehydrate value to set.
        Returns:
        the ProtectedItem object itself.
      • withResourceGuardOperationRequests

        public GenericProtectedItem withResourceGuardOperationRequests​(List<String> resourceGuardOperationRequests)
        Set the resourceGuardOperationRequests property: ResourceGuardOperationRequests on which LAC check will be performed.
        Overrides:
        withResourceGuardOperationRequests in class ProtectedItem
        Parameters:
        resourceGuardOperationRequests - the resourceGuardOperationRequests value to set.
        Returns:
        the ProtectedItem object itself.
      • withIsArchiveEnabled

        public GenericProtectedItem withIsArchiveEnabled​(Boolean isArchiveEnabled)
        Set the isArchiveEnabled property: Flag to identify whether datasource is protected in archive.
        Overrides:
        withIsArchiveEnabled in class ProtectedItem
        Parameters:
        isArchiveEnabled - the isArchiveEnabled value to set.
        Returns:
        the ProtectedItem object itself.
      • withPolicyName

        public GenericProtectedItem withPolicyName​(String policyName)
        Set the policyName property: Name of the policy used for protection.
        Overrides:
        withPolicyName in class ProtectedItem
        Parameters:
        policyName - the policyName value to set.
        Returns:
        the ProtectedItem object itself.