CreateMode Class

public final class CreateMode
extends ExpandableStringEnum<CreateMode>

Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

Field Summary

Modifier and Type Field and Description
static final CreateMode COPY

Static value Copy for CreateMode.

static final CreateMode DEFAULT

Static value Default for CreateMode.

static final CreateMode ONLINE_SECONDARY

Static value OnlineSecondary for CreateMode.

static final CreateMode POINT_IN_TIME_RESTORE

Static value PointInTimeRestore for CreateMode.

static final CreateMode RECOVERY

Static value Recovery for CreateMode.

static final CreateMode RESTORE

Static value Restore for CreateMode.

static final CreateMode RESTORE_EXTERNAL_BACKUP

Static value RestoreExternalBackup for CreateMode.

static final CreateMode RESTORE_EXTERNAL_BACKUP_SECONDARY

Static value RestoreExternalBackupSecondary for CreateMode.

static final CreateMode RESTORE_LONG_TERM_RETENTION_BACKUP

Static value RestoreLongTermRetentionBackup for CreateMode.

static final CreateMode SECONDARY

Static value Secondary for CreateMode.

Constructor Summary

Constructor Description
CreateMode()

Method Summary

Modifier and Type Method and Description
static CreateMode fromString(String name)

Creates or finds a CreateMode from its string representation.

static Collection<CreateMode> values()

Gets known CreateMode values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

COPY

public static final CreateMode COPY

Static value Copy for CreateMode.

DEFAULT

public static final CreateMode DEFAULT

Static value Default for CreateMode.

ONLINE_SECONDARY

public static final CreateMode ONLINE_SECONDARY

Static value OnlineSecondary for CreateMode.

POINT_IN_TIME_RESTORE

public static final CreateMode POINT_IN_TIME_RESTORE

Static value PointInTimeRestore for CreateMode.

RECOVERY

public static final CreateMode RECOVERY

Static value Recovery for CreateMode.

RESTORE

public static final CreateMode RESTORE

Static value Restore for CreateMode.

RESTORE_EXTERNAL_BACKUP

public static final CreateMode RESTORE_EXTERNAL_BACKUP

Static value RestoreExternalBackup for CreateMode.

RESTORE_EXTERNAL_BACKUP_SECONDARY

public static final CreateMode RESTORE_EXTERNAL_BACKUP_SECONDARY

Static value RestoreExternalBackupSecondary for CreateMode.

RESTORE_LONG_TERM_RETENTION_BACKUP

public static final CreateMode RESTORE_LONG_TERM_RETENTION_BACKUP

Static value RestoreLongTermRetentionBackup for CreateMode.

SECONDARY

public static final CreateMode SECONDARY

Static value Secondary for CreateMode.

Constructor Details

CreateMode

public CreateMode()

Method Details

fromString

public static CreateMode fromString(String name)

Creates or finds a CreateMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding CreateMode.

values

public static Collection values()

Gets known CreateMode values.

Returns:

known CreateMode values.

Applies to