Package com.oracle.bmc.recovery.model

Class CreateLongTermBackupDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210216")
public final class CreateLongTermBackupDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Describes the parameters required to create an on demand long term backup.
    Note: Objects should always be created or deserialized using the CreateLongTermBackupDetails.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 CreateLongTermBackupDetails.Builder, which maintain a set of all explicitly set fields called CreateLongTermBackupDetails.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

      • getDisplayName

        public String getDisplayName()
        A user provided name for the long term backup.

        The ‘displayName’ does not have to be unique, and it can be modified. Avoid entering confidential information.

        Returns:
        the value

      • getProtectedDatabaseId

        public String getProtectedDatabaseId()
        The OCID of the protected database for which you want to create the long-term backup.
        Returns:
        the value

      • getRetentionScn

        public Integer getRetentionScn()
        The desired target point (SCN) at which you want to create the long-term backup of the database.For example, specify the value as 1000 if you want to create the long-term backup until SCN 1000.

        If you want to specify the target point as a time expression instead of the SCN value, then use the longTermRetentionPointInTime parameter.

        Returns:
        the value

      • getRetentionPointInTime

        public Date getRetentionPointInTime()
        An RFC3339 formatted datetime string that indicates the desired target point in time in the database at which you want to create the long-term backup.

        For example, if you want the long-term backup to include all the changes until May 22 at 9:10 PM, then specify the value as, ‘2020-05-22T21:10:00.000Z’. If you want to specify the target point as an SCN value instead of the target time, then use the databaseSCN parameter.

        Returns:
        the value

      • getRetentionPeriod

        public List<RetentionPeriodValue> getRetentionPeriod()
        The maximum period to retain the long-term backup.

        Specify the retention period type and the duration for the long-term backup. If you have chosen the retention period type as ‘DAYS’, then specify a duration ranging from 90 days to 3650 days. If you have chosen the retention period type as ‘YEARS’, then specify a duration ranging from 1 year to 10 years.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        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. Example: {“foo-namespace”: {“bar-key”: “value”}}. For more information, see Resource Tags

        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