Package com.oracle.bmc.core.model

Class BootVolumeBackup.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • bootVolumeId

        public BootVolumeBackup.Builder bootVolumeId​(String bootVolumeId)
        The OCID of the boot volume.
        Parameters:
        bootVolumeId - the value to set
        Returns:
        this builder

      • compartmentId

        public BootVolumeBackup.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the boot volume backup.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • definedTags

        public BootVolumeBackup.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public BootVolumeBackup.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • displayName

        public BootVolumeBackup.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • expirationTime

        public BootVolumeBackup.Builder expirationTime​(Date expirationTime)
        The date and time the volume backup will expire and be automatically deleted.

        Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

        Parameters:
        expirationTime - the value to set
        Returns:
        this builder

      • freeformTags

        public BootVolumeBackup.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • imageId

        public BootVolumeBackup.Builder imageId​(String imageId)
        The image OCID used to create the boot volume the backup is taken from.
        Parameters:
        imageId - the value to set
        Returns:
        this builder

      • kmsKeyId

        public BootVolumeBackup.Builder kmsKeyId​(String kmsKeyId)
        The OCID of the Vault service master encryption assigned to the boot volume backup.

        For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

        Parameters:
        kmsKeyId - the value to set
        Returns:
        this builder

      • sizeInGBs

        public BootVolumeBackup.Builder sizeInGBs​(Long sizeInGBs)
        The size of the boot volume, in GBs.
        Parameters:
        sizeInGBs - the value to set
        Returns:
        this builder

      • sourceBootVolumeBackupId

        public BootVolumeBackup.Builder sourceBootVolumeBackupId​(String sourceBootVolumeBackupId)
        The OCID of the source boot volume backup.
        Parameters:
        sourceBootVolumeBackupId - the value to set
        Returns:
        this builder

      • timeCreated

        public BootVolumeBackup.Builder timeCreated​(Date timeCreated)
        The date and time the boot volume backup was created.

        This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeRequestReceived

        public BootVolumeBackup.Builder timeRequestReceived​(Date timeRequestReceived)
        The date and time the request to create the boot volume backup was received.

        Format defined by RFC3339.

        Parameters:
        timeRequestReceived - the value to set
        Returns:
        this builder

      • uniqueSizeInGBs

        public BootVolumeBackup.Builder uniqueSizeInGBs​(Long uniqueSizeInGBs)
        The size used by the backup, in GBs.

        It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

        Parameters:
        uniqueSizeInGBs - the value to set
        Returns:
        this builder

      • timeRetentionExpiresAt

        public BootVolumeBackup.Builder timeRetentionExpiresAt​(Date timeRetentionExpiresAt)
        The date and time when a backup\u2019s retention period ends and it is set to expire.

        This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.

        Parameters:
        timeRetentionExpiresAt - the value to set
        Returns:
        this builder

      • isPreventDeletionEnabled

        public BootVolumeBackup.Builder isPreventDeletionEnabled​(Boolean isPreventDeletionEnabled)
        Prevent backups from being deleted during the configured retention period.

        This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

        Parameters:
        isPreventDeletionEnabled - the value to set
        Returns:
        this builder

      • isRetentionLockEnabled

        public BootVolumeBackup.Builder isRetentionLockEnabled​(Boolean isRetentionLockEnabled)
        feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance.

        This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

        Parameters:
        isRetentionLockEnabled - the value to set
        Returns:
        this builder

      • isIndefiniteRetentionEnabled

        public BootVolumeBackup.Builder isIndefiniteRetentionEnabled​(Boolean isIndefiniteRetentionEnabled)
        feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies.

        This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.

        Parameters:
        isIndefiniteRetentionEnabled - the value to set
        Returns:
        this builder

      • volumeGroupBackupId

        public BootVolumeBackup.Builder volumeGroupBackupId​(String volumeGroupBackupId)
        The OCID of the volume group backup associated with the backup.

        This is an optional field. If it is not present in the response, the backup does not belong to a volume group.

        Parameters:
        volumeGroupBackupId - the value to set
        Returns:
        this builder