@acceleratxr/core_sdk / AssetStorageLocation
Class: AssetStorageLocation#
Defines a single location of remote storage that will be used to maintain assets.
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ AssetStorageLocation
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new AssetStorageLocation(other?: any): AssetStorageLocation
Overrides EntityBase.constructor
Defined in src/models/AssetStorageLocation.ts:83
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: AssetStorageLocation
Properties#
accessKey#
• accessKey: string = “”
Defined in src/models/AssetStorageLocation.ts:28
The API access key to authenticate with the remote server with.
active#
• active: boolean = true
Defined in src/models/AssetStorageLocation.ts:33
Indicates if the storage location is currently active for storing assets.
bucket#
• bucket: string = “”
Defined in src/models/AssetStorageLocation.ts:38
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/AssetStorageLocation.ts:23
A textual description of the storage location.
excludes#
• excludes: Array<string> = []
Defined in src/models/AssetStorageLocation.ts:43
A list of regex patterns of asset names that will be ignored from being stored in this location.
host#
• host: string = “”
Defined in src/models/AssetStorageLocation.ts:48
The host of the remote storage provider.
includes#
• includes: Array<string> = []
Defined in src/models/AssetStorageLocation.ts:53
A list of regex patterns of asset names that will be stored in this location.
name#
• name: string = “”
Defined in src/models/AssetStorageLocation.ts:18
The unique name of the storage location.
options#
• options: any = undefined
Defined in src/models/AssetStorageLocation.ts:58
Additional configuration options used by the storage provider.
path#
• path: string = “”
Defined in src/models/AssetStorageLocation.ts:63
The path prefix or sub-directory to store files.
provider#
• provider: StorageProvider = StorageProvider.LOCAL
Defined in src/models/AssetStorageLocation.ts:68
Describes the provider type of storage location.
region#
• region: string = “”
Defined in src/models/AssetStorageLocation.ts:73
The region that the bucket is located in. Note this is not supported by all providers.
secret#
• secret: string = “”
Defined in src/models/AssetStorageLocation.ts:78
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.
url#
• url: string = “”
Defined in src/models/AssetStorageLocation.ts:83
The public base URL that assets stored in this location will use.
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/AssetStorageLocation.ts:13
Returns: string