Class RestoreParameters


  • public final class RestoreParameters
    extends Object
    Parameters to indicate the information about the restore.
    • Constructor Detail

      • RestoreParameters

        public RestoreParameters()
    • Method Detail

      • restoreMode

        public RestoreMode restoreMode()
        Get the restoreMode property: Describes the mode of the restore.
        Returns:
        the restoreMode value.
      • withRestoreMode

        public RestoreParameters withRestoreMode​(RestoreMode restoreMode)
        Set the restoreMode property: Describes the mode of the restore.
        Parameters:
        restoreMode - the restoreMode value to set.
        Returns:
        the RestoreParameters object itself.
      • restoreSource

        public String restoreSource()
        Get the restoreSource property: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}.
        Returns:
        the restoreSource value.
      • withRestoreSource

        public RestoreParameters withRestoreSource​(String restoreSource)
        Set the restoreSource property: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}.
        Parameters:
        restoreSource - the restoreSource value to set.
        Returns:
        the RestoreParameters object itself.
      • restoreTimestampInUtc

        public OffsetDateTime restoreTimestampInUtc()
        Get the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
        Returns:
        the restoreTimestampInUtc value.
      • withRestoreTimestampInUtc

        public RestoreParameters withRestoreTimestampInUtc​(OffsetDateTime restoreTimestampInUtc)
        Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
        Parameters:
        restoreTimestampInUtc - the restoreTimestampInUtc value to set.
        Returns:
        the RestoreParameters object itself.
      • databasesToRestore

        public List<DatabaseRestoreResourceInner> databasesToRestore()
        Get the databasesToRestore property: List of specific databases available for restore.
        Returns:
        the databasesToRestore value.
      • withDatabasesToRestore

        public RestoreParameters withDatabasesToRestore​(List<DatabaseRestoreResourceInner> databasesToRestore)
        Set the databasesToRestore property: List of specific databases available for restore.
        Parameters:
        databasesToRestore - the databasesToRestore value to set.
        Returns:
        the RestoreParameters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.