@acceleratxr/core_sdk / BackupStorageLocation
Class: BackupStorageLocation#
Defines a single location of remote storage that will be used to maintain backup snapshots.
REQUIRES: Backup Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ BackupStorageLocation
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new BackupStorageLocation(other?: any): BackupStorageLocation
Overrides EntityBase.constructor
Defined in src/models/BackupStorageLocation.ts:71
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: BackupStorageLocation
Properties#
accessKey#
• accessKey: string = “”
Defined in src/models/BackupStorageLocation.ts:30
The API access key to authenticate with the remote server with.
active#
• active: boolean = true
Defined in src/models/BackupStorageLocation.ts:36
Indicates if the backup location is currently active for storing database snapshots. An inactive location can still be used to search and retrieve existing snapshots.
bucket#
• bucket: string = “”
Defined in src/models/BackupStorageLocation.ts:41
The name of the remote storage bucket.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
description#
• description: string = “”
Defined in src/models/BackupStorageLocation.ts:25
A textual description of the storage location.
host#
• host: string = “”
Defined in src/models/BackupStorageLocation.ts:46
The host of the remote storage provider.
name#
• name: string = “”
Defined in src/models/BackupStorageLocation.ts:20
The unique name of the storage location.
options#
• options: any = undefined
Defined in src/models/BackupStorageLocation.ts:51
Additional configuration options used by the storage provider.
path#
• path: string = “”
Defined in src/models/BackupStorageLocation.ts:56
The path prefix or sub-directory to store files.
provider#
• provider: StorageProvider = StorageProvider.LOCAL
Defined in src/models/BackupStorageLocation.ts:61
Describes the provider type of storage location.
region#
• region: string = “”
Defined in src/models/BackupStorageLocation.ts:66
The region that the bucket is located in. Note this is not supported by all providers.
secret#
• secret: string = “”
Defined in src/models/BackupStorageLocation.ts:71
The API secret to authenticate with the remote server with.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/BackupStorageLocation.ts:15
Returns: string