Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Backup

A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System.

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](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional backupSizeInGBs

backupSizeInGBs: undefined | number

The size of the backup in base-2 (IEC) gibibytes. (GiB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

backupType

backupType: BackupType

The type of backup.

compartmentId

compartmentId: string

The OCID of the compartment.

creationType

creationType: CreationType

Indicates how the backup was created: manually, automatic, or by an Operator.

Optional dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

Initial size of the data volume in GiBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

dbSystemId

dbSystemId: string

The OCID of the DB System the backup is associated with.

Optional dbSystemSnapshot

dbSystemSnapshot: model.DbSystemSnapshot

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user-supplied description for the backup.

Optional displayName

displayName: undefined | string

A user-supplied display name for the backup.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

OCID of the backup itself

lifecycleDetails

lifecycleDetails: string

Additional information about the current lifecycleState.

lifecycleState

lifecycleState: LifecycleState

The state of the backup.

Optional mysqlVersion

mysqlVersion: undefined | string

The MySQL server version of the DB System used for backup.

Optional retentionInDays

retentionInDays: undefined | number

Number of days to retain this backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional shapeName

shapeName: undefined | string

The shape of the DB System used for backup.

timeCreated

timeCreated: Date

The time the backup record was created.

timeUpdated

timeUpdated: Date

The time at which the backup was updated.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Backup): object

getJsonObj

  • getJsonObj(obj: Backup): object