Package com.oracle.bmc.core.model

Class BootVolumeBackup

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class BootVolumeBackup
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume.

    For more information, see Overview of Boot Volume Backups To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the BootVolumeBackup.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the BootVolumeBackup.Builder, which maintain a set of all explicitly set fields called BootVolumeBackup.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getBootVolumeId

        public String getBootVolumeId()
        The OCID of the boot volume.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the boot volume backup.
        Returns:
        the value

      • getDefinedTags

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

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

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

        Returns:
        the value

      • getSystemTags

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

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

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

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

        Returns:
        the value

      • getExpirationTime

        public Date getExpirationTime()
        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.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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"}

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the boot volume backup.
        Returns:
        the value

      • getImageId

        public String getImageId()
        The image OCID used to create the boot volume the backup is taken from.
        Returns:
        the value

      • getKmsKeyId

        public String getKmsKeyId()
        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.

        Returns:
        the value

      • getSizeInGBs

        public Long getSizeInGBs()
        The size of the boot volume, in GBs.
        Returns:
        the value

      • getSourceBootVolumeBackupId

        public String getSourceBootVolumeBackupId()
        The OCID of the source boot volume backup.
        Returns:
        the value

      • getSourceType

        public BootVolumeBackup.SourceType getSourceType()
        Specifies whether the backup was created manually, or via scheduled backup policy.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        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.

        Returns:
        the value

      • getTimeRequestReceived

        public Date getTimeRequestReceived()
        The date and time the request to create the boot volume backup was received.

        Format defined by RFC3339.

        Returns:
        the value

      • getUniqueSizeInGBs

        public Long getUniqueSizeInGBs()
        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.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel